Difference between revisions of "Formatting Tips"

Latest revision as of 20:24, 4 August 2016

The best thing to do is to look at the existing pages to see how they were formatted with codes. Find a page that matches the style you want to use and edit it to see what codes were used and how they were used.

This page lists some common formatting tags used when creating the training content that already exists on this page. You can also click on some formatting buttons that appear at the top of the page editor, which provides some of the most commonly used formatting marks. But, again, editing an existing page that has what you want to use is probably the best way... and just experimenting. Have fun!!

Note that a table of contents box automatically appears when more than three sections are used (see Table of Contents)...

[edit] Link to Other Pages

[edit] Linking to Internal Wiki Pages

Let's say you want to link to another page within our Training Wiki site. To do this, type two open square brackets "[[", type the name of the page as it displays on the top of that page, and type two closed square brackets "]]" like this:

[[Retain Deletion Management]]

On the Read page, it would like like this: Retain Deletion Management

What if you want to link to a specific section within a given internal Wiki page? For example maybe I want to link to the "Quick Find" section on the Retain Search page? Or, maybe I want to link to a page that has "Level 2" content.
To do this, type two open square brackets "[[", type the name of the page as it displays on the top of that page, follow that with the pound sign "#" and then the name of the section (if the section name consists of multiple words, use underscores between each word), and then type two closed square brackets "]]" like this:

[[Retain Search#Quick_Find]]

It would like like this on the Read page: Retain Search#Quick_Find

If you do not want the "underscore" character to display, you can add the pipe character "|" followed by the way you want it displayed:

[[Retain Search#Quick_Find|Quick Find]]

It would look like this on the Read page: Quick Find

For more detailed information on wiki linking, see http://www.mediawiki.org/wiki/Help:Links.

[edit] Linking to External Wiki or Web Pages

Let's say you want to create a hyperlink to another wiki or web page that is external to our Training Wiki system (i.e., KB articles). To do this, you simply start with an open square bracket "[", paste in the web page URL, type in your text for the hyperlink, and close it out with a closed square bracket "]", like this:

[http://support2.gwava.com/kb/?View=entry&EntryID=2425 "Where Data Is Store in Retain"].

This is what it would look like on the "Read" page: "Where Data Is Store in Retain"

For more detailed information on wiki linking, see http://www.mediawiki.org/wiki/Help:Links.

[edit] FONT COLOR (Example of blue)

<span style=color:0000ff>text</span>

For other color codes, CLICK HERE

[edit] BOX (for listing hands-on activities, etc)

This code:
<pre style="white-space: pre-wrap;

white-space: -moz-pre-wrap;

white-space: -pre-wrap;

white-space: -o-pre-wrap;

word-wrap: break-word;">

Your text goes here before the "</pre>" tag: Produces this box

</pre>

Produces this box

[edit] INDENTED BOX (for showing log entries, etc)

This box indents a little from the left. It is the same as the one above with the addition of two parameters: "margin-left:" and "width:"

<pre style="white-space: pre-wrap;

white-space: -moz-pre-wrap;

white-space: -pre-wrap;

white-space: -o-pre-wrap;

word-wrap: break-word;

margin-left: 2em;

width: 50%">

Produces this box
</pre>

Produces this box

[edit] Indented Box with Formatting

The pre tag allows you to use CSS Reference Standard, styling on the text

<pre style="white-space: pre-wrap;

white-space: -moz-pre-wrap;

white-space: -pre-wrap;

white-space: -o-pre-wrap;

word-wrap: break-word;

margin-left: 2em;

width: 50%;

font-size:medium;

font-weight: bold;">

</pre>

Alice was beginning to get very tired of sitting by her sister on the bank, and of having nothing to do: once or twice she had peeped into the book her sister was reading, but it had no pictures or conversations in it, 'and what is the use of a book,' thought Alice 'without pictures or conversations?'  So she was considering in her own mind (as well as she could, for the hot day made her feel very sleepy and stupid), whether the pleasure of making a daisy-chain would be worth the trouble of getting up and picking the daisies, when suddenly a White Rabbit with pink eyes ran close by her.  There was nothing so VERY remarkable in that; nor did Alice think it so VERY much out of the way to hear the Rabbit say to itself, 'Oh dear! Oh dear! I shall be late!'

[edit] TABLE

1L	private static final long serialVersionUID
1	private static final short STATE_DELETED
2	private static final short STATE_LITIGATIONHOLD
4	private static final short STATE_READ
8	private static final short STATE_UPDATE
16	private static final short STATE_SUBJECTHTML
32	private static final short STATE_ATTACHMENTS
64	private static final short STATE_HASTAG

[edit] ADDING A SCREENSHOT

1. Near the bottom of the left-hand navigation pane, click on "Upload File".
2. Browse for and select the source filename.
3. Either copy the "Destination filename" or make a note of it. It will be the "FILENAME" in your link (see step 4).
4. In your Wiki page, add:[[file:FILENAME||||border]]

(if you are editing this page to see the samples, ignore the "<nowiki>" tags - those allow this page to display the literal wiki code)

[edit] BULLET POINTS

To create numbered bullet points put # at the beginning of the line.

Example:

1. First
2. Second
3. Third

This looks like:

#First

#Second

#Third

In code (without the additional line spaces, see the edit for the proper example)

For circle bullets use the <ul> tag. It will look like this:

• First
• Second
• Third

Encoded:

<ul>

<li>First</li>

<li>Second</li>

<li>Third</li>

</ul>

Or, you know, check out the list/bullet section of the wiki: Wiki Help: List