Hi, I've realized that in the documentation of lot of modules the Table of Contents appears twice, i.e:
http://kamailio.org/docs/modules/devel/modules/avpops.html http://kamailio.org/docs/modules/devel/modules/db_mysql.html
But in others it appears once (as expected):
http://kamailio.org/docs/modules/devel/modules/counters.html
There are several differences between files within doc/ directory in both cases. Which is the guideline to follow? why does the Table of Contents appear twice in the above cases?
Thanks.
Hello,
the generated html includes ToC per book and per chapter. Kamailio docbook files are written as 'book' while ser docbooks are 'chapter' (or 'section').
So K readmes may look like having duplicate ToC if there is one chapter, but if there are many, then the inner ToC are different: http://kamailio.org/docs/modules/devel/modules_k/pua.html
Cheers, Daniel
On 4/28/11 11:32 PM, Iñaki Baz Castillo wrote:
Hi, I've realized that in the documentation of lot of modules the Table of Contents appears twice, i.e:
http://kamailio.org/docs/modules/devel/modules/avpops.html http://kamailio.org/docs/modules/devel/modules/db_mysql.html
But in others it appears once (as expected):
http://kamailio.org/docs/modules/devel/modules/counters.html
There are several differences between files within doc/ directory in both cases. Which is the guideline to follow? why does the Table of Contents appear twice in the above cases?
Thanks.
2011/4/28 Daniel-Constantin Mierla miconda@gmail.com:
the generated html includes ToC per book and per chapter. Kamailio docbook files are written as 'book' while ser docbooks are 'chapter' (or 'section').
So K readmes may look like having duplicate ToC if there is one chapter, but if there are many, then the inner ToC are different: http://kamailio.org/docs/modules/devel/modules_k/pua.html
Ok, so remaining ToC are "chapter" ToC. Nice to know.
Thanks a lot.
PS: It could be good to establish an unified syntax and guidelines for creating documentation.
On 4/28/11 11:45 PM, Iñaki Baz Castillo wrote:
2011/4/28 Daniel-Constantin Mierlamiconda@gmail.com:
the generated html includes ToC per book and per chapter. Kamailio docbook files are written as 'book' while ser docbooks are 'chapter' (or 'section').
So K readmes may look like having duplicate ToC if there is one chapter, but if there are many, then the inner ToC are different: http://kamailio.org/docs/modules/devel/modules_k/pua.html
Ok, so remaining ToC are "chapter" ToC. Nice to know.
Thanks a lot.
PS: It could be good to establish an unified syntax and guidelines for creating documentation.
I think the main thing to solve is who has time to do the conversion from one format to the other :-) Cheers, Daniel
2011/4/28 Daniel-Constantin Mierla miconda@gmail.com:
I think the main thing to solve is who has time to do the conversion from one format to the other :-)
And also which format to convert and which one to keep :)