README.md

   1 WL2PDF is an XSL-FO based converter from WLML (format
   2 used by [wolnelektury.pl][1] to print-friendly PDFs).
   3
   4
   5 License
   6 -------
   7
   8     Copyright © 2009,2010 Łukasz Rekucki
   9
  10     WL2PDF 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     WL2PDF 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 WL2PDF.  If not, see <http://www.gnu.org/licenses/>.
  22
  23
  24 Requirements
  25 ------------
  26
  27   * Fairly new Java Runtime (1.5+)
  28
  29   * [Apache FOP][2]
  30     (at least version 0.95, trunk is recommended)
  31
  32   * [Saxon][3] for XSLT2
  33
  34   * Hyphenation is done via FOP, so read a section on it in their docs.
  35
  36   * Some unicode-capable font, like DejaVu.
  37
  38
  39 Configuration
  40 -------------
  41
  42      1. Compile FOP if needed.
  43      2. Generate font metrics (refer to FOP Documentation on that)
  44      3. Make a "fop-config.xml" out of the supplied example and place it in this directory.
  45
  46
  47 Running
  48 -------
  49
  50 With Jython:
  51
  52     jython wl2pdf <list_of_files_to_convert>
  53
  54 With Java:
  55
  56     java org.lqsoft.wlml.WL2PDF <path_to_config> <file_to_convert>
  57
  58 Rember to place FOP, it's libraries and Saxon under your classpath.
  59
  60   [1]: http://wolnelektury.pl/
  61   [2]: http://xmlgraphics.apache.org/fop/index.html
  62   [3]: http://www.saxonica.com/index.html