sandbox/paultremblay/python_interface/README.txt

   1 =========================
   2  README: Docutils2fo 0.6
   3 =========================
   4
   5 :Author: Paul Tremblay
   6 :Contact: paulhtremblay@gmail.com
   7 :Date: $Date$
   8 :Copyright: This document has been placed in the public domain.
   9
  10 .. contents::
  11
  12 Introduction
  13 ============
  14
  15 This directory contains stylesheets to convert docutils.xml to XSLFO.
  16 Once the document is converted to XSLFO, you would convert it to PDF
  17 in this way::
  18
  19  rst2xml.py  my_file.rst > my_file.xml
  20  docutils_to_fo.py my_file.xml > my_file.fo
  21  fop my_file.fo my_file.pdf
  22
  23 Or, to do all in one pass::
  24
  25  rst2xml.py my_file.rst | docutils_to_fo.py | fop -fo - -pdf my_file.pdf
  26
  27
  28 Completion
  29 ==========
  30
  31 * Ability to create custom pages of simple layout, of first page layout,
  32   of odd-even layout, and first, odd-even layout.
  33 * Sections
  34 * Transitions
  35 * Paragraphs
  36 * Bullet Lists
  37 * Enumerated Lists
  38 * Definition Lists
  39 * Field Lists
  40 * Bibliographic Fields
  41 * Option List
  42 * Line Blocks
  43 * Block Quotes
  44 * Headers and Footers, with the ability to create custom headers and
  45   footers for the first, odd, and even pages; and the ability to
  46   create custom headers and footers for the Table of Contents secions
  47   for the first, odd, and even pages; and the ability to suppress
  48   headers and footers on the first page.
  49 * Doctest Blocks
  50 * Tables
  51 * Footnotes
  52 * Citations
  53 * Hyperlinks
  54 * Interpreted Text
  55 * inline Literals
  56 * Specific Admonitions
  57 * Generic Admonition
  58 * Image
  59 * Figure
  60 * Topic
  61 * Sidebar
  62 * Parsed Literal Block
  63 * Rubric
  64 * Epigraph
  65 * Highlights
  66 * Pull-Quote
  67 * Compound Paragraph
  68 * Container
  69
  70 * documenttion of XSLT stylesheets
  71 * Develop code to process XSlT stylesheet (using lxml)
  72
  73 TODO
  74 =====
  75
  76
  77 Python Code
  78 ------------
  79
  80 - Develop code to read configuration file (in process of doing)
  81
  82 - Develop code to check configuration file (in process of doing)
  83
  84 - Develop code to output a customized XSLT stylesheet (in process)
  85
  86
  87
  88 Documentaion
  89 ------------
  90
  91 - Write a quick overview
  92
  93 - Write a detailed overview
  94
  95 Limitations
  96 ------------
  97
  98 * Cannot do transitions as well as latex
  99 * Cannot put borders around page
 100 * Cannot do sidebars