Help:Contents

From PBX Wiki

Overview

This is a nice simple explanation of how to add a Wiki Article. It's an idea only at the moment, not a standard, and is sure to change in the future.

Adding the Article

If you use the search pane to the left to find an article and the article does not yet exist, then you are given the option to "create this page". It's a link to the editing of the article. Click it and the editing window will be shown. This is where you can put the content of the article in, as well as the formatting.

Basic Layout

For the first few articles on this Wiki site, the basic layout has followed a standard format:

==Overview==

[some content here describing what the article is about]

==PBX Programming Prodedures==

[Examples of how to execute commands in a PBX]

==References==

[Documents referenced (manuals) with document numbers]

[[Category:Category Information]]

So what does it all mean?

Basic Formatting

Below are some of the basics of editing a Wiki article.

Sections, Subsections etc.

The first part of formatting a Wiki article is the section headings. Start with two equals signs (==) type the title of the section and end with two more equals signs (==). Voila! you now have a section heading. It also places a link to that section in a table of contents automatically with no extra work on your part.

To create a sub-section you can use three equals signs (===) the name of the subsection and three more equals signs (===). to create a sub-subsection you could use four equals signs (====) and so on and so forth.

Example Wiki Code

==My First Section==
content
===My First Sub Section
content
====My First Sub-Sub Section====
content
===My Second Sub Section===
content
==My Second Section===
content

If you were to create this page you would see a very simple Wiki article.

Internal Links

Another common function of Wiki articles is linking to another Wiki article. This is an internal link. To create an internal link, just put two brackets ([[) around the article title you wish to link to, followed by two closing brackets (]]). Here's an example to link to the LOGI article:

Example Wiki Code

[[LOGI]]

Example Internal Link
LOGI

Lists

There are two major types of lists. Numbered, and bulleted.

Numbered Lists

Numbered lists are very simple. Merely precede each line with a number sign (#) and the page will automatically create a numbered list. Use more number signs to indent the item.

Example Wiki Code

#First thing
##First sub-thing
#Second Thing
#Third Thing
##Third Sub Thing
###Third Sub Sub Thing

Example Wiki Output

1. First thing
   1. First sub-thing
2. Second Thing
3. Third Thing
   1. Third Sub Thing
      1. Third Sub Sub Thing

Bulleted Lists

Bulleted lists are just as easy. Just precede the line with an asterisk (*) and the page will automatically create a bulleted list. Use more asterisks to indent the item.

Example Wiki Code

*First Thing
**First Sub Thing
***First Sub Sub Thing
**First Second Sub Thing (if that makes sense)
*Second Thing
**Second Sub Thing

Example Wiki Output

• First Thing
  • First Sub Thing
    • First Sub Sub Thing
  • First Second Sub Thing (if that makes sense)
• Second Thing
  • Second Sub Thing

Bold and Itallics

To denote certain important words, you may wish to bold them or italicize them.

Bold Words

To make a word bold, encompass it with three single quotation marks (')

Example Wiki Code

'''This is my bold sentence'''

Example Wiki Output

This is my bold sentence

Italicized Words

To make a word italicized, encompass it with two single quotation marks (')

Example Wiki Code

''This is my italicized sentence''

Example Wiki Output

This is my italicized sentence

Pre-Formatted Output (Code)

In order to denote a terminal session with the PBX, it is usually helpful to remove Wiki formatting from the information. This can be accomplished two ways:

1. By leaving a leading space in front of each line
2. By using the HTML pre tags

Example 1 - Using leading space

I left one space before this line

Example 2 - Using the pre tags

I used the < pre > < /pre > tags here

Categories

Articles can be placed into categories. This allows other users to find them based on a general idea of what they are looking for, rather than a specific article name. To place an article in a category, use the following format:

[[Category:CategoryName]]

So, for example, if it's a Nortel PBX-related article, you could place it in the Nortel PBX category.

[[Category:Nortel PBX]]

See Also

To see Wikipedia's full article on editing Wiki pages follow this link:

• How to Edit a Page

To see an example of formatted Nortel-related article follow this link:

• Nortel Speed Call Lists

Too see a list of available Categories follow this link:

• List of Categories