Help:Editing a Page

From Cissa.ca Wiki

(Redirected from Help:Editing)
Jump to: navigation, search

This page can show all the different ways to add styles to your wiki pages. Please note that this page is not editable (for obvious reasons). If you want to test these methods out (and we encourage you to do so before editing/creating an article, please visit the sandbox.

If we've left anything out, or have anything missing, please email the webmaster
Note: Most, if not all, of this information can be found at Wikipedia.
This is simply copied here for your convenience.

Contents

Creating a Page

MediaWiki recommends that in order to create a new page, first go to the page you want to link from. For instance, if I wanted to create a new page on the SCC, I would probably go to CISSA Info, and go to edit that page, putting in a link (described below) to CISSA SCC (as an example). This is done because otherwise the new page could become orphaned and difficult to locate in the future (in the process of readying this wiki, that couple times). The other, less recommended way, is to go directly to the intended page URL.

When you save changes, you can click on the newly created link (should be coloured red to indicate a non-existant page).

The same goes for creating different kinds of content, such as images (described below). Simply create a link to the content you wish to be displayed/used, and go to the link you created.

Basic Formatting

Basic formatting can be accomplished by using the simple controls located at the top of any edit box. However, to make it readibly understood, here are some quick tips.

  • ''italics'' appears as italics (2 apostrophes on both sides of the words you want italicized)
  • '''bold''' appears as bold (3 apostrophes on both sides of the words you want bolded)
  • '''''bolded italics''''' appears as bolded italics (5 apostrophes on both sides of the words you want bold italicized)


Also, you are able to use regular HTML tags to accomplish your formatting, such as <u>underline</u> to underline text

Creating Links

Linking to External Pages

There are 2 ways of displaying a link to an external page:

  • Display some link text
  • Display no link text


Displaying Link Text
[http://www.someurl.com/somepath/randomfile.ext Displayed text]

So that you get something like this!

Display no Link Text

If you choose to omit the text, you will be presented with a link that looks like a footnote reference, like this: [1]. It is best to use this style of linking only when providing a footnote link or other reference that doesn't require any informative text.

Linking to Internal Pages

To link to an article found within this wiki, you first need to know the article name (case sensitive), with or without the joining underscores. You then enclose that article name in double square braces ([[article]]). For instance, if I wanted to link to the CISSA Events article, I would type something like this:

[[CISSA Events|Text to make the link]]

Resulting in this look: Text to make the link

The official MediaWiki documentation states to create an internal link, while inside the square brackets, any text after the pipe (|) is optional. If the text after the pipe is omitted, the link will be created simply using the article name, such as CISSA Guides. If the optional name is omitted, for best appearance, you can omit the underscores.


Remember:  If you're creating an external link, use only 1 set of square brackets.
If you're creating an internal link, use 2 sets of square brackets.

Displaying Lists

Again, there are several different ways of displaying a list of data.

Bulleted Lists

To show a basic, bulleted list, you can do something like this:

* Item 1
* Item 2
* Item 3

By doing this, we will get a list such as:

  • Item 1
  • Item 2
  • Item 3

You can also have sub-items in you list by adding an additional asterisk:

* Item 1
* Item 2
** Item 2a
** Item 2b
*** Item 2bi
* Item 3

And we get:

  • Item 1
  • Item 2
    • Item 2a
    • Item 2b
      • Item 2bi
  • Item 3

As far as I know, there is no limit to how many sub-items you can have, but I'm sure at some point, one would start losing track of where they were :P

Numbered Lists

To create a numbered list, you put a hash symbol, pound sign, or whatever else they're called (#) at the beginning of the line, like this:

# Item 1
# Item 2
# Item 3

Displaying:

  1. Item 1
  2. Item 2
  3. Item 3

Again, as with a bulleted list, you can create a sub-item by adding an extra # symbol:

# Item 1
# Item 2
## Item 2a
## Item 2b
### Item 2bi
# Item 3

Displaying:

  1. Item 1
  2. Item 2
    1. Item 2a
    2. Item 2b
      1. Item 2bi
  3. Item 3

Simple Indentation

If you would like to indent your information, but don't require any formal listing, you are able to indent your text using the following method:

Item 1
:Item 2
::Item 2a
:Item 3

And we get:

Item 1

Item 2
Item 2a
Item 3

Displaying Images

The first way will display an image completly seperate from the rest of the content. The default way to display an image this way is using:

[[Image:CISSALogoTest.png]]

And we will see:

Image:CISSALogoTest.png

The other way to display an image is to display an inline image:

[[Image:CISSALogo.png|<alignment>|<maximum_size_in_px>|<thumbnail?>|<alt_text>]]

A point to note, is that <maximum_size> should properly scale the image, so quality loss is at a minimum. All of those extra parameters are of course optional. If everything is configured, we can get something like this:

CISSA Logo
Enlarge
CISSA Logo

Please note, than when using this method, any text placed afterwards will appear on the side of the image. To break out of this, just keep entering newlines until your new text is beyond the inline image.

There is no displaying of an external image. If you want an external image displayed, first make sure you have rights to reproduce it, and upload it.











Tables

Tables are rather interesting to create. It took a bit of searching to find out the wiki syntax to create a table. Still, not all table features are supported, like the <tbody>, <thead>, and <tfoot> tags. However, it supports most things, so here is the syntax:

{|

begins a table, and

|}

ends a table. These are the equivalent of <table>...</table>. After the {|, you can put any extra parameters in there, such as align, rules, style, padding, etc.


The next thing you do after that tag (and any extra parameters), is:

|-

which marks the first <tr>...</tr> section (let's say you wanted to do some table headers, for instance.

Next,

|

a single pipe character, marks a single <td>...</td> section.

For each | line you have in the first |- section, you need to have a | line in subsequent |- sections. The syntax for the | sections are:

|<extra parameters> (optional)|text to appear in field

If you don't need any extra parameters, you can just

|text to appear in field

When you are done entering the | sections, you mark the end of the |- with yet another |-. The only exception is when you are completing the final |- section.

Putting this all together:

{| align="center" rules="all" style="border:1px solid #000;width:45em;border-collapse:collapse;" cellpadding="4"
|-
|align="center" style="font-weight:bold;" bgcolor="lightgray"|Name
|align="center" style="font-weight:bold;" bgcolor="lightgray"|Age
|align="center" style="font-weight:bold;" bgcolor="lightgray"|Gender
|-
|align="center"|Bob McBob
|align="center"|27
|align="center"|Male
|-
|align="center"|Shirley Yule
|align="center"|40
|align="center"|Female
|}

will produce the following:

Name Age Gender
Bob McBob 27 Male
Shirley Yule 40 Female

Special Features

Comment Boxes

While reading this, you've probably noticed some boxes scattered around, looking like this:

Some text to read!

This is very, very simple to add. All you need to do is put an extra space at the beginning of the sentance. If the sentance/paragraph is getting very long, you will need to put some of it on a new line, so it looks proper on lower resolutions. Remember again to put a space at the beginning of every line you want to be displayed inside the indented box, otherwise you'll end up with:

Some text that is being

displayed within a box.

When displaying an inline image with one of these boxes next to it, this is the behaviour:

CISSA Logo
Enlarge
CISSA Logo
Please note how the leftmost portion of
this area is covered by the image box.





Table of Contents

A TOC is automatically added when there are 4 or more headers in the document (lines starting/ending with at least 2 equal signs (=)

Alternatively, you can force a TOC by either putting __FORCETOC__ anywhere in the document, or by placing __TOC__ in the document where you want the TOC to be displayed.


Also, to remove a TOC, place __NOTOC__ anywhere in the document.


Displaying Wiki-code as Plain HTML

During the course of this Help, there have been many instances where Wiki-code is displayed directly to you. This can be accomplished by using the <nowiki>Wiki-code</nowiki> command. If you were to see:

''This text is not italicized''

You would assume either the <nowiki> tag was used, or the editor used HTML codes (very cumbersome if doing a lot of Wiki-code you want displayed).


Anything Else

If the styling question you want answered is not covered here, please email the webmaster, post on the discussion page, or read the MediaWiki documentation.

Personal tools