Table of contents
Introduction
All of the pages on this site use a special type of formatting,
which follows some features commonly found in Wiki systems.
The documents of this site (including submissions) are not edited in HTML or bbCode!
This page explains all of the features of this customized markup
language, which is developed in simplicity of editing in mind.
Paragraphs
- Words wrap and fill as needed. Do not bother with line lengths.
- Separate paragraphs with blank lines.
Example: This is paragraph one.
This is paragraph two. There is a blank
line in between.
However, if your lines begin with a space, none of this happens.
See preformatted text.
Lists
- Lists are like this.
- In order to create a list, put * at the start of each line.
- If you need to make a list with deeper hierarchy,
- you can do it by placing ** for second level, etc.
- Use * for bullet lists, # for numbered lists (mix at will)
- ;Term:def Definition for definition lists
- One line for each item; list items can not span multiple lines (but you can use %%%).
Hint: See the source code of this page to see how the markup works.
Line breaking
Note: If what you want is to make a list, read above.
If you want to make paragraph breaks, just put an empty line between the paragraphs.
If you want to make paragraph breaks, just put an empty line between the paragraphs.
Now, if you really
need to write
like this, you can use
the %%% code to force a linebreak.
But it is not recommended.
need to write
like this, you can use
the %%% code to force a linebreak.
But it is not recommended.
Headings
- ‘! ’ at the start of a line makes a small heading.
- ‘!!’ at the start of a line makes a medium heading.
- ‘!!!’ at the start of a line makes a large heading.
- ‘!!!!’ at the start of a line makes a main heading. Because the system automatically creates a main heading for normal pages, this markup is only usable for system pages.
- Usage of headings for structuring the document is recommended. Headings also constitute the table of contents (%%TOC%%).
Four or more minus signs at the start of a line make a horizontal ruler.
Emphasis
- Use doubled single-quotes ('') for emphasis (italics).
- Use doubled underscore (__) for strong emphasis (bold).
- Use doubled parentheses (( and )) for smaller text. (Can be nested)
- Use doubled braces {{ and }} for
teletype text
. - Use triple dashes (---) for
overstrike effect(when you wish to emphasize that something has been changed/removed from the page). - Use double square quotes «« and »» for
inline quotations (
.Can be nested
) - Emphasis can cross line boundaries, so be careful – a rogue “---” for example can cause the entire page appear in strike-over.
Preformatted text
In order to use preformated text, such as indented code, use space as the first character of a line (monospace font).
Example: This is standard text
This is preformatted text using a monospace font (space as first character). Here is an action scene: +__-+- “One image says more than a thousand words.” -- \__| _____ _: _____ ____ - -- | | |_ - - --- / |__\__ -- _/ |__\|_ - O ~ | \ _ - __ `-o----o-'__ `-o-----o-' __ `-oo--^--o-'
Notice the usage of '''' (four successive apostrophes) to break long strings of underscores to prevent them being interpreted as bold on/off.
Please use preformatted text for program source code and such
only. Otherwise, ensure your lines do not begin with space.
References (Links)
- Hyperlinks to other pages can be made by enclosing them in brackets: [RecentChanges] or [recent changes].
- Also, precede URLs with “http:”, “ftp:” or “mailto:” to create links automatically as in: http://www.google.com/ .
- You can suppress automatical hyperlink parsing by preceding the link with a ‘!’, e.g. !http://not.linked.to/.
- It is possible to give your link a different name by using square brackets and ‘|’ like this: [FAQ|Questions and answers] produces: Questions and answers.
- To output brackets as-is, put them in doubles: [[ and ]]
- URLs ending with .png, .gif, .jpg are inlined if put in square brackets (embedded images).
(But when you embed images, please make sure that you have the permission to do so from the server where the image is being loaded from!) - To left- or right-align an embedded picture, the link text can be “left” or “right” respectively.
When you make links to pages of this site (including the forum), just
link to the page by name, e.g. [guidelines] (guidelines)
or [828S] (#828: Bisqwit's NES Mega Man in 16:57.93). Do not write an URL between the brackets.
Linking to submissions
Construct the link from the movie ID and "S". For example, Rockman submission is #1032, so the link is written as: [1032S].
To add description, write for example: [1032S|rockman submission].
To add description, write for example: [1032S|rockman submission].
You can find the number from the URL of the submission.
Linking to movies
Construct the link from the movie ID and "M". For example, Rockman movie is movie 515, so the link is written as: [515M].
To add description, write for example: [515M|rockman movie].
To add description, write for example: [515M|rockman movie].
You can find the number at List All Movies.
(Note: This was recently changed. Before it used to be =movies.cgi?id=number)
Linking to forum topics
Construct the link from "=forum/t/" and the topic ID. For example, the Gradius topic is written as [=forum/t/629|Gradius topic].
Linking to forum posts
Construct the link from "=forum/p/" and post ID. For example, the forum rules is written as [=forum/p/9#9|forum rules].
Linking to other internal pages
To link to any other page that does not have a
e.g. [=movies.cgi?name=Mega+Man+X], [=ref.exe?page=TODO], [=forum/]
.html
in the URL,
take the URL and replace “http://bisqwit.iki.fi/nesvideos/” with “=”e.g. [=movies.cgi?name=Mega+Man+X], [=ref.exe?page=TODO], [=forum/]
- Footnotes: create links to footnotes with [#1] or any other number (i.e. square brackets + hash + number), and precede the footnote itself with [1] (i.e. square brackets + number). Example: [1]
Tables
Tables are created with lines that begin with vertical bars.
Doubled vertical bars create headers.
Example:
||header1||header2||header3||header4|| |field1a|field2a| |field4a| |field1b|field2b with [|] vertical bar|field3b with%%%a few words|field4b|
becomes:
header1 | header2 | header3 | header4 |
---|---|---|---|
field1a | field2a | field4a | |
field1b | field2b with | vertical bar | field3b with a few words | field4b |
To output a literal vertical bar in a table, surround it in brackets: [|]. To output empty cells, put a space between the cell edges.
To ensure that the table format and appearance is consistent (white lattice with border), every row should have one more vertical bar separator than the number of cells in a table row.
Mark-Up Language (HTML)
- Do not try to use HTML. HTML markup does not work.
- < and > and & are themselves.
Table of contents
- You can insert a table of contents to the page with the %%TOC%% macro. (See the top of this page for an example of its use.)
- The table of contents must come before any headers or else it will not work.
Tabs
To create tab entries, write as follows:
%%TAB header_text1%% entry1 %%TAB header_text2%% entry2 ... %%TAB header_textn%% entryn %%TAB_END%%
For example:
%%TAB Table of Pokémon%% Bulbasaur, Venusaur, Ivysaur, and hundreds of others. %%TAB Minimize tab%% %%TAB_END%%
produces:
Bulbasaur, Venusaur, Ivysaur, and hundreds of others.
-
%%TAB_
END%%
is important. If it is missing, the tab will not show up. - Tabs cannot be nested.
Note: In the current implementation of the site, tabs are implemented
with Javascript. It is not recommended to use them, because the tabs
are not usable with Javascript-challenged browsers.
Comments and if macros
- To write something in the source without having it show up in the page, surround the comment with [if:0]...[endif].
- Surrounding anything with [if:1]...[endif] does nothing to the text.
- The wiki reserves some variables which evaluate to 1 if true and 0 if false:
- UserIsLoggedOn
- CanEditPages (1 if user is an editor)
- UserHasHomepage
- CanViewSubmissions (as for now, always 1)
- CanSubmitMovies (as for now, same as UserIsLoggedOn)
- CanJudgeMovies
- CanPublishMovies
- CanRateMovies (as for now, same as UserIsLoggedOn)
e.g. [if:!UserIsLoggedOn]
(The ! reverses 1 and 0)
(The ! reverses 1 and 0)
Other macros
- [expr:UserGetWikiName] returns the reader's wiki username (if logged on).
- [user:user_name] links to the homepage of user_name (if there is one).
Character set
- This server uses unicode with UTF-8 encoding. This means that you can use all characters supported by unicode, including the Japanese characters. But please note that not everyone can read them.
[1]: This is an example of footnote.