d19505d36ac41fbadba57ff2e55819ed45a98f01
[librarian.git] / README.md
1 License
2 -------
3     
4     Copyright © 2008,2009,2010 Fundacja Nowoczesna Polska <fundacja@nowoczesnapolska.org.pl>
5     
6     For full list of contributors 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 About 
23 ------
24
25 Librarian converts XML-based markup language used by FNP for writing books to 
26 other formats, which are more suitable for presentation.
27
28 Currently we support:
29
30  * HTML4, XHTML 1.0
31  * Plain text 
32  
33 In the future, we plan to support:
34
35  * EPUB (XHTML based)
36  * print-ready PDF 
37
38
39 Other features: 
40
41  * extract DublinCore meta-data from documents;
42  * extract marked "themes" from documents.
43
44
45 Dependencies
46 ------------
47
48  * [lxml] (http://codespeak.net/lxml/) >= 2.2
49
50
51 Installation
52 ------------
53
54 Librarian uses standard Python distutils for packaging. After installing all the dependencies just run:
55
56     python setup.py install
57     
58
59 Usage
60 ------
61
62 To convert a series of file to XHTML:
63
64     book2html file1.xml [file2.xml ...]
65
66 To convert a series of file to plain text:
67
68     book2txt file1.xml [file2.xml ...]
69
70 To extract book fragments marked as "theme":
71
72     bookfragments file1.xml [file2.xml ...]
73
74
75 Authors
76 -------
77 Originally written by Marek Stępniowski <marek@stepniowski.com>
78         
79 Later contributions:
80
81  * Łukasz Rekucki <lrekucki@gmail.com>