License
-------
-
- Copyright © 2008,2009,2010 Fundacja Nowoczesna Polska <fundacja@nowoczesnapolska.org.pl>
-
- For full list of contributors see AUTHORS section at the end.
+
+ ![AGPL Logo](http://www.gnu.org/graphics/agplv3-155x51.png)
+
+ Copyright © 2008-2019 Fundacja Nowoczesna Polska <fundacja@nowoczesnapolska.org.pl>
+
+ For full list of contributors see AUTHORS file.
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as published by
along with this program. If not, see <http://www.gnu.org/licenses/>.
-About
+About
------
-Librarian converts XML-based markup language used by FNP for writing books to other formats, whiche are more subtable for presentation.
+Librarian converts XML-based markup language used by FNP for writing books to
+other formats, which are more suitable for presentation.
Currently we support:
- * HTML4, XHTML 1.0
- * Plain text
-
-In the future, we plan to support:
-
+ * HTML4, XHTML 1.0 (?)
+ * Plain text
* EPUB (XHTML based)
- * print-ready PDF
-
+ * MOBI
+ * print-ready PDF
+ * FB2
-Other features:
+Other features:
* extract DublinCore meta-data from documents;
* extract marked "themes" from documents.
Dependencies
------------
- * [lxml] (http://codespeak.net/lxml/) >= 2.2
+ * lxml <http://codespeak.net/lxml/>, version 2.2 or later
+ * additional PDF converter dependencies:
+ * XeTeX with support for Polish language
+ * TeXML <http://getfo.org/texml/>
+ * recommended: morefloats LaTeX package, version >=1.0c
+ for dealing with documents with many motifs in one paragraph.
+ <http://www.ctan.org/tex-archive/help/Catalogue/entries/morefloats.html>
Installation
Librarian uses standard Python distutils for packaging. After installing all the dependencies just run:
python setup.py install
-
+
+PDF converter also needs the Junicode-WL fonts (librarian/pdf/JunicodeWL-*.ttf) installed.
+In Debian/Ubuntu, put those files in ~/.fonts/ and run `fc-cache'.
Usage
------
-To convert a series of file to XHTML:
+To convert a series of files to XHTML:
book2html file1.xml [file2.xml ...]
-To convert a series of file to plain text:
+To convert a series of files to plain text:
book2txt file1.xml [file2.xml ...]
-To extract book fragments marked as "theme":
+To convert a file to EPUB:
- bookfragments file1.xml [file2.xml ...]
+ book2epub file.xml
+To convert a file to PDF:
-Authors
--------
-Originally written by Marek Stępniowski <marek@stepniowski.com>
-
-Later contributions:
+ book2pdf file.xml
- * Łukasz Rekucki <lrekucki@gmail.com>
\ No newline at end of file
+To extract book fragments marked as "theme":
+
+ bookfragments file1.xml [file2.xml ...]