 |
 |
 |
The SkunkWeb STML Reference |  |
 |
 |
|
|
|
The SkunkWeb STML Reference | |
|
|
<:doc:>
[ template, component, or datacomp documentation ]
<:/doc:>
This tag is a great tool for your development projects! At the beginning of any STML document, place a single <:doc:> tag. Inside the tag, write text documentation about the document (any STML tags will be ignored). Describe the role of the document in your application. Also describe the user arguments it looks for (if it's a template) or the arguments it expects (if it's a component or data component). If your STML document raises exceptions with the <:raise:> tag, describe which exceptions it can raise. For data components, also describe what kinds of objects are returned.
The skunkdoc tool, which comes with the SkunkWeb software, can then extract all of your STML documents' <:doc:> contents, and construct a surfable, cross-referenced HTML documentation set for your website. (It also will include all of your custom SkunkWeb Python modules and their documentation.)
Use the <:doc:> tag; you will be forever glad you did.
Note that this tag considers all of its contents to be text; STML tags are not parsed. The resulting documentation will be in plain text, unless you use the magic skunkdoc XML format: make the first two non-whitespace characters in the tag ** and the skunkdoc tool will parse them as XML. See the non-existant manual ``Documentation Tools'' on the skunk.org website to learn all about the skunkdoc XML format.
|
|
|
The SkunkWeb STML Reference | |
|
|