Template:Tranclude

From OLPC
Jump to navigation Jump to search

The purpose of this template is to reveal those sections of pages that come from transcluded pages. Pages using this template will be included in the Category:Page with transclusion and will display the contents of the transcluded page in a lightyellow color as a reminder of its off-page source.

Usage

The template takes 1 required,

  1. wiki page title
    • Enter the local wiki page title (or interwiki prefix:remote title, if interwiki transclusion is allowed by the administrators).


and 4 optional parameters:

  1. collapsed
    • Default: (empty string) - This shows the transcluded page.
    • Enter collapsed=collapsed to have the transcluded page collapsed on page load (if javascript is enabled).
  2. note
    • Default: <small>'''Note:''' The contents of this section have been transcluded from another page, [[{{{1}}}]]:</small>
    • You may enter any text, which will be displayed before the transclusion in place of the default.
  3. heading
    • Default: (empty string) - This shows the page title heading above the transclusion (by means of this wikicode, <h1>[[{{{1}}}]]</h1>.
    • Entering any non-whitespace text will be used with the {{#if: parser function to replace the default page title heading with another block of introductory text.
    • To hide the page title header, enter <nowiki></nowiki>.
  4. interwikiprefix
    • Default: (empty string) - no effect.
    • Entering any non-whitespace text will be used with the {{#if: parser function to bring in the designated Wiki logo image ahead of the transclusion (currently limited to the OLPC wiki). In future versions, we may migrate to using a widget to embed a page from the source wiki in a frame that would serve to preserve the source formating and context.


Example syntax:

{{Transclude|the transcluded wiki page|note=|heading=optional introductory text|collapsed=collapsed}}

The example wiki text below produces this transclusion:

{{Transclude|olpc:Community Jabber Servers|interwikiprefix=olpc}}

Template:Community Jabber Servers

See http://wiki-devel.sugarlabs.org/go/Template:Transclude for the appearance of this page with interwiki transclusion enabled.