Difference between revisions of "Project:Wiki Markup Tutorial"

From Girlfriend Kari Wiki
Jump to: navigation, search
m
m
 
Line 1: Line 1:
 
Welcome to the wiki markup tutorial! This page serves as a easy tutorial for those that need help editing articles by source on this wiki, or to serve as a quick reference on how to use some basic wiki markup text features.
 
Welcome to the wiki markup tutorial! This page serves as a easy tutorial for those that need help editing articles by source on this wiki, or to serve as a quick reference on how to use some basic wiki markup text features.
  
As a quick introduction, this guide is for anyone, whether old or new. It'll list a bunch of things that will help you utilize the source editor on this Wiki well. Of course, you can always edit using the Visual Editor, but source editing is always preferred!
+
As a quick introduction, this guide is for anyone, whether old or new. It'll list a bunch of things that will help you utilize the source editor on this Wiki well. Of course, you can always edit using the Visual Editor, but source editing is good to know, since it's generally faster!
 +
 
 +
As a general rule of thumb, use the source editor whenever possible or dealing with non-formatting related issues. Then, use the Visual Editor to format your text properly and easily, and to also add images if necessary. If you follow this general rule, you'll rarely ever run into trouble!
  
 
Please remember that all articles, by default, can be edited by anyone at any time. Don't be discouraged if the edit you made got replaced/removed by someone else - there was probably a reason behind it! Usually, the editor will leave a comment for their actions in the history log, so that's a good place to check out first. If you're still wondering, feel free to post on the editor's talk page! After all, we're a community!
 
Please remember that all articles, by default, can be edited by anyone at any time. Don't be discouraged if the edit you made got replaced/removed by someone else - there was probably a reason behind it! Usually, the editor will leave a comment for their actions in the history log, so that's a good place to check out first. If you're still wondering, feel free to post on the editor's talk page! After all, we're a community!
Line 122: Line 124:
 
===Special Pages===
 
===Special Pages===
 
*Uploading files
 
*Uploading files
 +
**Visit the [[Project:Uploading Policies]] to see what you can upload, and what you can't upload!
 +
