21 Apr
2005
21 Apr
'05
3:05 p.m.
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(a)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