Text Formatting Rules

    Keywords: SL description

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

Text

Emphasis (Bold/Italic)

  • Put two single-quotes '' on both sides for emphasis (''italic'' -> italic).
  • Put two underscore __ on both sides for strong emphasis (__bold__ -> bold).
  • These can be combined (__''bolditalic''__ -> bolditalic)
  • Emphasis can be used multiple times within a line, but cannot cross line boundaries.

Paragraphs

  • Extra spaces/tabs and single line breaks inside text are ignored, all the text will be considered a single paragraph.
  • To make multiple paragraphs, use a blank line between them
  • To make a line break at a specific point, use %%% (in headings and lists too: continue text in same line).
  • Four (or more) minus signs (----) at the start of a line make a horizontal rule.
  • %%%% makes a "clear all" linebreak, forcing text below a diagram. [1]

To indent a paragraph, start the line either with

'>' (indents everything, with a line in front of it: lists, headings, diagrams) or with
';:' ("mis"using definition lists).
In order to use preformatted text or make simple 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
      • *** for third 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.

2nd note: all headings show up in the TOC (Table Of Contents) of the page.

Display Text Formatting Symbols

  1. To force a symbol to be displayed (instead of being interpretted as formatting), place a "!" before the symbol. To display B4 instead of B4, type in !B4 in edit page.
  2. For displaying the square brackets ('['), use ![ for the opening bracket, or else it will be interpreted as a link (e.g. [aji] against aji ).
  3. "!" may not work for all symbols. In the case of multi character symbols, consider typing the formatting symbol ' or _ 4 times in between the text formatting symbols.

Eg: %%''''%% for %%%%
or %%____TOC%% for %%TOC%%
or %%_''''_''''_''''_TOC%% for %%____TOC%%
or Teacher''''Name for TeacherName

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 [ext] predefined HTML entity names. Examples: &# 21163; renders as 劫, & Uuml; renders as Ü.
  • Be aware that not everyone can display Unicode.

Subpages

  • 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.

Subpages have some limitations, so you must have a good reason to create a subpage, as you cannot structure content with this concept.

More specifically, they lack following:

References (Links)

You can use hyperlinks to link parts of your text to other pages, parts of them (diagrams, headers, footnotes, anchors) or arbitrary URLs or to add pictures to your text. Some links are usually created automatically, but you can suppress them.

Suppressing links and specifying the text

  • JoinedWords and some URLs are usually automatically linked, as explained below
    • You can suppress this automatic linking by preceding the them with a '!', e.g. !NotLinkedAsWikiName, !http://not.linked.to/.
  • You can create a link with arbitrary text and target by using square brackets and '|' (or '') in the form [(linked-text)|(target)], where (target) is one of the variants described below, e.g. a Wiki Name or a URL:
  • The second form is more general, as you can link single words, multiple words with spaces or arbitrary text. This can make your text easier to read: compare The Art of 9x9 Go with "TheArtOf9x9Go".

Linking to other (main) pages

  • You can link to other pages by JoiningCapitalizedWords or by enclosing in square brackets: [Go].
    • If you use square brackets, spaces and the caracters [ . , - ' + ( ) ] are removed, as explained at WikiName.
    • In all cases, the result should be the Wiki Name of the page (see there for details).

Linking to related pages

Linking to parts of pages

You can link to particular points on pages (anchors), using automatically generated or manually specified anchors:

  • Use automatically generated anchors to link to (sub-)headers, diagrams or footnotes by number:
    • Caution: These links may be invalidated if the order (or number) of headers, diagrams or footnotes on the target page changes; use manually generated anchors, to avoid this.
    • Links to (sub-)headers by number: use #tocnumber at the end or on its own (on the same page). Example: [ReferenceSection - Cultural pages|ReferenceSection#toc2] produces ReferenceSection - Cultural pages.
    • Links to diagrams by number: use #diagnumber at the end or on its own. Example: [Ko diagram 3 | ko#diag3] produces Ko - diagram 3; the unnamed link ko#diag3 also links there.
    • Links to footnotes (next section) by number: use #number at the end or on its own. Example: [Ko note 3 | ko#3] produces Ko - note 3; the unnamed link ko#3 also links there.
    • N.B.
      • There are also automatically generated anchors #r(number), but these are very unlikely to be useful: they refer to the (first) place referring to a footnote, and are used to return there from the footnote.
  • Use manually specified anchors to link to an arbitrary point on a page using the anchor template (see there for details):
    • Choose an (anchor-name) consisting only of numbers and letters; see the template for other restrictions.
    • Create an HTML anchor on the target page by inserting {{:anchor|(anchor-name)}} at the desired point, e.g. {{:anchor|list}} for an anchor called list (as on page EGC).
    • Refer to it on the same page as #(anchor-name). Warning: the name is case-sensitive.
    • Refer to it from another page by adding #(anchor-name) to the page link, e.g. EGC#list for the example.

Linking to URLs

  • URLs starting with "http:", "https:", "ftp:" or "mailto:" (obfuscated!) are linked automatically, as in: http://gtl.xmp.net/.
  • URLs of images, ending with .png, .gif or .jpg, are inlined if put in square brackets. See How to add images.

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)#(number)].

A reference to a footnote looks like[99].

Here is another reference[99].

[99] A footnote looks like this; the number links back to the first reference to it.

Diagrams

[Diagram]
A ko  
 $$ A ko
 $$ . . O X . .
 $$ . O . O X .
 $$ . . O X . .


All diagram lines start with "$$ ".

The first line is the title line. It can define two things:

  • Whether odd numbers are black or white. If the line begins with $$B, the numbers will be rendered as B1,W2,B3, and so on. Enter W right after the "$$" for W1,B2,W3.
  • The caption of the diagram. Any other text will be displayed below the diagram.

In the board area, you can enter the following:

  • 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; marked as hoshi: ,; marked completely blank: _
  • Numbered stones: 1 through 9 and 0 ("0" produces W10 or B10, the highest number possible, unless you specify a higher starting point with m.)
  • Letters: a-z (lowercase)
  • Borders and corners: -, |, +

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 "B3 is good" by writing "B3 is good", and in the same way to marked stones: "WS is good" gives "white+square is good".

Read more about it in How Diagrams Work.

Images

Tools

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

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.

Prefabricated Boxes

CJK-box

Box placed in the top right corner for displaying Chinese, Korean and Japanese translation of (Go-)terms.

Search box

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

Tables

Miscellaneous

  • Lines starting with a single '%' are comments / remarks 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.


See also:


Text Formatting Rules last edited by PJTraill on November 22, 2018 - 16:05
RecentChanges · StartingPoints · About
Edit page ·Search · Related · Page info · Latest diff
[Welcome to Sensei's Library!]
RecentChanges
StartingPoints
About
RandomPage
Search position
Page history
Latest page diff
Partner sites:
Go Teaching Ladder
Goproblems.com
Login / Prefs
Tools
Sensei's Library