Difference between revisions of "Documentation:User Templates"

From FSDeveloper Wiki
Jump to: navigation, search
m
m
 
(27 intermediate revisions by the same user not shown)
Line 1: Line 1:
 +
{{:Ambox-Wiki-Editors}}
 +
{{:Ambox-Content-WIP}}
 
This page contains a list of templates available on this site for use in wiki pages.
 
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.
 
Page requires expanding to include Page & Section framework templates.
  
== Template Types ==
+
== Page templates ==
=== Page templates ===
+
Placeholder text for '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.
+
== Section templates ==
<br>
+
Placeholder text for 'Section templates'.
These should be standalone, uncategorised, pages, containing just the core text.
 
  
Editing a page containing a transclusion, will just display the calling wikicode.
+
== Transclusion templates ==
<br>
+
Transclusion code is a special link which inserts the entire contents of a page into the calling page.
Look beneath the edit window, you'll see a list of links to all the 'templates' called in that page.
 
<br>
 
Clicking those links allows direct 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'''
+
See - [[Templates-Transclusion/doc]]
<br>
 
The comment section should be left in place in the transclusion page.
 
<br>
 
This allows editors to easily copy & paste the wikicode directly into their required content page.
 
  
== Category: Missions ==
+
== Ambox templates ==
Transclusion templates for use in the Missions category.
+
Placeholder text for 'Ambox templates'.
  
'''NB'''
+
See - [[Templates-Ambox/doc]]
<br>
 
'''TopicPageName''', in the code samples below, is a 'placeholder title' for your page's title.
 
  
----
+
== Infobox templates ==
=== Oneline ===
+
Placeholder text for 'Ambox templates'.
Oneline, a single-line explanation of the topic.  
 
  
Has multiple uses, primarily intended for placement wherever the briefest description is required.
+
See - [[Templates-Infobox/doc]]
<br>
 
e.g.
 
* Listings of related pages.
 
* As the first line in the section above the 'Contents' box.
 
  
==== Useage ====
+
== Navbox templates ==
Used in the following page types or sections -
+
Transclusion code is a special link which inserts the entire contents of a page into the calling page.
* Function Reference (Listing)
 
* FunctionType (Detail)
 
* FunctionName (Detail)
 
* Related Internal
 
  
==== Examples ====
+
See - [[Templates-Navbox/doc]]
See examples at -
 
* [[Example In Use]]
 
* [[Example Source]]
 
  
==== Code ====
+
== Sandbox Testing ==
<pre>
+
A sandbox area for wiki code testing.
<!-- Paste the following line to required location -
 
{{:Transclusion-Missions-Oneline-TopicPageName}}
 
-->
 
'''[[TopicPageName]]''' oneline, a single-line explanation of the topic.  
 
</pre>
 
  
----
+
See - [[Wiki-Sandbox_Test_Area]]
=== 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.
+
[[Category:Wiki-Documentation]]
Should also be preceeded by the 'Oneline' transclusion.
 
 
 
==== Useage ====
 
Used in the following page types or sections -
 
* FunctionType (Detail)
 
* FunctionName (Detail)
 
 
 
==== Examples ====
 
See examples at -
 
* [[Example In Use]]
 
* [[Example Source]]
 
 
 
==== Code ====
 
<pre>
 
<!-- 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>
 
</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
 
 
 
==== Examples ====
 
See examples at -
 
* [[Example In Use]]
 
* [[Example Source]]
 
 
 
==== 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>
 
 
 
----
 
=== Related ===
 
Pre-assembled lists of related page 'oneline' transclusions.
 
 
 
For replication across all related pages in a detail 'level'.
 
 
 
'''NB'''
 
<br>
 
When initially created, if the transclusions do not exist yet, the list may appear as a string of links.
 
<br>
 
Do not double-space the list to force the display.
 
<br>
 
On creating the transclusions, the list will display correctly.
 
 
 
==== Useage ====
 
Used in the following page sections -
 
* Related Internal
 
 
 
==== Examples ====
 
See examples at -
 
* [[Example In Use]]
 
* [[Example Source]]
 
 
 
==== Code ====
 
<pre>
 
<!-- 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}}
 
</pre>
 

Latest revision as of 09:23, 6 February 2010

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.

Page templates

Placeholder text for 'Page templates'.

Section templates

Placeholder text for 'Section templates'.

Transclusion templates

Transclusion code is a special link which inserts the entire contents of a page into the calling page.

See - Templates-Transclusion/doc

Ambox templates

Placeholder text for 'Ambox templates'.

See - Templates-Ambox/doc

Infobox templates

Placeholder text for 'Ambox templates'.

See - Templates-Infobox/doc

Navbox templates

Transclusion code is a special link which inserts the entire contents of a page into the calling page.

See - Templates-Navbox/doc

Sandbox Testing

A sandbox area for wiki code testing.

See - Wiki-Sandbox_Test_Area