Documentation:User Templates: Difference between revisions

From FSDeveloper Wiki
Jump to navigationJump to search
(New page: This page contains a list of templates available for use in wiki pages. -- Template Types -- --- Transclusion templates --- Allow use of single-source 'boilerplate text' to be replicate...)
 
mNo edit summary
Line 2: Line 2:




-- Template Types --
== Template Types ==
 
=== Page templates ===
--- Transclusion templates ---
=== Section templates ===
=== Transclusion templates ===
Allow use of single-source 'boilerplate text' to be replicated across multiple pages.
Allow use of single-source 'boilerplate text' to be replicated across multiple pages.


Line 16: Line 17:
This allows users to easily copy & paste the wikicode directly into their required content page.
This allows users to easily copy & paste the wikicode directly into their required content page.


-- :Category:Missions --
== :Category:Missions ==
Transclusion templates for use in the Missions category.
Transclusion templates for use in the Missions category.


--- Oneline ---
=== Oneline ===
Oneline, a single-line explanation of the topic.  
Oneline, a single-line explanation of the topic.  


--- Useage ----
==== Useage ====
Used in the following page types or sections -
Used in the following page types or sections -
* Function Reference (Listing)
* Function Reference (Listing)
Line 29: Line 30:
* Related Internal
* Related Internal


---- Code ----
==== Code ====
<nowiki><pre>
<pre>
<!-- Paste the following line to required location -
<!-- Paste the following line to required location -
{{:Transclusion-Missions-Oneline-TopicPageName}}
{{:Transclusion-Missions-Oneline-TopicPageName}}
  -->
  -->
'''[[TopicPageName]]''' oneline, a single-line explanation of the topic. Used in -
'''[[TopicPageName]]''' oneline, a single-line explanation of the topic.  
</pre></nowiki>
</pre>




--- Overview ---
=== Overview ===
Overview, a multi-line explanation of the topic.
Overview, a multi-line explanation of the topic.
Includes a 'More about TopicPageName...' link to the full-detail page.
Includes a 'More about TopicPageName...' link to the full-detail page.
Line 45: Line 46:
Should also be preceeded by the 'Oneline' transclusion.
Should also be preceeded by the 'Oneline' transclusion.


--- Useage ----
==== Useage ====
Used in the following page types or sections -
Used in the following page types or sections -
* FunctionType (Detail)
* FunctionType (Detail)
* FunctionName (Detail)
* FunctionName (Detail)


---- Code ----
==== Code ====
<nowiki><pre>
<pre>
<!-- Paste the following line to required location -
<!-- Paste the following line to required location -
{{:Transclusion-Missions-Overview-TopicPageName}}
{{:Transclusion-Missions-Overview-TopicPageName}}
Line 59: Line 60:
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></nowiki>
</pre>


--- Related ---
=== Related ===
Pre-assembled lists of related page 'oneline' transclusions.
Pre-assembled lists of related page 'oneline' transclusions.


Line 68: Line 69:
See examples at -
See examples at -


--- Useage ----
==== Useage ====
Used in the following page sections -
Used in the following page sections -
* Related Internal
* Related Internal


---- Code ----
==== Code ====
<nowiki><pre>
<pre>
<!-- Paste the following line to required location -
<!-- Paste the following line to required location -
{{:Transclusion-Missions-Related-TopicPageName}}
{{:Transclusion-Missions-Related-TopicPageName}}
  -->
  -->
'''[[TopicPageName]]''' related, a list of single-line explanations of the topic.
'''[[TopicPageName]]''' related, a list of single-line explanations of the topic.
</pre></nowiki>
</pre>

Revision as of 09:28, 13 January 2008

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


Template Types

Page templates

Section templates

Transclusion templates

Allow use of single-source 'boilerplate text' to be replicated across multiple pages.

These are standalone, uncategorised, pages, containing just the core text.

Editing a transclusion page 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}}
 -->
'''[[TopicPageName]]''' related, a list of single-line explanations of the topic.