Changed README syntax to markdown.
[wolnelektury.git] / README
1 Dependencies
2 ============
3  
4  * [Django 1.0](http://djangoproject.com/) (application framework)
5  * [lxml 2.0.0](http://codespeak.net/lxml/) (for importing books)
6  
7  
8 Numbering
9 =========
10
11 Co numerujemy
12
13  1. W utworach wierszowanych każdy wers,
14     * przy czym powinien pokazywać się co 5 numer wersu
15     * utwory wierszowane tzn. wiersze liryczne, poematy prozą, powieści poetyckie, dramaty wierszowane itp.; należą tu np. „Pieśni” Kochanowskiego, liryki Leśmiana, „Giaur” Byrona, „Pan Tadeusz” Mickiewicza, „Balladyna” Słowackiego i in.
16     * NIE numerujemy wersów utworów liczących sobie mniej niż 5 wersów 
17     * za to wskazujemy 5 i 10 wers w utworach, które z zasady liczą sobie zawsze stałą liczbę wersów – tzn. sonety)
18  2. W utworach prozą, każdy akapit (wyróżniony wcięciem akapitowym), 
19     * przy czym każdy numer akapitu powinien się wyświetlać, ułatwiając orientację w tekście 
20     * do utworów prozą należą np. opowiadania, powieści, „Księgi narodu polskiego i pielgrzymstwa polskiego” Mickiewicza, dramaty prozą takie jak „Moralność Pani Dulskiej” Zapolskiej
21     * NIE numerujemy w dramatach: list dialogowych, nagłówków (numer aktu, sceny, osoba), «wers_cd» ani didaskaliów – tylko goły tekst.
22     * NIE numerujemy nagłówków i tytułów w opowiadaniach, nowelach, legendach i powieściach
23     * tam, gdzie akapit jest przerwany cytatem i następnie kontynuowany bez wcięcia akapitowego (akap_cd» – liczymy go razem z cytatem jako jeden numer
24  3. W dramatach numeracja zamyka się w ramach jednego aktu
25  4. W utworach mieszanych – pisanych na przemian wierszem i prozą (np. dramaty Shakespeare'a) numerujemy w części wierszowanej każdy wers (wyświetlając co 5), a w części prozą – kolejne akapity 
26  5. Ustaloną tradycyjnie numerację ma jedynie „Biblia” i tych ustaleń się trzymamy 
27