Wikicode: Difference between revisions

Jump to navigation Jump to search

Wikicode (view source)

Revision as of 12:51, 4 May 2020

1,635 bytes added ,  12:51, 4 May 2020
Medium rewrite
(Added note about passthrough of url-hashes for redirects.)
(Medium rewrite)
Line 1: Line 1:
{{Needs revision
= About =
|reason=Needs reformatting and slight restructuring. I suggest to move the yogstation-wiki-specific templates to a new article which then can include details on how to use, create and document them.
There are two ways to make our articles look nice: Wikicode and HTML+CSS. Wikicode is very simple and fast to learn, while the available HTML+CSS (background images don't work for example) is powerful yet ugly to maintain. Always try to use wikicode instead of HTML.
|user=[[User:Helpful Herbert|Helpful Herbert]] ([[User talk:Helpful Herbert|talk]]) 21:12, 1 May 2020 (UTC)
}}


==Wikicode==
This article doesn't cover wikicode in depth, for additional information refer to:
Wikicode is the strange syntax used by all wikipedias including this one. If you don't know it and are prepared to learn, continue reading. Otherwise, you can read the Wikipedia help page [http://en.wikipedia.org/wiki/Help:Wiki_markup Here], or read the MediaWiki help page [http://www.mediawiki.org/wiki/Help:Formatting here]. <br>
* http://en.wikipedia.org/wiki/Help:Wiki_markup
* http://www.mediawiki.org/wiki/Help:Formatting


This page is meant to be a much shorter list than one you would find on wikipedia, and also meant for some of our own internal templates or similar tools. Really, this will be some kind of list of some basic/advanced formatting techniques and how to use them.
When in doubt, check the sourcecode of an article or ask on [{{Constant/Discordurl}} #wiki-and-mentor]
<br>
==Page Links==


Page links are important because without them, finding pages becomes too hard. Linking to other pages minimizes the total amount of information needed on one page, but also chains pages together for ease of access. Note, any time a page has spaces in the title, they must be replaced with underscores {_}
= Commands =
The easiest method to link to another page on our wiki is to use <nowiki>[[A_page_name]]</nowiki>. For example:
== Basic commands ==
{| class="wikitable" | style="text-align: center;"
A short summary of how to do different things
{| class="wikitable"
! colspan="3"| Most used wikicodes
|-
! Formatting
! Code
! Example
|-
! Bold
| <pre><nowiki>Quite a '''bold''' move, Mr Bond</nowiki></pre>
| Quite a '''bold''' move, Mr Bond
|-
! Italic
| <pre><nowiki>Do you ''really'' want that drink?</nowiki></pre>
| Do you ''really'' want that drink?
|-
|-
! This || Gives us this
! Italic & bold
| <pre><nowiki>No! '''''Please'''''! NO!</nowiki></pre>
| No! '''''Please'''''! NO!
|-
|-
|<nowiki>This will direct you to the [[Engineer]] page.</nowiki> ||
! Strike-through
This will direct you to the [[Engineer]] page.
| <pre>We make <s>mistakes</s> happly little accidents</pre>
|} <br>
| We make <s>mistakes</s> happly little accidents
 
But lets say you want to link to a specific header or part of the page. Instead, we add a # symbol with the header name. like this: <nowiki>[[Name_of_page#Header]]</nowiki>. An example:
{| class="wikitable" | style="text-align: center;"
|-
|-
! This || Gives us this
! Colored text
| <pre><span style="color: green">Money money money</span></pre>
| <span style="color: green">Money money money</span>
|-
|-
|<nowiki>This will direct you to the [[Engineer#Doing_your_duty]] header.</nowiki> ||
! Centered text
This will direct you to the [[Engineer#Doing_your_duty]] header.
| <pre><center>Look at me</center></pre>
|} <br>
| <center>Look at me</center>
 
Alternatively, you can use an <nowiki>{{anchor}}</nowiki> on your page. The [[Template:Anchor|Anchor]] is a template that creates an invisible anchor on the page for linking. All you do is type <nowiki>{{Anchor|Name_of_Anchor}}</nowiki>, and all you need to do is make a link to the anchor. See the [[Wikicode#Templates|templates]] section for more info. An example:
{| class="wikitable" | style="text-align: center;"
|-
|-
! This || Gives us this
! Small and big text
| <pre><big>big</big> and <small>small</small></pre>
| <big>big</big> and <small>small</small>
|-
|-
|<nowiki>{{Anchor|donk}} This [[Wikicode#donk]] will bring you here.</nowiki> ||
! Code
{{Anchor|donk}} This [[Wikicode#donk]] will bring you here.
| <pre>Either use <code>inline-codes</code> or
|} <br>
&lt;pre&gt;Use
 
mutiple
In many cases, we don't want the actual page name to be in the link we make. So now we use <nowiki>[[Name_of_page|Name_of_link]]</nowiki>. An example:
lines&lt;/pre&gt;</pre>
{| class="wikitable" | style="text-align: center;"
| Either use <code>inline-codes</code> or
<pre>Use
mutiple
lines</pre>
|-
|-
! This || Gives us this
! Prevent wikicode
| <pre>&lt;nowiki&gt;'''bold'''&lt;/nowiki&gt; will be '''bold'''</pre>
| <nowiki>'''bold'''</nowiki> will be '''bold'''
|-
|-
|<nowiki>Doing your [[Engineer#Doing_your_duty|doody]]</nowiki> ||
! Paragraphs
Doing your [[Engineer#Doing_your_duty|doody]]
| <pre>Leave empty lines
|} <br>


==Redirecting pages==
or just use<br>manual breaks</pre>
| Leave empty lines


In some cases, creating a blank page to redirect to a similar named page or object is helpful. This especially helps when using the search function on the wiki. To make a redirect, create a new page of the word you need redirected, and only enter '''<nowiki>#REDIRECT [[page_to_redirect_to]]</nowiki>'''. This makes it so whenever someone loads the page, they will be automatically redirected to the indicated page.
or just use<br>manual breaks
|-
! Sections
| <pre>= Level 1 =
== Level 2 ==
=== Level 3 ===
==== Level 4 ====
===== Level 5 =====</pre>
| [[File:Wiki header example.png]]
|-
! Link (Internal)
| <pre><nowiki>Check [[Wikicode]] or [[Wikicode|click here fore more]]</nowiki></pre>
| Check [[Wikicode]] or [[Wikicode|click here fore more]]
|-
! Link (External)
| <pre><nowiki>http://en.wikipedia.org/wiki/Help:Wiki_markup</nowiki></pre>
| http://en.wikipedia.org/wiki/Help:Wiki_markup
|-
! Link (External, custom text)
| <pre><nowiki>[http://en.wikipedia.org/wiki/Help:Wiki_markup click me]</nowiki></pre>
| [http://en.wikipedia.org/wiki/Help:Wiki_markup click me]
|-
! List (Unordered)
| <pre>* Talk
** shit
* Get
** hit</pre>
|
* Talk
** shit
* Get
** hit
|-
! List (Ordered)
| <pre><nowiki># Stop
## Really, stop
#: ...I said stop
## DUDE!
# Drop
# Roll</nowiki></pre>
|
# Stop
## Really, stop
## ...I said stop
## DUDE!
# Drop
# Roll
|}


Redirects will pass through any url-hashes (anything behind a #). This does not work however if there is a row of redirects. Therefore redirects should always point to the direct target.
== Linking and Anchors ==
Linking of articles was already covered in the basics. To link article-sections you need to use anchors. From a technical point of view an anchor is any tag with an <code>id</code>-attribute. From a usage point of view an anchor is anything that can be linked with a #. This is done automatically for the TOC (Tables of contents).


==Headers==
<code><nowiki>[[#Commands|this]]</nowiki></code> '''[[#Commands|this]]''' will take you to the appropriate section on the same page. This can be done for other articles as well like [[General_items#Paper]].


Headers separate the page into their respective sections (duh). As referenced earlier, headers can be linked to directly using the # symbol with the header name combined with the page name. (<nowiki>[[PageName#HeaderName]]</nowiki>)
Sometimes you will want to link things that don't have a header around. Just create an anchor <code><nowiki>{{anchor|MyThing}}</nowiki></code>{{anchor|MyThing}} and create your link [[#MyThing]].
Headers are created by using the equals symbol (=) before and after a header name. For example:
{| class="wikitable" | style="text-align: center;"
|-
! This || Gives us this
|-
|<nowiki>=Heading=</nowiki> ||
==Heading==
|} <br>


If you want to make a sub-section, all you have to do is add another set of equals (=) symbols.
'''Beware''': If there are multiple anchors/headers with the same title, the first one on the page will win when linked.
==Just==
<nowiki>==Just==</nowiki>
===Like===
<nowiki>===Like===</nowiki>
====This====
<nowiki>====This====</nowiki>


Also, as you may have noticed at the top of most pages, there is a 'contents' menu. All of the headers and sub-headers are listed here for quick access.
== Images ==
<br>
First of all, you need to upload your image. This can be done under [[Special:Upload|Upload file]] in the menu. Don't forget to add a comment. Once uploaded you can use images like <code><nowiki>[[File:Example.png]]</nowiki></code>.
==Page Formatting==
Images can be placed by placing <nowiki>[[File:Example.png]]</nowiki>.
In most cases, just using the return/enter key and headers is good enough for a page. But sometimes, you just want to add some extra ''flare'' '''to''' <strike>your</strike> pages.
===Text===
Some text editing tools are built into the page editor. Some examples are:


{| class="wikitable" | style="text-align: center;"
<pre>[[File:Generic_engineer.png]]</pre>
! This || Gives us this || This || Gives us this 
[[File:Generic_engineer.png]]
|-
|<nowiki>'''bold'''</nowiki> || '''bold''' || <nowiki><small>Small text</small></nowiki> || <small>Small text</small>
|-
|<nowiki>''Italics''</nowiki> || ''Italics'' || <nowiki><big>Big text</big></nowiki> || <big>Big text</big>
|-
|<nowiki><s>striking text</s></nowiki> || <strike>striking text</strike> || <nowiki><u>Underline</u></nowiki> || <u>Underline</u>
|}


===Other Than Text===
When you simply call up an image, it will be in it's full sized format. Resizing the image is not simple anymore. Adding |thumb after the file name forces it to be a thumbnail size. If the image is already smaller than the thumbnail size, then the image will not be re-sized. Also, the image will be placed in a frame (which you can add without making the image a thumbnail by adding <code>|frame</code> instead) and default to the right side of the page. The location of the image can also be changed by adding <code>|left</code> or <code>|center</code>.
<nowiki><br></nowiki> works similar to using the return/enter key, but sometimes works better. Forces the line of text to break off and leave space above it.


{| class="wikitable" | style="text-align: center;"
<pre>[[File:Generic_engineer.png|thumb|left]]</pre>
|-
[[File:Generic_engineer.png|thumb|left]]
! This || Gives us this
|-
|<nowiki>Spacing out <br> your text</nowiki> ||
Spacing out <br> your text
|} <br>


Numbering and bullet points can also be used on a page without having to space it out. They both follow the same format, but use different symbols.
As we can see the text will be flowing around the image.


{| class="wikitable" |
{{Clear}}
|-
Sometimes the thumb is too big or too small. So instead, you can replace <code>|thumb</code> with <code>|30px</code>, where the 30 can be any sized number (assuming you don't want it larger than an average screen). The <code>px</code> stands for pixels, and does not need to be changed. For some reason the wiki seems to have issues shrinking images, so I have no clue how to properly thumbnail other than uploading a separate smaller version of the image.
! This || Gives us this || This || Gives us this
|-
|
<nowiki># Line one </nowiki> <br>
<nowiki># Line two </nowiki> <br>
<nowiki>## Sub </nowiki> <br>
<nowiki>#: Continuing </nowiki> <br>
<nowiki>Stopping </nowiki> <br>
<nowiki># Starting a new line </nowiki> <br>
||
# Line one
# Line two
## Sub
#: Continuing
Stopping
# Starting a new line
||
<nowiki>* Line one </nowiki> <br>
<nowiki>* Line two </nowiki> <br>
<nowiki>** Sub </nowiki> <br>
<nowiki>*: Continuing </nowiki> <br>
<nowiki>Stopping </nowiki> <br>
<nowiki>* Starting a new line </nowiki> <br>
||
* Line one
* Line two
** Sub
*: Continuing
Stopping
* Starting a new line
|}
<br>
==Templates==
Templates are exactly what they sound like; They are a predefined format for easy use. Similar to the [[Template:Anchor|anchor]] template listed [[Wikicode#Page_Links|earlier]], templates are their own separate pages that are designed to only require variable data to be inserted. Most, if not all templates should have a detailed description of how to use it on its page.
The currently used templates can be found [[Special:MostLinkedTemplates|here]], and the currently unused templates can be found [[Special:UnusedTemplates|here]]. Note, just because a template is unused, doesn't mean it is useless. If you can find a use for one, use it!
To use any template, you need to reference the name of it's page within double brackets {{}}, then define the variables. A good example of a useful template is the <nowiki>{{Item}}</nowiki> template. The <nowiki>{{Item}}</nowiki> template actually uses multiple templates within itself, but I won't go into much detail about that. When you want to use the <nowiki>{{Item}}</nowiki> template, paste the code from the page like so:


<div class="toccolours mw-collapsible mw-collapsed"><pre>
When any image is placed on a page, clicking the picture will take you to another page. The default setting takes you to the images page, where you can view the upload history of that specific image. By adding a <code>|link=www.example.com</code> or <code>|link=Engineering</code>, you can make the image link to another internal or external page. Also, adding text such as <code>|text goes here</code> adds a small pop-up dialog that shows the defined text.
{{Item
|name=Test Item
|bgcolor1 = #FFEE88
|bgcolor2 = #FFDD66
|image = Redtoolbox.png
}} </pre></div>
Then your template (in this case, our item box) shows on the page like so:
{{Item
|name=Test Item
|bgcolor1 = #FFEE88
|bgcolor2 = #FFDD66
|image = Redtoolbox.png
}} <br>


Basically, all this template did was define the '''Name''', '''Background Color 1''' (bgcolor1), '''Background Color 2'''(bgcolor2), and the '''Image'''. The name is simply text defined by the user, and the backgrounds are colors that you pick. You can also replace the #FFEE88 with the actual name of the color like orange, red, blue, and so on. The image variable calls out the picture file on the wiki (so first you have to upload it). Capitalization and the file extension are important for this! Otherwise the code will think you want a different file. Normally when you try to use a image or similar file with wikicode, you need to define it as a file first. Depending on how the template is built, it can put the "File:" in for you, so all you have to type is the name of the file itself.
<pre>[[File:locker.png|link=Storage_items#Lockers|This is a locker]]</pre>
[[File:locker.png|link=Storage_items#Lockers|This is a locker]]


==Tables==
== Tables ==
Tables are a little tricky to cover in depth without taking up a ton of space. So for more detailed information, check out Wikipedia's table page <s>[http://en.wikipedia.org/wiki/Table_%28furniture%29 here].</s> [http://en.wikipedia.org/wiki/Help:Table Here].
Tables are a little tricky to cover in depth without taking up a ton of space. So for more detailed information, check out Wikipedia's table page <s>[http://en.wikipedia.org/wiki/Table_%28furniture%29 here].</s> [http://en.wikipedia.org/wiki/Help:Table Here].
<br>
<br>
Tables are similar to templates, mostly just because they are a type of coding that define stuff. Most templates end up using a table of some sort to make it look pretty anyways. An extremely simple table works like so:
Tables are similar to templates, mostly just because they are a type of coding that define stuff. Most templates end up using a table of some sort to make it look pretty anyways. An extremely simple table works like so:


<div class="toccolours mw-collapsible mw-collapsed"><pre>{| class="wikitable"  
{{Spoiler
|content=<pre>{| class="wikitable"  
|-
|-
! One || Two
! One || Two
|-
|-
| Three || Four
| Three || Four
|}</pre></div>
|}</pre>
 
}}
Gives us
 
{| class="wikitable"  
{| class="wikitable"  
|-
|-
Line 181: Line 165:
| Three || Four
| Three || Four
|}
|}
Each part of the code defines where it belongs and what it does. The '''{|''' and '''|}''' are the opening and closing brackets of our table, they indicate the start and the end. The '''class="wikitable"''' defines the style of the table borders. Instead, you could replace the class with '''border=''' and define the size and style of the border. The '''|-''' indicates the end of a row, and adding a new line after it will make an extra row beneath it. The '''!''' defines the row to be a title of sorts, which also defaults the text to be centered in the box. In the case of the '''class="wikitable"''', it makes the row a different color. The '''||''' marks the end of the box, and any data past it will be in the next box over.
Each part of the code defines where it belongs and what it does. The '''{|''' and '''|}''' are the opening and closing brackets of our table, they indicate the start and the end. The '''class="wikitable"''' defines the style of the table borders. Instead, you could replace the class with '''border=''' and define the size and style of the border. The '''|-''' indicates the end of a row, and adding a new line after it will make an extra row beneath it. The '''!''' defines the row to be a title of sorts, which also defaults the text to be centered in the box. In the case of the '''class="wikitable"''', it makes the row a different color. The '''||''' marks the end of the box, and any data past it will be in the next box over.
To add more to a table, simple add a column with '''||''', or add a new row by making a new line and adding '''|-''' then another line and '''|'''.
To add more to a table, simple add a column with '''||''', or add a new row by making a new line and adding '''|-''' then another line and '''|'''.
<div class="toccolours mw-collapsible mw-collapsed"><pre>
 
=== Bigger table ===
{{Spoiler
|content=<pre>
{| class="wikitable"  
{| class="wikitable"  
|-
|-
Line 191: Line 179:
|-
|-
| One || More || Time
| One || More || Time
|}</pre></div>
|}</pre>
 
}}
{| class="wikitable"  
{| class="wikitable"  
|-
|-
Line 201: Line 189:
| One || More || Time
| One || More || Time
|}
|}
<div class="toccolours mw-collapsible mw-collapsed"><pre>
 
=== Colored table ===
{{Spoiler
|content=<pre>
{| class="wikitable" || style="text-align: center;"
{| class="wikitable" || style="text-align: center;"
|-
|-
Line 211: Line 202:
|-
|-
|style="background: blue; color: white" | Three || 3 || 6 || 9
|style="background: blue; color: white" | Three || 3 || 6 || 9
|}</pre></div>
|}</pre>
 
}}
{| class="wikitable" | style="text-align: center;"
{| class="wikitable" | style="text-align: center;"
|-
|-
Line 224: Line 215:
|}
|}


And a sortable table:
=== Sortable table ===
<div class="toccolours mw-collapsible mw-collapsed"><pre>
{{Spoiler
|content=<pre>
{| class="wikitable sortable" border="1"
{| class="wikitable sortable" border="1"
|-
|-
Line 246: Line 238:
| 3 || 6 || 9 || 1
| 3 || 6 || 9 || 1
|-
|-
|}</pre></div>
|}</pre>
 
}}
{| class="wikitable sortable" border="1"
{| class="wikitable sortable" border="1"
|-
|-
Line 270: Line 262:
|}
|}


==Images==
== Hiding/collapsing content ==
Unless you put an external link to an image on a image hosting site, you will be using images uploaded to the wiki. Mostly GIF and PNG formats are preferred. The best way to get an image from the game is to download the [https://github.com/NTStation/NTStation13 Source Code], and export the image. Images can be placed by placing <nowiki>[[File:Example.png]]</nowiki>. An example:
Sometimes there are huge walls of texts and big images that would stop the reading flow, or we want to hide some spoilers. This can be done by applying the <code>mw-collapsible</code>-class. If the item should start collapsed add the "mw-collapsed" as well.
{| class="wikitable" | style="text-align: center;"
 
=== Table-example ===
<pre>{| class="mw-collapsible mw-collapsed wikitable"
! The header || remains visible
|-
|-
! This || Gives us this
| This content || is hidden
|-
|-
| <nowiki>[[File:Generic_engineer.png]]</nowiki> || [[File:Generic_engineer.png]]
| at first || load time
|}
|}</pre>
When you simply call up an image, it will be in it's full sized format. Resizing the image is not simple anymore. Adding |thumb after the file name forces it to be a thumbnail size. If the image is already smaller than the thumbnail size, then the image will not be re-sized. Also, the image will be placed in a frame (which you can add without making the image a thumbnail by adding |frame instead) and default to the right side of the page. The location of the image can also be changed by adding |left or |center.
{| class="mw-collapsible mw-collapsed wikitable"
{| class="wikitable" | style="text-align: center;"
! The header || remains visible
|-
| This content || is hidden
|-
|-
! This || Gives us this
| at first || load time
|-
| <nowiki>[[File:Generic_engineer.png|thumb|left]]</nowiki> || [[File:Generic_engineer.png|thumb|left]]
|}
|}
<br>
Sometimes the thumb is too big or too small. So instead, you can replace |thumb with '''|30px''', where the 30 can be any sized number (assuming you don't want it larger than an average screen). The '''px''' stands for pixels, and does not need to be changed. For some reason the wiki seems to have issues shrinking images, so I have no clue how to properly thumbnail other than uploading a separate smaller version of the image.


<br>
=== Textbox example ===
When any image is placed on a page, clicking the picture will take you to another page. The default setting takes you to the images page, where you can view the upload history of that specific image. By adding a '''|link=www.example.com''' or '''|link=Engineering''', you can make the image link to another internal or external page. Also, adding text such as '''|text goes here''' adds a small pop-up dialog that shows the defined text.
<pre><div class="toccolours mw-collapsible" style="width:400px">
{| class="wikitable" | style="text-align: center;"
This text is collapsible.
|-
</div></pre>
! This || Gives us this
<div class="toccolours mw-collapsible" style="width:400px">
|-
This text is collapsible.
| <nowiki>[[File:locker.png|link=Storage_items#Lockers|This is a locker]]</nowiki> || [[File:locker.png|link=Storage_items#Lockers|This is a locker]]
</div>
|}<br>
 
=== Using the Spoiler-Template ===
<pre>{{Spoiler
|title=Something, Something, Something...
|content=...Dark Side
}}</pre>
{{Spoiler
|title=Something, Something, Something...
|content=...Dark Side
}}
 
== Redirects ==
To create a redirect for a page, just like [[Drinks]] redirects to [[Guide to Drinks]], insert this command in the first line:
<pre>#REDIRECT [[page_to_redirect_to]]</pre>
You don't need to remove the rest of the article for this to work. Be careful about redirect-targets, because the user won't slide through multiple cascaded redirects.
 
== Templates ==
Templates are exactly what they sound like; They are a predefined format for easy use. Similar to the [[Template:Anchor|anchor]] template listed [[#Linking and Anchors|earlier]], templates are their own separate pages that are designed to only require variable data to be inserted. Most, if not all templates should have a detailed description of how to use it on its page.
<!-- The currently used templates can be found [[Special:MostLinkedTemplates|here]], and the currently unused templates can be found [[Special:UnusedTemplates|here]]. Note, just because a template is unused, doesn't mean it is useless. If you can find a use for one, use it!-->
 
To use any template, you need to reference the name of it's page within double brackets <code>{{}}</code>, then define the variables. A good example of a useful template is the <nowiki>{{Item}}</nowiki> template. The [[Template:Item|<nowiki>{{Item}}</nowiki> template]] actually uses multiple templates within itself, but I won't go into much detail about that. When you want to use the [[Template:Item|<nowiki>{{Item}}</nowiki> template]], paste the code from the page like so:
 
{{Spoiler
|title=Compact version
|content=<pre>{{Item|name=Test Item|bgcolor1=#FFEE88|bgcolor2=#FFDD66|image=Redtoolbox.png}}</pre>
}}
{{Spoiler
|title=Expanded version
|content=<pre>{{Item
|name=Test Item
|bgcolor1=#FFEE88
|bgcolor2=#FFDD66
|image=Redtoolbox.png
}}</pre>
}}
Then your template (in this case, our item box) shows on the page like so:
{{Item
|name=Test Item
|bgcolor1=#FFEE88
|bgcolor2=#FFDD66
|image=Redtoolbox.png
}}


== Hiding/collapsing content ==
Basically, all this template did was define the '''Name''', '''Background Color 1''' (bgcolor1), '''Background Color 2'''(bgcolor2), and the '''Image'''. The name is simply text defined by the user, and the backgrounds are colors that you pick. You can also replace the #FFEE88 with the actual name of the color like orange, red, blue, and so on. The image variable calls out the picture file on the wiki (so first you have to upload it). Capitalization and the file extension are important for this! Otherwise the code will think you want a different file. Normally when you try to use a image or similar file with wikicode, you need to define it as a file first. Depending on how the template is built, it can put the "File:" in for you, so all you have to type is the name of the file itself.
Add "mw-collapsed" to the class to have it start collapsed. See examples 1 and 3.


=== Example 1: Table ===
Oneliners vs multirow
namend / positional arguments
Recursion?


<nowiki>{| class="mw-collapsible mw-collapsed wikitable"</nowiki><br>
= Yogstation specific =
<nowiki>! The header || remains visible</nowiki><br>
There are a few templates and neat things to make your life easier. Because this guide will never be able to cover all templates in full detail, use these steps to learn more yourself:
<nowiki>|-</nowiki><br>
# Find a template you like. This can be done while looking at the sourcecode or browsing [[:Category:Templates]]
<nowiki>| This  content || is hidden</nowiki><br>
# Visit the page of the template by typing <code>Template:</code> in front of it like [[Template:Vendingmachine]]
<nowiki>|-</nowiki><br>
# If the creator did his job well, you should see a short article about what the template is used for, which parameters it uses and some examples. If this is not enough, read the sourcecode and look for code that is not inside <code><nowiki><noinclude></nowiki></code>-tags
<nowiki>| at first || load time</nowiki><br>
Hopefully, you understand how important proper documentation is for everyone. Try to remember this when making templates yourself.
<nowiki>|}</nowiki>


{| class="mw-collapsible mw-collapsed wikitable"
== List of templates ==
! The header || remains visible
=== General ===
A list of the most important templates.
{| class="wikitable"
!Template
!Notes
|-
![[Template:Anchor]]
| Adding anchors for specific linking
|-
![[Template:Click]]
|Making clickable images
|-
![[Template:Clear]]
|Properly starting on a line when images are on the left or right.
|-
![[Template:Important]]
|
|-
![[Template:Collapsible]]
|Hide things with style
|-
![[Template:Spoiler]]
|Very similar to [[Template:Collapsible]]. Width can be set.
|-
![[Template:Tooltip]]
|
|-
![[Template:Depticon]]
|Icons for departments
|-
![[Template:ChemBottle]]
|
|-
|-
| This  content || is hidden
![[Template:Item]]
|
|-
|-
| at first || load time
![[Template:Locker]]
|
|}
|}


=== Example 2: Text ===
=== Article-specific ===
{| class="wikitable"
!Template
!Notes
|-
![[Template:LocationSmall]]
|Compact infobox for locations
|-
![[Template:Location]]
|Full infobox for locations
|-
![[Template:Plant]]
|Infobox for plants
|-
![[Template:CCol]]
|
|-
![[Template:Speech]]
| Person with speechbubble, useful for creating immersive intros
|-
![[Template:Song]]
|
|-
![[Template:TechWeb]]
|
|-
![[Template:Uplink]]
|
|-
![[Template:UplinkStorage]]
|
|}


<nowiki><div class="toccolours mw-collapsible" style="width:400px"></nowiki><br>
== Creating templates ==
<nowiki> This text is collapsible. {{Lorem}}</nowiki><br>
Go ahead and use this template:
<nowiki></div></nowiki><br>
<pre><nowiki><includeonly>I, for one, welcome our new {{{overlord|Nanotrasen}}} overlords</includeonly><noinclude>
== About ==
Short details of XXXXXXXXXXXXXXX, intended use in XXXXXXXXXXXXXXXXXXXXX.


<div class="toccolours mw-collapsible" style="width:400px">
== Parameter-Usage ==
This text is collapsible.
{| class="wikitable"  
</div>
!Parameter
<br>
!Default
=== <span class="mw-customtoggle-0" style="font-size:small; display:inline-block; float:right;"><span class="mw-customtoggletext">[Show/hide]</span></span> Example 3: Section ===
!Description
<div  id="mw-customcollapsible-0" class="mw-collapsible mw-collapsed">
|-
Text
!
|
|
|}


Text
== Examples ==
 
=== Bare ===
</div>
&lt;pre&gt;{{MyTemplate}}&lt;/pre&gt;
{{MyTemplate}}


=== Normal ===
&lt;pre&gt;&lt;/pre&gt;


<nowiki>== <span class="mw-customtoggle-0" style="font-size:small; display:inline-block; float:right;"><span class="mw-customtoggletext">[Show/hide]</span></span> Example 3: Section ==</nowiki><br>
[[Category:Templates]]
<nowiki><div  id="mw-customcollapsible-0" class="mw-collapsible mw-collapsed"></nowiki><br>
</noinclude></nowiki></pre>
<nowiki>Text</nowiki><br>
* Code
<nowiki>Text</nowiki><br>
** Your actual templatecode is in the <code>includeonly</code>- and your comments in the <code>noinclude</code>-tags. This way we don't insert our documentation every time we use the template.
<nowiki></div></nowiki><br>
** <code><nowiki>{{{1}}}</nowiki></code> will insert the value of the first positional parameter. Positional parameters are those without a name - <code><nowiki>{{{1}}}</nowiki></code> for <code><nowiki>{{MyTemplate|Hello}}</nowiki></code> would be ''Hello''
** <code><nowiki>{{{uwu}}}</nowiki></code> will insert the value of the named parameter '''uwu'''. Will insert the text <code><nowiki>{{{uwu}}}</nowiki></code> if the uwu-parameter is missing
** <code><nowiki>{{{uwu|What is this}}}</nowiki></code> will insert the value of the named parameter '''uwu'''. If the uwu-parameter is missing it will insert ''"What is this"''
** <code><nowiki>{{#if: {{{uwu|}}} | {{{uwu}}} | Nope}}</nowiki></code> will insert the value of the named parameter '''uwu''' if it is existing and non-empty. Otherwise it will insert ''"Nope"''.
** You can nest if-clauses inside each other, though there is a limit of about 6 or 7 levels. And yes, it gets ugly really fast
** Linebreaks in the code will be displayed when included. Use <code>noinclude</code>-tags to kill any unwanted whitespace. Using html comments <code><nowiki><!-- ... --></nowiki></code> works, but will fill the page source with garbage so it is rather ugly.
* Documentation
** '''About:''' Purpose and intended use of the template. It is a good practice to link an article that uses the template for real life examples.
** '''Parameter-Usage:''' List of all named and positional parameters. If there is no default value, an example value in the description can help the reader.
** '''Examples:''' A selected set of examples to cover the most important use cases. Adding examples for missing / empty parameters can help identifying errors as well as giving the reader an impression of the default behaviour.


[[Category:Guides]]
[[Category:Guides]] [[Category:Game Resources]]
{{Contribution guides}}
{{Contribution guides}}
Helpful Herbert
1,133

edits

Retrieved from "https://wiki.yogstation.net/wiki/Special:MobileDiff/31940"

Navigation menu