.. -*- coding: utf-8 -*-

project logilab-doctools
========================
:creation date: 2006/11/06

logilab's documentation tools

tools to manipulate and construct documents at Logilab

version 0.2.2
-------------
:publication date: 2006/09/25
:expected date: n/a

version 0.2.3
-------------

Small improvements in the ReST to DocBook conversion
:publication date: 2008/06/04
:expected date: n/a

ticket #5137: does not work with python2.5
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
:type: bug
:load: 0.000
:state: resolved

mkdoc does not work with python2.5 because elementtree is in the xml package in
that version.

ticket #4758: [rest2dcbk] use unknown id on footnotes
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
:type: bug
:load: 0.000
:state: resolved

When parsing footnotes, the code uses an id attribute that doesn't exist on the
ReST node.

Comments ::

  On 2008/03/04 17:54 - ocayrol wrote :
  The ids of a ReST node are in the ``node['ids']`` list

ticket #4772: [rest2dcbk] contents table should not be inserted in docbook documents
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
:type: bug
:load: 0.000
:state: resolved

When converting rest to docbook, the code inserts the *contents table* at the
beginning of the document. This is not useful as Docbook processors will
generate the contents table.

ticket #4765: [rest2dcbk] title not in bookinfo
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
:type: bug
:load: 0.000
:state: resolved

The title of the document should be in the metadata section (e.g. bookinfo,
articleinfo, etc.)

version 0.2.4
-------------
:publication date: 2008/07/15
:expected date: n/a

ticket #5591: [rst2dcbk] Don't insert automatic numbers in section titles
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
:type: enhancement
:load: 0.250
:state: resolved

In Docbook, the sections are automatically numbered. When converting from rest
to docbook, we should not insert generated numbers in the sections titles.

ticket #5593: [rst2dcbk] Specify first item number in ordered lists
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
:type: enhancement
:load: 0.250
:state: resolved

In rest, we can manually specify the number of a list item in an ordered list
(at least the number of the first item of the ordered list). We should add this
information into the docbook through an extension attribute on the <orderedlist>
element.

Comments ::

  On 2008/07/15 17:24 - ocayrol wrote :
  the extension attribute can be ldg:first-number.

version 0.2.5
-------------
:publication date: 2008/10/24
:expected date: n/a

ticket #6283: bad package
~~~~~~~~~~~~~~~~~~~~~~~~~
:type: bug
:load: 0.250
:state: rejected

using apt-get install::

Les paquets suivants contiennent des dépendances non satisfaites :
logilab-doctools: Dépend: python-xml mais ne sera pas installé E: Paquets
défectueux

Les paquets suivants contiennent des dépendances non satisfaites : python-xml:
Dépend: python (< 2.5) mais 2.5.2-2 devra être installé E: Paquets défectueux

Comments ::

  On 2008/10/06 08:58 - nchauvat wrote :
  solved with `apt-get install python-xml=0.8.4-10.1` as problem was rotten
  python-xml package in our private repository.
  On 2008/10/06 08:59 - afayolle wrote :
  apt-get install python-xml=0.8.4-10.1

ticket #5877: Debian package depends on logilab-xml (not in public repository)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
:type: bug
:load: 1.500
:state: resolved

The dependency needs to be weakened to suggests.

version 0.2.6
-------------

Cleaning up XML processing and adding missing functionalities
:publication date: 2009/08/26
:expected date: n/a

ticket #10006: Don't use python-xml
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
:type: bug
:load: 0.500
:state: resolved

Clean up the use of XML libraries. We should only use one. As lxml is already
used by some modules, let's just use lxml everywhere.

ticket #2913: genere pdf for attendance list and evaluation sheets
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
:type: enhancement
:load: 0.500
:state: resolved

For the training sessions, we need to generate an attendance list and evaluation
sheets in PDF.

version 0.2.7
-------------
:publication date: 2010/01/04
:expected date: n/a

ticket #10045: Missing logo file
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
:type: bug
:load: 0.250
:state: resolved

The generation of the documents for the training sessions doesn't work because
the logo file is not installed with the source code.

version 0.2.8
-------------

New year Version!
:publication date: 2010/01/04
:expected date: n/a

ticket #19535: Change name of PDF documents for training sessions
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
:type: enhancement
:load: 0.100
:state: resolved

The names of the PDF documents produced when processing a training session
(attendance list and feedback sheets) should be prefixed with the reference of
the training session

version 0.2.9
-------------
:publication date: 2010/01/07
:expected date: n/a

ticket #19558: Missing logo
~~~~~~~~~~~~~~~~~~~~~~~~~~~
:type: bug
:load: 0.200
:state: resolved

The logo for the PDF documents produced for the training sessions doesn't exist

version 0.2.10
--------------
:publication date: 2010/01/25
:expected date: n/a

ticket #19951: Add a page break in ReST documents
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
:type: bug
:load: 0.200
:state: resolved

In some ReST documents (with lot of images), we want to insert page breaks to
better control the PDF generation.

Comments ::

  On 2010/01/25 16:30 - ocayrol wrote :
  We will define a new ReST directive that can insert a paragraph that begins with
  a page break.

version 0.2.11
--------------
:publication date: 2010/04/13
:expected date: n/a

ticket #23244: [ReST transform] No identifier on the root DocBook element
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
:type: bug
:load: 0.100
:state: resolved

When generating XML DocBook from a ReST source, the root element (book, chapter,
etc.) doesn't have an id attribute whereas the section elements in the document
will always have an id attribute.

version 0.2.12
--------------
:publication date: 2010/08/23
:expected date: n/a

ticket #28789: cannot install doctools 0.2.11 on lenny
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
:type: bug
:load: 0.100
:state: validation pending

because of an dependency problem:

logilab-doctools: Dépend: python-reportlab (>= 2.2) mais 2.1dfsg-2 devra être
installé

ticket #37932: Make logilab-doctools compliant with PyBill 1.0
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
:type: bug
:load: 0.100
:state: resolved

mkdoc should recognize files in PyBill 1.0 format and send them to pybill.

Please note that mkdoc should still recognize files in older PyBill formats.