Lack of a strict formatting style for XML

[Matthew East]

On Thu, 2006-03-30 at 15:39 -0500, Alexandre Vassalotti wrote:
> While editing the documentation, I remarked a lack of style
> consistence in the DocBook source files. For example, check
> how the <para> tags are indented.
> 
> I propose that we append a indentation style into the
> Styleguide. Then, we could distribute a list settings for different
> text editors. (ie. Emacs and VIM) Just like Linux did with their
> Coding Style. This would ensure the readability and ease the
> maintaining of the documents.

I suppose we can run the documents through "tidy" or something. I don't
know whether we should enforce this strictly, eg through the styleguide,
because not everyone has time to be careful about this stuff and not
everyone uses an editor which supports these settings (I use gedit,
which I don't think has such an option). What do others think?

> Along this, a list of the commonly used DocBook tags with a example
> for each would be greatly appreciated by new writers. This would make
> the DocBook format more accessible and would encourage a consistent
> style in the sources.

See https://wiki.ubuntu.com/DocumentationTeam/DocbookTags

Matt
-- 
mdke at ubuntu.com
gnupg pub 1024D/0E6B06FF
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 189 bytes
Desc: This is a digitally signed message part
URL: <https://lists.ubuntu.com/archives/ubuntu-doc/attachments/20060330/515df142/attachment.pgp>