Search Tips | Editing Guide

About this page

The Editing Guide serves as a knowledge base for maintaining this site. You will be able to find tips on formatting, as well as snippits of code that should be reused throughout the site.

Back to Top

Basic formatting

The most basic of formatting options are given to you at the top of the editing window, and will automatically apply the formatting codes described below to whatever you have selected in the editing window at the time.

To make	Use this...	And you'll get this...
Bold	This is some '''bold''' text	This is some bold text
Italic	This is some ''italic'' text	This is some italic text
List item	* This is a list item	• This is a list item

Back to Top

Line spacing

Use one or more empty lines to start a new paragraph.

Back to Top

Page structure

It's hard to predict what sort of content you might want to present in the pages you work on. However, it's necessary to define a consistent page structure. This structure, much like any page on a wiki, is a work in progress and may be subject to change down the road.

Keep your pages as simple and concise as possible. Use level two headers (!!) to divide your page up into sections. Try to limit your pages to anywhere between three and 10 major sections. Use a table of contents (see below) when it is appropriate.

Use pre-formatted structures ( and @@ ) when displaying code or shell commands.

Back to Top

Images

It is possible to upload images to use in your wiki page. Getting an image on a page is a two-step process:

Navigate to the page you want to add an image to. Click the Add File button. Upload the file to the wiki page.

Insert the following code, which will display the uploaded image.

>>rfloat<<
Attach:filename.jpg
This is the caption
>><<

This code will float the image to the right side, give it a lighter background, and add some padding. You'll want to insert this code right above the paragraph you want it to appear next to.

Back to Top

Table of contents

Help now has the PageTableOfContents plugin installed, so the only code needed to generate the table of contents is

(:toc:)

This code inserts the table of contents, and inserts anchors (see anchors section) above every header. You'll still have to insert links to go back to the top of the page. Insert them at the end of every major section.

[[#top|Back to top]]

Back to Top

Redirecting

Redirecting is used to automatically forward the user from one page to another. This is useful when you want to create a page that is similar in nature to another page, and forward viewers to that page. For example, the SFTP? and FTP? pages all forward to the YummyFTP? page. To accomplish this, create your new page and add this code and only this code as the content:

(:redirect GroupName.PageName:)

Back to Top

Anchors

Anchors are used to jump to a location farther down or up on the same page.

To define the location on the page you want to jump to, add [[#name]] to the end of the line. This identifies an exact location on the page.

To create the link used to get to this specific point (the anchor), use [[#name|linktext]].

The anchor cannot begin with a digit.

Incorrect: [[#2008]] Correct: [[#SN2008]]

Anchors are case sensitive, so the anchor and location markup must be the same. For example, the link will not work if the anchor is [[#SN2008]] and the link markup reads [[#sn2008|2008]].

Also, spaces will not work in an anchor.

Back to Top

Links

To link to a Web site outside the wiki, such as http://www.statenews.com, enclose it in brackets:

[[http://www.statenews.com]]

To change the link text, so it reads as The State News, add |linktext here to the end:

[[http://www.statenews.com|The State News]]

Back to Top

Tables

Tables can be used to organize data, such as on the State News Leaders page.

Creating a table requires both a start and an end tag:

Start: (:table:)

End: (:tableend:)

The first cell in each new row must start with (:cellnr:) and every cell after that should say (:cell:) in consecutive rows in the wiki.

Each cell goes on a consecutive line in the wiki markup. A space followed by the cell data go after each (:cell:) or (:cellnr:) tag, so the first two rows of the State News Leaders page looks like this:

(:table:)
(:cell:) '''2000s'''
(:cell:) '''1990s'''
(:cell:) '''1980s'''
(:cell:) '''1970s'''
(:cell:) '''1960s'''
(:cell:) '''1950s'''
(:cell:) '''< 1950'''
(:cellnr:) [[#SN2009|2009]]
(:cell:) [[#SN1999|1999]]
(:cell:) [[#SN1989|1989]]
(:cell:) [[#SN1979|1979]]
(:cell:) [[#SN1969|1969]]
(:cell:) [[#SN1958|1958]]
(:cell:) [[#SN1949|1949]]
(:tableend:)

If a cell is supposed to be empty, type in   to prevent errors in the table.

For more on tables, visit PmWiki page on table directives.

Back to Top