How do I compose a Formatted FAQ using markup?

Markup is written in a basic text file, and you can use whichever text editor you want, even Notepad. As long as you include the proper markup, the guide will be converted to the new format automatically when it is uploaded into the editor.

A Formatted FAQ must have an extension of ".txt", and the following text as the first line of the file:


This line tells the editor to interpret the guide as a Formatted FAQ. Otherwise, it will be considered a standard text file and unable to be uploaded into the Formatted FAQ Editor.

How do I add markup to a Formatted FAQ?

Formatted FAQ markup is loosely based off of the WikiMedia Markup format, with customizations to better suit FAQ writing.

Basic Formatting
A double line break denotes a paragraph. More than two line breaks in a row are ignored, and will be considered a paragraph break. A single line break is treated as a regular space for ease of readability when creating markup. To make your text bold, use two apostrophes on either side of the text you want bolded. For italics, use three apostrophes. For bold and italic text, use five apostrophes.
Your Text:Is Displayed As:
Hello world


Hello world

How are you doing?

This is a ''bold'' move
This is a bold move
Missed it by '''that''' much
Missed it by that much
People say I '''''overemphasize''''' some words
People say I overemphasize some words
It has a good --u--underlying--u-- effect
It has a good underlying effect
And for that '''''--u--extra oomph--u--'''''
And for that extra oomph
Sections, Headers, Boxes, and Links

Headers denote the beginning of the Sections of your guide. The first and second level Sections are automatically included in your Table of Contents, so they should only be used to denote important areas. To begin a new section, surround its title with two or more equals signs.

A Box is a section that is highlighted with a background color, using an equals sign and two dashes to denote its start. You can create a box without a title by starting it with =-----=. A box can be ended by using the ending notation =-=.

You can link to any section within your guide by enclosing the section header title in double square brackets. If you have multiple sections in your guide with the same title, then the link will be made to the highest level, then the first, section with that title.

If you want to have a horizontal rule, place a % as the only character on the line.

Your Text:Is Displayed As:
==Section Header==

Section Header

===Sub-Section Header===

Sub-Section Header

====Sub-Sub-Section Header====

Sub-Sub-Section Header

=====Sub-Sub-Sub-Section Header=====
Sub-Sub-Sub-Section Header
=--Boxed Section--=
This text is in the box.
This text is not in the box.
Boxed Section

This text is in the box.

This text is not in the box.

This box has no title.
This text is not in the box.

This box has no title.

This text is not in the box.

[[Section Header]]
[[Section Header|Custom Link Text]]
Section Header
Custom Link Text
There are -s-inline spoilers-s- here
There are inline spoilers here
Text above a horizontal line
Text below it
Text above a horizontal line
Text below it

One asterisk (*) as the first character of each line denotes an unordered list. Multiple asterisks in a row (**) within a list denote sublists. Ordered lists are denoted with the number sign, #. Indented lists are denoted with the colon, :.

Your Text:Is Displayed As:
*Item 1
*Item 2
**Item 2.1
**Item 2.2
*Item 3
  • Item 1
  • Item 2
    • Item 2.1
    • Item 2.2
  • Item 3
#Item 1
#Item 2
##Item 2.1
##Item 2.2
#Item 3
  1. Item 1
  2. Item 2
    1. Item 2.1
    2. Item 2.2
  3. Item 3
: Item 1
: Item 2
:: Item 2.1
:: Item 2.2
: Item 3
Item 1
Item 2
Item 2.1
Item 2.2
Item 3

To create a table, begin a new line with a vertical line character. Table headers are delineated with an asterisk immediately following the line. Spacing is ignored, so you may format the table in text to make it more readable while editing. Trailing markup with no data is also ignored.

You can make multi-column table cells by using a + sign followed by the number of columns, or multi-row cells with the - sign (15 is the maximum, use hexadecimal values 2-9 for single digit values and A-F for 10-15).

You can set the text alignment in individual cells by adding l, c, or r immediately after the |. You can also make multi-column or multi-row cells by adding that markup after the text alignment letter. If no text alignment is specified, it defaults to left as the standard.

|*This   |*is   |*the     |*table     |*header   |
| This   | is   | a       | table     | row      |
| This   | is   | another | table     | row      |
| This   | is   |c+2 a centered table | row      |
Thisisa centered tablerow
Comments (not supported in FFAQ Editor)

