47b3d982282b27f8b133197a4a4de86112447479
[wl2pdf.git] / README
1     
2     WL2PDF is an XSL-FO based converter from WLML (format used 
3     by wolnelektury.pl for writing e-books) to print-friendly PDFs.
4                  
5     
6     LICENSE SECTION 
7     ---------------
8     
9     Copyright © 2009,2010 Łukasz Rekucki
10
11     WL2PDF is free software: you can redistribute it and/or modify
12     it under the terms of the GNU Affero General Public License as published by
13     the Free Software Foundation, either version 3 of the License, or
14     (at your option) any later version.
15
16     WL2PDF is distributed in the hope that it will be useful,
17     but WITHOUT ANY WARRANTY; without even the implied warranty of
18     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
19     GNU Affero General Public License for more details.
20
21     You should have received a copy of the GNU Affero General Public License
22     along with WL2PDF.  If not, see <http://www.gnu.org/licenses/>.
23     
24     
25     REQUIREMENTS
26     ------------
27     
28       - Fairly new Java Runtime (1.5+)
29     
30       - Apache FOP <http://xmlgraphics.apache.org/fop/index.html> 
31           (at least version 0.95, trunk is recommended)
32           
33       - XSLT 2.0 processor: Saxon9 <http://www.saxonica.com/index.html>          
34           
35       - Hyphenation is done via FOP, so read a section on it in their docs.
36            
37       - Some unicode-capable font, like DejaVu. 
38            
39     
40    CONFIGURING
41    -----------
42     
43      1) Compile FOP if needed.
44      2) Generate font metrics (refer to FOP Documentation on that)
45      3) Make a "fop-config.xml" out of the supplied example and place it in this directory.
46      
47      
48    RUNNING
49    -------
50    
51     With Jython:
52     
53       jython wl2pdf <list_of_files_to_convert>
54       
55     With Java:
56     
57       java org.lqsoft.wlml.WL2PDF <path_to_config> <file_to_convert>
58     
59       (Rember to place FOP, it's libraries and Saxon under your classpath).      
60       
61    
62     
63