Loading...
 

Editor guide

Wiki-Syntax


Formatting a wiki article is slightly different from formatting in a standard word processor. Tiki Wiki uses a special formatting language that creates special effects based on use of special symbols. For example placing an ! point before a line of text will make that line a header like the "Wiki Syntax" line above this paragraph, and typing four hyphens (-) in a row on a single line will create a solid line like the one right above this paragraph.

Once you have an idea of how the basics work you should try out what you have learned in the Sandbox. You can freely experiment with syntax there without worrying about messing up any existing work.



Wiki-syntax links are arguably the single most important feature of wikis. Here is how they work. When you are editing a page, if you put a word inside of a set of double curly brackets, it will automatically make that word into a link to a page who's title is that word.

For example:
If you were to type ((user guide)).
You would get user guide, which is a link to a page on this wiki that is labeled "user guide", in this case that is this page.

If you make a link to a page that doesn't already exist, you can click the question mark that will appear next to that link and it will create that page for you! This is how you create a page From there you can edit it just like any other page. It's that easy.

You can also give the link a custom name while still linking to specifically named page.
If you were to type ((user guide|this is a custom named link to the page called user guide)).
You would get this is a custom named link to the page called user guide, which is still a link to the user guide page.


In addition you can link to external websites in exactly the same way but with single squared brackets.
So typing [http://www.google.com]
yields http://www.google.com.

And typing [http://www.google.com|example link to google]
yields example link to google.

Note: you must also include the http:// for external websites

Nomenclature (or how to name new pages)

Take care when creating new pages for something very generic sounding like "Student Accounts" as it could easily refer to many different types of student accounts, like email accounts, blackboard accounts, sirs accounts, etc..

A useful rule of thumb that we follow is to name pages with category prefix and a period.

For example:
Instead of making a page named Student Accounts
Make a page with a more specific name such as:
SIRS.Student Accounts
Blackboard.Student Accounts
Helpdesk.Student Accounts

Text Formatting


Most of the text formatting options that you will use are available on the top toolbar above the edit window. However it is still a good idea to be familiar with how it works since you will still have to see the formatting code even if you use the toolbar buttons.

Cheat Sheet

Desired FormattingSyntaxResult
Bold__text__text
Centered::text::
text
Color Font~~red:text~~text
Italic''text''text
Monospaced-+text+--+text+-
Underlined===text===text
Text Box^text^
text
Strikethrough text--text--text
Display syntax~np~__not bold__~/np~__not bold__

note that for italics the command is a double apostrophe on each side, not quotation marks

Tables

Tables (such as the cheat sheet right above) are easily created using the table builder button on the toolbar above the text area. Once a table is created it is pretty easy to make changes using the text editor.

Headers

Placing an ! point before a line of text will make that line a header like the "Wiki Syntax" line at the top of this page.Placing double !! before a line will make a slightly smaller header like the "Wiki-Syntax Links" header below that. And a triple exclamation point will make an even smaller sub-sub-heading such as the "Headers" line above this paragraph.

Table of contents

If you have a page with many headers, a table of contents is a useful navigational aid. Creating one is easy, just make a line with the tag {maketoc} and it will create a hierarchy sensitive table of contents for you, just like the one at the top of this page.

Indentation

Indentation is done by beginning a line with a ;: combination.
Example 1:
;:First example of indented text
produces:
;:First example of indented text


You can also put text in between the colons to serve as intro text.
Example 2:
;Intro Text: Second example of indented text
produces:
;Intro Text: Second example of indented text

Color Fonts

Text color is not restricted to the simple colors that we have common names for. If you are familiar with html color codes you can use those to define the color to be used instead of the word.

For example;
Typing ~~#F5A9BC:this text is pinkish~~
will yield this text is pinkish .

Superscript and Subscript

You can also use subscripts and superscripts by putting the text that you want inside of a set of special tags.

For example:
Typing {SUP()}This text is a super script{SUP}.
will yield This text is a super script.

And
Typing {SUB()}This text is a sub script.{SUB}
will yield This text is a sub script.


Bulleted and Numbered Lists

You can create a bulleted list by simply placing an asterisk (*) at the beginning of each line that you want bulleted, and a numbered list by placing a number sign (#) in the beginning of each numbered item.

Nested lists can also be created by using a double or triple set of asterisks or numbered sign.

For example,
typing
*This *is a *bulleted list ##This ##is a ##nested numbered list

yields

  • This
  • is a
  • bulleted list
    1. This
    2. is a
    3. nested numbered list


Inserting Images

  • The easiest way to insert images is to hit one of the edit page buttons to take you to the text editing screen. Put the cursor where you want the image to go.
  • Then push the button that looks like a picture above the edit field (to the right of the buttons for bold and italic text); this button is labeled Choose or upload images if you hover your mouse over it. A new window will pop up.
  • Either drag your image file over to the grey box in the new pop up window, or push the Browse files button and select your image file that way.
  • Below that a thumbnail of your image will appear, and bellow that an Uploadbutton, though you might have to scroll down slightly. Push the Upload button.
  • Now the confusing part. Click right onto the thumbnail and the window will disappear.
  • You will see that where the cursor was there is now some fresh gibberish, this is the wiki code for your image. You don't have to do anything with this. Just hit the save button at the bottom and check to see if your page looks correct.

Once an image is on the page there will be a little green puzzle piece icon next to it, you can use that to freely modify the way the image is displayed later, for example you can make the thumbnail any size you want.
MVtiki Logo

Youtube Videos

You can also easily embed youtube videos like so:
{YOUTUBE(movie=G1TuB5P4Ypw,width=>425,height=>350,quality=>high, allowFullScreen=y)}{YOUTUBE}

or
{YOUTUBE(movie=http://www.youtube.com/watch?v=G1TuB5P4Ypw,width=>425,height=>350,quality=>high, allowFullScreen=y)}{YOUTUBE}

Just replace the bolded characters after the equal sign in movie=G1TuB5P4Ypw with either the entire url of the video that you want or just the stuff that is after the equal sign of that url.
Either way the result should look like this:



Uploading files

If you would like to contribute a file to be stored on the wiki the easiest and most organized way to do so is the use the 'Attach File' button at the bottom of each page.

You can also upload files directly to file galleries but we prefer that you not do that because it is both less organized and it seems to not allow uploads of .docx files.

Categories - (i.e. private sections)

Categories are special sections of the site that can be set up to have special restrictions for who is allowed to see or edit them. Any wiki page can be placed into a category using the Categories tab at the top of the edit window. If the user has permissions for a category he will be able to check the box for that category there. Categories can be configured to have a different appearance so that one is able to easily tell at a glance whether a page is in public section of the site or not.
If you would like a category created (for inner department use or whatever) please contact Sergey Staskevich at sstaskevich at mvcc.edu.

Deleting pages

Currently for security purposes only administrators have permissions to delete a page entirely. If you need to have this done (it's no big deal) just send an email with a link to the pages that you want deleted to sstaskevich at mvcc.edu

User Pages

A user page is just like any other wiki page except that only the owner of that page (or an administrator) can edit it. This is a useful place to put things such as office hours, contact information, links to syllabuses, or anything else that you want to put there.

Here is how you create your own user page:
  1. Click here.
  2. On the right side of the box you will see User-yourusername?. See that questionmark at the end? Click that!
  3. Done! Put in whatever information you want into there.
There is a very in depth but slightly bloated tiki wiki markup language guide here.

Also, there is a very nice first time user tutorial on wiki markup here. There are a few major differences between their wiki markup language and ours but it is still a fantastic introduction to the basic concepts.