[Welcome to Sensei's Library!]

StartingPoints
ReferenceSection
About


Paths
HowToUseWiki

Sub-pages
Discussion

Referenced by
RGGFAQFormatGuide...
WikiName
AddingPages
SLConventions
TextFormattingRul...
EncyGoPedie
WikiNews
LinkTeam
Messt
SLConventions/Use...
Unicode/Discussion
WikiAndHTMLDiscus...

Homepages
KgsStanzaItaliana

 

Text Formatting Rules
Path: HowToUseWiki   · Prev: WikiEtiquette   · Next: HowDiagramsWork
    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 Table of diagrams
A ko

Paragraphs

  • Words wrap and fill as needed.
  • Use blank lines as separators.
  • Four or more minus signs at the start of a line make a horizontal rule.
  • %%% makes a linebreak (in headings and lists too).
    • %%%% makes a "clear=all" linebreak, forcing text below a diagram.[1]
  • To indent paragraphs, always use either
    • ">" for an indentation. You can ident everything (lists, headings, diagrams) using this indentation.
    • ";:" for a indentation (mis)using definition lists
  • In order to use preformated text use "space" as the first character of a line (monospace font).[2]

Example: This is standard text

This is a level 1 indentation using ;: (semicolon-colon).
And this is a level 2 indentation ;;: (semicolon-semicolon-colon).

This is a level 1 indentation using > (greater_than).

And this is a 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 (space as first character).

Lists

  • * at the start of a line for first level
  • ** 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
  • Other leading whitespace signals preformatted text, changes font.

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.

Emphasis

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

References (Links)

  • Hyperlinks to other pages can be made by JoinCapitalizedWords - a single word can be used by enclosing it in square brackets: [Go].
  • It is easier for readers if you use an alternative way to write hyperlinks: put them into square brackets - you can then use space to separate the words, e.g. [join capitalized words] is the same as JoinCapitalizedWords (see Wiki Name for complete description).
  • 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: [ext] http://gtl.jeudego.org/.
  • URLs ending with .png, .gif, .jpg are inlined if put in square brackets.
  • to left- or right-align an inlined picture, filename must end in resp. -leftalign or -rightalign, followed by the extension.
  • It is possible to give your link a different name by using square brackets and '|' like this: [Go Teaching Ladder|http://gtl.jeudego.org/] produces: [ext] Go Teaching Ladder.
  • 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).

Subpages

  • subpages show up in the left yellow page area.
  • The syntax for subpages is "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.
  • Be aware that not everyone can display Unicode

Diagrams

[Diagram]
A ko

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 for numbers on stones.
  • 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 these 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 "WS is good".

Read more about it in How Diagrams Work.

Table of Contents

  • Use the %%TOC%% macro to create the table of contents (See the top of this page for an example of its use.)
  • %%TOC+%% will also add a table of content of subpages.

Guided Tours aka Paths

How Paths Work explains the [>SomePageName] construction.

Miscellaneous

  • Lines starting with a single '%' are a comment and are not shown when viewing a page. This behaviour can be changed.
% this is a comment - it will not show up on the final page

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] unkx80: Preformatted text do not wrap, so please do not enter long lines in preformatted text.



Path: HowToUseWiki   · Prev: WikiEtiquette   · Next: HowDiagramsWork
This is a copy of the living page "Text Formatting Rules" at Sensei's Library.
(OC) 2004 the Authors, published under the OpenContent License V1.0.