An introduction to the OWLScribble markup language.
OWLScribble is a wiki markup language based on the markup used by OpenWiki. It was designed for use with the SewWiki project by Gavin Kistner.
Paragraphs start on a line of their own and may be continued onto multiple consecutive lines. A double line break indicates the start of a new paragraph. If the start of the text is indented at all, however, then it is treated as preformatted text.
Paragraphs start on a line of their own and may be continued onto multiple consecutive lines.
A double line break indicates the start of a new paragraph.
If the start of the text is indented at all, however, then it is treated as preformatted text.
: An exception to the indented-paragraph rule is this.
: Paragraphs (on a single line)
: with whitespace preceding a colon
: are indented based on the amount of space
: But, as seen here, each line is its own paragraph.
An exception to the indented-paragraph rule is this.
Paragraphs (on a single line)
with whitespace preceding a colon
are indented based on the amount of space
But, as seen here, each line is its own paragraph.
{{{
for ( var i=0; i<10; ++i ){
alert( 'hi!' );
}
}}}
for ( var i=0; i<10; ++i ){
alert( 'hi!' );
}
To be clear about the start and end, you may specify preformatted text by wrapping it in {{{...}}} over multiple lines.
Such text is automatically unindented by the amount of indentation on the end markers.
This text **is bold**, this //is italic//,
and --this has been struck--.
//You can start a paragraph with an inline
style, but you cannot wrap it across lines.//
This is a @@code reference@@,
as is {{{this text}}}.
A double-exclamation point is a special
'todo' item. !!Add more examples!!
You can also ^^superscript^^ and
__subscript__ text, like H__2__O
or e^^pi*i^^.
This text is bold, this is italic,
and this has been struck.
You can start a paragraph with an inline style, but you cannot wrap it across lines.
This is a code reference, as is this text.
A double-exclamation point is a special 'todo' item. TODO - Add more examples
You can also superscript and subscript text, like H2O or epi*i.
= Heading Level 1 = == Heading Level 2 == === Heading Level 3 === ==== Heading Level 4 ==== ===== Heading Level 5 ===== ====== Heading Level 6 ======
Headings must begin at the start of the line. Markup inside headings is ignored. (For example, == My //Sweet// Heading == will not make the word italic, but will instead show the // characters in the output.)
* Visit SiteMap, HomePage, or WhereDoIBegin to get started. * Visit the [[What is a Wiki?]] page if you're really lost. * Visit hTTp://www.google.com to find stuff on the web. * The [hTTp://www.microsoft.com company that shall not be named] thinks they can beat Google. * This page was edited by [GavinKistner the Wiki Gardener].
OWLScribble supports three styles of specifying a link:
With either URLs or WikiWords, you can optionally use an alternative description for the link text. As shown above, place a single set of square brackets around what you want linked, with the URL or WikiWord as the first item.
Sometimes you want to write something that looks like a
~WikiWord (such as ~OpenWiki) but you don't want it to
appear as a link to a page in the wiki.
You can either wrap it in preformatted text delimiters
like @@{{{OpenWiki}}}@@, or place a tilde (~) character right
before it, as in {{{~OpenWiki}}}.
Sometimes you want to write something that looks like a WikiWord (such as OpenWiki) but you don't want it to appear as a link to a page in the wiki.
You can either wrap it in preformatted text delimiters like {{{OpenWiki}}}, or place a tilde (~) character right before it, as in ~OpenWiki.
1 2 3 4 5 6
12345678901234567890123456789012345678901234567890123456789012345
* Bullet lists need **at least one space** before the asterisk.
* **A space** must appear after the asterisk.
* They may be nested to an arbitrary depth.
* Tabs may also be used for indentation.
* Mixing tabs and spaces is asking for trouble.
1 2 3 4 5 6
12345678901234567890123456789012345678901234567890123456789012345
1. Numbered lists must also have a space before the number.
1. The actual number doesn't matter...
3. ...but the period after the number does.
1. As well as the space after the period.
# You can also use the 'octothorp' if you like.
# //(A fancy name for the 'sharp' or 'pound' symbol.)
# Other types of numbered lists are supported beyond arabic.
a. For arabic lists, you can use 1, 2, 3, ... 23, etc.
a. but for the following, you must use the actual character.
a. A lowercase 'a' is for lowercase alphabetical lists.
A. An uppercase 'A' is for uppercase alphabetical lists.
i. A lowercase 'i' is for lowercase roman numeral lists.
I. An uppercase 'I' is for uppercase roman numeral lists.
1 2 3 4 5
12345678901234567890123456789012345678901234567890123456789
* Bulleted and numbered lists may be alternately nested
1. And (as seen above)...
i. ...you can mix numbered list styles on the fly
* But woe unto you if you try to mix a bullet...
1. ...and a number in the same list.
* //Sorry buddy, but that doesn't fly.//
1 2 3 4 5 12345678901234567890123456789012345678901234567890123456789 ; Semantic : of or relating to meaning in language ; Grok : to understand //completely// ; : to inherently and almost intuitively comprehend
|| **Age** || **Sex** || **Weight** || || 32 || M || 180 || || 30 || F || 150 || |||| //average// || **165** ||
| Age | Sex | Weight |
| 32 | M | 180 |
| 30 | F | 150 |
| average | 165 | |
You don't have to line up the bars from one row to the next, but you may if you want the text representation to look clean. As seen above, you can cause a cell to span multiple columns.
A processing directive appears as a pair of pound symbols with a command inside, optionally followed by parameters to that command inside parentheses. For example:
##TableOfContents## ##IncludePage(ProcessingDirectives)##
OWLScribble currently recognizes the following directives:
Note that OWLScribble only handles the TableOfContents directive natively. The other directives are replaced with an empty non-HTML 'wiki_command' tag, such as <wiki_command do="TableOfContents" /> or <wiki_command do="IncludePage" param="CommonFooter" />. It is up to the consumer of OWLScribble to handle and/or replace such tags with meaningful information.
There are two ways to handle these tags. One way is to parse and modify the HTML produced by OWLScribble as a string. This is effective, but not recommended.
The recommended mechanism for handling processing directives is to spin through the #wiki_commands collection of the OWLScribble object after initialization, processing the commands and replacing the tags as desired. Once this is done, call the #to_s or #to_html methods on the OWLScribble instance to get the final output.
HTML entities are not needed (and do not work) inside OWLScribble; you can type "this & that" and it will produce the HTML this & that, displaying as "this & that". Typing & will actually show "&".