Wiki Writing Reference

From ESE205 Wiki
Jump to: navigation, search

A Quick Guide to Wiki Writing

Introduction:

This guide is a quick reference for all of your wiki formatting needs. The goal is to help give you the tools to quickly and confidently organize and structure your wiki.

Headings:

Headings are an important tool for your wiki. They are a quick and easy way to make the various sections stand apart, while also helping you to organize your wiki into subcategories or themes. An example of a good place to use headings is in your weekly log, use it to separate each log entry or use it in your project wiki page to differentiate between Obstacles, Challenges, and Project Overview.

You can insert a heading with the format below:

== TEXT FOR HEADING HERE==

Additionally you can get different types of headings by adding additional equal signs (=) on either side. The maximum is 5 on either size, and as the number of equal signs increase, the size of the heading decreases. For example:


===TEXT FOR HEADING 2 ===

Becomes:

TEXT FOR HEADING 2

=====TEXT FOR HEADING 3=====

Becomes:

TEXT FOR HEADING 3

Text Manipulation:

Text manipulation such as bold and italics can help to draw emphasis to a specific word or phrase in your wiki.

You can bold words with the format below:

'''BOLDED TEXT'''

Becomes:

BOLDED TEXT

You can italicize words with the format below:

''ITALICIZIED TEXT''

Becomes:

ITALICIZIED TEXT

Indentation:

Indentation is a good way to make the information on your wiki clearer and easier to read.

You can indent a paragraph using the format below:

:The quick brown fox jumps over the lazy dog.

This will indent the entire paragraph like so:

The quick brown fox jumps over the lazy dog. The quick brown fox jumps over the lazy dog. The quick brown fox jumps over the lazy dog. The quick brown fox jumps over the lazy dog. The quick brown fox jumps over the lazy dog. The quick brown fox jumps over the lazy dog. The quick brown fox jumps over the lazy dog. The quick brown fox jumps over the lazy dog. The quick brown fox jumps over the lazy dog. The quick brown fox jumps over the lazy dog.

Don't want to indent a full paragraph? Why not try using bullet points instead? You can use bullet points using the format below:

*Bullet point text

In order to further indent bullet points, just add another asterisk (*)

*Bullet point text 1 indent
**Bullet point text 2 indent
***Bullet point text 3 indent

Becomes:

  • Bullet point text 1 indent
    • Bullet point text 2 indent
      • Bullet point text 3 indent

Links:

Using hyperlinks are a good way to allow the reader to get to a more in depth topic without bogging down your wiki page with unnecessary clutter. They can also be used in order to cite something, refer to code, or link to a webpage without using a big long URL.

You can link to a URL using the format below (we are linking back to this wiki guide):

[https://classes.engineering.wustl.edu/ese205/core/index.php?title=Quick_Wiki_Writing_Reference&action=submit TEXT THAT APPEARS AS THE HYPER LINK]

This would become:

TEXT THAT APPEARS AS THE HYPER LINK

Now lets make that a little bit neater:

[https://classes.engineering.wustl.edu/ese205/core/index.php?title=Quick_Wiki_Writing_Reference&action=submit LINK]

This would become: LINK

Pictures:

Pictures are a great way to convey a lot of information in a quick frame as well as providing a nice break to the text typically filling wikis. Before we can post a picture on our wiki page, we must first upload the picture to the wiki. You can do so by following the instructions here

After uploading, you can insert a picture using the format below:

[[File:GenericPic.jpg | 200px | thumb| left | Caption for Generic Photo]]

This would appear as so:

Caption for Generic Photo









We can change the picture by referencing a different file in the first section. The second section allows us to change the size. The third section sets the pictures format. The fourth section determines what side the picture will be on. The last section is the caption underneath the photo. Lets see if we can move the picture to the right and also make bigger. Using the code below:

[[File:GenericPic.jpg | 250px | thumb | right | Caption for Generic Photo]]

This code would become:

Caption for Generic Photo












You can do the same with video files as well, just substitute the picture file for video file.

[[File:GraviCaseArdunioBlink.mp4 | 300px | thumb | left | Basic Arduino Blink Program]]

This would become: