Help:Editing

From Pikipedia, the Pikmin wiki
Revision as of 23:47, February 7, 2022 by Soprano (talk | contribs) (Various small improvements and cleanup.)
Jump to navigation Jump to search

This page is a reference and a tutorial for basic Mediawiki syntax, which is the code used on this wiki to produce formatted articles from plain text. More advanced techniques can be found in Help:Editing/Advanced techniques. If there is something that you cannot find in either of these places, but want explained, ask in this guide's discussion page.

Text

Text entered into the editor will appear in the article as standard text.

To separate paragraphs, there must be an empty line between them.

Code Result
This is some text.

This is a new paragraph.
This is some text.

This is a new paragraph.

Sections

Articles are divided into sections, and there can be multiple levels of sections. To make a paragraph of text into a section heading, surround it with 2 or more equals signs.

Code Result
== Main heading ==
Paragraph.

=== Subheading ===
Paragraph.

==== Minor heading ====
Paragraph.

Main heading


Paragraph.

Subheading

Paragraph.

Minor heading

Paragraph.

A table of contents is automatically generated when there are more than 4 sections in an article.

To make a piece of text function like a heading but not appear in the table of contents, place a semicolon at the start of the line.

Code Result
;Obstacles
*Dirt wall
*Bridge

;Enemies
*Bulborb
*Fiery Blowhog
Obstacles
  • Dirt wall
  • Bridge
Enemies
  • Bulborb
  • Fiery Blowhog

Links

To link to another page, surround a piece of text with 2 square brackets. This will create a link to the article within the square brackets.

Code Result
A [[Bulborb]] is found in the [[Garden of Hope]].
A Bulborb is found in the Garden of Hope.

To change the text displayed in the link, place a vertical bar between the link text and the displayed text.

Code Result
Caves are [[Randomization|randomly generated]] by arranging [[Cave unit|rooms]].
Caves are randomly generated by arranging rooms.

It is possible to link to sections of an article by placing a # sign between the article name and the section name. Omitting the article name will link to another section of the current article.

