(forwarding to sr-dev).
Jan.
On 07-05 14:34, Jan Janak wrote:
On 07-05 14:22, Henning Westerholt wrote:
On Sonntag, 3. Mai 2009, Daniel-Constantin Mierla wrote:
- Admin Guide
- 1.1. Overview
- 1.2. Dependencies
[..]
- Overview
- Dependencies
Hi Jan,
i noticed that the READMEs generated for modules_k looks now a bit different then the ones generated for the modules_s. The k ones uses "1.", the s ones "1.1", for the first chapter for example.
This is because docbook documents in ser modules start with <section>, not <book>, we do not use <book> and <chapter> tags anymore in our docbook documents because it makes it hard to include such documents into other documents.
Another thing that is missing both of them is modules_s READMEs, is the list of the examples. Is this a bug or do you wanted to change this?
This was intentional. I think it makes no sense to have lists of examples in short plain-text documents like the READMEs (there are no page numbers anyway).
I have also removed the list of functions and parameters. I think such lists are only useful if you have page numbers, so that you can jump to the corresponding function/parameter/example quickly, but READMEs have no page numbers and the less boilerplate we have at the beginning of the document the better, IMHO.
Nevertheless, if people think that READMEs should have lists of functions and parameters at the beginning, I can modify the templates and put it back.
Jan.