README.md

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