Text Formatting Rules (version 40)

This page lists all formatting rules for text in pages. See Text Formatting Rules - Introduction if you are just beginning to edit pages.

Table of contents Paragraphs Lists Headings Emphasis Display Text Formatting Symbols References (Links) Footnotes Subpages Mark-Up Language (HTML) Diagrams Table of Contents Search box Navigation Box Miscellaneous SL Writing Guidelines

Table of diagrams A ko

Paragraphs

• Words wrap and fill as needed.
• Use blank lines to separate paragraphs.
• Four (or more) minus signs at the start of a line make a horizontal rule.
• %%% makes a linebreak (in headings and lists too: continue text in same line).
• %%%% makes a "clear all" linebreak, forcing text below a diagram. ^[1]

To indent a paragraph, start the line either with

• • '>' (indents everything: lists, headings, diagrams) or with
  • ';:' ("mis"using definition lists).
  • In order to use preformatted text or make tables, start lines with a space (monospace font). ^[2]

Example: This is standard text

This is level 1 indentation using ;: (semicolon-colon).

And this is level 2 indentation ;;: (semicolon-semicolon-colon).

This is level 1 indentation using > (greater_than).

And this is level 2 indentation. > > (greater_than-greater_than)

• This is an indented list. > > * (greater_than-greater_than-asterisk)

This is preformatted text
using a monospace font
(each line started with a space).

Lists

• * at the start of a line for first level
• ** for second level, etc.
• Use * for bullet and # for numbered lists (mix at will)
• ;Term: Definition for definition lists
• One line for each item
• Other leading whitespace signals preformatted text, changing font.

Headings

• '== ' at the start of a line makes a large heading.
• '=== ' at the start of a line makes a medium heading.
• '==== ' at the start of a line makes a small heading.

You can optionally end the line with the same amount of '=' (Wikipedia style).

Note: There has to be a space after the '=' at the start.

Emphasis

• Put doubled single-quotes ('') on both sides for emphasis (italics).
• Put doubled underscore (__) on both sides for strong emphasis (bold).
• Emphasis can be used multiple times within a line, but cannot cross line boundaries.

Display Text Formatting Symbols

1. Place a "!" before the symbol. Eg: B4 (it is typed in as !B4 in edit page), [I am very good!]
2. But "!" may not work for all symbols. In this case, consider typing the formatting symbol ' or _ 4 times in between the text formatting symbols.
   

Eg: %%%%, %%TOC%%

References (Links)

• Hyperlinks to other pages can be made by JoiningCapitalizedWords or by enclosing in square brackets: [Go].
• The second form is more general (single words too) and easier for readers (spaces allowed). Compare "join capitalized words" with "JoinCapitalizedWords". (See Wiki Name for complete description.)
• It is possible to give your link a different name by using square brackets and '|' (or '¦') like this: [Go Teaching Ladder | http://gtl.xmp.net/] produces Go Teaching Ladder.
• You can suppress linking to references by preceding the word with a '!', e.g. NotLinkedAsWikiName, http://not.linked.to/.
• Also, precede URLs with "http:", "ftp:" or "mailto:" (obfuscated!) to create links automatically as in: http://gtl.xmp.net/.
• URLs to images, ending with .png, .gif, .jpg, are inlined if put in square brackets. See HowToAddImages.
• To left- or right-align an inlined picture, filename must end in resp. -alignleft or -alignright, followed by the extension. For example: [http://senseis.xmp.net/images/goban-alignright.jpg] ^[3]
• To link to forum entries use the prefixes p:, posting:, t:, topic:, f:, or forum: like this: p:1 topic:1 forum:ArnoHollosi
• Links to subheaders of pages: use #tocXY at the end. Example: [ReferenceSection - Cultural pages|ReferenceSection#toc2] becomes ReferenceSection - Cultural pages. Caution: order (or amount) of headers on a page can change and then the link will point to the wrong header.
• Links to diagrams on other pages: use #diagXY at the end. Example: [Ko - diagram 3 | ko#diag3] becomes Ko - diagram 3 or use an unnamed link ko#diag3. Caution: order (or amount) of diagrams on a page can change and then the link will point to a wrong diagram.

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).
• In order to link to a footnote at another page, use [pagename#XY].

Subpages

• Subpages cannot have further subpages. So you must have a good reason to create a subpage, as you cannot structure content with this concept.
• Subpages show up in the left yellow page area.
• Their name is of the form "basename / subpage".
• Links to subpages are of the form [basename / subpage].
• A subpage from the current page can be referenced by [/subpage].
• The %%Subpages%% macro will create a table of content of subpages.

Mark-Up Language (HTML)

• Don't bother.
• '<' and '>' and '&' are themselves.
• To insert special characters (HTML entities) use the numerical &#XXXX; syntax, hexadecimal &#xYYYY; syntax, or use one of the predefined HTML entity names. Examples: &# 21163; renders as 劫, & Uuml; renders as Ü.
• Be aware that not everyone can display Unicode.

Diagrams

A ko  

$$ A ko
$$ . . O X . .
$$ . O . O X .
$$ . . O X . .

Diagram lines start with "$$ ". The first line is the title line.

• White stone: O, marked with circle: W, marked with square: @
• Black stone: X, marked with circle; B, marked with square: #
• Empty point: ., marked with circle; C, marked with square: S
• Use a-z (lowercase) for letters, use 1-9+0 for numbered stones (>1-10, not more possible)
• In title line: $$B makes "1" a black stone, $$W makes "1" a white stone.
• -, |, + can be used as borders.
• All diagrams are also available as SGF files -- you can download them by clicking on the diagram graphic.

You can also refer to moves with images like " is good" by writing "B3 is good", and in the same way to marked stones: "WS is good" gives " is good".

Read more about it in How Diagrams Work.

Table of Contents

• Use the %%TOC%% macro to create the table of contents (as the one on the top of this very page).
• %%TOC+%% will also add a table of content of subpages (as made by %%Subpages%%).
• %%TOC-%% will omit the table of diagrams, and only show the table of contents

Search box

%%Search%% will add a search box in the page

Navigation Box

Back to beginning
See SL Tips and Tricks for more

• Subsequent lines preceded by => are displayed in a distinct right aligned box. This can be useful as a navigating aid. See the example at the right side.
• Lines preceded by =< are displayed in a left aligned box.

Miscellaneous

• Lines starting with a single '%' are comments and are not shown when viewing a page. This behaviour can be changed in User Preferences.

SL Writing Guidelines

You may follow some SL Conventions, but they are less important than your ideas and insights!

[1] Charles: I consistently make that eight per-cents, in order to give a good clearance below diagrams. But I don't know whether that depends on the browser in use (I have IE).

[2] Preformatted text does not wrap, so please do not enter long lines in preformatted text.

[3] Inline pictures, aligned left or right do not show everytime? (see my inline-aligne-test -- RueLue)