3debf766740fabc6b1316f8789b3496d763fa7bf
[librarian.git] / README.txt
1 Librarian
2 =========
3 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.
4
5 Obecnie obsługiwane są formaty:
6
7  * XML
8  * TXT
9  
10 Biblioteka librarian potrafi również parsować metadane opisane przez DublinCore oraz wyciągać fragmenty motywów z lektur.
11
12
13 Wymagania
14 ---------
15
16  * [lxml 2.2](http://codespeak.net/lxml/)
17
18  
19 Instalacja
20 ----------
21 Zainstaluj biblioteki z sekcji *Wymagania* powyżej. Następnie rozpakuj archiwum z biblioteką librarian, przejdź w terminalu do rozpakowanego katalogu i wpisz:
22
23 <pre>python setup.py install</pre>
24
25 Na Linuxie i OSX mogą być wymagane uprawnienia administratora. W takim wypadku wpisz:
26
27 <pre>sudo python setup.py install</pre>
28
29 Alternatywnie możesz zainstalować bibliotekę librarian w wybranym przez siebie katalogu. W takim wypadku należy użyć argumentu *prefix* do *setup.py*:
30
31 <pre>python setup.py install --prefix=ŚCIEŻKA_DO_WYBRANEGO_KATALOGU</pre> 
32
33 W takim wypadku będzie jednak potrzebne własnoręczne edytowanie zmiennych systemowych *PATH* i *PYTHONPATH*.
34
35
36 Sposób użycia
37 -------------
38 Konwersja plików lektur do XHTML:
39
40 <pre>book2html LEKTURA1 LEKTURA2...</pre>
41
42 Konwersja plików lektur do TXT:
43
44 <pre>book2txt LEKTURA1 LEKTURA2...</pre>
45
46 Wyciągnięcie wszystkich fragmentów motywów z wygenerowanych plików XHTML:
47
48 <pre>bookfragments PLIK1 PLIK2...</pre>
49