# Documentation:About cIRcle Editing Guide

Jump to: navigation, search

This page is intended as a quick reference for useful documentation pages to assist with the creation of cIRcle Wiki content. For more general Wiki/Wordpress documentation, see the Library's tutorial page

# Before You Start

• Categorize!

Add the category "Circle" to the bottom of your wiki page using the format: [[Category:categoryname]] (case and space sensitive!). See Help:Categories for more information.

• Watchlist

Click "Watch this page" at the bottom of each page you create, edit, or want to reference. You can then use the *Watchlist tab at the top of the Wiki page to navigate to quickly to all the pages you are working on. Note: You will receive updates about this page whenever it is edited so you may want to remove a page from your Watchlist if you no longer need it.

# "About cIRcle" Pages by Type

## Wiki-Embedded Pages

Edit content for these pages through the UBC Wiki. The easiest way to do this if you are looking at a page on the WordPress site (and are logged on as an admin) is to click the "in Wiki Embed List" link at the bottom of the page, and then click the link to the wiki listed under "URL." Note: you must previously also be logged in to edit the wiki, otherwise it will kick you back to the wiki homepage after you login (if you aren't logged in yet, ctrl+click the login button to open it in a new window, then refresh the page once you have logged in). After you've edited the wiki content and refreshed it on the WordPress page, return to the WordPress page and click "Edit" and then "Publish". This will ensure that the WordPress page displays the same last updated date as the Wiki. See below for instruction on editing wiki content.

About cIRcle Links ~ WordPress -- Wiki
Getting Started for Faculty ~ WordPress -- Wiki
Getting Started for Students ~ WordPress -- Wiki
Setting up a New cIRcle Community ~ WordPress -- Wiki
Licensing & Copyright ~ WordPress -- Wiki
User Guides ~ WordPress -- Wiki
FAQ ~ WordPress -- Wiki
Contact Us ~ WordPress -- Wiki

## WordPress-Only Pages

These pages are located only in Wordpress and need to be edited there. Most content can easily be edited using the built-in WYSIWYG editor, however, in order to properly preserve menus and anchored links on the Policies pages you may need to copy and paste some of the existing HTML. Forms need to be edited using the "Gravity Forms" plugin from the Wordpress admin dashboard. For details on editing each of these sections, see below.

Getting Started Launch Page
Policies (all pages)
Forms (all pages)
Note - Forms must be edited from the "Forms" section of the WP dashboard; NOT "Pages."

# Wiki editing

You can format your text using the formatting toolbar or wiki markup. Wiki markup can be thought of as a simplified version of html and it consists of normal characters like asterisks, single quotes or equation marks which have a special function in the wiki. For example, to format a word in italic, you include it in two single quotes like ''this''.

## Text Formatting

Description You type You get
character (inline) formatting – applies anywhere
Italic text ''italic'' italic
Bold text '''bold''' bold
Bold and italic '''''bold & italic''''' bold & italic
Ignore wiki markup <nowiki>no ''markup''</nowiki> no ''markup''
section formatting – only at the beginning of the line
Preformatted text
 preformatted text is done with
a '''space''' at the
''beginning'' of the line


This way of preformatting only applies to section formatting, and character formatting markups are still effective.

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


## Organizing

### Headers & Lines

Description You type You get
section formatting – only at the beginning of the line (with no leading spaces)
Headings of different levels
=level 1=
==level 2==
===level 3===
====level 4====
=====level 5=====
======level 6======


Level 1 is normally set aside for the article title. An article with 4 or more headings automatically creates a table of contents.

Level 1
Level 2
Level 3
Level 4
Level 5
Level 6
Horizontal rule ----

### Lists

Description You type You get
section formatting – only at the beginning of the line (with no leading spaces)
Bullet list
* one
* two
* three
** three point one
** three point two


Inserting a blank line will end the first list and start another.

• one
• two
• three
• three point one
• three point two
Numbered list
# one
# two<br />spanning more lines<br />doesn't break numbering
# three
## three point one
## three point two

1. one
2. two
spanning more lines
doesn't break numbering
3. three
1. three point one
2. three point two
Definition list
;item 1
: definition 1
;item 2
: definition 2-1
: definition 2-2

item 1
definition 1
item 2
definition 2-1
definition 2-2
Adopting definition list to indent text
: Single indent
:: Double indent
::::: Multiple indent


This workaround may be controversial from the viewpoint of accessibility.

Single indent
Double indent
Multiple indent
Mixture of different types of list
# one
# two
#* two point one
#* two point two
# three
#; three item one
#: three def one
# four
#: four def one
#: this rather looks like the continuation of # four
#: and thus often used instead of <br />
# five
## five sub 1
### five sub 1 sub 1
## five sub 2

;item 1
:* definition 1-1
:* definition 1-2
:
;item 2
:# definition 2-1
:# definition 2-2


The usage of #: and *: for breaking a line within an item may also be controversial.

1. one
2. two
• two point one
• two point two
3. three
three item one
three def one
4. four
four def one
this rather looks like the continuation of # four
often used instead of <br />
5. five
1. five sub 1
1. five sub 1 sub 1
2. five sub 2
item 1
• definition 1-1
• definition 1-2
item 2
1. definition 2-1
2. definition 2-2

For even more on list, check out Wikipedia's List Help article.

### Signatures

You should always sign your comments, though signatures can be inserted anywhere on a wiki page.

Description You type You get
character (inline) formatting – applies anywhere
Signature Three tildes for just a signature, ~~~ Three tildes for just a signature, Cynthia (UBC LSIT)
Signature with Date and Time Four tildes for your signature with date and time, ~~~~ Four tildes for your signature with date and time, Cynthia (UBC LSIT) 22:27, 26 May 2010 (UTC)
Only Date and Time Five tildes for date and time only, ~~~~~ Five tildes for date and time only, 22:27, 26 May 2010 (UTC)
• Note: Once you save, the signature and date/time are automatically created. The next time someone edits, it no longer show the tildes.

## Links

• Please see Help:Links for detailed information on creating hyperlinks

## Paragraphs

MediaWiki ignores single line breaks. To start a new paragraph, leave an empty line. You can force a line break within a paragraph with the HTML tags <br />.

## HTML Formatting

Some HTML tags are allowed in MediaWiki, for example <code>, <div>, <span> and <font>. These apply anywhere you insert them.

Description You type You get
Underscore <u>underscore</u> underscore
Strikethrough <del>Strikethrough</del> or <s>Strikethrough</s> Strikethrough
Fixed width text <tt>Fixed width text</tt> or <code>source code</code> Fixed width text or source code
Blockquotes

text text text text text text text text text text text text text text text text text text text text text text text text <blockquote> quote quote quote quote quote quote </blockquote> text text text text text text text text text text text text

text text text text text text text text text text text text text text text text text text text text text text text text

quote quote quote quote quote quote

text text text text text text text text text text text text
Typewriter font
Puts text in a <tt>typewriter
font</tt>. The same font is
generally used for <code>
computer code</code>.

Puts the text in a typewriter

font. The same font is generally used for computer code.

Superscripts and Subscripts
X<sup>2</sup>, H<sub>2</sub>O

X2, H2O
Centered text
<center>Centered text</center>
* Please note the American spelling of "center".

Centered text
Comment <!-- This is a comment -->

Text can only be viewed in the edit window.

Completely preformatted text
<pre>this way, all markups are '''ignored'''</pre>

 this way, all markups are '''ignored'''.

Customized preformatted text

<pre style="CSS text">this way, all markups are '''ignored''' and formatted with a CSS text</pre>

this way, all markups are '''ignored'''
and formatted with a CSS text


## Mathematical formulas

MediaWiki allows you to use LaTeX to insert mathematical formulae by typing in $Formula here$. Included here are a couple of examples and commonly used functions and expressions.

What you type What it looks like
Superscript $a^2$ 
Subscript $a_3$ 
Grouping $a_{x,y}$ 
Combination $a_3^2 or {a_3}^2$  or 
Root $([n] is optional) \sqrt[n]{x}$ 
Fraction $\frac{3}{4}=0.75 or (small) \tfrac{1}{3}=0.\bar{3}$  or (small) 
More Complex Example $\sum_{n=0}^\infty \frac{x^n}{n!}$ 

See WikiMedia's Help on Displaying a Formula for a full article on using TeX to display formulae. Beginning at Section 3 (Functions, symbols, special characters) is a comprehensive list of all the symbols.

## Footnotes

You can add footnotes to sentences using the ref tag -- this is especially good for citing a source.

What it looks like What you type
There are over six billion people in the world.[1] References:
1. CIA World Factbook, 2006.
There are over six billion people in the world.<ref>CIA World Factbook, 2006.</ref> References: <references/>

See Also: Help:Footnotes and References

There are two main types of links that can be created on the the UBC Wiki:

1. internal links to other pages in the wiki
2. external links to other websites

## Internal links

To add an internal link, enclose the name of the page you want to link to in double square brackets. When you save the page, you'll see the new link pointing to your page. If the page exists already it is displayed in blue, if it does not, in red. Selflinks to the current page are not transformed in URLs but displayed in bold. (If you really want to link to the current page, use an anchor (see below), or [[#top|current page]] which always links to the top.)

The first letter of the target page is automatically capitalized, unless otherwise set by the admins, and spaces are represented as underscores (typing an underscore in the link will have a similar effect as typing a space, but is not recommended, since the underscore will also be shown in the text).

Description You type You get
Internal link
[[Main Page]]

Main Page
Piped link
[[Main Page|different text]]

different text
Shortened sort-of-piped link
[[Internationalisation]]s

Internationalisations
Redirect
#REDIRECT [[Main Page]]


See also Help:Redirects

Main Page
Internal link to an anchor
[[#See also]]


Section headings and the top of the page are automatically anchored.

#See also
Internal link to an anchor at another page
[[Help:Formatting#See also]]


If two or more anchors have the same name, add a number, example: #See also2

Help:Formatting#See also
Internal link to the current page's talk page
[[{{TALKPAGENAME}}|Discussion]]

Discussion
Internal link to a subpage
[[/example]]


Shortcut for [[Help:Links/example]]. See also Help:Subpages.

/example
Internal link to a subpage without the leading slash
[[/example/]]


Shortcut for [[Help:Links/example|example]].

example
Internal link to a category page
[[:Category:Help]]


See also Help:Categories

Category:Help
Direct link to an image, pdf, or other file type (rather than linking to the file page)
[[media:example.jpg]]

[[media:example.pdf]]


See also Help:Adding Media

media:example.jpg

media:example.pdf

Internal link to the user's user page
[[Special:MyPage]]

Special:MyPage