Difference between revisions of "Help:Contents"

From USI-RPG
Jump to navigation Jump to search
Line 9: Line 9:
 
Lastly, the help page is used for linking site-like documents such as Templates.  
 
Lastly, the help page is used for linking site-like documents such as Templates.  
 
----
 
----
 +
==Editing Pages Help==
 +
 +
There are two parts to editing Pages. Luckily, Editing pages is largely simple as typing in text like you would a word processor. Formatting however, is done in two ways.
 +
 +
The first is by use of the Wiki Syntax. A good example is the above line that says "Editing Pages Help". To accomplish the title likeness and the underline, two <nowiki>==</nowiki> were placed, one before and one after the block of text. The full syntax looked like this
 +
<nowiki> ==Editing Pages Help== </nowiki>
 +
 +
Which gave us our desired result.
 +
 +
Links are generated by the site by the use of double brackets. <nowiki>[[ ]]</nowiki> are containers for links.
 +
 +
Example
 +
<nowiki>[[RPG:Old_Faq|Old FAQ]]</nowiki>
 +
 +
A <nowiki>|</nowiki> is used to seperate a potentially non-formatted text to replace with your own. Otherwise the link itself will show the underscore.
 +
 +
Why an underscore ? The link you create uses the link as its page title. So if you create a link called <nowiki>[[thisoldhouse]]</nowiki> you end up with a page title as thisoldhouse. Doesn't look very nice. However, underscores in links are converted to spaces in the page titles. So you end up with <nowiki>[[This_Old_House]]</nowiki> being '''This Old House''' as your title.
 +
 +
Templates are a great thing. In function it allows any page to act like any type of database simply by referencing the template to be used, and telling it which variables to fill in for you.
 +
 +
Take a look at this [[Template:Factions|template]] (open in new window) This is the faction template used on factions. You will see that by itself its pretty self explanitory. The {{{Text}}} are used as variables for definition when we use a template. When we use the template, we dont' paste that code in on the page of use. We do this instead.
 +
 +
<code><nowiki>
 +
 +
{{
 +
Template:Factions
 +
|Image=
 +
|Name=
 +
|Location=
 +
|Military=
 +
|Government=
 +
|TechLevel=
 +
|AssocSpecies=
 +
|About=
 +
|Diplomatic=
 +
|History=
 +
|Other=
 +
|Category=
 +
 +
}}
 +
 +
</code></nowiki>
 +
 +
and we then simply fill in the blanks as if it was a normal database on the old site. The order isn't important, but its little syntax is (though it could all be on a single line if you wanted it to be.) I break it down for each section per line to make editing easier in the future. The link below is our current templates in use.
  
 
[[Templates]]
 
[[Templates]]
 +
 +
==More Formatting==
 +
You can format your text using wiki markup. This consists of normal characters like asterisks, single quotes or equation marks which have a special function in the wiki, sometimes depending on their position. For example, to format a word in ''italic'', you include it in two single quotes like <tt><nowiki>''this''</nowiki></tt>
 +
 +
== Text formatting markup ==
 +
 +
{| align="center" {{Prettytable}}
 +
|-
 +
|{{Hl2}} |'''Description'''
 +
|{{Hl2}} |'''You type'''
 +
|{{Hl2}} |'''You get'''
 +
|-
 +
| colspan="3" align="center" | ''applies anywhere''
 +
|-
 +
|Italic text
 +
|<tt><nowiki>''italic''</nowiki></tt>
 +
|''italic''
 +
|-
 +
| Bold text
 +
|<tt><nowiki>'''bold'''</nowiki></tt>
 +
|'''bold'''
 +
|-
 +
| Bold and italic
 +
|<tt><nowiki>'''''bold & italic'''''</nowiki></tt>
 +
|'''''bold & italic'''''
 +
|-
 +
|Escape wiki markup
 +
|<tt><nowiki><nowiki>no ''markup''</nowiki></nowiki></tt>
 +
|<nowiki>no ''markup''</nowiki>
 +
|-
 +
| colspan="3" align="center" | ''only at the beginning of the line''
 +
|-
 +
|Headings of<br />
 +
different sizes
 +
|
 +
<tt><nowiki>==level 1==</nowiki></tt><br />
 +
<tt><nowiki>===level 2===</nowiki></tt><br />
 +
<tt><nowiki>====level 3====</nowiki></tt><br />
 +
<tt><nowiki>=====level 4=====</nowiki></tt>
 +
|
 +
==Level 1==
 +
===Level 2===
 +
====Level 3====
 +
=====Level 4=====
 +
|-
 +
|Horizontal rule
 +
|
 +
<tt><nowiki>----</nowiki></tt>
 +
|
 +
----
 +
|-
 +
|Bullet list
 +
|
 +
&#42; one<br>
 +
&#42; two<br>
 +
&#42; three<br>
 +
&#42;&#42; three and one-third<br>
 +
&#42;&#42; three and two-thirds<br>
 +
|
 +
* one
 +
* two
 +
* three
 +
** three and one-third
 +
** three and two-thirds
 +
|-
 +
|Numbered list
 +
|
 +
&#35; one<br />
 +
&#35; two<nowiki><br></nowiki>spanning several lines<nowiki><br></nowiki>without breaking the numbering<br />
 +
&#35; three<br />
 +
&#35;&#35; three point one<br />
 +
&#35;&#35; three point two<br />
 +
|
 +
# one
 +
# two<br>spanning several lines<br>without breaking the numbering
 +
# three
 +
## three point one
 +
## three point two
 +
|-
 +
| Mixture of bulleted<br /> and numbered lists
 +
|
 +
&#35; one<br />
 +
&#35; two<br />
 +
&#35;&#42; two point one<br />
 +
&#35;&#42; two point two<br />
 +
|
 +
# one
 +
# two
 +
#* two point one
 +
#* two point two
 +
|-
 +
|Definition list
 +
|
 +
&#59;Definition<br />
 +
&#58;item 1<br />
 +
&#58;item 2<br />
 +
|
 +
;Definition
 +
:item 1
 +
:item 2
 +
|-
 +
|Preformatted text
 +
|
 +
&nbsp;&nbsp;preformatted text is done with<br />
 +
&nbsp;&nbsp;a space at the<br />
 +
&nbsp;&nbsp;beginning of the line<br />
 +
|
 +
preformatted text is done with
 +
a space at the
 +
beginning of the line
 +
|}
 +
 +
 +
== Paragraphs ==
 +
 +
Mediawiki ignores normal line breaks. To start a new paragraph, leave an empty line. You can also start a newline with the HTML tag <tt><nowiki><br&nbsp;/></nowiki></tt>. 
 +
 +
== HTML ==
 +
 +
Some HTML-Tags are allowed in MediaWiki, for example <tt><nowiki><code></nowiki></tt>, <tt><nowiki><div></nowiki></tt>, <tt><nowiki><span></nowiki></tt> and <tt><nowiki><font></nowiki></tt>.
 +
 +
{{Admin tip|tip=If you trust your users you can allow full HTML by setting <code>$wgRawHtml = true;</code> in LocalSettings.php.}}
 +
 +
 +
== More advanced formatting ==
 +
Beyond the basic text formatting markup shown above, there are some more advanced formatting tricks:
 +
*[[Help:Links|Links]]
 +
*[[Help:Images|Images]]
 +
*[[Help:Tables|Tables]]
 +
 +
== External Links ==
 +
{{meta|Help:Editing}}
 +
 +
{{Languages|Help:Formatting}}
 +
 +
__NOTOC__
 +
__NOEDITSECTION__
 +
 +
[[Category:Help|Formatting]]

Revision as of 15:56, 1 May 2007

Ack help.

Well for most people you just need to be able to browse the site. Not too hard ;)

If you're editing pages, you'll want to head over to the MEdiawiki people until i get their support/help pages onto this site. Otherwise send me an email with your problem and I'll try and get you taken care of.

Here is the Old FAQ we had on the site. It contains mostly RPG related info.

Lastly, the help page is used for linking site-like documents such as Templates.

Editing Pages Help

There are two parts to editing Pages. Luckily, Editing pages is largely simple as typing in text like you would a word processor. Formatting however, is done in two ways.

The first is by use of the Wiki Syntax. A good example is the above line that says "Editing Pages Help". To accomplish the title likeness and the underline, two == were placed, one before and one after the block of text. The full syntax looked like this 

 ==Editing Pages Help==

Which gave us our desired result.

Links are generated by the site by the use of double brackets. [[ ]] are containers for links.

Example 

[[RPG:Old_Faq|Old FAQ]]

A | is used to seperate a potentially non-formatted text to replace with your own. Otherwise the link itself will show the underscore.

Why an underscore ? The link you create uses the link as its page title. So if you create a link called [[thisoldhouse]] you end up with a page title as thisoldhouse. Doesn't look very nice. However, underscores in links are converted to spaces in the page titles. So you end up with [[This_Old_House]] being This Old House as your title.

Templates are a great thing. In function it allows any page to act like any type of database simply by referencing the template to be used, and telling it which variables to fill in for you.

Take a look at this template (open in new window) This is the faction template used on factions. You will see that by itself its pretty self explanitory. The {{{Text}}} are used as variables for definition when we use a template. When we use the template, we dont' paste that code in on the page of use. We do this instead.

{{ Template:Factions |Image= |Name= |Location= |Military= |Government= |TechLevel= |AssocSpecies= |About= |Diplomatic= |History= |Other= |Category= }} </code>

and we then simply fill in the blanks as if it was a normal database on the old site. The order isn't important, but its little syntax is (though it could all be on a single line if you wanted it to be.) I break it down for each section per line to make editing easier in the future. The link below is our current templates in use.

Templates

More Formatting

You can format your text using wiki markup. This consists of normal characters like asterisks, single quotes or equation marks which have a special function in the wiki, sometimes depending on their position. For example, to format a word in italic, you include it in two single quotes like ''this''

Text formatting markup

Description You type You get
applies anywhere
Italic text ''italic'' italic
Bold text '''bold''' bold
Bold and italic '''''bold & italic''''' bold & italic
Escape wiki markup <nowiki>no ''markup''</nowiki> no ''markup''
only at the beginning of the line
Headings of

different sizes

==level 1==
===level 2===
====level 3====
=====level 4=====

Level 1

Level 2

Level 3

Level 4
Horizontal rule

----

Bullet list

* one
* two
* three
** three and one-third
** three and two-thirds
  • one
  • two
  • three
    • three and one-third
    • three and two-thirds
Numbered list

# one
# two<br>spanning several lines<br>without breaking the numbering
# three
## three point one
## three point two
  1. one
  2. two
    spanning several lines
    without breaking the numbering
  3. three
    1. three point one
    2. three point two
Mixture of bulleted
and numbered lists

# one
# two
#* two point one
#* two point two
  1. one
  2. two
    • two point one
    • two point two
Definition list

;Definition
:item 1
:item 2
Definition
item 1
item 2
Preformatted text

  preformatted text is done with
  a space at the
  beginning of the line

 
preformatted text is done with
a space at the 
beginning of the line


Paragraphs

Mediawiki ignores normal line breaks. To start a new paragraph, leave an empty line. You can also start a newline with the HTML tag <br />.

HTML

Some HTML-Tags are allowed in MediaWiki, for example <code>, <div>, <span> and <font>.

Template:Admin tip


More advanced formatting

Beyond the basic text formatting markup shown above, there are some more advanced formatting tricks:

External Links

Template:Click MetaWiki: Help:Editing

Template:Languages

Retrieved from "http://www.usi-rpg.com/wiki/index.php?title=Help:Contents&oldid=2124"