Hi, as I'm working on the TOC stuff which will allow automatic numbering I would like to discuss an aspect that would influence how the numbering is realized. In particular, I'm interested in knowing what is the typical document structure you guys use and how you apply the headings into document sections. What I have seen on xwiki.org is a mixture of various patterns like: 1 title 1.1 chapter1 1.1.1 subchapter1 1.1 chapter2 or 1.1 title 1.1.1 chapter1 1.1.1.1 subchapter1 1.1.1 chapter2 or 1 chapter1 1.1 subchapter1 1 chapter2 or 1.1 chapter1 1.1.1 subchapter1 1.1 chapter2 In our team we used to use this pattern: 1 title 1.1 chapter1 1.1.1 subchapter1 1.1 chapter2 The problem is that generated numbered TOC than would look like: 1 title 1.1 chapter1 1.1.1 subchapter1 1.2 chapter2 which is not consistent with our company's standard Word documentation structure (a common document structure, IMHO) which has this natural TOC: title 1. chapter1 1.1 subchapter1 2. chapter2 ... My question is whether you think it would be good idea to treat a document title as a specific part of document and introduce a new tag like {title} or 0 ... and have its own CSS item. In Confluence the document title is equal to physical wiki document name and rendered separately on top of the page. Another possibility which would solve the generation of TOC issue is to add an option to the TOC tag what initial heading level it should start the generation at. I would personally prefer to treat document title specifically as I consider the mentioned TOC option as a kind of hack, IMHO. Jiri.
Hi Jiri, I think you should consider the first 1. to be the title. I tend to think that using the document name as a title is not so good, even with spaces allowed in it. I'm looking into extracting the first 1 in a document and use it as a title automatically. I think some documents might not start with a first level title mainly because of presentation, or because they are ment to be included in other documents. I agree with the option in the TOC tag to choose the level at which generation is started. It could also allow to choose the way numbering are generated: A: for letters I: for roman numbers 1: for numbers a: for small letters {toc:level=1|format=I.1.a} -> #toc(1 "I.1.a") -> start at level 1 with roman numbers, numbers, and letters for level 1, 2 and 3 {toc:level=2|format=1.a} -> #toc(1 "1.a") -> start at level 2 with numbers and letters for level 2 and 3 Ludovic Jiri Luzny a écrit :
Hi,
as I'm working on the TOC stuff which will allow automatic numbering I would like to discuss an aspect that would influence how the numbering is realized. In particular, I'm interested in knowing what is the typical document structure you guys use and how you apply the headings into document sections. What I have seen on xwiki.org is a mixture of various patterns like: 1 title 1.1 chapter1 1.1.1 subchapter1 1.1 chapter2 or 1.1 title 1.1.1 chapter1 1.1.1.1 subchapter1 1.1.1 chapter2 or 1 chapter1 1.1 subchapter1 1 chapter2 or 1.1 chapter1 1.1.1 subchapter1 1.1 chapter2
In our team we used to use this pattern: 1 title 1.1 chapter1 1.1.1 subchapter1 1.1 chapter2
The problem is that generated numbered TOC than would look like: 1 title 1.1 chapter1 1.1.1 subchapter1 1.2 chapter2
which is not consistent with our company's standard Word documentation structure (a common document structure, IMHO) which has this natural TOC: title 1. chapter1 1.1 subchapter1 2. chapter2 ...
My question is whether you think it would be good idea to treat a document title as a specific part of document and introduce a new tag like {title} or 0 ... and have its own CSS item. In Confluence the document title is equal to physical wiki document name and rendered separately on top of the page. Another possibility which would solve the generation of TOC issue is to add an option to the TOC tag what initial heading level it should start the generation at. I would personally prefer to treat document title specifically as I consider the mentioned TOC option as a kind of hack, IMHO.
Jiri.
------------------------------------------------------------------------
-- You receive this message as a subscriber of the xwiki-dev@objectweb.org mailing list. To unsubscribe: mailto:xwiki-dev-unsubscribe@objectweb.org For general help: mailto:sympa@objectweb.org?subject=help ObjectWeb mailing lists service home page: http://www.objectweb.org/wws
-- Ludovic Dubost XPertNet: http://www.xpertnet.fr/ Blog: http://www.ludovic.org/blog/ XWiki: http://www.xwiki.com Skype: ldubost AIM: nvludo Yahoo: ludovic
I think you should consider the first 1. to be the title.
I'm not sure I like it. It is based on too weak and undocumented rule, IMHO.
I tend to think that using the document name as a title is not so good, even with spaces allowed in it.
Agree. I hate when people use whole titles for names of files which is similar to names of wiki documents...
I'm looking into extracting the first 1 in a document and use it as a title automatically.
Are you sure an author will always mean the first 1 as a title?
I agree with the option in the TOC tag to choose the level at which generation is started.
OK, will add this option.
It could also allow to choose the way numbering are generated
Should not be big problem but the default/standard number format is good enough for the initial version so I leave it as a space for future enhancements. Jiri. On Thu, 21 Apr 2005 15:05:13 +0200, you wrote:
Hi Jiri,
I think you should consider the first 1. to be the title. I tend to think that using the document name as a title is not so good, even with spaces allowed in it. I'm looking into extracting the first 1 in a document and use it as a title automatically.
I think some documents might not start with a first level title mainly because of presentation, or because they are ment to be included in other documents.
I agree with the option in the TOC tag to choose the level at which generation is started. It could also allow to choose the way numbering are generated:
A: for letters I: for roman numbers 1: for numbers a: for small letters
{toc:level=1|format=I.1.a} -> #toc(1 "I.1.a") -> start at level 1 with roman numbers, numbers, and letters for level 1, 2 and 3 {toc:level=2|format=1.a} -> #toc(1 "1.a") -> start at level 2 with numbers and letters for level 2 and 3
Ludovic
Jiri Luzny a écrit :
Hi,
as I'm working on the TOC stuff which will allow automatic numbering I would like to discuss an aspect that would influence how the numbering is realized. In particular, I'm interested in knowing what is the typical document structure you guys use and how you apply the headings into document sections. What I have seen on xwiki.org is a mixture of various patterns like: 1 title 1.1 chapter1 1.1.1 subchapter1 1.1 chapter2 or 1.1 title 1.1.1 chapter1 1.1.1.1 subchapter1 1.1.1 chapter2 or 1 chapter1 1.1 subchapter1 1 chapter2 or 1.1 chapter1 1.1.1 subchapter1 1.1 chapter2
In our team we used to use this pattern: 1 title 1.1 chapter1 1.1.1 subchapter1 1.1 chapter2
The problem is that generated numbered TOC than would look like: 1 title 1.1 chapter1 1.1.1 subchapter1 1.2 chapter2
which is not consistent with our company's standard Word documentation structure (a common document structure, IMHO) which has this natural TOC: title 1. chapter1 1.1 subchapter1 2. chapter2 ...
My question is whether you think it would be good idea to treat a document title as a specific part of document and introduce a new tag like {title} or 0 ... and have its own CSS item. In Confluence the document title is equal to physical wiki document name and rendered separately on top of the page. Another possibility which would solve the generation of TOC issue is to add an option to the TOC tag what initial heading level it should start the generation at. I would personally prefer to treat document title specifically as I consider the mentioned TOC option as a kind of hack, IMHO.
Jiri.
------------------------------------------------------------------------
-- You receive this message as a subscriber of the xwiki-dev@objectweb.org mailing list. To unsubscribe: mailto:xwiki-dev-unsubscribe@objectweb.org For general help: mailto:sympa@objectweb.org?subject=help ObjectWeb mailing lists service home page: http://www.objectweb.org/wws
It's never sure the first line is the title, but it is very much the case.. We could start all empty document with an automatic title based on the document name that was chosen. Also the XWiki system could use the document name if there is no heading starting the document. Ludovic Jiri Luzny a écrit :
I think you should consider the first 1. to be the title.
I'm not sure I like it. It is based on too weak and undocumented rule, IMHO.
...
I'm looking into extracting the first 1 in a document and use it as a title automatically.
Are you sure an author will always mean the first 1 as a title?
-- Ludovic Dubost XPertNet: http://www.xpertnet.fr/ Blog: http://www.ludovic.org/blog/ XWiki: http://www.xwiki.com Skype: ldubost AIM: nvludo Yahoo: ludovic
OK, but still it might be a little bit confusing if not documented well... On Fri, 22 Apr 2005 09:21:18 +0200, you wrote:
It's never sure the first line is the title, but it is very much the case.. We could start all empty document with an automatic title based on the document name that was chosen.
Also the XWiki system could use the document name if there is no heading starting the document.
Ludovic
Jiri Luzny a écrit :
I think you should consider the first 1. to be the title.
I'm not sure I like it. It is based on too weak and undocumented rule, IMHO.
...
I'm looking into extracting the first 1 in a document and use it as a title automatically.
Are you sure an author will always mean the first 1 as a title?
We could create a small Javascript component that shows in the Interface what is the current title based on the different info.. Ludovic Jiri Luzny a écrit :
OK, but still it might be a little bit confusing if not documented well...
On Fri, 22 Apr 2005 09:21:18 +0200, you wrote:
It's never sure the first line is the title, but it is very much the case.. We could start all empty document with an automatic title based on the document name that was chosen.
Also the XWiki system could use the document name if there is no heading starting the document.
Ludovic
Jiri Luzny a écrit :
I think you should consider the first 1. to be the title.
I'm not sure I like it. It is based on too weak and undocumented rule, IMHO.
...
I'm looking into extracting the first 1 in a document and use it as a title automatically.
Are you sure an author will always mean the first 1 as a title?
------------------------------------------------------------------------
-- You receive this message as a subscriber of the xwiki-dev@objectweb.org mailing list. To unsubscribe: mailto:xwiki-dev-unsubscribe@objectweb.org For general help: mailto:sympa@objectweb.org?subject=help ObjectWeb mailing lists service home page: http://www.objectweb.org/wws
-- Ludovic Dubost XPertNet: http://www.xpertnet.fr/ Blog: http://www.ludovic.org/blog/ XWiki: http://www.xwiki.com Skype: ldubost AIM: nvludo Yahoo: ludovic
participants (2)
-
Jiri Luzny -
Ludovic Dubost