[Welcome to Sensei's Library!]

StartingPoints
ReferenceSection
About


Paths
UsingAndContribut...

Referenced by
HowToUseWiki
WikiNews
AddingPages
WikiName
OldMetaDiscussion
OldGuineaPigsFeed...

 

Text Formatting Rules
    Keywords: SL description

Discussion at the bottom.

Paragraphs

  • Don't Indent paragraphs
  • Words wrap and fill as needed
  • Use blank lines as separators
  • Four or more minus signs make a horizontal rule
  • %%% makes a linebreak (in headings and lists too)
    • %%%% makes a "clear=all" linebreak, forcing text below a diagram
  • Indent with one or more spaces to use preformated text (monospace font):
 This is preformatted text using a monospace font

This is not

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

  • Hyperlinks to other pages are made by JoinCapitalizedWords? - a single word can be used by enclosing it in square brackets: [Go]
  • An alternative way to write hyperlinks is to put them into square brackets - you can then use space to separate the words, e.g. [join capitalized words] is the same as JoinCapitalizedWords?
  • You can suppress linking to references by preceeding the word with a '!', e.g. NotLinkedAsWikiName, http://not.linked.to/
  • Also, precede URLs with "http:", "ftp:" or "mailto:" to create links automatically as in: [ext] http://gtl.jeudego.org/
  • URLs ending with .png,.gif,.jpg are inlined if put in square brackets.
  • 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
  • Footnodes: create links to footnodes with [#1] or any other number (i.e. square brackets + hash + number), and preceede the footnode itself with [1] (i.e. square brackets + number).

Mark-Up Language (HTML)

  • Don't bother
  • < and > and & are themselves

Diagrams

[Diagram]
Diag.: 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.

Read more about it in HowDiagramsWork

Guided Tours aka Paths

See HowPathsWork



Discussion

Please do not use lines with length greater than 80, it makes the ``diff'' unreadable in the RecentChanges.

That is not always possible. E.g. list items have to be in one line. I have added a quick hack that tries to underline small changes in long lines (e.g. correction of a typo). It works quite well. I hope that solves the problem sufficiently. --ArnoHollosi

We have dropped off the instruction for using "semicolon-colon" to create indented blocks of text. Was this intentional or accidental? It still works and is a better way to insert comments in the midst of someone else's text. People tend to use prefomatted text to do this but the problem there is that preformatted doesn't wrap automatically so the page becomes too wide for the browser window.

--DaveSigaty

Actually, the semicolon, colon creates a definitionlist (<DL>). You can put the term to be defined between the colon and the semicolon, or leave it out, thusly:

Aardvark
Often mistakenly quoted to be the first word in english dictionaries
Definition of a term without the term :-)

Having said that, it may well be that the use of 'empty' definitions is the best way to make comments.
Like you point out, monospaced (first char = space) doesn't do linebreaks, and using italics or bold isn't always appropriate. Let's try it and see how it goes.

--MortenPahle



This is a copy of the living page "Text Formatting Rules" at Sensei's Library.
(C) the Authors, published under the OpenContent License V1.0.