a84d45ff8933f904edf01ee2880c74ed8f645746
[librarian.git] / README.md
1 License
2 -------
3
4   ![AGPL Logo](http://www.gnu.org/graphics/agplv3-155x51.png)
5     
6     Copyright © 2008,2009,2010 Fundacja Nowoczesna Polska <fundacja@nowoczesnapolska.org.pl>
7     
8     For full list of contributors see AUTHORS section at the end. 
9
10     This program is free software: you can redistribute it and/or modify
11     it under the terms of the GNU Affero General Public License as published by
12     the Free Software Foundation, either version 3 of the License, or
13     (at your option) any later version.
14
15     This program is distributed in the hope that it will be useful,
16     but WITHOUT ANY WARRANTY; without even the implied warranty of
17     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18     GNU Affero General Public License for more details.
19
20     You should have received a copy of the GNU Affero General Public License
21     along with this program.  If not, see <http://www.gnu.org/licenses/>.
22
23
24 About 
25 ------
26
27 Librarian converts XML-based markup language used by FNP for writing books to 
28 other formats, which are more suitable for presentation.
29
30 Currently we support:
31
32  * HTML4, XHTML 1.0
33  * Plain text 
34  
35 In the future, we plan to support:
36
37  * EPUB (XHTML based)
38  * print-ready PDF 
39
40
41 Other features: 
42
43  * extract DublinCore meta-data from documents;
44  * extract marked "themes" from documents.
45
46
47 Dependencies
48 ------------
49
50  * lxml <http://codespeak.net/lxml/>, version 2.2 or later
51
52
53 Installation
54 ------------
55
56 Librarian uses standard Python distutils for packaging. After installing all the dependencies just run:
57
58     python setup.py install
59     
60
61 Usage
62 ------
63
64 To convert a series of file to XHTML:
65
66     book2html file1.xml [file2.xml ...]
67
68 To convert a series of file to plain text:
69
70     book2txt file1.xml [file2.xml ...]
71
72 To extract book fragments marked as "theme":
73
74     bookfragments file1.xml [file2.xml ...]
75
76
77 Authors
78 -------
79 Originally written by Marek Stępniowski <marek@stepniowski.com>
80         
81 Later contributions:
82
83  * Łukasz Rekucki <lrekucki@gmail.com>