Code Result
[[Ship part#List]] is a section of the [[ship part]] article. See [[#Sections|sections]] for more information about sections.
Ship part#List is a section of the ship part article. See sections for more information about sections.

Note that the capitalization of article titles in links must be correct for the link to work (except for the first letter in the title, which can have any capitalization).

Formatting

To make text italic or bold, surround it with 2 or 3 apostrophes.

Code Result
''This text is italic.''

'''This text is bold.'''

'''''This text is italic and bold.'''''
This text is italic.

This text is bold.

This text is italic and bold.

To make a bulleted list, put an asterisk at the start of each line. Using multiple asterisks will indent the list.

Code Result
Enemies:
*Grub-dog family
**Bulborb
**Orange Bulborb
*Breadbug family
**Dwarf Bulborb
**Dwarf Orange Bulborb
Enemies:
  • Grub-dog family
    • Bulborb
    • Orange Bulborb
  • Breadbug family
    • Dwarf Bulborb
    • Dwarf Orange Bulborb

A numbered list is similar, but with # symbols instead.

Code Result
Areas:
#The Impact Site
#The Forest of Hope
#The Forest Navel
#The Distant Spring
#The Final Trial
Areas:
  1. The Impact Site
  2. The Forest of Hope
  3. The Forest Navel
  4. The Distant Spring
  5. The Final Trial

A paragraph of text can be indented by starting it with a colon. Using multiple colons will indent it further. This is commonly used in talk pages to indicate a reply.

Code Result
This is a paragraph.
:This is a reply to that paragraph.
::This is another reply.
This is a paragraph.
This is a reply to that paragraph.
This is another reply.

When writing a dash, it's preferable to use the HTML code for the dash rather than the character itself, which can be confused with a hyphen. This can be done by writing the text – in place of the dash. The same thing can be done (with different codes) for other special characters.

Code Result
In ''Pikmin'', Yellow Pikmin can carry [[bomb-rock]]s – an ability necessary to access certain sections of areas.
In Pikmin, Yellow Pikmin can carry bomb-rocks – an ability necessary to access certain sections of areas.

Images

To make an image appear on an article, link to the page containing the image, which will start with File: and end with the image's file format.

Code Result
[[File:SSBB Olimar.jpg]]
Artwork of Captain Olimar from Super Smash Bros. Brawl.

This produces an image with no frame and at its original resolution, which is generally not a good thing. To fix these things, put |thumb after the file name, which will turn it into a thumbnail.

Code Result
[[File:SSBB Olimar.jpg|thumb]]
Artwork of Captain Olimar from Super Smash Bros. Brawl.

It is possible to add a caption to images by putting text after another vertical bar.

Code Result
[[File:SSBB Olimar.jpg|thumb|Olimar in ''Super Smash Bros. Brawl''.]]
Artwork of Captain Olimar from Super Smash Bros. Brawl.
Olimar in Super Smash Bros. Brawl.

Finally, it is possible to change the size of images and their position on the page with additional pieces of text before the caption. 250px will make the image 250 pixels wide (this number can be changed, and the default size is 200 pixels wide), and left will place the image on the left of the screen (center and right also work, and right is the default position).

Code Result
[[File:SSBB Olimar.jpg|thumb|left|250px|Olimar in ''Super Smash Bros. Brawl''.]]
Artwork of Captain Olimar from Super Smash Bros. Brawl.
Olimar in Super Smash Bros. Brawl.

An alternative way to show images is in a gallery. Galleries display images at small sizes in a grid. To make one, surround a section with <gallery> and </gallery>, and place each file name (without the File: prefix) on a new line. Image captions can be placed after a vertical bar.

Code Result
<gallery>
PuffyBlowhog.png|The Puffy Blowhog in ''Pikmin 2''.
Puffy Blowhog P3 side view.jpg|The Puffy Blowhog in ''Pikmin 3''.
</gallery>

Note that the mobile version of the website displays images differently, so some of these formatting changes may make no difference depending on your device.

Templates

Templates are special pages starting with "Template:" that can be included on other pages. This allows similar pieces of MediaWiki code to appear in multiple articles, making consistency between pages easier, among other benefits.

To make a template appear in another page, surround its name (without the "Template:" prefix) with 2 curly brackets.

As an example, to indicate that an article or a section of an article is a stub (meaning it needs expansion), you can write {{stub}}.

Code Result
{{stub}}
The leaf texture used in Pikmin 2's Challenge Mode menu. (Used on Pikipedia in the {{stub}} template.)

This article is a stub. You can help Pikipedia by expanding it.

Many templates have arguments, which are additional pieces of information that influence the template. Arguments are separated by vertical bars.

An example of this is the {{date}} template, which is used to display dates in a standardized format. It can have 3 arguments, which in order represent the day, month, and the year.

Code Result
{{date|14|September|2010}}
September 14th, 2010
''Pikmin 3 Deluxe'' released on {{date|30|October|2020}}.
Pikmin 3 Deluxe released on October 30th, 2020.

Arguments can have names, which means that instead of just separating the arguments by vertical bars, each argument contains a name and a value connected by an equals sign.

Some templates are more complex, featuring many arguments. An example of this is {{infobox upgrade}}, which is used to show basic information about upgrades. These include which games the upgrade appears in, an image of the upgrade, the areas it appears in, and the upgrade's weight. To make large templates like this easier to work with, it's recommended to place each argument on its own line. For the Dodge Whistle, the template would look like this:

Code Result
{{infobox upgrade
|p3           = y
|name         = Dodge Whistle
|icon         = Dodge Whistle icon.png
|image        = DodgeWhistleArt.png
|caption      = The Dodge Whistle's capsule.
|area         = [[Distant Tundra]]
|weight       = 10
|max_carriers = 20
|function     = Allows leaders and Pikmin to dodge
}}
Dodge Whistle Icon.
Image of the Dodge Whistle capsule.
The Dodge Whistle's capsule.
Games Pikmin 3
Function Allows leaders and Pikmin to dodge

Template pages will have information on what the template does and how to use it, so check each template's page for more information.

Categories

Pages can be included in categories, which allow related pages to be grouped together for navigation purposes. Some examples of categories are Category:Bosses, Category:Menus, and Category:2-Player Battle images. To include an article, image, category, or any other page inside a category, create a link to that category anywhere in the page (but preferably at the bottom). It will not appear as a link, and instead the page will be added to the category. A list of categories a page is in can be found at the bottom of the page in the desktop version of the site.

Code Result (see bottom of page)
[[Category:Help]]

A faster way of adding, changing, or removing categories is by using HotCat. You can enable this tool by going to your preferences page. Note that only registered users can use this tool. To gain access to the tool, you must create an account or login.

basic
How HotCat looks like when it is enabled.

Other

Redirect pages

Redirect pages are special pages that automatically go to another page when someone searches them or clicks on a link to them. They're useful when an article has multiple things it could be called. To create a redirect page, start it with #REDIRECT and then link to the article. An example of this is Olimar, which contains #REDIRECT [[Captain Olimar]].

Talk pages

In talk pages, you can end your post with a signature, which contains your username and the date and time of your post. To sign your posts, put 4 tildes (~~~~) at the end of the post. (3 tildes will produce just the username, and 5 tildes will produce just the time and date.) It's possible to customize your signature in your preferences page. Below is an example of a custom signature.

Code Result
~~~~
{EspyoT} 12:00, January 1, 2020 (EST)

Tables

For some types of information, it may be practical to display it on a table. Since table syntax can be complicated, it is described at Help:Tables instead of on this page.

Pikipedia standards

Pikipedia's policies and guidelines contain useful information in making sure edits fit Pikipedia's style. Here are a few tips:

  • Always italicize the names of games.
  • Don't refer to the player as "you", except in guide sections.
  • Images should always have a proper description and license.
  • If you notice a problem with an article, such as a lack of information or confusing writing, and don't know how to fix it, place a maintenance template on it so that others can know to fix it. There are several to choose from, including {{stub}} and {{clean}}.

See also