Template:Documentation

Revision as of 01:11, 4 July 2013 (view source) Fabartus (Talk | contribs) (genesis, port unchanged from WikiMedia+cat w/{{Mediawiki} -- needs ParserFunctions to turn on, disabled interwiki lang links) ← Older edit		Revision as of 01:12, 4 July 2013 (view source) Fabartus (Talk | contribs) (rv to stub verson to avoid all that parserfunction clutter for the moment) Newer edit →
Line 1:		Line 1:
−	<!--	+	<onlyinclude>{{{{BASEPAGENAME}}/doc}}
−	Automatically add {{template sandbox notice}} when on a /sandbox page.	+	[[Category:{{{other|Templates}}}|{{PAGENAME}}]]</onlyinclude>
−	-->{{#ifeq: {{SUBPAGENAME}} | sandbox	+	<noinclude>This is the template documentation page for <nowiki>{{</nowiki>{{FULLPAGENAME}}<nowiki>}}</nowiki>
−	| <div style="clear: both;"></div>{{template sandbox notice|{{{livepage|}}}}}	+	[[Category:Templates|{{PAGENAME}}]]
−	}}<!--	+	{{FAB-todo}}
−	Start of green doc box.	+	{{Underconstruction}}
−	-->{{documentation/start box2	+	:This is a quick and dirty 'rough start' to create a simpler version of the {{documentation}} templates used on Wikibooks and Wikipedia.
−	| preload = {{{preload|}}}   <!--Allow custom preloads-->	+
−	| heading = {{{heading|¬}}}  <!--Empty but defined means no header-->	+
−	| heading-style = {{{heading-style|}}}	+
−	| content = {{{content|}}}	+
−	<!--Some namespaces must have the /doc, /sandbox and /testcases	+	;*Needs to evolve to check presence of Documentation sub-page (/doc page) and if present build a transcluded link set then incorporate that help inside HTML formatting.
−	in talk space-->	+	*Otherwise, allow 'text=' parameter to be sandwiched on page and so also giving page self-documenting status automatically.
−	| docspace = {{documentation/docspace}}	+
−		+
−	| 1 = {{{1|}}}  <!--Other docname, if fed-->	+
−		+
−	<!--The namespace is added in /start box2-->	+
−	| template page = {{documentation/template page}}	+
−		+
−	}}<!-- Start content --><!--	+
−	Start load the /doc content:	+
−	Note: The line breaks between this comment and the next line are necessary	+
−	so  "=== Headings ===" at the start and end of docs are interpreted.	+
−	-->	+
−	{{#switch: {{#if:{{{content|}}}|1|0}}{{#if:{{{1|}}}|1|0}}{{#ifexist:{{{1|}}}|1|0}}{{#ifexist:{{documentation/docspace}}:{{documentation/template page}}/doc|1|0}}	+
−	| 1000 | 1001 | 1010 | 1011 | 1100 | 1101 | 1110	+
−	| 1111 = {{{content|}}}	+
−	| 0110 | 0111 = {{ {{{1}}} }}	+
−	| 0001 | 0011 = {{ {{documentation/docspace}}:{{documentation/template page}}/doc }}	+
−	| 0000 | 0100 | 0010 | 0101 =	+
−	}}	+
−	<!--	+
−	End load the /doc content:	+
−	Note: The line breaks between this comment and the previous line are necessary	+
−	so  "=== Headings ===" at the start and end of docs are interpreted.	+
−	-->{{documentation/end box2	+
−	| preload = {{{preload|}}}  <!--Allow custom preloads-->	+
−	| content = {{{content|}}}	+
−	| link box = {{{link box|}}}  <!--So "link box=off" works-->	+
−		+
−	<!--Some namespaces must have the /doc, /sandbox and /testcases	+
−	in talk space-->	+
−	| docspace = {{documentation/docspace}}	+
−		+
−	| 1 = {{{1|}}}  <!--Other docname, if fed-->	+
−		+
−	<!--The namespace is added in /end box2-->	+
−	| template page = {{documentation/template page}}	+
−		+
−	}}<!--	+
−	End of green doc box	+
−	--><noinclude>	+
−	{{mediawiki}}	+
−	<!-- Add categories and interwikis to the /doc subpage, not here! -->	+
	</noinclude>		</noinclude>
		+	{{lts}}

---

Revision as of 01:12, 4 July 2013

This template automatically displays a documentation box like you are seeing now, of which the content is transcluded from another page. It is intended for pages which are transcluded in other pages, i.e. templates, whether in the template namespace or not.

Usage

Normal

<noinclude>{{documentation}}<noinclude>
or <noinclude>{{documentation|template:any page/doc}}<noinclude>

This code should be added at the bottom of the template code, with no extra space before "<noinclude>" (which would cause extra space on pages where the template is used). The parameter can be used as shown above to transclude an arbitrary documentation page.

Add categories and interwiki links to the documentation page inside includeonly tags.

If the documentation page contains includeonly or noinclude tags as part of the documentation, replace the "<" with "&lt;".

Customizing display

Overrides exist to customize the output in special cases:

• {{documentation|heading=}}: change the text of the "documentation" heading. If this is set to blank, the entire heading line (including the first [edit] link) will also disappear.

Functions

If the documentation page doesn't exist, the "edit" link includes a preload parameter so that clicking it will pre-fill the edit form with the basic documentation page format.

Rationale

This template allows any page to use any documentation page, and makes it possible to protect templates while allowing anyone to edit the template's documentation, categories, and interwiki links. It also reduces server resources by circumventing a technical limitation of templates (see a developer's explanation).

