Changes

Jump to navigation Jump to search

Wurmpedia editing handbook

10,757 bytes added, 16:45, 1 July 2022
m
==Guidelines==
The Wurmpedia is a resource used by new and experienced players alike. It is typically the first place a new player will turn when they want to understand something. As such, we want the Wurmpedia to be as organized, accurate, and user-friendly as possible. These are some guidelines in place to help us all keep the Wurmpedia to a high standard. Always abide by Wurm game rules while editing the wiki. ==General Wurmpedia Etiquette==* As the Wurmpedia team works as a team, we want to run any large changes past other editors and WAs before taking any steps. Trying to look at similar pages before you correct any formatting.  * Stay in touch with the rest of the Wurmpedia team via the Discord or IRC.  * If you see wrong information, you can correct it yourself, but you may want to bring it up on Discord if it seems like a larger issue. Please don't assume that incorrect wiki information is brought on by malice. Don't engage in edit wars. Reverts are not (and shouldn't be) personal.  * Please don’t edit anyone’s personal page, except your own. Exception: you may remove dead (red) links.  * Let's be respectful of other WAs and editors and all staff. We all contribute!  * Feel free to bring up issues with the Wurmpedia to the management or direct other players to management for issues you can't resolve with wiki information.  * Please report any vandalism to the wiki, but also fix it! * As of right now, the only language we are translating the Wurmpedia into is Russian. If you’d like to work on another language project (or that one!) please message the Manager or the team in general.
==Stylistic Guide==
* Please use [[wikipedia:list of common misspellings | correct spelling]] and do not use slang, [[wikipedia:texting language | 'txtspk']] or [[wikipedia:leet speak | 'leet speak']]. Example: 'You need to', not 'U need 2'.
* Spelling in Wurm is a strange and diverse mix of UK and US spelling. However, the Wurmpedia must conform to the game, not what we feel is the “right way”. So armour, but favorand liter. Check in game for other spellings.**Feel free to post a bug report for mistakes found in spelling or grammar in game.
* If you aren't a spelling and grammar pro, use a spell checker. ([http://www.iespell.com/ IE] [http://www.svarteper.com/ff/aspellfox/ FF] [http://aspell.net/ Opera]).
* Excluding proper nouns, words in page titles should '''not''' be capitalized. Use "Small metal shield" or "small metal shield"<sup>[1]</sup>, and not "Small Metal Shield". Also, don't capitalize nouns in the middle of sentences, unless they're proper nouns.
**If you use a capitalized proper noun in a page title, you must also make a redirect page with only the first word capitalized (or add it to the daily edit Discord channel and a WA will do so.)
* Don't use underscores in links - you don't need them! Example: <nowiki>[[</nowiki><font style="background:#E6FFE6;">item creation</font><nowiki>]]</nowiki> is equivalent to <nowiki>[[</nowiki><font style="background:#E6FFE6;">item_creation</font><nowiki>]]</nowiki>, and looks twice as neat.
* Use wikitext instead of HTML when possible. Example: * lists instead of &lt;br&gt; lists
* Try to limit use of colored text for colorblind accessibility.
* Add descriptions to new pictures. (If you need help on this, just ask!)
* Use the [[Special:Categories|categories]] and [[:Category:Template|templates]] when appropriate. Look at a similar page and see what it uses for hints.
* Use <nowiki>[[links]]</nowiki> when referring to other pages (refrain from linking the same page multiple times in the same article.)
* Much of our crafting information has been moved into the Itembox template, including dye information. Please don't add crafting instructions to the main wiki article, unless you check in with other WAs/staff. If you need help with the itembox, ask in Discord. * Don't add specific skill gains at each skill level with a specific tool. This would be better for a guide. Please make guides!**You may add specific gated skill levels to make an item, such as 60 carpentry required to make a large crate. * Don't use dates for updates or links to posts.* Don't use information taken from WU or speculation.* We no longer add food recipes to the wiki, including links. * Avoid personal bias when editing, including personal feelings on hardware. When in doubt, take it to the talk page.
* Do not post suggestions. They belong in the forums or on IRC - not here.
* If you need to add a picture, a WA can upload it for you. Don't use a link to an outside website.
* Everything on the Wurmpedia is a work in progress, including this handbook.
 
=== Breadcrumbs ===
For items with only one possible size (same weight, no combine), note the number of items needed with the suffix 'x', e.g. "15x [[stone brick]]". If the item can be reduced in weight (e.g. [[shaft]]), also include the minimum weight possible for use. For other items specify the total weight needed and avoid listing the "normal" number of items used.
For the English portion of the wiki, please Please use a decimal point (period) when referring to fractional numbers. Always specify weights with two decimal places. This avoids ambiguity between "item has integer weight" and "didn't bother to check exact weight".
===Itembox===
We have moved much of the information on crafting into the itemboxtemplate, including dye information. Please don’t add crafting instructions to the main article. If you need assistance with the template, ask in the Discord.
==Namespaces==
* Appearance: Here you can change the wiki skin (I hate all the other ones!), change the way dates and times are displayed, as well as your time zone, among some other things.
* Editing: The editing preferences contain many highly useful and awesome features that you can enable to help with your editing. You can Enable section editing by right clicking on section title, Edit pages on double click, Mark all edits minor by default, warn me when I leave an edit page with unsaved changes, side-by-side preview (shown below), and more.
 
[[File:Handbook2.png|border|]]
 
===Recent Changes, Watchlist, Search===
* Recent changes: You can view the recent changes, which shows articles and files recently edited, in the Recent changes page (linked on the sidebar, as shown below). In your preferences, you can change how this page will display by default, including how many days to show, number of edits to show, you can group changes by page, hide minor edits, hide patrolled edits, and more.
 
[[File:Handbook3.png|border|]]
==Special Pages==
There are some special pages on the Wurmpedia which collect articles based on some criteria. These special pages can be useful for finding articles that are out of date, have incorrect links, are missing images, and more. These pages are found [[Special pages:SpecialPages|here]].
It is a good idea to check through some of these pages, especially if you are looking for something to edit but are having trouble figuring out what to do.
The right column includes your edits. Text is highlighted where you have made changes.
===Basic Wiki Markup===
The Wurmpedia uses wiki markup, a type of coding language used to format text and images in a custom way. You can do anything from making text bold and italic, to making text appear only if certain conditions are met (for example, if the item is made of wood, display text indicating the types of wood that item can be made from). For this introductory course, you will be introduced to formatting text in bold and italics, creating headers, and linking to other articles or webpages. These are the most common markup codes you will use in editing.
|-
|Link to the Wurm Online forums that says forums||<nowiki>Link to the [https://forum.wurmonline.com forums]</nowiki>||Link to the [https://forum.wurmonline.com forums]
|-
|Redirect || <nowiki> #redirect [[Target page]] </nowiki>|| #redirect [[Target page]]
|-
|Bulleted lists || <nowiki> *one *two **subtopic to two </nowiki> ||
*one
*two
**subtopic to two
|}
 ===Previewing Your Changes===
[[File:Handbook8.png|border|]]
Showing the preview before saving a page is a great habit to get into.
===Using Images===
To include a file in a page, use a link in one of the following forms:
<nowiki>[[File:File.jpg]]</nowiki> to use the full version of the file
Click the red link to be taken to the not yet created article, where you can begin editing.
===Article Content===
When creating a page, it can be helpful to find a similar page to kind of copy from. You don't always, and will rarely, need to create an article totally from scratch. In our Purple unicorn example, we may find useful information on the Unicorn page. If most information is the same, you could find it easier to go into the Unicorn article's Edit page, copy everything, paste it into your new article, then modify it to match the info you have about the Purple unicorn. (Note: I regret to tell you, but I don't think purple unicorns are in the works for Wurm Online at this time. I'm sorry!!!)
If you do choose to do this when making an article, make sure that every reference to the current page (aside from <nowiki>{{PAGENAME}}</nowiki>, which will give the name of whichever page it is currently on) is changed to that of your current article. Also be sure to check the categories, as some may be in categories that are not relevant to the new article.
===Redirects=== A redirect is a way to forward from one page to another, by placing #redirect <nowiki>[[New page]]</nowiki> in the body of a page, where New page is the proper page name that the user should be redirected to. Please use redirects sparingly as they can become confusing. You may use a redirect in the following situations: To forward from a page with different letter case than the main page, but has the same exact spelling.Example: Settlement:Tap_dance may redirect to Settlement:Tap_Dance.To forward between a User and a Player page owned by the same person.Example: User:Keenan redirects to Player:Keenan. Don't make double redirects. If there are multiple redirects to one page, because of spelling or condensed pages, have them all go to the end result page.  ===Headers===
One useful thing that you'll find on most Wurmpedia articles is a header of links which shows what categories the item is a part of.
<nowiki>[[CDB|Main]] / [[:Category:Bestiary|Bestiary]] / '''{{PAGENAME}}'''</nowiki>
===Linking Articles to Categories===
[[File:Handbook16.png|border|]]
'''Fun Fact''': You can create a clickable link to get to that category page by adding a colon to the beginning. To link to the Blacksmithing items category, you would add <nowiki>[[:Category:Blacksmithing items]]</nowiki>.
====Babel categories====
[[File:Handbook21.png|border|]]
===Creating a Template===
'''====Step 1: Choose a name for your template and go to create the page.'''====
[[File:Handbook12.png|border|]]
'''====Step 2: Content'''====
We want the template to tell pages "This is a <colour> unicorn". For the basic text, you can just add it within the tags.
[[File:Handbook22.png|border|]]
'''====Step 3: Include and noinclude'''====
Any content written directly into the template will show on both the template’s page as well as any pages using the template.
[[File:Handbook24.png|border|]]
===“If” Statements===
====What is an if statement ?!====
For those who are not familiar with coding, an if statement is something that is used to do a certain thing if the statement is true, and something else if it is false. For example:
If this was your code, it would result in Say yes.
====How do I make an if statement?====
In templates, we sometimes want to add an if statement so that we can make the template work in many different articles. For example, in the Fence template, here is a sample of an if statement:
<pre>{{#if:{{{gate|}}}|[[Iron fence gate]]|[[Iron fence]]}}</pre>
'''Tip:''' You can place if statements within if statements for more complex scenarios. For example, maybe you want an if statement that does something like this:
[picture of if tree I guess]
But let's not get ahead of ourselves. Getting started with if statements is enough on your plate!
====If a variable = something specific:====
The next if statement we should talk about is the '''#ifeq''' statement. This is used when you want to ask if something matches something else. In our case, we will just about always use it to ask if an inputted variable is something specific. For example, you may have "material" as a variable in your template, where a user would put what material it is made of. Let's say you want the page to display that a pottery bowl is used in cooking if the material given is "clay", and otherwise display "Cannot be used in cooking."
===Table Construction Markup===
Let's start with the markup. The following table is taken from mediawiki.org.<pre> {| table start, required
<nowiki>{| table start, required|+ table caption, optional; only between table start and table row |- table row, optional on first row—wiki engine assumes the first row ! table header cell, optional. Consecutive table header cells may be added on same line separated by double marks (!!) or start on new lines, each with its own single mark (!). | table data cell, optional. Consecutive table data cells may be added on same line separated by double marks (||) or start on new lines, each with its own single mark (|). |} table end, required</nowikipre>
Unfortunately, each of these codes do have to go on a new line, which can make your article look really complicated, especially if you create bigger tables. Using these codes get gets you the layout of a table without any borders, backgrounds, or anything - just text.
[[File:Handbook26.png|border|]] [[File:Handbook27.png|border|]]
This *could* be useful in some cases, but generally when making a table, you'll probably want it to look like a table and not just a bunch of floating words. For example, on the Animals article, there is a giant table that looks like this:
[[File:Handbook28.png|border|]]
To make your table look like a table, you need to tell it that you'd like there to be a border, for example. We'll take a look at some different formatting options available for tables now.
To align the table to the right, you'll add
<pre>style="margin-left:auto;"</pre>
to your table start line, which is
<pre> {|</pre>
[[File{|style="border-style:Handbook29.png]]solid; margin-left:auto;" border="1" !Column 1 !Column 2 !Column 3 |- |Row 1||Row 1||Row 1 |- |Row 2||Row 2||Row 2 |}
Below is the code to create this table:
To align the table to the center, you'll add
<pre>style="margin:auto;" </pre>
to your table start line.
[[File{|style="border-style:Handbook30.png]]solid; margin:auto;" border="1" !Column 1 !Column 2 !Column 3 |- |Row 1||Row 1||Row 1 |- |Row 2||Row 2||Row 2 |}
Finally, you can float the table alongside the article text by adding the following to your table start line:
</pre>
[[File:Handbook31.png|border|]]
===Text Alignment===
Text alignment in cells can be left, right, or center-aligned, as well as vertically aligned to the top, middle, or bottom.
====Horizontal Alignment====
To align to the left, right or center, use
 
<pre>
style="text-align:center;"
</pre>
This code can be used in the table start, row start, or cell start levels.
If placed at the table start level, it will align all text within the table the way specified. [[File:Handbook32.png]] <pre>{|border=1 style="text-align:center; width: 60%; height: 60%;"</pre>|-If placed at the row start level, it will only align the text within that row's cells the way specified.|Row 1||Row 1||Row 1|-[[File:Handbook33.png]]|Row 2||Row 2||Row 2<pre>|-style="text-align:center;"</pre>|Row 3||Row 3||Row 3If placed at the cell level, it will only align that individual cell the way specified. [[File:Handbook34.png]] <pre>|-style="text-align:center;"</pre>|Row 4||Row 4||Row 4Note: When adding styling code such as this to the cell level, you need to add a vertical bar after your code, dividing it from the text your cell contains. For example, the second row in this code looks like this:|}
<pre>
{|Row 2||border=1 style="text-align:center; width: 60%; height: 60%;"|-|Row 1||Row 1||Row 1|-|Row 2||Row 2||Row 2|-|Row 3||Row 3||Row 3|-|Row 4||Row 4||Row 4|}
</pre>
 ====Vertical Alignment====
Vertical alignment can be set to top, middle, or bottom with, at cell or row level.
style="vertical-align:bottom;"
</pre>
 
{| class="wikitable"
|- style="vertical-align:top;"
| style="height:100px; width:100px; text-align:left;" | A
| style="height:100px; width:100px; text-align:center;" | B
| style="height:100px; width:100px; text-align:right;" | C
|- style="vertical-align:middle;"
| style="height:100px; width:100px; text-align:left;" | D
| style="height:100px; width:100px; text-align:center;" | E
| style="height:100px; width:100px; text-align:right;" | F
|- style="vertical-align:bottom;"
| style="height:100px; width:100px; text-align:left;" | G
| style="height:100px; width:100px; text-align:center;" | H
| style="height:100px; width:100px; text-align:right;" | I
|}
The first row is vertically aligned to the top, the second to the middle, and the third to the bottom. In this example, the code is applied to the whole row.
<pre>
{| class="wikitable"
|- style="vertical-align:top;"
| style="height:100px; width:100px; text-align:right;" | I
|}
</pre>
You can use the code at the cell level as well, which will modify the individual cell.
{| border="1" style="width:300px; height:200px;"
|-
|style="vertical-align:top;"|Row 1||style="vertical-align:bottom;"|Row 1||style="vertical-align:top;"|Row 1
|-
|Row 2||Row 2||Row 2
|}
<pre>
{| border="1" style="width:300px; height:200px;"
|-
|Row 2||Row 2||Row 2
|}
</pre>
Note: When adding styling code such as this to the cell level, you need to add a vertical bar after your code, dividing it from the text your cell contains.
 
<pre>
style="vertical-align:top;"|Row 1||
</pre>
 
===Cell, Row, and Table Sizing===
 
You can set the size of the table, rows, and cells to a width and height in pixels or percentages of the screen. Percentages are recommended as they will ensure a similar view for any screen size.
 
To set the width or height, these are the codes you will use - they are used at the table start or individual cell levels:
<pre>
style="width:50%;"
style="height:50px;"
</pre>
 
'''Width:''' Used on the table start level, this will adjust the total size the table will take up, in height or as a percentage of the screen/browser window. Used on the individual cell level, it will adjust the amount of space it takes within the table.
 
'''Height:''' Used with a percentage will indicate what percentage of the table it will take up. On the table start level, a percentage cannot be used with the height - use 'px' for pixels instead.
 
====Example 1: Defining a table's width and height====
 
{| border="1" style="width:75%; height:300px;"
|-
|Row 1||Row 1||Row 1
|-
|Row 2||Row 2||Row 2
|}
 
<pre>
{| border="1" style="width:75%; height:300px;"
|-
|Row 1||Row 1||Row 1
|-
|Row 2||Row 2||Row 2
|}
</pre>
 
====Example 2: Defining a row's height====
{| border="1" style="width:75%; height:300px;"
|-style="height:75%;"
|Row 1||Row 1||Row 1
|-
|Row 2||Row 2||Row 2
|}
 
<pre>
{| border="1" style="width:75%; height:300px;"
|-style="height:75%;"
|Row 1||Row 1||Row 1
|-
|Row 2||Row 2||Row 2
|}
</pre>
<hr>
====Row and Column Spans====
 
You can span cells across multiple rows or columns, which is the same as merging cells together in word processing programs.
To span a cell across multiple columns:
 
<pre>
colspan="2"
</pre>
To span a cell across multiple rows:
<pre>
rowspan="2"
</pre>
Each of these is used at the individual cell level. Note that your table will have as many columns as the largest row; this means that if your table has 3 columns per row, and you use a column span on one of your cells, your table will be 4 columns wide.
 
{| border="1"
|-
|colspan="2"|Row 1||Row 1||Row 1
|-
|Row 2||Row 2||Row 2
|}
 
<pre>
{| border="1"
|-
|colspan="2"|Row 1||Row 1||Row 1
|-
|Row 2||Row 2||Row 2
|}
</pre>
 
{| border="1"
|-
|rowspan="2"|Row 1||Row 1||Row 1||Row 1
|-
|Row 2||colspan="2" |Row 2
|-
|}
<pre>
{| border="1"
|-
|rowspan="2"|Row 1||Row 1||Row 1||Row 1
|-
|Row 2||colspan="2" |Row 2
|-
|}
</pre>
 
===Colouring - Tables, Cells, and Text===
 
Sometimes it may be nice to add some colour to the table, at least to make it stand out on the article a bit more.
Since we're in the table business, let's look at the colour codes in a table! Note that colours can be written or specified with the hex value.
 
{| class="wikitable"
|-
| Colour text || style="color:white;"
style="color:#009999;"
|-
| Colour entire table or cells ||style="background-color:white;"
style="background-color:#009999;"
|}
 
{|style="color:white; background-color: #009999; width: 50%;"
|style="background-color: black;"|Column! || Another column || Another one
|- style="background-color:white; color:black;"
|A new row ||this row is coloured differently! || final cell
|}
 
<pre>
{|style="color:white; background-color: #009999; width: 50%;"
|style="background-color: black;"|Column! || Another column || Another one
|- style="background-color:white; color:black;"
|A new row ||this row is coloured differently! || final cell
|}
</pre>
 
Colour codes can be placed at different levels depending on what you are trying to achieve. In the table I have created above, the whole table is coloured a teal colour, while some other cells are coloured differently. This gives the illusion of a coloured border when a border size is not specified.
 
===Table Borders and Spacing===
====Table Borders====
 
By default, tables are made with no borders, as you saw in Tables: Basic Construction.
 
{|
|-
|Row 1||Row 1||Row 1
|-
|Row 2||Row 2||Row 2
|}
 
This doesn't make it look much like a table now, does it?
 
To add a simple border, you can add the following code at the table start level:
<pre>
border="1"
</pre>
 
{| border="1"
|-
|Row 1||Row 1||Row 1
|-
|Row 2||Row 2||Row 2
|}
 
You can change the border width on each side of the table by using the following at the table start level:
<pre>
style="border-width:10px 40px 80px 0px;"
</pre>
 
These define top, right, bottom, and left borders respectively.
 
{| border="1" style="border-width:10px 40px 80px 0px;"
|-
|Row 1||Row 1||Row 1
|-
|Row 2||Row 2||Row 2
|}
 
If you wish to have the top and bottom have the same border width, as well as the left and right sides to have the same, it is defined by top/bottom and left/right respectively.
<pre>
style="border-width:10px 40px;"
</pre>
 
 
{| border="1" style="border-width:10px 40px;"
|-
|Row 1||Row 1||Row 1
|-
|Row 2||Row 2||Row 2
|}
 
====Table Spacing====
You can add some space in your cells by adding cell padding. To do so, add the following code to the table start level:
<pre>
cellpadding="10"
</pre>
This will create a 10-pixel margin of space in every direction in your cell.
{| border="1" cellpadding="10"
|-
|Row 1||Row 1||Row 1
|-
|Row 2||Row 2||Row 2
|}
 
===Table Classes (Styles)===
There are some table classes that provide some table formatting for you.
 
To add a class to your table, simply add the class name to the table start level. For example:
 
<pre>
{|class="wikitable"
</pre>
 
====Wikitable====
The wikitable class gives a light grey background to cells, and simple table borders.
 
{|class="wikitable"
!Column 1
!Column 2
!Column 3
|-
|Row 1||Row||Row
|-
|Row 2||Row||Row
|}
 
<pre>
{|class="wikitable"
!Column 1
!Column 2
!Column 3
|-
|Row 1||Row||Row
|-
|Row 2||Row||Row
|}
</pre>
 
====Wikitable Sortable====
The wikitable sortable class gives the same things as the wikitable class does, but also makes your columns sortable (alphabetically).
 
{|class="wikitable sortable"
!Column 1
!Column 2
!Column 3
|-
|Row 1||Row||Row
|-
|Row 2||Row||Row
|}
 
<pre>
{|class="wikitable sortable"
!Column 1
!Column 2
!Column 3
|-
|Row 1||Row||Row
|-
|Row 2||Row||Row
|}
</pre>
 
====Sortable====
The sortable class adds the ability to sort columns alphabetically without the wikitable formatting.
 
{|class="sortable"
!Column 1
!Column 2
!Column 3
|-
|Row 1||Row||Row
|-
|Row 2||Row||Row
|}
 
<pre>
{|class="sortable"
!Column 1
!Column 2
!Column 3
|-
|Row 1||Row||Row
|-
|Row 2||Row||Row
|}
</pre>
editor
7,290

edits

Navigation menu