How to use Wiki Markup

	Contents Text Simple Formatting Ignore Formatting Lists Columns and Sections Tables caGrid Tables Simple Confluence Tables Links Images Standard Image Image with Caption Gallery Special Boxes

For a complete guide on text editing and Wiki markup for Confluence, see http://cagrid.org/renderer/notationhelp.action. This page will cover some basic editing tools with specific explanations and examples in regard to the cagrid.org site.

Text

Most simple text editing can be done easily using the Rich Text tab when editing a page. However, it is beneficial to know the wiki markup of text formatting in instances when the Rich Text editor cannot be used due to formatting issues or the use of macros.

Simple Formatting

To bold text, place a "*" on either side of the text that you want to bold. For example:

*This is bold text*

You can italicize and underline text. However, in accordance with caGrid notation standards, we ask that you refrain from such formatting unless absolutely necessary. Instead, please bold text for items that you would like italicized or underlined.

Alignment can be "left", "center", or "right." You can also align images to the right which will cause text to wrap around it. We will cover this in more detail in the Images section.

{align:center}
Here is some centered text
{align}

Ignore Formatting

To ignore any macros, brackets for links, #, *, or other formatting symbols, use a "\" before the desired symbol or macro.

\*This is not bold because there is a "\" before the first asterisk.*

Lists

Lists allow you to use bullets, numbers, or a combination of both to organize a series of ordered items.

* bullets
* are
* fun

# numbers
# are
# fun

* Some
* bullet
## indented
## numbers
* points
** indented
** bullets

Columns and Sections

Columns are particularly helpful when you want text next to images or a table. To create columns, use {column} before and after the content for the first column in the Wiki Markup tab of the page editor. Then use another {column} and add the content for the second column. After the content for the second column, use another {column} to close the column. You can create more than two columns by added more {columns} around additional content. However, keep in mind that with each additional column, the width of the columns will get smaller. If you want one column to be wider than another add the width parameter to the {column} macro (width is set to a percentage). If you only want to use columns for a certain part in the page, the use {section} before and after your columns to designate that section as the only part on the page as using columns.

{column}
Here is the content in the first column
{column}
{column}
Here is the content in the second column
{column}

{column:width=80%}
Here is the content in the first column
{column}
{column:width=20%}
Here is the content in the second column
{column}

If you only want to use columns for a certain part in the page, the use {section} before and after your columns to designate that section as the only part on the page as using columns.

Here is a bunch of text that I don't want in the columns. Notice how it is before the section macro.
{section}
{column}
Here is the content in the first column
{column}
{column}
Here is the content in the second column
{column}
{section}
Here is some more text that I want after the columns. Notice how it is after the section macro

Produces:

Here is a bunch of text that I don't want in the columns. Notice how it is before the section macro.

Here is some more text that I want after the columns. Notice how it is after the section macro

Tables

caGrid Tables

The caGrid.org also uses its own macro that offers more flexibility when creating tables. This macro has been used throughout this page to display the wiki notation and examples. If you see a table format on any of pages that you would like to use, it is sometimes helpful to select "Edit this page" to see the wiki markup for that table.

Here is a general format for caGrid tables:

{cagridtable}
{table-row}
{th:class=confluenceTh|colspan=2}*Dogs vs. Cats*{th}
{table-row}
{table-row}
{th:class=confluenceTh|colspan=1}*Dogs*{th}
{th:class=confluenceTh|colspan=1}*Cats*{th}
{table-row}
{table-row}
{cagridtablecell}
{align:center}
German Shepard
{align}
{cagridtablecell}
{cagridtablecell}
{align:center}
Siamese
{align}
{cagridtablecell}
{table-row}
{table-row}
{cagridtablecell}
{align:center}
Snoopy
{align}
{cagridtablecell}
{cagridtablecell}
{align:center}
Garfield
{align}
{cagridtablecell}
{table-row}
{table-row}
{cagridtablecell}
{align:center}
*Best Friend*
{align}
{cagridtablecell}
{cagridtablecell}
{align:center}
*Independent*
{align}
{cagridtablecell}
{table-row}
{cagridtable}

Notice above that general text editing still applies. You can align and bold text among other things. Table headers automatically are centered and colored in accordance with the "confluenceTh" as the set class. Headings can be set to span a specific number of columns. Also notice that all macros need to come before and after the content they are using or modifying. So when you want a new row, make sure you start with {table-row} and once all of the content has been added, you place another {table-row} at the end to "close" that row. The same applies for {cagridtablecell} and the entire {cagridtable}.

For tables that are too wide, add a

{div:class=horizscroll}

around the table. E.g.,

{div:class=horizscroll} 
{cagridtable}
{table-row}
...
...
...
{cagridtable}
{div}

See Special Boxes for an example.

Simple Confluence Tables

It is also possible to use Confluence style tables by denoting "||" around column headers and "|" around table cell content. Each row must be defined on a single line in the editor. According to caGrid Notation standards, we ask that you use this format sparingly and instead use the {cagridtable} macro.

