Difference between revisions of "Help:Editors Toolbox"

Latest revision as of 00:25, 10 February 2011

Wiki Help

This page some available tools for Wiki editors. For LSL Portal specific tools, please read the LSL Editing Primer.

For userpage specific templates, see Quickie Wiki Intro/Usercategories.

For general MediaWiki syntax, please have a look at the Quickie Wiki Intro as well as the MediaWiki Help Pages.

Templates

The description provided at this page is a short summary of the functionality of the templates. For further details on usage, please browse to the linked documentation pages.

Template	Description
{{Anchor\|<ID>}}	Sets an anchor at a page. You can link there with `[[PAGENAME#<ID>]]` (or just `[[#<ID>]]` for anchors on the same page). Note: MediaWiki automatically generates anchors for headings.
{{Age\|<DD>\|<MM>\|<YYYY>}}	Displays a difference between the current date and a given date in days. See also Template:CountDown.
{{CategoryTOC}}	Adds a table of contents to a category.
{{CountDown\|<YYYY>\|<MM>\|<DD>}}	Dispays the difference between a given date and the current date in days. See also Template:Age
{{Delete\|<REASON>}}	Requests the deletion of a page.
{{Ediquette}}	Places an infobox at a users talkpage which gives suggestions to be more thoughtful with the Wikis resources.
{{forum post\|<LINK TITLE>\|<OPTIONAL POST ID>}}	Adds a link to a forum post from forum.secondlife.com, defaults to using {{SUBPAGENAME}} if the optional post ID is not present.
{{Help}}	Displays a Help Header and Multi-lang bar above the article and can add it to certain categories.
{{Hint\|mode=<MODE>\|desc=<DESCRIPTION>}}	Is able to create a variety of different warning boxes.
{{HoverText\|<TERM>\|<HOVER>}}	Underlines <TERM> and displays the hovertext specified in <HOVER> as an on-mouse-over effect.
{{HoverLink\|<LINK>\|<HOVER>}}	Creates an internal wiki link with a given hovertext.
{{Jira\|<ISSUE-ID>}}	Places a link to the specified issue the public issue tracker.
{{KeyCombo\|ctrl=*\|<KEY>}}	Displays key combination used for shortcuts. Have a look at it's documentation page for further info on usage.
{{Keypress\|<KEY>}}	Like Template:KeyCombo, but for single keys.
{{L$\|<AMOUNT>}}	Used for adding L$ amounts to articles.
{{Multi-lang}}	Displays a language bar on top of the article which links to translated versions. See also Project:Languages.
{{Navbox\|title=<TITLE>\|content=<CONTENT>}}	Creates a navigation box, floating right.
{{RightToc}}	Places the table of contents on the right side of the article.
{{SLurl\|<REGION>}}	Provides an easy way to create SLurls.
{{SLurl2\|<SLurl>}}	Displays <SLurl> in a nicer format.
{{Unsigned\|<USERNAME>\|<DATE>}}	Supposed to be used on talk pages, to mark a comment as unsigned and to provide the right signature.
{{User\|<USERNAME>}}	Creates a link to <USERNAME>s profile.
{{User2\|<USERNAME>}}	Only creates a link to <USERNAME>s profile, in case <USERNAME> created a profile page. Otherwise just displays the name as text.
{{Ram}}	Notes that care should be used in editing a page that is widely transcluded by other pages.

Information for template creators

All extensions currently installed in the wiki are listed at Special:Version. The most important ones for template creators are:

Useful templates to be used inside of templates are {{!}} (adds a pipe |), {{!!}} (adds two pipes ||), {{=}} (adds an equal sign =) and {{bc}} (adds a closing bracket }). These are useful when you'd like to add these signs inside a parserfunction but would like to prevent the template from executing them as part of the function. E.g. tables inside a parser function. Also useful: {{ZWSP}}, which adds a zero-width space.

Note that there are a couple of so called magic words available, which can return values (like the current time, the page title, etc.) or change the style of your page (hide or fix the table of contents, etc.). Read the MediaWiki documentation on magic words for further information.

Widgets

See http://www.mediawiki.org/wiki/Extension:Widgets for general information about widgets. All currently in the SL Wiki available widgets can be found at Special:PrefixIndex/Widget:. You can suggest the implementation of further widgets via the issue tracker.

Videos and Images

Videos

The VideoFlash extension allows to add YouTube and Google Videos (as well as some others). We also got a Blip.tv widget as well as one for YouTube playlists, which is falsely named as Widget:YouTubeChannel.

Images

Images can either be added via the regular MediaWiki syntax (see Mediawiki Help:Images) or via the ImageMap extension. The ImageMap manual from Wikipedia as well as the ImageMap editor tool can be useful. Note that images added via this extension cause a line break which can be avoided by putting image and text in between <div class="imagemap-inline"></div>.

