-Licence
-=======
-
+License
+-------
+
+ 
+
Copyright © 2008,2009,2010 Fundacja Nowoczesna Polska <fundacja@nowoczesnapolska.org.pl>
-
- For full list of contibutors see AUTHORS section at the end.
+
+ For full list of contributors see AUTHORS section at the end.
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/>.
-Librarian
-=========
+About
+------
+
+Librarian converts XML-based markup language used by FNP for writing books to
+other formats, which are more suitable for presentation.
+
+Currently we support:
-Librarian (*ang. bibliotekarz*) to biblioteka służąca do konwersji języka składu książek opartego na XML opracowanego przez Fundację Nowoczesna Polska na inne formaty.
+ * HTML4, XHTML 1.0
+ * Plain text
+ * EPUB (XHTML based)
+ * print-ready PDF
-Obecnie obsługiwane są formaty:
+Other features:
- * XML
- * TXT
-
-Biblioteka librarian potrafi również parsować metadane opisane przez DublinCore oraz wyciągać fragmenty motywów z lektur.
+ * extract DublinCore meta-data from documents;
+ * extract marked "themes" from documents.
-Wymagania
----------
+Dependencies
+------------
- * [lxml 2.2](http://codespeak.net/lxml/)
+ * 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>
-
-Instalacja
-----------
-Zainstaluj biblioteki z sekcji *Wymagania* powyżej. Następnie rozpakuj archiwum z biblioteką librarian, przejdź w terminalu do rozpakowanego katalogu i wpisz:
-<pre>python setup.py install</pre>
+Installation
+------------
-Na Linuxie i OSX mogą być wymagane uprawnienia administratora. W takim wypadku wpisz:
+Librarian uses standard Python distutils for packaging. After installing all the dependencies just run:
-<pre>sudo python setup.py install</pre>
+ python setup.py install
-Alternatywnie możesz zainstalować bibliotekę librarian w wybranym przez siebie katalogu. W takim wypadku należy użyć argumentu *prefix* do *setup.py*:
+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'.
-<pre>python setup.py install --prefix=ŚCIEŻKA_DO_WYBRANEGO_KATALOGU</pre>
+Usage
+------
-W takim wypadku będzie jednak potrzebne własnoręczne edytowanie zmiennych systemowych *PATH* i *PYTHONPATH*.
+To convert a series of files to XHTML:
+ book2html file1.xml [file2.xml ...]
-Sposób użycia
--------------
-Konwersja plików lektur do XHTML:
+To convert a series of files to plain text:
-<pre>book2html LEKTURA1 LEKTURA2...</pre>
+ book2txt file1.xml [file2.xml ...]
-Konwersja plików lektur do TXT:
+To convert a file to EPUB:
-<pre>book2txt LEKTURA1 LEKTURA2...</pre>
+ book2epub file.xml
-Wyciągnięcie wszystkich fragmentów motywów z wygenerowanych plików XHTML:
+To convert a file to PDF:
+
+ book2pdf file.xml
+
+To extract book fragments marked as "theme":
+
+ bookfragments file1.xml [file2.xml ...]
-<pre>bookfragments PLIK1 PLIK2...</pre>
Authors
-------
-Originally written by Marek Stępniowski <marek@stepniowski>;
+Originally written by Marek Stępniowski <marek@stepniowski.com>
Later contributions:
- Łukasz Rekucki <lrekucki@gmail.com>
-
-
-
+ * Łukasz Rekucki <lrekucki@gmail.com>
+ * Radek Czajka <radek.czajka@gmail.com>
\ No newline at end of file
fnp / librarian.git / blobdiff