X-Git-Url: https://git.mdrn.pl/librarian.git/blobdiff_plain/aa0daf95a4ba4503a94fc6458ede9d9ca8b1d0d1..f33381c4b0468544123ff05295033da7cc4bf61f:/README.md diff --git a/README.md b/README.md index d19505d..7c27d2d 100755 --- a/README.md +++ b/README.md @@ -1,5 +1,7 @@ License ------- + + ![AGPL Logo](http://www.gnu.org/graphics/agplv3-155x51.png) Copyright © 2008,2009,2010 Fundacja Nowoczesna Polska @@ -28,14 +30,10 @@ other formats, which are more suitable for presentation. Currently we support: * HTML4, XHTML 1.0 - * Plain text - -In the future, we plan to support: - + * Plain text * EPUB (XHTML based) - * print-ready PDF - - + * print-ready PDF + Other features: * extract DublinCore meta-data from documents; @@ -45,7 +43,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 @@ -59,14 +63,22 @@ Librarian uses standard Python distutils for packaging. After installing all the 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 convert a file to EPUB: + + book2epub file.xml + +To convert a file to PDF: + + book2pdf file.xml + To extract book fragments marked as "theme": bookfragments file1.xml [file2.xml ...] @@ -78,4 +90,5 @@ Originally written by Marek Stępniowski Later contributions: - * Łukasz Rekucki \ No newline at end of file + * Łukasz Rekucki + * Radek Czajka \ No newline at end of file