README.md

   1 Licence
   2 =======
   3
   4     Copyright © 2008,2009,2010 Fundacja Nowoczesna Polska <fundacja@nowoczesnapolska.org.pl>
   5
   6     For full list of contibutors see AUTHORS section at the end.
   7
   8     This program is free software: you can redistribute it and/or modify
   9     it under the terms of the GNU Affero General Public License as published by
  10     the Free Software Foundation, either version 3 of the License, or
  11     (at your option) any later version.
  12
  13     This program is distributed in the hope that it will be useful,
  14     but WITHOUT ANY WARRANTY; without even the implied warranty of
  15     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16     GNU Affero General Public License for more details.
  17
  18     You should have received a copy of the GNU Affero General Public License
  19     along with this program.  If not, see <http://www.gnu.org/licenses/>.
  20
  21
  22 Librarian
  23 =========
  24
  25 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.
  26
  27 Obecnie obsługiwane są formaty:
  28
  29  * XML
  30  * TXT
  31
  32 Biblioteka librarian potrafi również parsować metadane opisane przez DublinCore oraz wyciągać fragmenty motywów z lektur.
  33
  34
  35 Wymagania
  36 ---------
  37
  38  * [lxml 2.2](http://codespeak.net/lxml/)
  39
  40
  41 Instalacja
  42 ----------
  43 Zainstaluj biblioteki z sekcji *Wymagania* powyżej. Następnie rozpakuj archiwum z biblioteką librarian, przejdź w terminalu do rozpakowanego katalogu i wpisz:
  44
  45 <pre>python setup.py install</pre>
  46
  47 Na Linuxie i OSX mogą być wymagane uprawnienia administratora. W takim wypadku wpisz:
  48
  49 <pre>sudo python setup.py install</pre>
  50
  51 Alternatywnie możesz zainstalować bibliotekę librarian w wybranym przez siebie katalogu. W takim wypadku należy użyć argumentu *prefix* do *setup.py*:
  52
  53 <pre>python setup.py install --prefix=ŚCIEŻKA_DO_WYBRANEGO_KATALOGU</pre>
  54
  55 W takim wypadku będzie jednak potrzebne własnoręczne edytowanie zmiennych systemowych *PATH* i *PYTHONPATH*.
  56
  57
  58 Sposób użycia
  59 -------------
  60 Konwersja plików lektur do XHTML:
  61
  62 <pre>book2html LEKTURA1 LEKTURA2...</pre>
  63
  64 Konwersja plików lektur do TXT:
  65
  66 <pre>book2txt LEKTURA1 LEKTURA2...</pre>
  67
  68 Wyciągnięcie wszystkich fragmentów motywów z wygenerowanych plików XHTML:
  69
  70 <pre>bookfragments PLIK1 PLIK2...</pre>
  71
  72 Authors
  73 -------
  74 Originally written by Marek Stępniowski <marek@stepniowski>;
  75
  76 Later contributions:
  77     Łukasz Rekucki <lrekucki@gmail.com>
  78
  79
  80
  81