See also

• Template:documentation subpage<includonly>
• Template:Documentation
• wikipedia:Wikipedia:Template documentation

This is the template documentation page for {{Template:Documentation}}∅

This page is UNDER CONSTRUCTION… a stub, actively undergoing expansion by the incorporation of new material here on the TrainzOnline Wiki. If you are knowledgeable about the topic you can help, but not just now—another TrainzOnline editor has placed this tag to warn off other users from adding to the content on this page. In short, it is undergoing active expansion and editing by {{{1}}}. Check back later and if the page hasn't undergone any saved changes for a while, just use the edit tab above and clear this tag after leaving a message on the particular user's talk page (i.e. who hung the tag). If unfamiliar with Wiki editing, see the How-to edit pages and Help:Contents for guidance and How-to information.

This is a quick and dirty 'rough start' to create a simpler version of the

This template automatically displays a documentation box like you are seeing now, of which the content is transcluded from another page. It is intended for pages which are transcluded in other pages, i.e. templates, whether in the template namespace or not.

Usage

Normal

<noinclude>{{documentation}}<noinclude>
or <noinclude>{{documentation|template:any page/doc}}<noinclude>

This code should be added at the bottom of the template code, with no extra space before "<noinclude>" (which would cause extra space on pages where the template is used). The parameter can be used as shown above to transclude an arbitrary documentation page.

Add categories and interwiki links to the documentation page inside includeonly tags.

If the documentation page contains includeonly or noinclude tags as part of the documentation, replace the "<" with "&lt;".

Customizing display

Overrides exist to customize the output in special cases:

• {{documentation|heading=}}: change the text of the "documentation" heading. If this is set to blank, the entire heading line (including the first [edit] link) will also disappear.

Functions

If the documentation page doesn't exist, the "edit" link includes a preload parameter so that clicking it will pre-fill the edit form with the basic documentation page format.

Rationale

This template allows any page to use any documentation page, and makes it possible to protect templates while allowing anyone to edit the template's documentation, categories, and interwiki links. It also reduces server resources by circumventing a technical limitation of templates (see a developer's explanation).

See also

• Template:documentation subpage<includonly>
• Template:Documentation
• wikipedia:Wikipedia:Template documentation

Contents 1 Usage 1.1 Normal 1.2 Customizing display 2 Functions 3 Rationale 4 See also 5 Usage 5.1 Normal 5.2 Customizing display 6 Functions 7 Rationale 8 See also

  templates used on Wikibooks and Wikipedia.

• Needs to evolve to check presence of Documentation sub-page (/doc page) and if present build a transcluded link set then incorporate that help inside HTML formatting.

• Otherwise, allow 'text=' parameter to be sandwiched on page and so also giving page self-documenting status automatically.

Template:Documentation (edit talk links history)