Difference between revisions of "Template:DocExample/doc"
From SpiralKnights
m (Created page with '<noinclude>{{documentation subpage}}</noinclude> == Usage == Useful for quickly adding examples to doc pages. == Parameters == (To Be Updated) == Examples == (None) …') |
m |
||
| Line 3: | Line 3: | ||
== Usage == | == Usage == | ||
| − | Useful for quickly adding examples to doc pages. | + | Useful for quickly adding examples to doc pages. The markup limitations make this much less useful, though. |
| Line 9: | Line 9: | ||
== Parameters == | == Parameters == | ||
| − | + | ; desc: {{varRequired}} The text to go in the description column - should be short. | |
| + | ; descWidth: {{varRequired}} Width of the first column for the description. | ||
| + | ; render: {{varRequired}} The code to be rendered, not surrounded by ''pre'' tags. We need a whole new variable because of wiki markup limitations. | ||
| + | ; code: {{varRequired}} The code to be exemplified. Note that because of the aforementioned limitations, you must manually wrap the ''pre'' tags. | ||
| Line 24: | Line 27: | ||
| desc = | | desc = | ||
| descWidth = | | descWidth = | ||
| + | | render = | ||
| code = | | code = | ||
}}</pre> | }}</pre> | ||
Latest revision as of 16:03, 10 April 2012
 |
This is a documentation subpage for Template:DocExample (see that page for the template itself). It contains usage information, categories and other content that is not part of the original template page. |
Contents
Usage
Useful for quickly adding examples to doc pages. The markup limitations make this much less useful, though.
Parameters
- desc
- Required. The text to go in the description column - should be short.
- descWidth
- Required. Width of the first column for the description.
- render
- Required. The code to be rendered, not surrounded by pre tags. We need a whole new variable because of wiki markup limitations.
- code
- Required. The code to be exemplified. Note that because of the aforementioned limitations, you must manually wrap the pre tags.
Examples
(None)
Copy & Paste
{{DocExample
| desc =
| descWidth =
| render =
| code =
}}
