Jump to content

User:Robbiemuffin/Templates/DT main/doc

From Wikibooks, open books for an open world
 

{{User:Robbiemuffin/Templates/DT main}} — Documentation Template


Purpose

[edit | edit source]

The purpose of the documentation template is to make creating template or other documentation speedy and efficient.

Specification

[edit | edit source]
<div style="
  background-color:#abc; 
  padding: 2px; 
  border-top-right-radius: 2em; border-top-left-radius: 2em; 
  -webkit-border-top-left-radius: 2em; -webkit-border-top-right-radius: 2em; 
  -moz-border-radius-topleft: 2em; -moz-border-radius-topright: 2em;">

<div style="font-size: 5px; line-height: 5px"> </div>
{{{title|}}}

 <div style="margin-left: 5%; margin-right: 5%;">

{|
| __TOC__
|}
<br />

<!-- Add sections here -->
{{{content|}}}

<!-- end document -->
 </div>

<div style="font-size:3em"> </div>
[[Image:Ajax-hacker.full.png|100px|center|]]
<div style="
  margin-left: auto; margin-right: auto; 
  text-align: center; 
  font-size:0.85em">
    ''this page was brought to you by an Ajax hacker''
</div>

</div>

Usage

[edit | edit source]

{{ subst:  User:Robbiemuffin/Templates/DT main | title=doc_title | content=doc_preinsertion_content }}

title Title text for the Documentation.
contents Convenience method, puts contents at the insertion point.

Example

[edit | edit source]

Replacing the two sections that default with a new documentation page with:

{{subst:User:Robbiemuffin/Templates/DT main|title=Some documentation|content=

{{subst:User:Robbiemuffin/Templates/DT section|title=Purpose}}
{{subst:User:Robbiemuffin/Templates/DT section|title=Specification}}
{{subst:User:Robbiemuffin/Templates/DT section|title=Usage}}
{{subst:User:Robbiemuffin/Templates/DT section|title=Example}}
{{subst:User:Robbiemuffin/Templates/DT section|title=See Also}}

}}

-- generated this page. (Save and load the page, then come back and edit the documentation to fill it.)

See Also

[edit | edit source]


 
this page was brought to you by an Ajax hacker