Added report about open-source code used in our project.
[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  * Python libraries from lib directory
7  * Django applications from apps directory
8
9
10 How to deploy
11 =============
12
13 Just execute this commands:
14     
15     cd wolnelektury.pl
16     source setpythonpath.sh
17     cd wolnelektury
18     ./manage.py syncdbc
19     ./manage.py importbooks ../books/01 ../books/02 ../books/03
20     ../setmainpage.py
21
22 [TODO]
23
24
25 Numbering
26 =========
27
28 Co numerujemy
29
30  1. W utworach wierszowanych każdy wers,
31     * przy czym powinien pokazywać się co 5 numer wersu
32     * 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.
33     * NIE numerujemy wersów utworów liczących sobie mniej niż 5 wersów 
34     * za to wskazujemy 5 i 10 wers w utworach, które z zasady liczą sobie zawsze stałą liczbę wersów – tzn. sonety)
35  2. W utworach prozą, każdy akapit (wyróżniony wcięciem akapitowym), 
36     * przy czym każdy numer akapitu powinien się wyświetlać, ułatwiając orientację w tekście 
37     * 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
38     * NIE numerujemy w dramatach: list dialogowych, nagłówków (numer aktu, sceny, osoba), «wers_cd» ani didaskaliów – tylko goły tekst.
39     * NIE numerujemy nagłówków i tytułów w opowiadaniach, nowelach, legendach i powieściach
40     * tam, gdzie akapit jest przerwany cytatem i następnie kontynuowany bez wcięcia akapitowego (akap_cd» – liczymy go razem z cytatem jako jeden numer
41  3. W dramatach numeracja zamyka się w ramach jednego aktu
42  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 
43  5. Ustaloną tradycyjnie numerację ma jedynie „Biblia” i tych ustaleń się trzymamy 
44
45
46 Używany kod open-source
47 =======================
48
49 django
50 ------
51  - Źródła: [djangoproject.com](http://www.djangoproject.com/)
52  - Autorzy: [wielu autorów](http://code.djangoproject.com/browser/django/trunk/AUTHORS)
53  - Licencja: [BSD License](http://code.djangoproject.com/browser/django/trunk/LICENSE)
54  - Typ: framework
55
56 django-chunks
57 -------------
58  - Źródła: [Google Code](http://code.google.com/p/django-chunks/)
59  - Autorzy: Clint Ecker <clintecker@gmail.com>
60  - Licencja: [New BSD License](http://www.opensource.org/licenses/bsd-license.php)
61  - Typ: biblioteka (aplikacja django)
62
63 django-pagination
64 -----------------
65  - Źródła: [Google Code](http://code.google.com/p/django-pagination/)
66  - Autorzy: James Tauber <jtauber@gmail.com>, leidel@gmail.com
67  - Licencja: [New BSD License](http://www.opensource.org/licenses/bsd-license.php)
68  - Typ: biblioteka (aplikacja django)
69
70 django-compress
71 ---------------
72  - Źródła: [Google Code](http://code.google.com/p/django-compress/)
73  - Autorzy: Andreas Pelme <andreas.pelme@gmail.com>
74  - Licencja: [MIT License](http://www.opensource.org/licenses/mit-license.php)
75  - Typ: biblioteka (aplikacja django)
76
77 django-newtagging
78 -----------------
79  - Źródła: [BitBucket](http://www.bitbucket.org/zuber/django-newtagging/)
80  - Autorzy: Marek Stępniowski <marek@stepniowski.com>
81  - Licencja: [MIT License](http://www.opensource.org/licenses/mit-license.php)
82  - Typ: biblioteka (aplikacja django)
83  - Nota: Aplikacja wzorowana na [django-tagging](http://code.google.com/p/django-tagging/), która jest również wydana na licencji [MIT](http://www.opensource.org/licenses/mit-license.php) Około połowa kodu jest dzielona.
84
85 feedparser
86 ----------
87  - Źródła: [Google Code](http://code.google.com/p/feedparser/)
88  - Autorzy: Mark Pilgrim <pilgrim@gmail.com>
89  - Licencja: [MIT License](http://www.opensource.org/licenses/mit-license.php)
90  - Typ: biblioteka
91
92 markupstring
93 ------------
94  - Żródła: [ASPN Cookbook](http://code.activestate.com/recipes/389023/)
95  - Autorzy: Thomas Hinkle
96  - Licencja: [MIT License](http://code.activestate.com/help/terms/)
97  - Typ: biblioteka
98  - Nota: Zmienione przez Marka Stępniowskiego <marek@stepniowski.com> tak, żeby akceptowało ciągi znaków Unicode
99  
100 lxml
101 ----
102  - Żródła: [codespeak.net](http://codespeak.net/lxml/index.html#download)
103  - Autorzy: [wielu autorów](http://codespeak.net/lxml/credits.html)
104  - Licencja: [BSD License](http://codespeak.net/lxml/index.html#license)
105  - Typ: biblioteka
106