Difference between revisions of "Documentation:User Templates"

From FSDeveloper Wiki
Jump to: navigation, search
m (Category: Missions)
m (Transclusion templates)
Line 6: Line 6:
 
=== Section templates ===
 
=== Section templates ===
 
=== Transclusion templates ===
 
=== Transclusion templates ===
Allow use of single-source 'boilerplate text' to be replicated across multiple pages.
+
Transclusion code inserts the entire contents of a page into another.
  
These are standalone, uncategorised, pages, containing just the core text.
+
This allows use of single-source 'boilerplate text' to be replicated across multiple pages.
 
<br>
 
<br>
Editing a transclusion page will cause text on every calling page to display the applied changes.
+
These should be standalone, uncategorised, pages, containing just the core text.
 +
 
 +
Editing a page containing a transclusion, will just display the calling wikicode.
 +
<br>
 +
Look beneath the edit window, you'll see a list of links to the 'templates' called by the wikicode.
 +
<b>
 +
Clicking those links allows editing of the transclusion's content.
 +
<br>
 +
Editing the transclusion page itself, will cause text on every calling page to display the applied changes.
  
 
'''NB'''
 
'''NB'''

Revision as of 09:41, 13 January 2008

This page contains a list of templates available for use in wiki pages.


Template Types

Page templates

Section templates

Transclusion templates

Transclusion code inserts the entire contents of a page into another.

This 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 the 'templates' called by the wikicode. Clicking those links allows 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 users to easily copy & paste the wikicode directly into their required content page.

Category: Missions

Transclusion templates for use in the Missions category.


Oneline

Oneline, a single-line explanation of the topic.

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>

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}}