Difference between revisions of "Template:Main"

From IokeWiki
Jump to: navigation, search
(New page: DokGen is the tool that is used to generate the reference documentation for Ioke. It will be a general purpose tool for any Ioke application. It extracts the documentation information fr...)
 
Line 1: Line 1:
DokGen is the tool that is used to generate the reference documentation for Ioke.
+
:<div class="noprint">''Main article{{#if:{{{2|}}}|s}}&#58; [[{{{1}}}]]{{#if:{{{2| }}}
 +
  |{{#if:{{{3|}}}|,&#32;|&#32;and&#32;}}[[{{{2}}}]]}}{{#if:{{{3|}}}
 +
  |{{#if:{{{4|}}}|,&#32;|,&#32;and&#32;}}[[{{{3}}}]]}}{{#if:{{{4|}}}
 +
  |{{#if:{{{5|}}}|,&#32;|,&#32;and&#32;}}[[{{{4}}}]]}}{{#if:{{{5|}}}
 +
  |, and [[{{{5}}}]]}}''{{#if:{{{6| }}}|&#32; (too many parameters in &#123;&#123;[[Template:main|main]]&#125;&#125;)}}</div><noinclude>
  
It will be a general purpose tool for any Ioke application. It extracts the documentation information from defined objects and then generates an HTML structure from it that can be easily navigated. If specs are available for objects and methods, it will try to incorporate these together with the documentation. At the moment, there is no way to run dokgen on a subset of Ioke code, but that should be available very soon now.
+
== Usage ==
  
At the moment, running the dokgen script will create a directory called "dok" which contains the full documentation. It will use all specs it can find in the directory test.
+
To link to a "main article" on a topic, use &#123;{main|The other article}}.
 +
 
 +
== See also ==
 +
 
 +
* {{tl|Further}}
 +
 
 +
[[Category:Section templates|{{PAGENAME}}]]
 +
[[Category:List templates|{{PAGENAME}}]]
 +
</noinclude>

Revision as of 00:45, 26 January 2009

Main article{{#if:|s}}: [[{{{1}}}]]{{#if:
 |{{#if:|, | and }}[[{{{2}}}]]}}{{#if:
 |{{#if:|, |, and }}[[{{{3}}}]]}}{{#if:
 |{{#if:|, |, and }}[[{{{4}}}]]}}{{#if:
|, and [[{{{5}}}]]}}{{#if: | (too many parameters in {{main}})}}

Usage

To link to a "main article" on a topic, use {{main|The other article}}.

See also