You are here

Help

Wiki Help


So you want to help out on the StarBreak Wiki? Great! Let's get started.

Your best resource for wiki formatting codes is: http://daringfireball.net/projects/markdown/syntax

However, we have also made frequent use of some HTML formats that are not on there. Here are some of the more common ones:

Page Heading


You may notice that pages have a large white heading with a line under them. In order to keep a consistent theme, please begin your pages with the following code:
<h1 style="color:#ffffff">PAGENAMEHERE</h1><hr/>

Horizontal Rules

Horizontal rules, which look like


can be added by typing
<hr/>

Page Creation

In order to create (and link to a new or existing) page, use the markup:
[Example Page](/?q=wiki/Example_Page/) which looks like:
Example Page


Section Headings

Headings can be created by putting various amounts of # before it:

#H1

##H2

###H3

####H4

Two ## then a horizontal rule works best for top level sections. Use increasing numbers for lower level sections.


Pictures

  1. Choose a file to upload (e.g., TestImage.png)
  2. In the content, insert an img source URL that conforms with the following formatting guidelines:
  3. <img src="http://www.crunchy.com/sites/default/files/[ImageName]"/>
  4. so in our above example, use
  5. <img src="http://www.crunchy.com/sites/default/files/TestImage.png"/>
  6. Never, ever, EVER, remove the uploaded image from the wiki content

The way that our website works, if images are removed from the associated content then the file is deleted from our server. What I ended up doing is hiding the upload widget on the wiki content so the image isn't duplicated. But if you do delete the image from the content page, having the inline URL will NOT keep the file around and it will be removed for our server. So please be careful.

We do backup our server, but I will not be performing a restore to recover an accidentally deleted image from the wiki. As such, I would strongly recommend that anyone interested in maintaining the wiki keep copies of the images so you can manually correct any accidentally deleted images. Thanks. - Nirolo

Bold Text

text can be made bold by surrounding it with <b></b>
<b>like this</b>


Lists

there are two kinds of lists, Ordered (Numbered) lists, and Unordered (Bulleted) Lists.
Ordered lists: surround list items with <ol></ol>
Urdered lists: surround list items with <ul></ul>

List Items

in order for a word or phrase to have a number or bullet in front of it, surround it with <li></li>
For more help on lists, look at the Example Page.

Blank Lines

Use <br/>to make a blank line

Notices

Notices should be used to give important information about a page, such as it containing incorrect or outdated information, or being in need of expansion. Notices should always include a reason for the notice, the action required before the notice can be removed, and the last date at which it was confirmed valid. Notices should have a horizontal rule below them, and always be the first thing on a page after the page heading. For example:

Page Title


NOTICE TO ALL READING THIS PAGE:

This page contains outdated information. Some of it may not be reliable. Please consider updating it if you have current information and time to spend.

If all information is updated, this notice can be removed. It remains valid as of 10/23/2015.


Source:

<h1 style="color:#ffffff">Items</h1> <hr/>

**NOTICE TO ALL READING THIS PAGE:**

This page contains outdated information. Some of it may not be reliable. Please consider updating it if you have current information and time to spend.

If all information is updated, this notice can be removed. It remains valid as of 12/9/2015. <hr />


Anchors

Some work is required to set up anchors, but once that is done, they can be referenced by hyperlinks elsewhere in the wiki. For your information, all source code for images in the Image Directory is already configured for use with anchors.

To set up an anchor, put something like this at the beginning of what you want to link:

|a name='name'||/a| (replace line breaks with appropriate formatting)

You will need to remember what you put in the quotes, so make sure you insert something intuitive.

To link to the anchor, make a hyperlink to the desired page as usual, but add "#name" to the end of the URL. For links on the same page as the anchor, one can also link directly to the anchor using only the # tag. Note that you will need to insert "%20" wherever a space is supposed to occur when linking to anchors which have spaces in their names.

Example:

Anchors

I inserted an anchor called Anchors at the beginning of this section, and clicking on the link will take you back up to it.

Source:

[Anchors](#Anchors)

There is a second method of establishing and linking to anchors, but its mechanisms are similar and should not be hard to grasp. The Wildfire Equipment page's source code has good examples of it - look for "a href" and "span id".