| bac94e | 2004-06-05 | Marc Dirix | |
|
| 22c133 | 2001-08-20 | Martin Nilsson | |
#include <module.h>
inherit "module";
|
| bac94e | 2004-06-05 | Marc Dirix | | constant cvs_version = "$Id: tagdoc_notation.pike,v 2.3 2004/06/05 15:19:44 _cvs_dirix Exp $";
|
| 22c133 | 2001-08-20 | Martin Nilsson | | constant thread_safe = 1;
constant module_name = "TagDoc Notation exemplifier";
constant module_type = MODULE_TAG;
constant module_doc = "This module only demonstrates how tagdoc is "
"layouted in the final manual.";
TAGDOCUMENTATION;
constant tagdoc = ([
"example-tag": ({ #"<desc cont='cont'><p>This is how the tag documentation
looks like. This tag has been flagged as a container tag, i.e. you can
put content into it like this: <example-tag>content</example-tag>.
A tag may also be tagged as a tag-only tag, i.e. you may only write it as
|
| 8170eb | 2001-08-27 | Martin Nilsson | | <example-tag/>.</p></desc>
|
| 22c133 | 2001-08-20 | Martin Nilsson | |
<attr name='age' value='number' required='required'><p>
This is the documentation of the 'age' attribute to the <tag>example-tag</tag>.
In this case the attribute accepts a number, e.g. <example-tag age='42'></example-tag>.
This attribute is required. If it doesn't exists in the tag you will get an RXML parse error.
</p></attr>
<attr name='sort' value='up|down' default='up'><p>
This is the documentation of the 'sort' attribute. The sort attribute may have either the value
'up' or the value 'down'. If the attribute is omitted, the tag will assume the value 'up'.
</p></attr>", ([
"internal":#"<desc tag='tag'><p>This is an internal tag to <tag>example-tag</tag>, which means
|
| 8170eb | 2001-08-27 | Martin Nilsson | | that it is only available inside the <tag>example-tag</tag>. Below is an example of how
tag usage examples looks like. These may be a single box just showing how to write the tag
or it could be a double box showing both the code and the result.</p>
<ex type='box'>
<example-tag><internal/></example-tag>
</ex>
</desc>",
|
| 22c133 | 2001-08-20 | Martin Nilsson | | "&_.ent;":#"<desc ent='ent'><p>This entity is an internal entity of the <tag>example-tag</tag>
|
| 8170eb | 2001-08-27 | Martin Nilsson | | and only available inside it, just like <tag>internal</tag>.</p></desc>"
|
| 22c133 | 2001-08-20 | Martin Nilsson | | ])
})
]);
|