How do you learn to format Wiki pages?
Generally, it is important to use as little markup as possible:
These are the most important formatting rules:
_underline_→ bold, italic, underline (the pattern matching is pretty restrictive, to prevent mismatches).
%%*escaped*%%→ *escaped* (instead of bold, by ignoring markup)
##*escaped and monospaced*##→
*escaped and monospaced*(instead of bold and variable width)
_underline_) does not work:
----) on a separate line. Horizontal lines are used for the category section of pages, see WikiOrganization.
--) surrounded by spaces.
The official documentation is here:
The basic punctuation-based markup (see above) is preferable in all cases where it works. Alternative markup works in some additional contexts.
The following markup tags have special effects on this wiki. Use them like HTML tags.
<nowiki>[[No Link]]</nowiki>→ [[No Link]]
<pre>tags must be alone on a line, to work. Example: to produce a line with
foo, use this:
<pre> foo </pre>
The following standard HTML tags can be used on the wiki. Use them like HTML tags.
<u>foo bar (toto)</u>→ foo bar (toto)
<i>foo bar (toto)</i>→ foo bar (toto)
<b>foo bar (toto)</b>→ foo bar (toto)
<tt>foo bar (toto)</tt>→ foo bar (toto)
<em>foo bar (toto)</em>→ foo bar (toto)
<strong>foo bar (toto)</strong>→ foo bar (toto)
“BBCode is an abbreviation for Bulletin Board Code, the lightweight markup language used to format posts in many message boards. The available tags are usually indicated by rectangular brackets surrounding a keyword, and they are parsed by the message board system before being translated into a markup language the web browsers understands, usually HTML or XHTML” – Wikipedia
[b]this text is bold[/b] [i]this text is italic[/i] [u]this text is underlined[/u] [s]this text is striked through[/s] [strike]and this too[/strike] [tt]monospaced text[/tt] [sub]subscript[/sub] [sup]superscript[/sup] [color=blue]this text is blue[/color] [size=+2]this text is two sizes larger than normal[/size] [font=courier]this text is in the courier font[/font] [quote]quoted text[/quote] [code]preformatted monospaced text[/code] (no nesting of other bbCode!) [center]this text is centered[/center] [img]http://www.example.org/logo.png[/img] [left]this (often an image) floats left[/left] [right]this (often an image) floats right[/right] [h1]title[/h1] [h2]title[/h2] [h3]title[/h3] [h4]title[/h4] [h5]title[/h5] [h6]title[/h6] [list] [*]item one [*]item two [/list] :) :-) ☺ (smile) :( :-( ☹ (frown)
Note that traditionally,
[url=http://www.example.org/]text[/url] would also be allowed. Apparently spammers also like it, which is why it ended up on BannedRegexps.
‘Manual’– see EmacsManual.
The reflexive intermap-link EmacsWiki has some of the following actions:
A more complete list can be found at http://www.oddmuse.org/cgi-bin/oddmuse/Action_List
Lists and indented paragraphs start with a special character followed by at least one space character. For example, a bulleted list item starts with
‘* ’, not with just
‘***’), and so on
;’) and a space (see above), followed by any amount of text, and the description starts with a colon (’
:’). Your syntax should look like this:
; Term: Description.
For tabular information that doesn’t fit in lists or definition lists, use tables.
For example, this table has two columns, with the second row having an empty first column, and the third and final column spanning all the rows.
||First row||||Second column|| || ||Not empty|| ||||Span the columns||
|First row||Second column|
|Span the columns|
Official documentation is at Oddmuse:Table Markup Extension.
:’) – more colons mean more indention.
Conversation should be separated with
[new] on a line by itself (starting in column 1). Currently, everything below each
[new] is visually separated by having an alternate background color.
Alternate contributions (alternate
[new]’s) are shaded, like this:
[new] Someone’s contribution… [new] Someone else’s contribution. [new] Another contribution. [new] Yet another.
Putting [new::] will insert your UserName, and adds a timestamp to your contribution when you save the page. The timestamp appears when you move the mouse over the contribution. See also UsingPortraits.
Please refrain from altering the above example’s wiki markup in an attempt to “clean it up”; usually this leaves it looking like this:
[new:SamuelBronson:2009-04-29 17:27 UTC]
...}}, etc. do not prevent it’s being expanded; you must actually prevent those characters from all appearing next to one another in the source of the page in order to prevent their being expanded. (This is arguably a bug.) Also, we must use
<tt> to get fixed-width formatting because otherwised the
<nowiki> tags used to break up the string show up:
A contribution after a
[new] ends at either the next
[new], the next heading (see below), or the next horizontal line (see above).
Use headings, horizontal lines or even new pages to separate threads of discussions, but use
[new] to separate entries in the thread.
;;;) are formatted as code. No other rules are applied.
}}}are formatted as code.
<code>: Code (usually monospaced, plus escaping of wiki processing): <code>foo</code> →
foo(see WikiTags above)
<pre>: Preformatted (usually monospaced, for paragraphs, plus whitespace is preserved, plus escaping of wiki processing).
<pre>tags must be alone on a line, to work. (see WikiTags above)
Headings are enclosed in equals signs (=) on a line of their own. You can use up to six equals signs to produce headers of level one to six. Level one is the most important one, and should not be used because the page title already uses a level one heading. This is why level one headings are automatically translated to level two headings.
== Heading 2 == === Heading 3 ===
Using two or three equals signs is recommended (
== like this ==). Nothing beyond a level 4 heading is supported by the CSS stylesheet. After level 4, they are not displayed differently. Overuse of headings is poor style, as short Wiki pages are preferred to long ones. Consider splitting the page into two or more pages.
To put an image on a page, insert the URL with an image suffix.
Alternatively, put image: and a page name inside double square brackets to insert inline images. The images must exist on the Wiki, or be uploaded to a page on the Wiki. See UploadingImages.
Discussions in the EmacsChannel can be copied directly to the Wiki.
<hybrid> emacs has a text adventure game in it <PyroMithrandir> emacs IS a text adventure game
A page on the wiki can “include” other pages. This is especially helpful for marking certain pages as out-of-date, requiring refactoring, candidates for deletion, or wiki projects.
There is more to it, however. See Oddmuse:Transclusion.
The resulting HTML doesn’t tell you that ExamplePage has been transcluded, but if you’re on ExamplePage, clicking on the header will search for it. It’s up to the users to use a decent prefix to identify pages that are to be transcluded and to mention the page name this piece of text is from.
To change the name of a page without losing all of the archived links to the original name, create a new page with the original content and new name, and redirect the old name, by replacing the entire page with:
#REDIRECT FooBar”, where “FooBar” is the new, target Wiki page.
More details at PageRedirection
For questions, problems, and comments see TextFormattingDiscussion.
For discussions on formatting style see StyleGuide.
See also HowToEdit.