View Page Source

Revision (current)
Last Updated by CoolHandMike 23 days ago
Back to Page

%%TOC%%

!! Introduction

This site uses a bespoke [https://en.wikipedia.org/wiki/Markup_language|markup language] for formatting.
It is __distinct from HTML, BBCode, and Wikitext__, though it shares many features with the latter (Wikitext being the markup for MediaWiki, the [Wiki] system that you're probably most familiar with).

The markup described here applies to submission notes, wiki articles... everything on the site besides forum posts, which use [ForumMarkup|a variant of BBCode].

This page explains all of the features of this customized markup
language, which is developed with simplicity of editing in mind.

!! Paragraphs

* Words wrap and fill automatically. You do not need to bother with manually inserting line breaks..
* keep lines short to make diffs (page history) more easily readable.
* Separate paragraphs with a blank line.

Example: This is paragraph one.

This is paragraph two. There is a blank
line in between.

You can force a line break without making a new paragraph with %%''''%,
but it is not recommended. Example: %%%
This paragraph%%%
uses line breaks%%%
excessively.%%%

However, if your lines begin with a space, none of this happens.
See ''[=TextFormattingRules#PreformattedText|preformatted text]''.

!! Lists

* This is a bulleted list.
* In order to create a bulleted list, put * at the start of each line.
** You can get deeper hierarchy by placing ** for second level, *** for third etc.

# This is a numbered list.
# In order to create a numbered list, put # at the start of each line.
## You can use ## and ### as in the previous example.
#* You can also mix # and *.

* New line stops the list, but you can use %''''%% (see above).
* ;Term:def makes a definition list:
Example:%%%
'''';Term to be defined: Your explanation appears here.%%%
'''';TAS: A tool-assisted speedrun.%%%
Turns into:
;Term to be defined: Your explanation appears here.
;TAS: A tool-assisted speedrun.

Hint: See the [=Wiki/ViewSource?path=TextFormattingRules|source code] of this page to see how the markup works.


!! 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|system pages].
* The command %''''%TOC%% creates a table of contents consisting of the headings.
* Usage of headings for structuring the document is recommended. 

Four or more minus signs at the start of a line make a horizontal ruler. Example:
--------

!! 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»»)»».
* Use right angle bracket (>) for indented quotes:
> This is an example quote.
* Use double top half brackets ⸢''''⸢ and ⸣''''⸣ for ⸢⸢superscript⸣⸣. Useful to write {{X⸢⸢4⸣⸣ = X⸢⸢2⸢⸢2⸣⸣⸣⸣}}  in math.
* Use double bottom half brackets ⸤''''⸤ and ⸥''''⸥ for ⸤⸤subscript⸥⸥. Useful to write {{log⸤⸤⸤⸤2⸥⸥⸥⸥X}} in math.
* 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 preformatted 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.
Preformatted text does not line wrap and can break page layout if used incorrectly.

!! References (Links)

[http://files.tasvideos.org/guidelines/entertain.gif|right]
* Internal links (to other wiki pages here)
** Do NOT link to the fully qualified url i.e do NOT prefix with https:[if:1]//tasvideos.org[endif]
** Link to wiki page names by enclosing them in brackets: [[RecentChanges]] or [[recent changes]].
** It is possible to give your link a different name by using square brackets and ‘|’ like this: [[FAQ|Questions and answers]] produces [FAQ|Questions and answers].
** To output brackets as-is, put them in doubles: [[[[ and ]]]]
* External links (automatically gets a [http://dummy| ] icon)
** URLs with {{http:}}, {{ftp:}} or {{m''''ailto:}} are automatically linked: http://www.google.com/ .
** URLs can be named in the same way as internal links: [[!http://www.google.com|Google it!]] produces [http://www.google.com|Google it!]
** You can suppress automatic hyperlink parsing by preceding the link with a ‘!’, e.g. !''''!http://not.linked.to/.
* Images
** URLs ending in {{.png}}, {{.gif}}, {{.jpg}}, and {{.svg}} 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 suppress image embedding, use a space after the URL, it will act as a regular link.
** For internal links (relative), prefix the image's URL with a =.
** To left- or right-align an embedded picture, the link text can be “left” or “right” respectively. [[!https://files.tasvideos.org/guidelines/entertain.gif|right]] produces the image above.
** To include {{alt}} or {{title}} attributes in an image use {{alt=text}} or {{title=text}}.
** To include {{width}} or {{height}} attributes in an image use {{w=width}} or {{h=height}} respectively. Ex: [[!https://files.tasvideos.org/common/Forum/21792/bizhawk_mame_tutorial/Karnov-cover.jpg|w=480|h=360]]
** You can combine multiple image options by using '|' like this: [[=image.png|alt=Image of cows|title=Coolest image ever|left]] or this: [[http''''://images.google.com/image.png|alt=Image of cows|title=Coolest image ever|left]]
** You can create image links like this: [[!http://www.google.com|=googlelogo.png|alt=Google's Logo]] or this: [[!http://www.google.com|http''''://www.google.com/googlelogo.png|alt=Google's Logo]]


__Linking to submissions__

Construct the link from the movie ID and "S". For example, Rockman submission is #[1032S|1032], so the link is written as: [[1032S]].%%%
To add a ''custom'' description, write for example: [[1032S|rockman submission]]. The internal description can be seen when hovering over the link.

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 [515M|515], so the link is written as: [[515M]].%%%
To add a ''custom'' description, write for example: [[515M|rockman movie]]. The internal description can be seen when hovering over the link.

You can find the number at in the URL of a publication page, or from a link on the movie module for the movie.

__Linking to forum topics__

Construct the link from "Forum/Topics/" and the topic ID. For example, the [Forum/Topics/629|Gradius topic] is written as [[Forum/Topics/629|Gradius topic]].

__Linking to forum posts__

Construct the link from "Forum/Posts/" and post ID. For example, the [Forum/Posts/227916|forum rules] is written as [[Forum/Posts/227916|forum rules]].

__Linking to forum profiles__

Construct the link to the users profile simply use the user module with the user's username. For example for [user:feos] link with [[user:feos]]

__Linking to other internal pages__

To link to any other page, take the URL and replace “!https://tasvideos.org/” with “=” (for simple links, the "=" can be omitted)%%%
e.g. [[Forum/Subforum/2]], [[=Wiki/PageHistory?path=TODO]], [[UserFiles/Info/637936906469759936]]

* __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. ( | ) %%%
Double 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 {{<}} have no special meaning and will give a literal & or <, respectively; {{>}} has a special meaning only at the beginning of a line (for a note-style block), and otherwise gives a literal >.

!! 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:

%%TAB Table of Pokémon%%
Bulbasaur, Venusaur, Ivysaur, and hundreds of others.
%%TAB Minimize tab%%
%%TAB_END%%

__Important:__ There must be a newline after  %''''%TAB_END%% or else it will not work.

Note: Headings can not be embedded in tabs

! Directives:
__%''''%TAB_START%%__%%%
Start a tabset. Usually only needed if you want nested tabs.%%%
__%''''%TAB_HSTART%%__%%%
Start a tabset with tabs on left side instead of top.%%%
__%''''%TAB <name>%%__%%%
Create a new tab. Starts a tabset if there isn't one.%%%
__%''''%TAB_END%%__%%%
End the innermost tabset.%%%


* {{%%TAB_}}{{END%%}} is important. If it is missing, odd things happen.
* Tabs can be nested.
* There must be no headings in the tabs.
* Ending a tab ends any nested quotes and divs.

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.

!! Source code
__%''''%SRC_EMBED <hilighting>__%%%
Start block of code with specified hilighting type. Wiki markup is not processed inside this block.%%%
__%''''%END_EMBED__%%%
End a block of code.
%%SRC_EMBED lua
function factorial(n)
  local x = 1
  for i = 2, n do
    x = x * i
  end
  return x
end
%%END_EMBED

!! Quotations
__%''''%QUOTE [<name>]__%%%
Start a quote block (If <name> is specified, that is shown to be quoted).%%%
__%''''%QUOTE_END__%%%
End a quote block. Automatically ends any nested tabs and divs.

%%QUOTE Example Person
Example Quote
%%QUOTE_END

!! Divs 
__%''''%DIV <class>__%%%
Start a div block with given class <class>.%%%
__%''''%DIV_END__%%%
End a div block. Automatically ends any nested tabs and quotes.

%%DIV card border-primary
%%DIV card-header
Example card div header
%%DIV_END
%%DIV card-body
Example card div body
%%DIV_END
%%DIV_END
%%%

!! Comments and if macros

* To write something in the source without having it show up in the page, surround the comment with [[i''''f:0]]...[[endif]].
* Surrounding anything with [[i''''f:1]]...[[endif]] does nothing to the text.
* The wiki reserves some variables which evaluate to 1 if true and 0 if false:
** UserIsLoggedIn
** CanEditPages (1 if user is an ''[Staff|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. [[i''''f:!UserIsLoggedIn]]%%%(The ! reverses 1 and 0)

__Other macros__

* [[e''''xpr:UserGetWikiName]] returns the reader's wiki username (if logged on).
* [[u''''ser:user_name]] links to the user profile of the user (if there is one).
* [[module:xxx]] inserts a module which performs some function. See the [TextFormattingRules/ListOfModules|list of modules] for more information. Some modules are restricted.

!! 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 a footnote.