save indent inside frame
[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  * EPUB (XHTML based)
35  * print-ready PDF
36
37 Other features:
38
39  * extract DublinCore meta-data from documents;
40  * extract marked "themes" from documents.
41
42
43 Dependencies
44 ------------
45
46  * lxml <http://codespeak.net/lxml/>, version 2.2 or later
47  * additional PDF converter dependencies:
48    * XeTeX with support for Polish language
49    * TeXML <http://getfo.org/texml/>
50    * recommended: morefloats LaTeX package, version >=1.0c
51      for dealing with documents with many motifs in one paragraph.
52      <http://www.ctan.org/tex-archive/help/Catalogue/entries/morefloats.html>
53
54
55 Installation
56 ------------
57
58 Librarian uses standard Python distutils for packaging. After installing all the dependencies just run:
59
60     python setup.py install
61
62 PDF converter also needs the Junicode-WL fonts (librarian/pdf/JunicodeWL-*.ttf) installed.
63 In Debian/Ubuntu, put those files in ~/.fonts/ and run `fc-cache'.
64
65 Usage
66 ------
67
68 To convert a series of files to XHTML:
69
70     book2html file1.xml [file2.xml ...]
71
72 To convert a series of files to plain text:
73
74     book2txt file1.xml [file2.xml ...]
75
76 To convert a file to EPUB:
77
78     book2epub file.xml
79
80 To convert a file to PDF:
81
82     book2pdf file.xml
83
84 To extract book fragments marked as "theme":
85
86     bookfragments file1.xml [file2.xml ...]
87
88
89 Authors
90 -------
91 Originally written by Marek Stępniowski <marek@stepniowski.com>
92         
93 Later contributions:
94
95  * Łukasz Rekucki <lrekucki@gmail.com>
96  * Radek Czajka <radek.czajka@gmail.com>