[kde-guidelines] CVS - Attempt to summarise

[Lauri Watts]

On Thursday 04 November 2004 13:08, Frans Englich wrote:
> On Thursday 04 November 2004 10:56, Ellen Reitmayr wrote:

> The one-word variant is a bit simpler, but I don't think it matters much.
> However, important is that the naming scheme for id-tags are identical,
> such that they are consistent.

Use whatever scheme you like for the names, the only two inviolable rules are:
* They must be unique within the document (where for our purposes "the 
document" is the entire set of guidelines)
* They must begin with a letter

It's also best to not use spaces (because they are sometimes used to generate 
filenames) and to keep them under 255 characters (because some processors 
barf on them if they're longer than that)

Personally I like to use the title, lowercased and dashes, because then it's 
very easy to link to from an xref or a link, and I don't have to look them 
up.  So whatever you choose, it's a good idea for your own convenience to use 
a scheme that helps you remember them for crossreferencing.  

In the end though, you can call them id="tw-54219-rev1-randomletters" and it'd 
be perfectly valid.

> (BTW, I think we should use <section> instead of <sectX> unless someone
> objects, since they aren't specific on what level they are in. FYI )

I object, I wrote the xslt to deal with the nested sections, and they give a 
clear visual and semantic guide to where you are in the hierarchy, which is 
both useful and in fact, important when the source files are not indented.

The structure of the doc and the rendering tricks being done with it, require 
a specific nesting structure.  <sectN> are not deprecated, they will not be 
going away soon (DB always deprecates elements for at least a major version 
before removal)  

Regards,
-- 
Lauri Watts
KDE Documentation: http://docs.kde.org
KDE on FreeBSD: http://freebsd.kde.org
-------------- next part --------------
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 187 bytes
Desc: not available
Url : http://mail.kde.org/pipermail/kde-guidelines/attachments/20041104/a9ef218b/attachment.pgp