X-Git-Url: https://git.mdrn.pl/librarian.git/blobdiff_plain/07fdba2c7fe8e11b6867712d47bdd608e88c29fb..6642c1c71c5c6ce6ef3401c8c9da84cf076b018b:/README.txt diff --git a/README.txt b/README.txt new file mode 100644 index 0000000..3debf76 --- /dev/null +++ b/README.txt @@ -0,0 +1,49 @@ +Librarian +========= +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. + +Obecnie obsÅugiwane sÄ formaty: + + * XML + * TXT + +Biblioteka librarian potrafi również parsowaÄ metadane opisane przez DublinCore oraz wyciÄ gaÄ fragmenty motywów z lektur. + + +Wymagania +--------- + + * [lxml 2.2](http://codespeak.net/lxml/) + + +Instalacja +---------- +Zainstaluj biblioteki z sekcji *Wymagania* powyżej. NastÄpnie rozpakuj archiwum z bibliotekÄ librarian, przejdź w terminalu do rozpakowanego katalogu i wpisz: + +
python setup.py install+ +Na Linuxie i OSX mogÄ byÄ wymagane uprawnienia administratora. W takim wypadku wpisz: + +
sudo 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*: + +
python setup.py install --prefix=ÅCIEÅ»KA_DO_WYBRANEGO_KATALOGU+ +W takim wypadku bÄdzie jednak potrzebne wÅasnorÄczne edytowanie zmiennych systemowych *PATH* i *PYTHONPATH*. + + +Sposób użycia +------------- +Konwersja plików lektur do XHTML: + +
book2html LEKTURA1 LEKTURA2...+ +Konwersja plików lektur do TXT: + +
book2txt LEKTURA1 LEKTURA2...+ +WyciÄ gniÄcie wszystkich fragmentów motywów z wygenerowanych plików XHTML: + +
bookfragments PLIK1 PLIK2...+