X-Git-Url: https://git.mdrn.pl/librarian.git/blobdiff_plain/861348cca153705d844f9e50358a2076ef8be295..82c0860d1520489be56457829d49eb17f165b9cd:/README.md?ds=inline diff --git a/README.md b/README.md old mode 100755 new mode 100644 index d3c99cd..a64e37a --- a/README.md +++ b/README.md @@ -1,9 +1,11 @@ License ------- - - Copyright © 2008,2009,2010 Fundacja Nowoczesna Polska - - For full list of contributors see AUTHORS section at the end. + + ![AGPL Logo](http://www.gnu.org/graphics/agplv3-155x51.png) + + Copyright © 2008-2023 Fundacja Wolne Lektury + + 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 @@ -19,23 +21,22 @@ License along with this program. If not, see . -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 WL 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. @@ -44,7 +45,13 @@ Other features: Dependencies ------------ - * [lxml] (http://codespeak.net/lxml/) >= 2.2 + * lxml , version 2.2 or later + * additional PDF converter dependencies: + * XeTeX with support for Polish language + * TeXML + * recommended: morefloats LaTeX package, version >=1.0c + for dealing with documents with many motifs in one paragraph. + Installation @@ -53,28 +60,29 @@ 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 - -Later contributions: + book2pdf file.xml - * Łukasz Rekucki \ No newline at end of file +To extract book fragments marked as "theme": + + bookfragments file1.xml [file2.xml ...]