User:Sirryan2002/WikiGuide
Assigned to:Sirryan2002
Wiki Editing Tutorial
Many people want to edit the Paradise wiki but have absolutely no idea how or where to start learning. This guide serves as the easiest way to pick up on basic-intermediate wiki code and provide a stepping stone for others to improve their wiki knowledge.
This is not a set of rules for the wiki, for that, you should go Here. Template:TOC
Making Edits
Wikis are such a fabulous tool for games because they can be constantly edited and updated by the playerbase much like our wiki is. Whenever you make a change/edit to any page it is documented in the view history tab at the top of the page. In there you can see who made the edit, when they made it, and what they said they edited. In addition, you can compare edits to see the changes between them.
Whenever you make an edit, you are required to do two things.
- Summarize your edit
- Declare the type of edit you're making
When summarizing your edit, keep it concise(in 1 sentence) and describe vaguely what you did. For example, if you add a bunch of items to a table, you can just specify "Added additional items to the (insert name here) table."
If your edit is purely to correct a small(within 50 characters) grammatical/phrasing/spelling issue then you should declare your edit as a Minor Edit "grammar fix" or "spellcheck" will suffice as a summary for these types of edits.
Comments
You are able to add commented out text inside the pages wikicode. This is great for letting other editors what to do/not do.
Comments should be avoided unless they're:
- Explaining Template Code
- Warning users not to delete certain code
- Explaining weird/uncommon syntax
- Warning users not to add something because previous content of that type has been repeatedly reverted
- Used to section areas of the code off when it gets messy
Comments should not be used to:
- Leave funny/friendly messages or jokes
- Temporarily remove sections to be re-added later (this is what user and draft pages are for)
- Explain changes made
Text Formatting
Text by itself is extremely boring and often hard to read, so you can use text formatting to make your words really POP!
Format Type | Usage | Output |
---|---|---|
Bold | Use this to bring attention to important text <b>This text is bold!</b>or '''This text is bold''' |
This text is bold! |
Underline | Use this to underscore important information or warnings <u>This text is underlined!</u> |
This text is underlined! |
Italic | Use this to enounciate certain words <i>This text is italicized!</i>or ''This text is italicized!'' |
This text is italicized! |
Headings | Use this to declare a section of your article and organize it
===Level 3=== ====Level 4==== =====Level 5===== ======Level 6 ====== |
Level 3Level 4Level 5Level 6 |
Bullet Lists | This is how you create bullet lists
*Item 1 * Item 2 ** Item 2.1 ** Item 2.2 * Item 3 ** Item 3.1 *:- Definition |
|
Numbered Lists | This is how you create numbered lists
#Item 1 # Item 2 ## Item 2.1 ## Item 2.2 # Item 3 ## Item 3.1 |
|
Preformatted Text | Use this to preformat text with a certain, this will alos allow you to write anything within the pre blocks without the wiki recognizing it as text formatting.
<pre>This text is preformatted to be the default font and style, <b>Things aren't bolded</b> or <i>Italicized</i>!!!</pre> |
This text is preformatted to be the default font and style, <b>Things aren't bolded</b> or <i>Italicized</i>!!! |
Comments | Use this to leave important notes/messages to people editing the page. Comments do not show up when you view the wiki page and are only visible in the page editor.
<!--This is a comment, to whoever is reading this don't do such and such --> The Fitness Gram Pacer Test is a multi-stage aerobic exercise... |
The Fitness Gram Pacer Test is a multi-stage aerobic exercise... |