[PATCH] Improve naxes documentation

Submitted by sspr on Wed, 2008-02-13 13:50

I've skimmed through the orocos-naxes.xml document and found
that the file has invalid XML.

Some rules to respect:

* Text should always be enclosed by a
element
* The id field (id="xyz") should not contain spaces
* Do not use , ,... as these do not allow composition of
documents or easy moving of sections without renaming. Use


instead.
* Use instead of when writing class names.

If you're using emacs, you can use the 'nxml' and 'relax-ng' (rng) schemes for
editing and debugging XML files.

A preview of the current state of this document (without patch) can be seen
here:

Peter

‹ [Bug 514] New: Compliant control components Make check: Simulationthread seems to be blocked ›
»
Ruben Smits's picture

[PATCH] Improve naxes documentation

Submitted by Ruben Smits on Thu, 2008-02-14 10:50.

On Wednesday February 13 2008 14:45:03 Peter Soetens wrote:
> I've skimmed through the orocos-naxes.xml document and found
> that the file has invalid XML.
>
> Some rules to respect:
>
> * Text should always be enclosed by a
element
> * The id field (id="xyz") should not contain spaces
> * Do not use , ,... as these do not allow composition of
> documents or easy moving of sections without renaming. Use


> instead.
> * Use instead of when writing class names.
>
> If you're using emacs, you can use the 'nxml' and 'relax-ng' (rng) schemes
> for editing and debugging XML files.
>
> A preview of the current state of this document (without patch) can be seen
> here:
> >rocos-naxes.html>

I added this guideline to and
applied the patch:

svn ci doc/xml/orocos-naxes.xml -m"Applied patch: [Orocos-Dev] [PATCH] Improve
naxes documentation"
Sending doc/xml/orocos-naxes.xml
Transmitting file data .
Committed revision 28955.

> Peter

»