||Heading 1||Heading 2||Heading 3||
|A1|A2|A3|
|B1|B2|B3|

Links

The general format for links is as follows:

[Title or text for link|spacekey:Page Name]

Make sure you have the correct spacekey and not the space title (for example, "cagrid13" not "caGrid 1.3").

• If you're linking to a page that is in the same space as the page that the link is on, then a spacekey is not needed. You would only need [Page Name] or [Text for Link|Page Name].
• If you want to link to a page in a different space, then you need to know the spacekey that the page is in. For example if you are creating a link on a page in the "introduce13" space and you want to refer to the page "Overview" (which is in the "introduce" space), then you would need this: [text for link|introduce:Overview]. The "text for link" could be "Overview" or anything else.

  It is very important to understand the concept of "spaces" so that your links will work properly. Always be aware of what space you are in and where you create pages. For more information on "spaces", see What are Spaces and Pages

So now if you want to reference any other page on the caGrid.org site, simply find the page you want and look at the URL for the spacekey and page name. It will always be:

https://cagrid.org/display/SPACEKEY/PAGE NAME

For example, look at the URL:

https://cagrid.org/display/knowledgebase/Getting+Started+with+caGrid+1.3

The spacekey is "knowledgebase" and the page name is "Getting Started with caGrid 1.3". You do not need the "+" for the page name in links so it would just be:

[Text of link|knowledgebase:Getting Started with caGrid 1.3]

You can also look at the breadcrumb for the title of the page.

If you want the link to point to a specific anchor or section on the page, use a "#" after the page name and then the heading title.
For example,

[Making going to the grid easy...|introduce:Overview#Making going to the grid easy...]

produces: Making going to the grid easy...
Note that you do not need to have the link title the same as the anchor/heading that is being pointed to.

Images

There are several options for displaying images on a page. Certain options may be more beneficial depending on your needs for the image on the page. However, caGrid notation standards ask that you use gallery as the primary choice for displaying images.

Before displaying the image, you must first attach it to the page you want to display it on. To do this select Edit->Attachments. In the attachments screen, Browse to the location of the image on your machine. Open the image and then select Attach File(s) to upload attach the image to the page. You can upload multiple images by selecting Attach more files and browsing to the additional images.

Once an image has been attached, you need to add the wiki markup on the page to display the image in one of several formats. The options for displaying the image are:

1. Standard full size image
2. An image with a caption
3. A gallery of images

Standard Image

For a standard full size image, use the following wiki format:

!image.gif! 

The "image.gif" is the file name of the image that you attached. Make sure you have the corresponding file type for the image (.gif,.jpg,.png) following the image name. You can also align the image by adding the alignment parameter:

!image.gif|align=center!

It is also possible to display an image that is attached to a different page by using the following format:

!spaceKey:Page Title^image.gif!

Image with Caption

For images with a caption, if there is a single size of the image, use {image-with-caption} macro:

{image-with-caption:tablealign=center|pagename=spaceKey:Page Name|attachmentname=image.png|caption=caBIG caGrid Portal}

Change the spaceKey and Page name to match the location of the attached image. If the image is attached to the current name, then the "attachmentname=" and "caption=" parameters are the only parameters needed.

Gallery

Galleries are a great way to show a small image or gallery of images that when clicked, expand into the full sized image. This is the preferred way for displaying images. Galleries can contain one or several images. We highly recommend using galleries to give your pages a clean and professional feel. You can add a title to the gallery by adding the "title=" parameter as seen in the second example.

{gallery:include=Right Menu.PNG,New Page Create.PNG}

{gallery:title=caGrid Pictures|include=Right Menu.PNG,New Page Create.PNG}

caGrid Pictures

Be aware that if you add a title, it will be included in the headings if you have a Table of Contents. To remove it from the table of contents, add the exclude parameter to the table of contents: {cagridtoc:exclude=GALLERY TITLE}

You can also only have on image in a gallery. Simply only include the wanted image in the gallery macro:

Notation {gallery:include=New Page Create.PNG}

Example

For a complete list of parameters that can be set for the {gallery} macro, see the "Images" section in the Notation Help

Special Boxes

There are several boxes that can be used around text:

Notation	Example
{noformat}Text that won't be edited by Confluence See: *this is not bold* but still has asterisks around it. It also places a blue box wit a dash outline around the text.{noformat}	Text that won't be edited by Confluence See: *this is not bold* but still has asterisks around it. It also places a blue box wit a dash outline around the text.
{code}Used for code{code}	Used for code
{code:xml}Used for XML code{code}	Used for XML code
{java}Used around Java code, also places Java symbol in corner{java}	Used around Java code, also places Java symbol in corner
{terminal}Used for commands in a command propmpt{terminal}	Used for commands in a command propmpt
{info}Puts a blue info box around text{info}	Puts a blue info box around text
{note}Puts a yellow note box around text{note}	Puts a yellow note box around text