Difference between revisions of "Help:Contents"

(Editing Guidelines)
(adding video tutorial)
 
(17 intermediate revisions by 4 users not shown)
Line 1: Line 1:
 +
<video type="youtube" id="tdsyRR0afV8" annotation=no position="right" frame="true" />
 
__NOTOC__
 
__NOTOC__
If you need any help, add a comment to the [[Help_talk:Contents|Help Talk Page]]. A reply will be made to your comment, so check back regularly.
+
Is this your first visit to UOGuide? Be sure to read our [[UOGuide:Introduction|introduction page]] on how you can help out the site.
 +
* '''Watch the Video Tutorial''' - If you are brand new and have never edited a wiki before.
 +
* '''Ask a Question''' - If you need any help, post a message in the [http://forum.uoguide.com/viewforum.php?f=3 UOGuide Discussion Forum]. A reply will be made to your comment, so check back regularly.
 +
* '''Sandbox''' - Feel free to use the [[UOGuide:Sandbox|Sandbox]] for getting a feel of the editing system. Don't worry about overwriting what is already there. It is meant as a playground to get you started.
  
Use the [[UOGuide:Sandbox|Sandbox]] for "testing" purposes.
+
==Editing Toolbar==
 +
[[File:Uoguide_editing_toolbar.jpg|thumb|The toolbar makes it quick and easy to format articles.]]
 +
When you are editing a page on UOGuide a helpful toolbar is located above the page text area. There are two modes for using the buttons:
 +
* '''Insert''' - Place your cursor at the location you want and press the icon, the code will be inserted at the cursor location.
 +
* '''Select''' - Highlight the text you want to format and press the icon, the code will surround the selected text.
 +
===Icons===
 +
[[File:uoguide toolbar icon bold.png|link=]] - Bold Text<br />
 +
[[File:uoguide toolbar icon italic.png|link=]] - Italic Text<br />
 +
[[File:uoguide toolbar icon link.png|link=]] - Opens a menu to create an internal or external site link<br />
 +
[[File:uoguide toolbar icon file.png|link=]] - Opens a menu to embed an image<br />
 +
[[File:uoguide toolbar icon reference.png|link=]] - Opens a menu to create a cited reference
 +
====Advanced====
 +
'''Heading''' - Inserts a section heading of the size you select<br />
 +
[[File:uoguide toolbar icon bulletlist.png|link=]] - Create bullet list<br />
 +
[[File:uoguide toolbar icon numberlist.png|link=]] - Create numbered list<br />
 +
[[File:uoguide toolbar icon nowiki.png|link=]] - Prevent text being altered by wiki formatting<br />
 +
[[File:uoguide toolbar icon newline.png|link=]] - Insert a line break<br />
 +
[[File:uoguide toolbar icon largetext.png|link=]] - Make text larger<br />
 +
[[File:uoguide toolbar icon smalltext.png|link=]] - Make text smaller<br />
 +
[[File:uoguide toolbar icon superscript.png|link=]] - Raise text a little (superscript)<br />
 +
[[File:uoguide toolbar icon subscript.png|link=]] - Lower text a little (subscript)<br />
 +
[[File:uoguide toolbar icon gallery.png|link=]] - Creates an image gallery<br />
 +
[[File:uoguide toolbar icon redirect.png|link=]] - Inserts code to create page redirect<br />
 +
[[File:uoguide toolbar icon table.png|link=]] - Opens a menu to create a table<br />
 +
[[File:uoguide toolbar icon search.png|link=]] - Opens a menu to search and replace text in the article
  
==Formatting==
+
====Special Characters====
Formatting content on UOGuide is really easy. Here are some basic notations from the [http://en.wikipedia.org/wiki/Wikipedia:Quick_guide Wikipedia] quick format guide:
+
Shows characters for many different languages. The symbols section is probably the most useful out of these.
 +
====Help====
 +
Shows a quick reference to explain common formatting code.
 +
==Wiki Formatting==
 +
Here are more detailed explanations and examples of how wiki formatting works.
  
{| style="border:1px solid #9F3215; font-size:95%; margin:auto; text-align:left;"
+
{| class="uoguidetable leftalign"
 
|-
 
|-
| style="background:#9F3215; color:#FFFFFF; padding:3px 5px; text-align:center; width:25%;" | '''Description'''
+
! '''Description'''
| style="background:#9F3215; color:#FFFFFF; padding:3px 5px; text-align:center; width:50%;" | '''You type'''
+
! '''You Type'''
| style="background:#9F3215; color:#FFFFFF; padding:3px 5px; text-align:center; width:25%;"|'''You get'''
+
! '''You Get'''
 
|-
 
|-
| colspan="3" style="background:#9F3215; color:#FFFFFF; font-family:sans-serif; font-size:0.9em; padding:3px 5px; text-align:center;" | Applies anywhere
+
! colspan="3" style="font-weight:normal;" | Applies anywhere
 
|-
 
|-
| style="padding:3px 3px 15px 3px;" | No table of contents
+
| '''Italicize Text'''
| style="padding:3px 3px 15px 3px;" | <code><nowiki>__NOTOC__</nowiki></code>
+
| {{Monospace|<nowiki>''italic''</nowiki>}}
| &nbsp;
+
| ''italic''
 
|-
 
|-
| style="padding:3px 3px 15px 3px;" | Italicize text
+
| '''Bold Text'''
| style="padding:3px 3px 15px 3px;" | <code><nowiki>''italic''</nowiki></code><br /><code><nowiki><span style="font-style:italic;">italic</span></nowiki></code>
+
| {{Monospace|<nowiki>'''bold'''</nowiki>}}
| style="padding:3px 3px 15px 3px;" | ''italic''
+
| '''bold'''
 
|-
 
|-
| style="padding:3px 3px 15px 3px;" | Bold text
+
| '''Bold and Italic'''
| style="padding:3px 3px 15px 3px;" | <code><nowiki>'''bold'''</nowiki></code><br /><code><nowiki><span style="font-weight:bold;">bold</span></b></nowiki></code>
+
| {{Monospace|<nowiki>'''''bold & italic'''''</nowiki>}}
| style="padding:3px 3px 15px 3px;" | '''bold'''
+
| '''''bold & italic'''''
 
|-
 
|-
| style="padding:3px 3px 15px 3px;" | Bold and italic
+
| '''Internal Link'''{{Line Break}}(within UOGuide)
| style="padding:3px 3px 15px 3px;" |
+
| {{Monospace|<nowiki>[[Name of Page]]</nowiki>{{Line Break}}<nowiki>[[Name of Page|Display
<code><nowiki>'''''bold & italic'''''</nowiki></code><br /><code><nowiki><span style="font-style:italic;</nowiki><br /><nowiki>font-weight:bold;">bold & italic</span></nowiki></code>
+
Text]]</nowiki>}}
| style="padding:3px 3px 15px 3px;" | '''''bold & italic'''''
+
| [[Name of Page]]{{Line Break}}[[Name of Page|Display Text]]
 
|-
 
|-
| style="padding:3px 3px 15px 3px;" | Underline text
+
| '''External Link'''{{Line Break}}(to other websites)
| style="padding:3px 3px 15px 3px;" | <code><nowiki><span style="text-decoration:underline;"></nowiki><br /><nowiki>Underlined</span></nowiki></code>
+
| {{Monospace|<nowiki>[http://www.example.com]</nowiki>{{Line Break}}<nowiki>[http://www.example.com display text]</nowiki>{{Line Break}}<nowiki>http://www.example.com</nowiki>}}
| style="padding:3px 3px 15px 3px;" | <span style="text-decoration:underline;">Underlined</span>
+
| [http://www.example.com]{{Line Break}}[http://www.example.com display text]{{Line Break}}http://www.example.com
 
|-
 
|-
| style="padding:3px 3px 15px 3px;" | Internal link<br />(within UOGuide)
+
| '''Escape Wiki Markup'''
| style="padding:3px 3px 15px 3px;" | <code><nowiki>[[Name of Page]]</nowiki></code><br /><code><nowiki>[[Name of Page|Display
+
| {{Monospace|<nowiki>''markup''</nowiki>{{Line Break}}<nowiki><nowiki>no ''markup''</nowiki></nowiki>}}
Text]]</nowiki></code><br /><code><nowiki>#REDIRECT [[Target Page]]</nowiki></code>
+
| ''markup''{{Line Break}}<nowiki>no ''markup''</nowiki>
| style="padding:3px 3px 15px 3px;" | [[Name of Page]]<br />[[Name of Page|Display Text]]<br />[[Target Page]]
+
 
|-
 
|-
| style="padding:3px 3px 15px 3px;" | External link<br />(to other websites)
+
| '''Line Break'''
| style="padding:3px 3px 15px 3px;" | <code><nowiki>[http://www.example.com]</nowiki></code><br /><code><nowiki>[http://www.example.com display text]</nowiki></code><br /><code><nowiki>http://www.example.com</nowiki></code>
+
| {{Monospace|<nowiki>one{{Line Break}}two</nowiki>}}
| style="padding:3px 3px 15px 3px;" | [http://www.example.com]<br />[http://www.example.com display text]<br />http://www.example.com
+
| one{{Line Break}}two
 
|-
 
|-
| style="padding:3px 3px 15px 3px;" | Escape wiki markup
+
| '''Monospace Text'''
| style="padding:3px 3px 15px 3px;" | <code><nowiki>''markup''</nowiki></code><br /><code><nowiki><nowiki>no ''markup''</nowiki></nowiki></code>
+
| {{Monospace|This text is not Monospace.{{Line Break}}<nowiki>{{Monospace|This text is Monospace.}}</nowiki>}}
| style="padding:3px 3px 15px 3px;" | ''markup''<br /><nowiki>no ''markup''</nowiki>
+
| This text is not Monospace.{{Line Break}}{{Monospace|This text is Monospace.}}
 
|-
 
|-
|colspan="3" style="border-top:1px solid #cee0f2;"|
+
| '''Sign Posts''' <br />on talk pages
 +
| <nowiki>~~~~</nowiki>
 +
| [[User:Username|Username]] {{CURRENTTIME}}, {{CURRENTDAY}} {{CURRENTMONTHNAME}} {{CURRENTYEAR}} (UTC)
 
|-
 
|-
| style="padding:3px 3px 15px 3px;" | Sign your posts <br />on talk pages
+
| '''Image'''
| style="padding:3px 3px 15px 3px;" | <nowiki>~~~~</nowiki>
+
| <nowiki>[[File:Kingdom_reborn_icon.jpg]]</nowiki>
| style="padding:3px 3px 15px 3px;" | [[User:Username|Username]] {{CURRENTTIME}}, <br />{{CURRENTDAY}} {{CURRENTMONTHNAME}} {{CURRENTYEAR}} (UTC)
+
| [[File:Kingdom_reborn_icon.jpg]]
 
|-
 
|-
| style="padding:3px 3px 15px 3px;" | Image
+
| '''Thumbnail Image'''
| style="padding:3px 3px 15px 3px;" | <nowiki>[[Image:Kingdom reborn icon.jpg]]</nowiki>
+
| <nowiki>[[File:Kingdom_reborn_icon.jpg|thumb|Caption text]]</nowiki>
| style="padding:3px 3px 15px 3px;" | [[Image:Kingdom reborn icon.jpg]]
+
| [[File:Kingdom_reborn_icon.jpg|thumb|Caption text]]
 
|-
 
|-
| style="padding:3px 3px 15px 3px;" | Thumbnail image
+
! colspan="3" style="font-weight:normal;" | Applies only when placed at the beginning of a new line
| style="padding:3px 3px 15px 3px;" | <nowiki>[[Image:Kingdom reborn icon.jpg|thumb|Caption text]]</nowiki>
+
| style="padding:3px 3px 15px 3px;" | [[Image:Kingdom reborn icon.jpg|thumb|Caption text]]
+
 
|-
 
|-
| colspan="3" style="background:#9F3215; color:#FFFFFF; font-family:sans-serif; font-size:0.9em; padding:3px 5px; text-align:center;" | Applies only at the beginning of the line
+
| '''Section Headings'''
 +
| {{Monospace|<nowiki>==Level 1==</nowiki>{{Line Break}}<nowiki>===Level 2===</nowiki>{{Line Break}}<nowiki>====Level 3====</nowiki>{{Line Break}}<nowiki>=====Level 4=====</nowiki>}}
 +
|
 +
==Level 1==
 +
===Level 2===
 +
====Level 3====
 +
=====Level 4=====
 
|-
 
|-
| style="padding:3px 3px 15px 3px;" | Headings<br />of different sizes<br />''A Table of Contents will''<br />''automatically be generated''<br />''when four headings are''<br />''added to an article.''
+
| '''Bulleted List'''
| style="padding:3px 3px 15px 3px;" | <code><nowiki>=Level 1=</nowiki></code><br /><code><nowiki>==Level 2==</nowiki></code><br /><code><nowiki>===Level 3===</nowiki></code><br /><code><nowiki>====Level 4====</nowiki></code><br /><code><nowiki>=====Level 5=====</nowiki></code><br /><code><nowiki>======Level 6======</nowiki></code>
+
| {{Monospace|* one{{Line Break}}* two{{Line Break}}** two point one{{Line Break}}** two point two{{Line Break}}* three}}
| style="padding:3px 3px 15px 3px;" |
+
=Level 1=
+
==Level 2==
+
===Level 3===
+
====Level 4====
+
=====Level 5=====
+
======Level 6======
+
|-
+
| style="padding:3px 3px 15px 3px;" | Bullet list
+
| style="padding:3px 3px 15px 3px;" | <code>&#42; one</code><br /><code>&#42; two</code><br /><code>&#42;&#42; two point one</code><br /><code>&#42; three</code>
+
 
| style="padding:3px 3px 15px 3px;" |
 
| style="padding:3px 3px 15px 3px;" |
 
* one
 
* one
 
* two
 
* two
 
** two point one
 
** two point one
 +
** two point two
 
* three
 
* three
 
|-
 
|-
| style="padding:3px 3px 15px 3px;" | Numbered list
+
| '''Numbered List'''
| style="padding:3px 3px 15px 3px;" | <code>&#35; one</code><br /><code>&#35; two</code><br /><code>&#35;&#35; two point one</code><br /><code>&#35; three</code>
+
| {{Monospace|# one{{Line Break}}# two{{Line Break}}## two point one{{Line Break}}## two point two{{Line Break}}# three}}
| style="padding:3px 3px 15px 3px;" |
+
|
 
# one
 
# one
 
# two
 
# two
 
## two point one
 
## two point one
 +
## two point two
 
# three
 
# three
 
|-
 
|-
| style="padding:3px 3px 15px 3px;" | Definition list
+
| '''Indenting Text'''
| style="padding:3px 3px 15px 3px;" | <code>&#59;Definition</code><br /><code>&#58;item 1</code><br /><code>&#58;item 2</code>
+
| {{Monospace|Definition{{Line Break}}: item 1{{Line Break}}: item 2}}
| style="padding:3px 3px 15px 3px;" |
+
|
;Definition
+
Definition
:item 1
+
: item 1
:item 2
+
: item 2
 
|-
 
|-
| style="padding:3px 3px 15px 3px;" | Unformatted text
+
| '''Create Table'''
| style="padding:3px 3px 15px 3px;" | <code>&nbsp;&nbsp;a space at the</code><br /><code>&nbsp;&nbsp;beginning of each line</code><br /><code>&nbsp;&nbsp;creates unformatted</code><br /><code>&nbsp;&nbsp;monospaced text</code>
+
|
| style="padding:3px 3px 15px 3px;" |
+
<pre>
a space at the
+
{|
beginning of each line
+
!Weapon
creates unformatted
+
!Weight
monospaced text
+
!Swing Delay
 
|-
 
|-
| style="padding:3px 3px 15px 3px;" | Horizontal line
+
|Katana
| style="padding:3px 3px 15px 3px;" | <nowiki>----</nowiki>
+
|6 stones
| style="padding:3px 3px 15px 3px;" |
+
|2.5 seconds
----
+
|-
 +
|Longsword
 +
|7 stones
 +
|3.5 seconds
 
|}
 
|}
 +
</pre>
  
 +
{| class="wikitable"
 +
|<nowiki>{|</nowiki>
 +
| Table start
 +
|-
 +
|<nowiki>|-</nowiki>
 +
| Table Row
 +
|-
 +
|<nowiki>!</nowiki>
 +
| Table Row for Header
 +
|-
 +
|<nowiki>|</nowiki>
 +
| Table Cell
 +
|-
 +
|<nowiki>|}</nowiki>
 +
| Table end
 +
|}
 +
|
 +
{|
 +
!Weapon
 +
!Weight
 +
!Swing Delay
 +
|-
 +
|Katana
 +
|6 stones
 +
|2.5 seconds
 +
|-
 +
|Longsword
 +
|7 stones
 +
|3.5 seconds
 +
|}
 +
|}
 
==Editing Guidelines==
 
==Editing Guidelines==
If you become a regular contributor to the site it is recommended you familiarize yourself with the general editing guidelines. It will help keep pages consistent throughout the site and make editing easier for yourself and other people.
+
'''<font color="red">Important Note</font>''': If you are a new contributor it is not nesessary to read any of the following pages. You are encouraged to contribute as best you can. If you become a regular contributor and want to learn a lot more about UOGuide editing there is the following:
* [[Help:Page Layout]] - How each page should be setup
+
* [[Help:Article Layout]] - The ideal layout for articles
 +
* [[Help:Creating an Item Page]] - A tutorial on creating a new page
 
* [[Help:Images]] - All about images
 
* [[Help:Images]] - All about images
 
* [[Help:Categories]] - All about categories
 
* [[Help:Categories]] - All about categories
 
* [[Help:Templates]] - All about templates
 
* [[Help:Templates]] - All about templates
If you would like to help edit but don't know where to start, see the [[UOGuide:Priorities|UOGuide Priorities]] page.
+
* [[Help: Guild Website Hosting]] - All a guild needs to know about their website
[[Category:UOGuide]]
+
* [[Help: User Page]] - All a user needs to know about their own page
 +
 
 +
{{Help}}

Latest revision as of 17:00, 10 October 2016

Is this your first visit to UOGuide? Be sure to read our introduction page on how you can help out the site.

  • Watch the Video Tutorial - If you are brand new and have never edited a wiki before.
  • Ask a Question - If you need any help, post a message in the UOGuide Discussion Forum. A reply will be made to your comment, so check back regularly.
  • Sandbox - Feel free to use the Sandbox for getting a feel of the editing system. Don't worry about overwriting what is already there. It is meant as a playground to get you started.

Editing Toolbar

The toolbar makes it quick and easy to format articles.

When you are editing a page on UOGuide a helpful toolbar is located above the page text area. There are two modes for using the buttons:

  • Insert - Place your cursor at the location you want and press the icon, the code will be inserted at the cursor location.
  • Select - Highlight the text you want to format and press the icon, the code will surround the selected text.

Icons

Uoguide toolbar icon bold.png - Bold Text
Uoguide toolbar icon italic.png - Italic Text
Uoguide toolbar icon link.png - Opens a menu to create an internal or external site link
Uoguide toolbar icon file.png - Opens a menu to embed an image
Uoguide toolbar icon reference.png - Opens a menu to create a cited reference

Advanced

Heading - Inserts a section heading of the size you select
Uoguide toolbar icon bulletlist.png - Create bullet list
Uoguide toolbar icon numberlist.png - Create numbered list
Uoguide toolbar icon nowiki.png - Prevent text being altered by wiki formatting
Uoguide toolbar icon newline.png - Insert a line break
Uoguide toolbar icon largetext.png - Make text larger
Uoguide toolbar icon smalltext.png - Make text smaller
Uoguide toolbar icon superscript.png - Raise text a little (superscript)
Uoguide toolbar icon subscript.png - Lower text a little (subscript)
Uoguide toolbar icon gallery.png - Creates an image gallery
Uoguide toolbar icon redirect.png - Inserts code to create page redirect
Uoguide toolbar icon table.png - Opens a menu to create a table
Uoguide toolbar icon search.png - Opens a menu to search and replace text in the article

Special Characters

Shows characters for many different languages. The symbols section is probably the most useful out of these.

Help

Shows a quick reference to explain common formatting code.

Wiki Formatting

Here are more detailed explanations and examples of how wiki formatting works.

Description You Type You Get
Applies anywhere
Italicize Text ''italic'' italic
Bold Text '''bold''' bold
Bold and Italic '''''bold & italic''''' bold & italic
Internal Link
(within UOGuide)
[[Name of Page]]
[[Name of Page|Display Text]]
Name of Page
Display Text
External Link
(to other websites)
[http://www.example.com]
[http://www.example.com display text]
http://www.example.com
[1]
display text
http://www.example.com
Escape Wiki Markup ''markup''
<nowiki>no ''markup''</nowiki>
markup
no ''markup''
Line Break one{{Line Break}}two one
two
Monospace Text This text is not Monospace.
{{Monospace|This text is Monospace.}}
This text is not Monospace.
This text is Monospace.
Sign Posts
on talk pages
~~~~ Username 13:37, 28 March 2024 (UTC)
Image [[File:Kingdom_reborn_icon.jpg]] Kingdom reborn icon.jpg
Thumbnail Image [[File:Kingdom_reborn_icon.jpg|thumb|Caption text]]
Caption text
Applies only when placed at the beginning of a new line
Section Headings ==Level 1==
===Level 2===
====Level 3====
=====Level 4=====

Level 1

Level 2

Level 3

Level 4
Bulleted List * one
* two
** two point one
** two point two
* three
  • one
  • two
    • two point one
    • two point two
  • three
Numbered List # one
# two
## two point one
## two point two
# three
  1. one
  2. two
    1. two point one
    2. two point two
  3. three
Indenting Text Definition
: item 1
: item 2

Definition

item 1
item 2
Create Table
{|
!Weapon
!Weight
!Swing Delay
|-
|Katana
|6 stones
|2.5 seconds
|-
|Longsword
|7 stones
|3.5 seconds
|}
{| Table start
|- Table Row
! Table Row for Header
| Table Cell
|} Table end
Weapon Weight Swing Delay
Katana 6 stones 2.5 seconds
Longsword 7 stones 3.5 seconds

Editing Guidelines

Important Note: If you are a new contributor it is not nesessary to read any of the following pages. You are encouraged to contribute as best you can. If you become a regular contributor and want to learn a lot more about UOGuide editing there is the following: