Templates-Transclusion/doc

From FSDeveloper Wiki
Jump to: navigation, search

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.
Generally these should be standalone, uncategorised, pages, containing just the core text.

Most useful for 'Function Reference' listings pages, and their matching detail pages.

A transclusion can call other transclusions, see the sample Related Transclusion below.

Transclusion templates - Samples

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 Transclusion

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
Examples

See examples at -

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

Overview Transclusion

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)
Examples

See examples at -

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 Transclusion

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 -

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 Transclusion

A transclusion can call other transclusions.

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

For replication across all related pages in a detail 'level'.

NB
When initially created, if the transclusions do not exist yet, the list may appear as a string of links.
Do not double-space the list to force the display.
On creating the transclusions, the list will display correctly.

Useage

Used in the following page sections -

  • Related Internal
Examples

See examples at -

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

Forum Link Transclusion

Example for a forum link.

Code
<!-- Paste the following line to required location -
{{:Transclusion:Forums-Oneline-Redirect-FORUMNAME}}
 -->
'''[http://www.fsdeveloper.com/forum/forumdisplay.php?f=TOPICNUMBER FORUMNAME Forum]''' {{:Transclusion:Forums-Oneline-Redirect-Instruct}}

Do not include [[Category:TOPICNAME]] as it displays the full transclusion page title.

Transclusion templates - Creating

Detail here.

Naming convention.

The comment section should always be left in place in the transclusion page.
This allows editors to easily copy & paste the wikicode directly into their required content page.

Transclusion templates - Applying

As per all wiki internal links, creating a link in a page, then clicking that link will take you to that page, (or editor window).

e.g. Pasting the following code into your page -

{{:Transclusion-Missions-SeeDetail}}

Gives the following output -

This is an overview page. For expanded detail click the topic links below.

Transclusion templates - Editing Content

Editing a page containing a transclusion, will not display the content text, just 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.