**Visit [http://www.mediawiki.org/wiki/Help:Images this site] for help on how to use images in wiki markup text.
 +
Don't worry too much about images - use Visual Editor for that if you need to, it's a lot easier!
  
 
===Tables===
 
===Tables===

Latest revision as of 20:38, 18 March 2015

Welcome to the wiki markup tutorial! This page serves as a easy tutorial for those that need help editing articles by source on this wiki, or to serve as a quick reference on how to use some basic wiki markup text features.

As a quick introduction, this guide is for anyone, whether old or new. It'll list a bunch of things that will help you utilize the source editor on this Wiki well. Of course, you can always edit using the Visual Editor, but source editing is good to know, since it's generally faster!

As a general rule of thumb, use the source editor whenever possible or dealing with non-formatting related issues. Then, use the Visual Editor to format your text properly and easily, and to also add images if necessary. If you follow this general rule, you'll rarely ever run into trouble!

Please remember that all articles, by default, can be edited by anyone at any time. Don't be discouraged if the edit you made got replaced/removed by someone else - there was probably a reason behind it! Usually, the editor will leave a comment for their actions in the history log, so that's a good place to check out first. If you're still wondering, feel free to post on the editor's talk page! After all, we're a community!

The complete reference guide to wiki editing using source editor may be found here. If after going through this tutorial you feel like learning more about general wiki syntax, this would be a good place to go. Also check here for a more complete reference guide on how to use wiki markup text.

The Basics

A wiki article is no different from writing a normal text document. You can format it easily with wiki-code to make your article look nice.

Font style and indents

  • Bold: Surround your text with triple apostrophes.
Usage: '''Bold Text''' gives Bold Text.
  • Italics. Surround your text with double apostrophes.
Usage: ''Italicized Text'' gives Italicized Text.
  • Indents: Place colons before a line to indent.
Usage: This line uses a single indent like :Usage.
Multiple colons can be used to increase the indent level. This line starts with ::Multiple.

Headings

  • Headings are used to separate an article's content into separate sections.
  • To insert a heading, surround a section title with equals signs.
Usage: ===Headings=== produces the heading for this section.
  • There are multiple levels of headings. The heading level is determined by the number of equals signs used on each side.
    • In most cases, level 2 (==Level 2 Heading==) headings are used for major sections. Level 2 headings are underlined and also come with a yin-yang orb graphic. Level 3 (===Level 3 Heading===) and level 4 (====Level 4 Heading====) headings are used for subsections.
  • Using headings will also help organize an article, since MediaWiki will automatically build a table of contents when an article has more than 3 headings.

Lists

Unordered Lists

A list of items with circle bullets.

Usage: Type a * before each item. Each item goes on its own line. Multiple *s can be used to increase indent level.

Example:

*one
**indented
*two
*three

  • one
    • indented
  • two
  • three

Ordered (Numbered) Lists

A list of items with numbered bullets.

Usage: Type a # before each item. Each item goes on its own line. Multiple #s can be used to increase indent level.

Example:

#one
##indented
#two
#three

  1. one
    1. indented
  2. two
  3. three

Categories

Most wiki pages belong in one or more categories. In order to specify the categories that they belong it, include a tag at the end of the article that looks like the following.

Usage: [[Category:Name|Sort]]
Example: [[Category:Help|Wiki Markup Tutorial]] will put this article into the "Help" category, where it will then be sorted alphabetically by the text, "Wiki Markup Tutorial."

Links

Internal Links

Internal links are links to articles on this wiki. To link to an article, surround an article name with two sets of square brackets.

Usage: [[article name]]
Example: [[Main UI]] gives Main UI

You can use the | (pipe) character in links to display something different.

Usage: [[article name|display name]]
Example: [[Main UI|The main page of the game.]] gives The main page of the game.

Interwiki Links

Interwiki links are links to articles on other wikis. Creating an interwiki link is similar to creating an internal link, but with the addition of a prefix before the article name. A list of available interwiki prefixes can be found at Special:Interwiki.

You know you need this when the page title comes with a "XXX:" sign. This means that it's not a part of the Girlfriend Kari wiki, but a part of something else. For example, this page is part of the "Project" wiki, which contains all of the policies, help, and information related to this wiki project. This is called a "namespace." There are more namespaces, so go around and look for them at Special:Interwiki.

Usage: [[prefix:article name]]
Example: [[Project:Editing Policies]] gives Project:Editing Policies

Using the | (pipe) character with interwiki links is recommended, as it removes the "prefix:" part from the displayed link.

Usage: [[prefix:article name|]]
Example: [[Project:Editing Policies|Editing Policies]] gives Editing Policies
Interlanguage Links

Although this is not completely applicable to the wiki as of yet, this will remain here for future reference. The below information was obtained from TouhouWiki. Interlanguage links behave a bit differently from interwiki links. Making an interwiki link using a language code (such as zh, fr, or ja) will not create an interwiki link on the page, but will actually add an entry to the "In other languages" section of the sidebar.

Usage: [[language:article name]]
Example: [[zh:东方神灵庙]] will place a link like 中文 under the "In other languages" section of this article's sidebar.

If you want to insert a link to such an article, add a : (colon) before the prefix. Once again, using the | (pipe) character is recommended.

Usage: [[:language:article name|]]
Example: [[:zh:Touhou Project|]] gives 东方维基

External Links

External links are for anything outside of this wiki. The URL must include a protocol prefix (such as http://).

Usage: [URL]
Example: [http://www.google.com] gives [1]

You can specify the text you want to display for the link. Unlike internal or interwiki links, the | (pipe) character is not used.

Usage: [URL custom text]
Example: [http://www.google.com google] gives google

At this point, you should know enough about wiki editing to understand most of the articles on the wiki. If you

Advanced Topics

Templates

Special Pages

Don't worry too much about images - use Visual Editor for that if you need to, it's a lot easier!

Tables

Tables are pretty simple to make. Wiki comes with its own table syntax so you don't have to use HTML. If you are familiar with HTML and CSS, the syntax pretty much just replaces <table>, <tr>, and <td>. You can use in-line CSS styling to decorate the table.

Start a table: {| border=1 solid
Table row: |-
Table Column: |This is my first cell || another cell!
Close a table: |}

Together, we have

{|border=1 solid
|- 
|This is my first cell || another cell!
|}

Which gives

This is my first cell another cell!

By combining these codes together, you can create tables quickly and easily.