Help:Wiki Editing Help

From CoxGenealogy
Revision as of 21:03, 9 December 2007 by Seanmcox (talk | contribs) (Wiki Editing Help moved to Help:Wiki Editing Help: Belongs in Help namespace)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

Here is some basic instruction regarding wiki editing.

Simple Editing

The simplest thing you can do is just type out text. Text you type will generally appear just like you've types it. If you add a line break, it will generally not create a paragraph break. In order to create a paragraph break in the page, you should enter a blank line in the edit window. (Further blank lines in the edit window will add further blank lines in the page.) For example, if I type:

This is a long line of text that is word-wrapped will appear. The following line will be adjoined to this same paragraph.
This is a short line.

This is a line that follows a blank space.


This is a line that follows a large space.

The page, when viewed will appear as follows:

This is a long line of text that is word-wrapped will appear. The following line will be adjoined to this same paragraph. This is a short line.

This is a line that follows a blank space.


This is a line that follows a large space.

Section Headings

Basic Heading Markup

When working on a page which has any significant amount of content, it is sometimes nice to provide a section heading at appropriate locations.

Section headings can be marked with the following wiki markup:

==Title==

For example, the section heading for this portion of the Wiki Editing Help page was created with the following code:

== Section Headings ==

This code must be all that appears on the line in order to be interpreted correctly.

Subsections

Subsections may be more particularly denoted by adding further "=" characters to both sides of the title, as follows.

==First Level Heading==
===Second Level Heading===
====Third Level Heading====
=====Fourth Level Heading=====

Font Style

To make text italic, simply enclose the text in doubled single quotation marks. Markup such as this:

<code>''Italicized''</code>

will appear like this:

Italicized

For bold text use three single quotation marks and to make text bold and italics, put the two together using five quotation marks. Thus text like this:

<code>'''Bold and''' '''''italicized.'''''</code>

will appear like this:

Bold and italicized.

Links

Internal Links

A shorthand exists for internal links. In order to link to another wiki page in this system, just enclose the title of the page in doubled square brackets like so:

<code>[[Main Page]]</code>

This will come out looking as follows:

Main Page

If you want the text of the link to be different from the name of the page, add a pipe character "|" to the end of the name of the page and then type the link text like so:

<code>[[Main Page|Home Page]]</code>

This will come out looking as follows:

Home Page

External Links

To link to external files, the URL is enclosed in single square brackets like so:

<code>[http://www.theshtick.org/]</code>

Which will appear like this:

[1]

To set custom linked text, add a space after the URL followed by the desired text like so:

<code>[http://www.theshtick.org/ The Shtick]</code>

Which will appear like this:

The Shtick

Lists

Wiki markup also makes it easy to create various lists. There are three kinds of lists, ordered lists, unordered lists, and definition lists.

Ordered and Unordered Lists

To make an ordered list, simply put each item in the intended list on separate sequential lines and put a "#" character at the beginning of the line, like so:

#item 1
#item 2
#item 3

This could would appear as follows:

  1. item 1
  2. item 2
  3. item 3

For an unordered list, the asterisk ("*") would be used in the place of the "#", like so:

*item 1
*item 2
*item 3

Which would appear as follows:

  • item 1
  • item 2
  • item 3

Definition Lists

The definition list uses the semicolon (";") and the colon (":") alternately. The colon at the beginning of a line marks the line as a term to be defined while the semicolon line which follows marks a definition and is indented. For example:

;Fromage:The French word for "cheese".
;Queso:The Spanish word for "cheese".
;Queijo:The Portuguese word for "cheese".

which would appear as:

Fromage
The French word for "cheese".
Queso
The Spanish word for "cheese".
Queijo
The Portuguese word for "cheese".

Indenting with the Definition List

A definition list doesn't need to have terms to be defined. For this reason, the colon (":") can be used to indent an entire paragraph. In fact, this is the most common use of the definition list.

For example, the following:

:A long indented paragraph. Lorem ipsum something-or-other? Eu nao estou capaz de escrever utilizando a linqua Latina, mas o Portuguese nao e muito dificil. (Entretanto, o meu teclado nao faz com seja facil marcar os assentos e tal.)

appears like so:

A long indented paragraph. Lorem ipsum something-or-other? Eu nao estou capaz de escrever utilizando a linqua Latina, mas o Portuguese nao e muito dificil. (Entretanto, o meu teclado nao faz com seja facil marcar os assentos e tal.)

Special Considerations

Within a single line of code, the interpretation of wiki markup may be turned off briefly using the <nowiki> tag. Thus <nowiki>[[Main Page]]</nowiki> will appear as [[Main Page]] rather than Main Page.