Wiki Formatting

From Flashpoint Database
Jump to: navigation, search

This page describes the most commonly used formatting options on the Flashpoint Wiki. For a comprehensive guide, see the MediaWiki Manual.

Sections

For top-level sections, use == Section Name ==.

For subsections, use === Subsection Name ===.

Lists

Create a bulleted list:

* Item one
* Item two

Create a numbered list:

# Item one
# Item two

Create a sub-list:

# Item one
#* Item one of bulleted sub-list
# Item two

If you need to create a numbered list with more than one line per item on the list, you may use an alternate format.

Surround each list item with the <li> tag, like this:

<li>
First line

Another line
</li>

Then, surround all of your list items with an <ol> tag, like this:

<ol>
<li>
First line

Another line
</li>

<li>
Another list item, for illustrative purposes
</li>
</ol>

Links

  • Link to an external webpage: [http://example.com/example.html Example Page].
  • Link to a page on this wiki: [[Main Page]].
  • Use custom text for a wiki link: [[Main Page|My Custom Text]]
  • Link to a specific section of a page on this wiki: [[Curation Format#Logo|My Custom Text]]
  • To link to a specific section of the current wiki page, omit the page name: [[#Links|My Custom Text]]

Custom Anchors

Using our template, you can add anchors to a page, so you can link directly to specific sections. This is used heavily on the Extended FAQ. To add an anchor, follow these steps:

  1. Choose the name for your anchor, which can be added to the wiki page's URL to link to the anchor's position on the page. For example, if this wiki page had an anchor called MyAnchor, the anchor link would be https://bluemaxima.org/flashpoint/datahub/Wiki_Formatting#MyAnchor.
  2. Choose the text to show at the anchor point. For example, on the extended FAQ, you would write the text of the question in the FAQ.
  3. Use the anchor template to write an anchor. Here is an example of a completed anchor: {{anchor|MyAnchor|How do I use an anchor?}}
  4. Add a link to your anchor using the format explained in the Links section. For example: [[#MyAnchor|How do I use an anchor?]].
  5. Combine the link with the anchor. To do this, replace the link text with the anchor you wrote in Step 3. For example, here is how you would combine the anchor from Step 3 with the link from Step 4: [[#MyAnchor|{{anchor|MyAnchor|How do I use an anchor?}}]]

Images

To add an image to a wiki page, you first need to upload an image. Log in, then go to the Upload page.

Once you've uploaded your image, use one of the forms explained in Upload to embed the image in a wiki page. For example, you might add this to the page you are editing:

[[File:Example_File.png|640px]]

Or, you may add multiple images to a gallery view, like this:

<gallery mode="traditional">
Image:ExampleImage1.jpg | Description one.
Image:Image2.PNG | Another description.
</gallery>

Code Blocks

To format a line with a fancy code block, simply add a space before the start of the line, like this:

 Line of code goes here

Adding a space before consecutive lines will make them part of the same code block.

If adding a space before every line gets tedious, or you want to preserve exact indentation, you can use the <pre> tag instead:

<pre>
Line of code goes here
    Another line, indented a bit.
Back to normal.
</pre>

For inline code blocks, you can use the <code> tag:

Normal text, <code>inline code</code>, normal text again!

Although code blocks are a nice way to highlight code, they will not prevent wiki formatting from being parsed. In order to stop the wiki parser from operating on a code block, you must add the <nowiki> tag inside the code block. Or, you may surround multiple lines with the <nowiki> tag, then add a space before the opening <nowiki> statement to surround the entire passage in a code block.

For some examples of how to use the <nowiki> tag, click "Edit" to see the wiki source of this page.