Tags & Formatting Guide

From KeystoneIntranet
Jump to navigation Jump to search

Table of Contents

A Table of Contents box (see above) is generated automatically by Wiki based on how you define sections (see below). You can suppress a table of contents on your current page by using two embedding NOTOC within two underscore characters. Example: __NOTOC__

You may alter where a table of contents appears on your page by embedding TOC within two underscore characters at the desired location. Example: __TOC__


Sections

Sections should be used to organize longer pages. Sections are defined by putting three equal signs (===) on each side of your section heading. You can create subsections by adding an equal sign before and after the section heading. On this page, for example, Symbols is a subsection of Fonts & Formatting. This was coded as:

===Fonts & Formatting===
...
====Symbols====
...


Categories

Categories are a way of grouping pages (for example, Payroll) in a reference. Any time a page is placed in a category, a link appears on the bottom of the page allowing the viewer to link back to that category. A page can be in multiple categories as well, thus a page could be in both PAYROLL and SETUP, and a user browsing either of those categories could find their way to the page. To include your page in a given category, use [[Category:CategoryName]]. To include a page in multiple categories, simply add additional tags.

To set up a page with a link to a category without including the page IN the category, prefix the word Category with a colon. For example: [[:Category:Setup]]

When a browser views a category, all pages will be in alphabetical order based on the page title. To change the sort order, add a pipe symbol following the category name. For example: [[:Category:Users|Jones, Bill]]


Comments

You can embed comments within the wiki code by using <!-- (comment here) --> These comments WILL NOT appear on the wiki screen, but are stored in the code so subsequent editors can view your remarks.


Links

You can set up a link by embedding the word within double brackets and can be used in the flow of your text.

For example [[Payroll Setup]] requires ... will generate the text:

Payroll Setup requires ...


You can also assign an alias to your link using the pipe symbol. The page that is actually linked appears before the pipe symbol, while the text to display appears afterwards.

For example [[Payroll Setup|Setup your payroll]] by clicking on... will generate the following text:

Setup your payroll by clicking on...


Transclusions

Transclusions are a way to embed entire pages within the current document. This is accomplished by placing double braces and a leading colon around the link to be included in your current page.

For example, {{:Transclusion Example}}

Template:Transclusion Example

Images

Images must be uploaded using the UPLOAD FILE link on the Toolbox. It is better to upload the image file prior to referencing the IMAGE tag. The format for the IMAGE tag is as follows:

[[IMAGE:{name}|{type}|{location}|{size}|{caption}]]

{name} is a required field. It contains the image name as it is known to Wiki when imported.

{type} is an optional field. It may contain the word THUMB if you wish to show a thumbnail version of the image.

{location} is an optional field. It may contain the parameters LEFT, RIGHT or CENTER, representing the alignment of the image.

{size} is an optional field representing the desired image size in pixels and must be suffixed with px. For example: 120px.

{caption} is an optional field containing the caption for the image.

For more information on images, click here: http://en.wikipedia.org/wiki/Wikipedia:Extended_image_syntax


Fonts & Formatting

Boldfaced text is accomplished by embedding text within three apostrophes ('''), or you can use the standard HTML markup tags of <b> and </b>.

Italicized text is accomplished by embedding text within two apostrohes (''), or you can use the standard HTML markup tags of <i> and </i>.

Boldfaced & Italicized text is accomplished by embedding text within five apostrophes ('''''), or you can use the standard HTML markup tags of <b><i> and </i></b>.

Underlining text is accomplished by embedding text within <u> and </u>

Typewriter font is accomplished by embedding text within <tt> and </tt>

Centering text is accomplished by embedding text within <center> and </center>

Strike-through is accomplished by embedding text within <strike> and </strike>

You can get Superscripts by embedding text within <sup> and </sup> and subscripts by using <sub> and </sub>

You can get small text by embedding text within <small> and </small> - this is especially useful for image captions.

blockquote is used to set up a paragraph which indent both margins when needed instead of the

left margin only as the colon does. This is accomplished by embeddeding text with <blockquote> and </blockquote>

To disable any parsing of tags by Wiki, use the the <nowiki> and </nowiki> tags around your text. It will still reformat your text however.

To disable parsing and text reformatting, use the <PRE> and </PRE> tags around your text. This will display all text within a box in the exact manner in which it is entered.

For example, <pre>Code segment goes in here</pre> generates : 

Code segment goes in here


Symbols

Trademark ™ is generated by embedded the word trade within & and ;

Copyright © is generated by embedding the word copy within & and ;

Registered ® is generated by embedding the word reg within & and ;


Tables

Tables are a combination of HTML and text code. The table must {be enclosed within braces}

HTML code can be used for setting border width, spacing, padding and alignment.

Each new column must be preceeded by a pipe symbol (for normal text) or an exclamation point (for boldface text).

Each new row entry must be preceeded by a hyphen.

Note: There is no merge/split cells possible within a Wiki table as there is with HTML.


The table below was generated by the following code: 

{| border="5" cellspacing="0" cellpadding="5" align="center"
! This
! is
|- 
| a
| table
|-
|}
This is
a table
[Click here for more table help.]

Unordered Lists

Leading asterisks generate bullet points for unordered lists. Additional asterisks generate indented bullet points.

  • Element 1 (this element was preceeded by *)
    • Sub-element of Element 1 (this element was preceeded by **)
  • Element 2 (this element was preceded by *)
    • Sub-element of Element (this element was preceeded by **)
      • Sub-element of sub-element of Element 2 (this element was preceeded by ***)
  • Element 3 (this element was preceeded by *)


Numbered Lists

Numbered lists work by using the pound sign.

  1. Item 1 (preceeded by #)
  2. Item 2 (preceeded by #)
    1. Item 2.1 (preceeded by ##)
      1. Item 2.1.1 (preceeded by ###)
    2. Item 2.2 (preceeded by ##)
  3. Item 3 (preceeded by #)


Paragraph Indentation

Indenting sentences is equally easy, using a colon as a prefix.

Indent 1 (preceeded by :)
Indent 2 (preceeded by ::)
Indent 3 (preceeded by :::)


Terms & Definitions

Defining terms is accomplished by prefixing your term (word(s) to be defined) with a semi-colon, then prefixing the definition itself with a colon. The term is automatically boldfaced and the definition is automatically indented on the line below. For example:

squirrel-boy (preceeded by a ;)
a male human obsessed or taunted by squirrels. (preceeded by a :)
Retrieved from "http://in.compucrete.com/index.php?title=Tags_%26_Formatting_Guide&oldid=646"