README.md

   1 License
   2 -------
   3
   4     Copyright © 2008,2009,2010 Fundacja Nowoczesna Polska <fundacja@nowoczesnapolska.org.pl>
   5
   6     For full list of contributors see AUTHORS section at the end.
   7
   8     This program is free software: you can redistribute it and/or modify
   9     it under the terms of the GNU Affero General Public License as published by
  10     the Free Software Foundation, either version 3 of the License, or
  11     (at your option) any later version.
  12
  13     This program is distributed in the hope that it will be useful,
  14     but WITHOUT ANY WARRANTY; without even the implied warranty of
  15     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16     GNU Affero General Public License for more details.
  17
  18     You should have received a copy of the GNU Affero General Public License
  19     along with this program.  If not, see <http://www.gnu.org/licenses/>.
  20
  21
  22 About
  23 ------
  24
  25 Librarian converts XML-based markup language used by FNP for writing books to other formats, whiche are more subtable for presentation.
  26
  27 Currently we support:
  28
  29  * HTML4, XHTML 1.0
  30  * Plain text
  31
  32 In the future, we plan to support:
  33
  34  * EPUB (XHTML based)
  35  * print-ready PDF
  36
  37
  38 Other features:
  39
  40  * extract DublinCore meta-data from documents;
  41  * extract marked "themes" from documents.
  42
  43
  44 Dependencies
  45 ------------
  46
  47  * [lxml] (http://codespeak.net/lxml/) >= 2.2
  48
  49
  50 Installation
  51 ------------
  52
  53 Librarian uses standard Python distutils for packaging. After installing all the dependencies just run:
  54
  55     python setup.py install
  56
  57
  58 Usage
  59 ------
  60
  61 To convert a series of file to XHTML:
  62
  63     book2html file1.xml [file2.xml ...]
  64
  65 To convert a series of file to plain text:
  66
  67     book2txt file1.xml [file2.xml ...]
  68
  69 To extract book fragments marked as "theme":
  70
  71     bookfragments file1.xml [file2.xml ...]
  72
  73
  74 Authors
  75 -------
  76 Originally written by Marek Stępniowski <marek@stepniowski>
  77
  78 Later contributions:
  79     Łukasz Rekucki <lrekucki@gmail.com>