Difference between revisions of "Documentation:User Templates"
m |
m |
||
Line 42: | Line 42: | ||
e.g. | e.g. | ||
* Listings of related pages. | * Listings of related pages. | ||
− | * As the | + | * As the first line in the section above the 'Contents' box. |
==== Useage ==== | ==== Useage ==== | ||
Line 60: | Line 60: | ||
---- | ---- | ||
− | |||
=== Overview === | === Overview === | ||
Overview, a multi-line explanation of the topic. | Overview, a multi-line explanation of the topic. | ||
Line 82: | Line 81: | ||
More blurb here. | More blurb here. | ||
<div style="text-align:right;margin-right:10px;margin-bottom:4px;">'''[[TopicPageName|More about TopicPageName...]]'''</div> | <div style="text-align:right;margin-right:10px;margin-bottom:4px;">'''[[TopicPageName|More about TopicPageName...]]'''</div> | ||
+ | </pre> | ||
+ | |||
+ | ---- | ||
+ | === SeeDetail === | ||
+ | SeeDetail, a user instruction to drill-down to next detail level. | ||
+ | |||
+ | Intended for placement as the last line in the section above the 'Contents' box. | ||
+ | |||
+ | ==== Useage ==== | ||
+ | Used in the following page types or sections - | ||
+ | * Any overview type page | ||
+ | |||
+ | ==== Code ==== | ||
+ | <pre> | ||
+ | <!-- Paste the following line to required location - | ||
+ | {{:Transclusion-Missions-SeeDetail}} | ||
+ | --> | ||
+ | This is an overview page. For expanded detail click the topic links below. | ||
</pre> | </pre> | ||
Revision as of 10:23, 13 January 2008
This page contains a list of templates available on this site for use in wiki pages.
Page requires expanding to include Page & Section framework templates.
Contents
Template Types
Page templates
Section templates
Transclusion templates
Transclusion code is a special link which inserts the entire contents of a page into the calling page.
Transclusions allows use of single-source 'boilerplate text' to be replicated across multiple pages.
These should be standalone, uncategorised, pages, containing just the core text.
Editing a page containing a transclusion, will just display the calling wikicode.
Look beneath the edit window, you'll see a list of links to all the 'templates' called in that page.
Clicking those links allows direct editing of the transclusion's content.
Editing the transclusion page itself, will cause text on every calling page to display the applied changes.
NB
The comment section should be left in place in the transclusion page.
This allows editors to easily copy & paste the wikicode directly into their required content page.
Category: Missions
Transclusion templates for use in the Missions category.
NB
TopicPageName, in the code samples below, is a 'placeholder title' for your page's title.
Oneline
Oneline, a single-line explanation of the topic.
Has multiple uses, primarily intended for placement wherever the briefest description is required.
e.g.
- Listings of related pages.
- As the first line in the section above the 'Contents' box.
Useage
Used in the following page types or sections -
- Function Reference (Listing)
- FunctionType (Detail)
- FunctionName (Detail)
- Related Internal
Code
<!-- Paste the following line to required location - {{:Transclusion-Missions-Oneline-TopicPageName}} --> '''[[TopicPageName]]''' oneline, a single-line explanation of the topic.
Overview
Overview, a multi-line explanation of the topic. Includes a 'More about TopicPageName...' link to the full-detail page.
Intended for placement in section above the 'Contents' box. Should also be preceeded by the 'Oneline' transclusion.
Useage
Used in the following page types or sections -
- FunctionType (Detail)
- FunctionName (Detail)
Code
<!-- Paste the following line to required location - {{:Transclusion-Missions-Overview-TopicPageName}} --> '''[[TopicPageName]]''' overview, a multi-line explanation of the topic. More blurb here. <div style="text-align:right;margin-right:10px;margin-bottom:4px;">'''[[TopicPageName|More about TopicPageName...]]'''</div>
SeeDetail
SeeDetail, a user instruction to drill-down to next detail level.
Intended for placement as the last line in the section above the 'Contents' box.
Useage
Used in the following page types or sections -
- Any overview type page
Code
<!-- Paste the following line to required location - {{:Transclusion-Missions-SeeDetail}} --> This is an overview page. For expanded detail click the topic links below.
Related
Pre-assembled lists of related page 'oneline' transclusions.
For replication across all related pages in a detail 'level'.
See examples at -
Useage
Used in the following page sections -
- Related Internal
Code
<!-- Paste the following line to required location - {{:Transclusion-Missions-Related-TopicPageName}} --> {{:Transclusion-Missions-Oneline-TopicPageName}} {{:Transclusion-Missions-Oneline-TopicPageName}} {{:Transclusion-Missions-Oneline-TopicPageName}} {{:Transclusion-Missions-Oneline-TopicPageName}} {{:Transclusion-Missions-Oneline-TopicPageName}}