Wikicode: Difference between revisions

This article doesn't cover wikicode in depth, for additional information refer to:

When in doubt, check the sourcecode of an article or ask on [{{Constant/Discordurl}} #wiki-public]

=Commands=

==Basic commands==

or just use<br>manual breaks</pre>

|Leave empty lines

or just use<br>manual breaks

|-

!Link (External)

|<pre><nowiki>http://en.wikipedia.org/wiki/Help:Wiki_markup</nowiki></pre>

|-

!Link (External, custom text)

|<pre><nowiki>[http://en.wikipedia.org/wiki/Help:Wiki_markup click me]</nowiki></pre>

|-

!List (Unordered)

#Roll

|}

==Linking and Anchors==

<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]].

'''Beware''': If there are multiple anchors/headers with the same title, the first one on the page will win when linked.

==Images==

Images can be placed by placing <nowiki>[[File:Example.png]]</nowiki>.

<pre>[[File:Generic_engineer.png]]</pre>

[[File:Generic_engineer.png]]

<pre>[[File:Generic_engineer.png|thumb|left]]</pre>

[[File:Generic_engineer.png|thumb|left]]

As we can see the text will be flowing around the image.

{{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.

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.

<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==

<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:

{{Spoiler

|content=<pre>{| class="wikitable"  

|}</pre>

}}

|-

!One||Two

|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.

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 '''|'''.

===Bigger table===

{{Spoiler

|}</pre>

}}

|-

!One||Two||Five

|One||More||Time

|}

===Colored table===

{{Spoiler

| style="background: blue; color: white" |Three||3||6||9

|}

===Sortable table===

{{Spoiler

|-

|}

==Hiding/collapsing content==

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.

===Table-example===

<pre>{| class="mw-collapsible mw-collapsed wikitable"

|at first||load time

|}

===Textbox example===

<pre><div class="toccolours mw-collapsible" style="width:400px">

This text is collapsible.

</div>

===Using the Spoiler-Template===

<pre>{{Spoiler

|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.

To use any template, you need to reference the name of it's page within double brackets <code><nowiki>{{}}</nowiki></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

|image=Redtoolbox.png

}}

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.

namend / positional arguments

Recursion?

=Yogstation specific=

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:

#Find a template you like. This can be done while looking at the sourcecode or browsing [[:Category:Templates]]

#Visit the page of the template by typing <code>Template:</code> in front of it like [[Template:Vendingmachine]]

#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

Hopefully, you understand how important proper documentation is for everyone. Try to remember this when making templates yourself.

==List of templates==

===General===

A list of the most important templates.

!Template

!Notes

|

|}

===Article-specific===

!Template

!Notes

|

|}

===Special===

[[Template:RecursiveChem/General]] is not ''a'' template, it is legion for it is many. It is the template behind recursive hover-recipes found in articles like [[Guide to Drinks]] and [[Guide to Chemistry]]. Make sure to use it, for it really makes reading the wiki more enjoyable. Exmaples:

*[[Template:RecursiveChem/Butter]]

*[[Template:RecursiveChem/Methamphetamine]]

*[[Template:RecursiveChem/Pentetic_Acid]]

See here for a '''[https://wiki.yogstation.net/index.php?title=Special%3APrefixIndex&prefix=RecursiveChem%2F&namespace=10 full list]'''

==Creating templates==

Go ahead and use this template:

[[Category:Templates]]

</noinclude></nowiki></pre>

*Code

**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.

**'''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:Game Resources]]

{{Contribution guides}}