References

For references, please use the Cite extension.

Usage: Text<ref>reference</ref> results in Text^[1]

Place the <references /> tag where you'd like to display the references.

↑ reference

[1] reference

[1]

@@ Line 1: / Line 1: @@
-This page lists tools for Wiki editors. For [[LSL Portal]] specific tools, please read the [[LSL Editing Primer]].
+{{Help|Wiki=*}}{{Navbox/Wiki}}{{RightToc}}This page some available tools for Wiki editors. For [[LSL Portal]] specific tools, please read the [[LSL Editing Primer]].
 For userpage specific templates, see [[Quickie Wiki Intro/Usercategories]].
+For general MediaWiki syntax, please have a look at the [[Quickie Wiki Intro]] as well as the [http://www.mediawiki.org/wiki/Help:Contents MediaWiki Help Pages].
+<br clear="all"/>
 == Templates ==
 The description provided at this page is a short summary of the functionality of the templates. For further details on usage, please browse to the linked documentation pages.
@@ Line 12: / Line 14: @@
 |-
 |<nowiki>{{</nowiki>[[Template:Anchor|Anchor]]|<ID>}}
-|Sets an anchor at a page. You can link there with <font color="blue"><nowiki>[[PAGENAME#<ID>]]</nowiki></font>.
+|Sets an anchor at a page. You can link there with <code><nowiki>[[PAGENAME#<ID>]]</nowiki></code> (or just <code><nowiki>[[#<ID>]]</nowiki></code> for anchors on the same page).
+Note: MediaWiki automatically generates anchors for headings.
 |-
-|<nowiki>{{</nowiki>[[Template:Box|Box]]|<TOPIC>|<TEXT>}}
+<!-- Error, fixed by ANSI Soderstrom -->
-|Places a nice box around the text. Might break when you use additional Wiki syntax within the the <TOPIC> or <TEXT> fields.
+<!--
+|<nowiki>{{</nowiki>[[Template:Age|Age]]|<YYYY>|<MM>|<nowiki><DD></nowiki>}}
+-->
+|<nowiki>{{</nowiki>[[Template:Age|Age]]|<nowiki><DD></nowiki>|<MM>|<YYYY>}}
+|Displays a difference between the current date and a given date in days. See also [[Template:CountDown]].
+|-
+<!-- Error, fixed by ANSI Soderstrom in 2011/02/10 -->
+<!-- Because : Breaks the visible Content -->
+<!--
+|<nowiki>{{</nowiki>[[Template:Box|Box]]|<TOPIC>|<TEXT>}}
+|Places a nice box around the text. Might break when you use additional Wiki syntax within the the <nowiki><TOPIC></nowiki> or <nowiki><TEXT></nowiki> fields.
+|-
+-->
+|<nowiki>{{</nowiki>[[Template:CategoryTOC|CategoryTOC]]}}
+|Adds a table of contents to a category.
+|-
+|<nowiki>{{</nowiki>[[Template:CountDown|CountDown]]|<YYYY>|<MM>|<nowiki><DD></nowiki>}}
+|Dispays the difference between a given date and the current date in days. See also [[Template:Age]]
 |-
 |<nowiki>{{</nowiki>[[Template:Delete|Delete]]|<REASON>}}
@@ Line 23: / Line 44: @@
 |Places an infobox at a users talkpage which gives suggestions to be more thoughtful with the Wikis resources.
 |-
-|<nowiki>{{</nowiki>[[Template:Footnote|Footnote]]|<TEXT>}}
+|<nowiki>{{</nowiki>[[Template:forum post|forum post]]|<LINK TITLE>|<OPTIONAL POST ID>}}
-|Saves text for a footnote. Supposed to be used in combination with [[Template:Footnotes]].
+|Adds a link to a forum post from forum.secondlife.com, defaults to using <nowiki>{{SUBPAGENAME}}</nowiki> if the optional post ID is not present.
-|-
-|<nowiki>{{</nowiki>[[Template:Footnotes|Footnotes]]}}
-|Displays footnotes defined with [[Template:Footnote]].
 |-
 |<nowiki>{{</nowiki>[[Template:Help|Help]]}}
 |Displays a [[Template:Help Header|Help Header]] and [[Template:Multi-lang|Multi-lang]] bar above the article and can add it to certain categories.
 |-
-|<nowiki>{{</nowiki>[[Template:Help/Box|Help/Box]]|<TOPIC>|<TEXT>}}
+<!-- Error, fixed by ANSI Soderstrom in 2011/02/10 -->
-|Creates an inforbox with defined <TOPIC> and <TEXT> in a [[Help Portal]] style.
+<!-- Because : Breaks the visible Content -->
+<!--
+|<nowiki>{{</nowiki>[[Template:Help/Box|Help/Box]]|<TOPIC>|<TEXT>}}
+|Creates an infobox with defined <TOPIC> and <TEXT> in a [[Help Portal]] style.
+|-
+|<nowiki>{{</nowiki>[[Template:Hilite|Hilite]]|<TEXT>}}
+|Will {{Hilite|highlight}} <TEXT>. Usable for editor notes while an article is sandboxed and edited.
+|-
+-->
+|<nowiki>{{</nowiki>[[Template:Hint|Hint]]|mode=<MODE>|desc=<DESCRIPTION>}}
+|Is able to create a variety of different warning boxes.
 |-
 |<nowiki>{{</nowiki>[[Template:HoverText|HoverText]]|<TERM>|<HOVER>}}
 |Underlines <TERM> and displays the hovertext specified in <HOVER> as an on-mouse-over effect.
 |-
-|<nowiki>{{</nowiki>[[Template:HoverLink|HoverLink]]|<LINK>|<HOVER>}}</nowiki>
+|<nowiki>{{</nowiki>[[Template:HoverLink|HoverLink]]|<LINK>|<HOVER>}}
 |Creates an '''internal''' wiki link with a given hovertext.
 |-
@@ Line 44: / Line 72: @@
 |Places a link to the specified issue the public [[issue tracker]].
 |-
-|<nowiki>{{</nowiki>[[Template:KB|KB]]|<ID>|<TITLE>}}
+|<nowiki>{{</nowiki>[[Template:KeyCombo|KeyCombo]]|ctrl=*|<KEY>}}
-|Displays a link to a KB article. See also [[Template:Slkb]].
+|Displays key combination used for shortcuts. Have a look at it's [[Template:KeyCombo|documentation page]] for further info on usage.
+|-
+|<nowiki>{{</nowiki>[[Template:Keypress|Keypress]]|<KEY>}}
+|Like [[Template:KeyCombo]], but for single keys.
+|-
+|<nowiki>{{</nowiki>[[Template:L$|L$]]|<AMOUNT>}}
+|Used for adding L$ amounts to articles.
 |-
 |<nowiki>{{</nowiki>[[Template:Multi-lang|Multi-lang]]}}
 |Displays a language bar on top of the article which links to translated versions. See also [[Project:Languages]].
 |-
+|<nowiki>{{</nowiki>[[Template:Navbox|Navbox]]|title=<TITLE>|content=<CONTENT>}}
+|Creates a navigation box, floating right.
+|-
+<!-- Error, fixed by ANSI Soderstrom in 2011/02/10 -->
+<!-- Because : Breaks the visible Content -->
+<!--
 |<nowiki>{{</nowiki>[[Template:NoWrap|NoWrap]]|<TEXT>}}
 |Prevents <TEXT> from beeing altered via line breaks.
 |-
+|<nowiki>{{</nowiki>[[Template:Quotation|Quotation]]|<TEXT>|<AUTHOR>|<DATE>|<SOURCE>}}
+|Displays <TEXT> in a in a quotationbox, stating <AUTHOR>, <DATE> and <SOURCE>
+|-
+-->
 |<nowiki>{{</nowiki>[[Template:RightToc|RightToc]]}}
 |Places the table of contents on the right side of the article.
-|-
-|<nowiki>{{</nowiki>[[Template:Slkb|Slkb]]|<ID>|<TITLE>}}
-|Creates a link to a KB article. See also [[Template:KB]].
 |-
 |<nowiki>{{</nowiki>[[Template:SLurl|SLurl]]|<REGION>}}
-|Provides an easy way to create [[SLURL]]s.
+|Provides an easy way to create [[SLurl]]s.
 |-
-|<nowiki>{{</nowiki>[[Template:SLURL2|SLURL2]]|<SLURL>}}
+|<nowiki>{{</nowiki>[[Template:SLurl2|SLurl2]]|<SLurl>}}
-|Displays <SLURL> in a nicer format.
+|Displays <SLurl> in a nicer format.
 |-
 |<nowiki>{{</nowiki>[[Template:Unsigned|Unsigned]]|<USERNAME>|<DATE>}}
-|Supposed to be used on talkpages, to mark a comment as unsigned and to provide the right signature.
+|Supposed to be used on talk pages, to mark a comment as unsigned and to provide the right signature.
 |-
 |<nowiki>{{</nowiki>[[Template:User|User]]|<USERNAME>}}
@@ Line 73: / Line 114: @@
 |<nowiki>{{</nowiki>[[Template:User2|User2]]|<USERNAME>}}
 |Only creates a link to <USERNAME>s profile, in case <USERNAME> created a profile page. Otherwise just displays the name as text.
+|-
+|<nowiki>{{</nowiki>[[Template:Ram|Ram]]}}
+|Notes that care should be used in editing a page that is widely transcluded by other pages.
 |}</div>
-=== Infos for template creators ===
+=== Information for template creators ===
-All extensions currently installed in the Wiki are listed at [[Special:Version]]. The most important ones for template creators might be
+All extensions currently installed in the wiki are listed at [[Special:Version]]. The most important ones for template creators are:
 *[http://www.mediawiki.org/wiki/Help:Extension:ParserFunctions Parser Functions]
 *[http://www.mediawiki.org/wiki/Extension:StringFunctions String Functions]
@@ Line 84: / Line 128: @@
 *[http://www.mediawiki.org/wiki/Extension:Widgets Widgets]
-Please note that not all parser functions listet there are available in the SL Wiki. <font color="blue">#titleparts</font> and <font color="blue">#iferror</font> are missing. Furthermore, there are known problems with conditionals and variables. See {{Jira|WEB-896}}.
+Useful templates to be used inside of templates are <nowiki>{{</nowiki>[[Template:!|!]]}} (adds a pipe <font color="black">|</font>), <nowiki>{{</nowiki>[[Template:!!|!!]]}} (adds two pipes <font color="black">||</font>), <nowiki>{{</nowiki>[[Template:=|=]]}} (adds an equal sign <font color="black">=</font>) and <nowiki>{{</nowiki>[[Template:bc|bc]]}} (adds a closing bracket <font color="black">}</font>). These are useful when you'd like to add these signs inside a parserfunction but would like to prevent the template from executing them as part of the function. E.g. tables inside a parser function. Also useful: <nowiki>{{</nowiki>[[Template:ZWSP|ZWSP]]}}, which adds a [http://en.wikipedia.org/wiki/Zero-width_space zero-width space].
+Note that there are a couple of so called ''magic words'' available, which can return values (like the current time, the page title, etc.) or change the style of your page (hide or fix the table of contents, etc.). Read [http://www.mediawiki.org/wiki/Help:Magic_words the MediaWiki documentation on magic words] for further information.
 == Widgets ==
@@ Line 92: / Line 139: @@
 == Videos and Images ==
 === Videos ===
-The [http://www.mediawiki.org/wiki/Extension:VideoFlash VideoFlash extension] allows to add YouTube and Google Videos (as well as some others). We also got a [[Widget:Blip.tv|Blip.tv widget]] as well as one for YouTube playlists, which is falsly named as [[Widget:YouTubeChannel]].
+The [http://www.mediawiki.org/wiki/Extension:VideoFlash VideoFlash extension] allows to add YouTube and Google Videos (as well as some others). We also got a [[Widget:Blip.tv|Blip.tv widget]] as well as one for YouTube playlists, which is falsely named as [[Widget:YouTubeChannel]].
 === Images ===
-Images can either be added via the regular MediaWiki syntax (see [http://www.mediawiki.org/wiki/Help:Images Mediawiki Help:Images]) or via the [http://www.mediawiki.org/wiki/Extension:ImageMap ImageMap extension]. The [http://en.wikipedia.org/wiki/User:Nihiltres/ImageMap_how-to ImageMap manual] from Wikipedia as well as the [http://toolserver.org/~dapete/ImageMapEdit/ImageMapEdit.html ImageMap editor tool] can be useful. Note that images added via this extension cause a line break which can be avoided by putting it in between <font color="blue"><nowiki><div class="imagemap-inline"></div></nowiki></font>.
+Images can either be added via the regular MediaWiki syntax (see [http://www.mediawiki.org/wiki/Help:Images Mediawiki Help:Images]) or via the [http://www.mediawiki.org/wiki/Extension:ImageMap ImageMap extension]. The [http://en.wikipedia.org/wiki/User:Nihiltres/ImageMap_how-to ImageMap manual] from Wikipedia as well as the [http://toolserver.org/~dapete/ImageMapEdit/ImageMapEdit.html ImageMap editor tool] can be useful. Note that images added via this extension cause a line break which can be avoided by putting image and text in between <code><nowiki><div class="imagemap-inline"></div></nowiki></code>.
+== References ==
+For references, please use the [http://www.mediawiki.org/wiki/Extension:Cite/Special:Cite.php Cite extension].
+Usage: Text<nowiki><ref>reference</ref></nowiki> results in Text<ref>reference</ref>
+Place the <nowiki><references /></nowiki> tag where you'd like to display the references.
+<references />