Difference between revisions of "How to Wiki"

From Alarums
Jump to navigationJump to search
(Created page with "Some best practices for editing and adding new pages on a wiki: To add a new page: Generally you shouldn't use the "Create a page" button, but instead edit a page that should...")
 
Line 9: Line 9:
 
==Page Organization==
 
==Page Organization==
  
<nowiki>Use two or more = around section headings; these will appear in a toc unless you supress that.  In general, you shouldn't use one = headers, since those are the markup for page headers (unless you want something to appear on the same level as a page header).  A section heading won't be parsed unless it's on a line by itself.
+
<nowiki>Use two or more = around section headings; these will appear in a toc unless you supress that.  In general, you shouldn't use one = headers, since those are the markup for page headers (unless you want something to appear on the same level as a page header).  A section heading won't be parsed unless it's on a line by itself.</nowiki>
  
 
Examples:
 
Examples:
  
==Top Level section==
+
<nowiki>==Top Level section==</nowiki>
  
===Second level section==
+
<nowiki>===Second level section==</nowiki>
  
====Third level section====
 
  
==Another Top Level section==
+
<nowiki>====Third level section====</nowiki>
 +
 
 +
 
 +
<nowiki>==Another Top Level section==</nowiki>
 +
 
  
</nowiki>
 
  
 
==Line/Paragraph markup==
 
==Line/Paragraph markup==
Line 27: Line 29:
 
There are various special kinds of lines.
 
There are various special kinds of lines.
  
<nowiki>
+
<nowiki>* Unordered List item</nowiki>
* Unordered List item
+
 
# Ordered list time
+
<nowiki># Ordered list time</nowiki>
# Another ordered list item
+
 
  Preformatted line wth two spaces in front
+
<nowiki># Another ordered list item</nowiki>
  Another pre-formated line. (a line that doesn't start with anything funny will be joined into the previous line unless there's whitespace in between).
+
<pre><nowiki>  Preformatted line wth two spaces in front</nowiki></pre>
</nowiki>
+
 
 +
If you put list items next to one another without whitespace, they will descend appropriately, and you can combine list references to control that descent.
 +
 
 
Examples:
 
Examples:
  
Line 39: Line 43:
 
# Ordered list time
 
# Ordered list time
 
# Another ordered list item
 
# Another ordered list item
 +
##Two levels of order
 +
##*And a list item under that.
  
 
You can also create tables using either standard HTML syntax (a bunch of standard HTML syntax is usable) or often better, special wiki syntax:
 
You can also create tables using either standard HTML syntax (a bunch of standard HTML syntax is usable) or often better, special wiki syntax:
 
<nowiki>
 
<nowiki>
 
{|border=1
 
{|border=1
One||Two||Three
+
|One||Two||Three
 
|-
 
|-
1||2||3
+
|1||2||3
 
|}</nowiki>
 
|}</nowiki>
  
 
{|border=1
 
{|border=1
One||Two||Three
+
|One||Two||Three
 
|-
 
|-
1||2||3
+
|1||2||3
 
|}
 
|}
  
Line 57: Line 63:
 
As above, a bunch of html works, but single quote and a few other things provide easier to write emphasis:
 
As above, a bunch of html works, but single quote and a few other things provide easier to write emphasis:
  
'Bold'
+
* ''Italic''
''Italic''
+
* '''Bold'''
'''Bold and Italic'''
+
*  ''''Bold and Italic'''
  
 
==Links==
 
==Links==
Line 65: Line 71:
 
To refer to another page, use two square brackets <nowki>[[Other Page]]</nowiki>.  To refer to a category, use [[:Category:Recipes]].  To refer to an uploaded file, use <nowiki>[[:File:Filename]]</nowiki>.
 
To refer to another page, use two square brackets <nowki>[[Other Page]]</nowiki>.  To refer to a category, use [[:Category:Recipes]].  To refer to an uploaded file, use <nowiki>[[:File:Filename]]</nowiki>.
  
To refer to an external site, use one square bracket <nowiki>[http://www.google.com|Google]</nowiki> ([http://www.google.com|Google]).
+
To refer to an external site, use one square bracket <nowiki>[http://www.google.com Google]</nowiki> ([http://www.google.com Google]).

Revision as of 12:47, 8 December 2016

Some best practices for editing and adding new pages on a wiki:

To add a new page: Generally you shouldn't use the "Create a page" button, but instead edit a page that should link to your new page to add the link (like this: [[My New Page]] or if you want the link to have a different text than the name of the page itself, [[Jane Newperson|my sister]]). Then save and click through to edit and create the text of your new page. You should also add categories appropriate to your new page, which will cause it to appear in the category pages that link together pages like that (and may mean that in the future we can have the magnet/section pages be automatically generated via the categories).

To add a new top level or second level section, do the same thing; edit the page that links to your new section page to link to it (you can also make links just because they should be there; they don't have to link to new pages) to add a reference to your new section, and then save and click through to add text to your new section heading.

There's also some very basic markup you'll want to know:

Page Organization

Use two or more = around section headings; these will appear in a toc unless you supress that. In general, you shouldn't use one = headers, since those are the markup for page headers (unless you want something to appear on the same level as a page header). A section heading won't be parsed unless it's on a line by itself.

Examples:

==Top Level section==

===Second level section==


====Third level section====


==Another Top Level section==


Line/Paragraph markup

There are various special kinds of lines.

* Unordered List item

# Ordered list time

# Another ordered list item

  Preformatted line wth two spaces in front

If you put list items next to one another without whitespace, they will descend appropriately, and you can combine list references to control that descent.

Examples:

  • Unordered List item
  1. Ordered list time
  2. Another ordered list item
    1. Two levels of order
      • And a list item under that.

You can also create tables using either standard HTML syntax (a bunch of standard HTML syntax is usable) or often better, special wiki syntax: {|border=1 |One||Two||Three |- |1||2||3 |}

One Two Three
1 2 3

Emphasis

As above, a bunch of html works, but single quote and a few other things provide easier to write emphasis:

  • Italic
  • Bold
  • 'Bold and Italic

Links

To refer to another page, use two square brackets <nowki>Other Page</nowiki>. To refer to a category, use Category:Recipes. To refer to an uploaded file, use [[:File:Filename]].

To refer to an external site, use one square bracket [http://www.google.com Google] (Google).