Difference between revisions of "Template:HelpSection"

From Wikispooks
Jump to navigation Jump to search
(Better documentation)
(expand use to set WikispooksPage)
Line 1: Line 1:
<noinclude>'''Used at the top of help sections.'''<br/>
+
<noinclude>[[Category:Semantic Templates]][[Category:Wikispooks Templates]]'''This started as just displaying an icon at the top of help sections, but is evolving into a semantic template.'''<br/>
Currently this does two things:
+
Currently this does 3 things:
 
# Makes an 100px icon on the right. The parameters is 'image' to chance to vary the icon from the default help icon.
 
# Makes an 100px icon on the right. The parameters is 'image' to chance to vary the icon from the default help icon.
 
# Includes [[WikiSpooks:Site Status]] so a warning appears if the site is undergoing maintenance.
 
# Includes [[WikiSpooks:Site Status]] so a warning appears if the site is undergoing maintenance.
 +
# Sets [[Property:Has objectClass2|Has objectClass2]]="WikispooksPage", for display of changes on the main page
 
<br/>
 
<br/>
 
Usage:<br/>
 
Usage:<br/>
:{{t|<nowiki>{{HelpSection}}</nowiki>}} or {{t|<nowiki>{{HelpSection|image=my_help_image.jpg}}</nowiki>}} or {{t|<nowiki>{{HelpSection|image=my_help_image.jpg|link=my_link_page}}</nowiki>}}</noinclude><includeonly>{{WikiSpooks:Site Status}}{{#if: {{{image|}}} | [[image:{{{image|}}}|100px|link={{{link|}}}|right]] | [[image:Torchlight_help_icon.png|100px|link={{{link|}}}|right]] }}</includeonly>
+
:{{t|<nowiki>{{HelpSection}}</nowiki>}} or {{t|<nowiki>{{HelpSection|image=my_help_image.jpg}}</nowiki>}} or {{t|<nowiki>{{HelpSection|image=my_help_image.jpg|link=my_link_page}}</nowiki>}}</noinclude><includeonly>{{WikiSpooks:Site Status}}{{#if: {{{image|}}} | [[image:{{{image|}}}|100px|link={{{link|}}}|right]] | [[image:Torchlight_help_icon.png|100px|link={{{link|}}}|right]] }}[[Has objectClass2::WikispooksPage]]</includeonly>

Revision as of 09:01, 19 September 2014

This started as just displaying an icon at the top of help sections, but is evolving into a semantic template.
Currently this does 3 things:

  1. Makes an 100px icon on the right. The parameters is 'image' to chance to vary the icon from the default help icon.
  2. Includes WikiSpooks:Site Status so a warning appears if the site is undergoing maintenance.
  3. Sets Has objectClass2="WikispooksPage", for display of changes on the main page


Usage:

{{HelpSection}} or {{HelpSection|image=my_help_image.jpg}} or {{HelpSection|image=my_help_image.jpg|link=my_link_page}}