To include comments in a file, which will not be displayed within HTML, begin a line with a semi-colon. You can not edit comments in the FFAQ Editor; they are meant to serve as private notes for the author using markup.

Your Text:Is Displayed As:
;You can't see this

How do I submit a Formatted FAQ?

You can submit a Formatted FAQ the exact same way you would submit a regular text FAQ, using the Submit File form. You don't need to do anything else to submit a Formatted FAQ, as long as it has the proper header line, it will be recognized and handled as such.

How do I preview my Formatted FAQ?

You can use the FAQ Test Preview form to preview a file without submitting it.

How can I add images to my Formatted FAQ?

This is how a small image is displayed.
Formatted FAQ images are perfect for including maps, charts, and other graphics in your FAQ. Images should be used to convey information that is difficult or impossible to put into text. Images can be used for:
  • Maps
  • Annotated or Illustrative Screenshots (those that point out a particular item or feature in the game, not just random pictures from the game)
  • Charts (with colors/graphics that can't be easily duplicated in text
You should not use images in a Formatted FAQ for anything non-essential to the guide, such as:
  • Title Graphics
  • Random Screenshots
  • Character Artwork
To add an image, create a line with:
  1. a carat (^)
  2. a lowercase "s" or "l" to denote a large or small image
  3. optional: a lowercase "l" or "r" to denote left or right alignment (small images only; large images can only be aligned left, even if you try to specify otherwise)
  4. an image ID (an integer from 1 to 100)
  5. a vertical line (|) to separate the image ID from the caption, and
  6. a caption for the image (displayed when hovering over the image)
Small images work best for screenshots or small diagrams - they're included to the right of the current text, and are intended to be viewed inline. Large images work best for maps or large diagrams - they break up the current text.

This is how a large image is displayed.
For example:
^sl1|This is image number 1.
Will create a small image with an ID of 1 - left justified, inline with text, with a maximum size of 300 pixels wide by 200 pixels high.
^l2|This is image number 2.
Will create a large image with an ID of 2 - left justified, separated from text, with a maximum size of 750 pixels wide by 500 pixels high.

Images must be JPG, BMP, PNG, or GIF. JPGs will remain in JPG format, while BMPs and GIFs will automatically be converted to PNG.

Images will not appear if you are using the markup preview page. When you upload your markup into the editor, you will need to upload your image files using the editor's Image Manager.

How can I add embedded videos to my Formatted FAQ?

Embedded videos are great for showing the viewer how to do something that is difficult or otherwise impossible to put into either text or images. You must either be the owner of the video being embedded or have permission from the original owner. You are responsible for the content contained within any linked video. We will reject FAQs with videos containing illegal or inappropriate content. Embedded videos are to be used sparingly and only for information essential to the guide that can not be covered by text or image. To add an embedded video, create a line with:
  1. the at sign (@)
  2. a lowercase "l" or "r" to denote left or right alignment
  3. a vertical line (|) to separate the alignment from the video ID, and
  4. the 11-character YouTube video ID (ex: 4XkvRNu3oyU)
At this time, only videos currently posted on YouTube are available for use with this feature. For example:
Will embed a video align to the right. Please note that all videos are set to be 480px in width and a height of 270px. When you press the play icon, you can always use YouTube's full-screen icon to enlarge it for ease of viewing.

Can I add foreign characters to a Formatted FAQ?

Formatted FAQs must be written in Latin text. We also support Japanese/Chinese characters but if you plan on using them in your guide, you must save the text file in UTF-8 format.

Do I have to submit new FAQs in this format?

No. GameFAQs will still be accepting and posting plain text FAQs for the foreseeable future. The new Formatted FAQs are completely optional, and it is up to each individual contributor whether or not they want to use it.

Can I update my existing FAQs in this format?

Yes, just submit your FAQ as a normal update. As long as it has the required Formatted FAQ markup, it will be automatically processed.

Can I submit both a plain text FAQ and a Formatted FAQ for a single game?

No. A Formatted FAQ is a replacement for your plain text FAQ. We will accept either a plain text FAQ or a Formatted FAQ for a game, but not both.