Editing HelpOnFormatting

   

<Include(HelpMenu)> OpenWiki offers many system options to the administrator of an OpenWiki site, so the formatting rules may differ between various OpenWiki sites. This particular wiki has every system option turned on except the one that would give editors the ability to enter raw HTML into a page (with some minor exceptions to that exception ;-) ). <TableOfContents/> === The Basics === * Forget HTML. It is not allowed. So <b>bold</b> will not appear in a bold font, but instead as you see it right now. The & character references will not work either. * Do not indent paragraphs. * Words wrap and fill as needed. * Leave a blank line between paragraphs. * Type 4 or more minus/dash/hyphen (-) characters to create a horizontal rule. * URL's and email addresses are automatically hyperlinked. * WikiName""s are automatically hyperlinked. A WikiName conforms to the LinkPattern, which basically is a word containing more than one capital letter where the capitals aren't right next to each other. In other words, simply SmashWordsTogetherLikeSo. That's basically all you need to know to get started. Following are more basic rules. For advanced formatting rules see HelpOnEditing. === Bold, Italic, Underscore, Strikethrough === To mark text as **bold** enclose text by two asterisks <nowiki>(*)</nowiki> characters on both sides. To mark text as //italic// enclose text by two slash (/) characters on both sides. To mark text __underlined__ enclose text by two underscore (_) characters on both sides. To mark text --strikethrough-- enclose text by two dash (-) characters on both sides. {{{ **Some bold text**, //some italic text//, and **//some bold and italic text//** __Some underlined text__ --Some strikethrough text-- }}} will appear as: **Some bold text**, //some italic text//, and **//some bold and italic text//** <br/> __Some underlined text__ --Some strikethrough text-- ~OpenWiki also supports the "old" style of placing emphasis on text which is used by several original wikis. {{{ <nowiki>''2 quotes are italic'', '''3 quotes are bold''', and '''''5 quotes are bold and italic'''''</nowiki> }}} will appear as: ''2 quotes are italic'', '''3 quotes are bold''', and '''''5 quotes are bold and italic''''' Note: whether the "new" and/or "old" style of placing emphasis on text is in effect depends on the system options as configured by the administrator of this site. === Linking === See also HelpOnLinking. InterWiki links, e.g.: * Whois:moonshake.com * Google:Aphex+Twin * Dictionary:GuineaPig * Artist:Radiohead * ISBN: 0-898-15627-0 * RFC:821 * Groups:alt.delete.this.group * Acronym:HTML * HtmlHelp:FORM === Lists === All lists start with 2 spaces at the beginning of a line. Sublists are created by adding an additional 2 spaces for every level that you want to add. See also HelpOnLists. ==== Bulleted Lists ==== {{{ * Bulleted Item * Another one * Subbulleted item * And another one * Last one }}} will appear as: * Bulleted Item * Another one * Subbulleted item * And another one * Last one ==== Numbered Lists ==== {{{ 1. First item 2. Second item 1. First subitem of //second item// 1. Second subitem of //second item// a. subitem a a. subitem b 1. Third subitem of //second item// i. subitem 1 i. subitem 2 3. Third item 1.#17 another item 1. yet another one 4. Fourth item a.#17 another item a. yet another one 5. Fifth item i.#17 another item i. yet another one }}} will appear as: 1. First item 2. Second item 1. First subitem of //second item// 1. Second subitem of //second item// a. subitem a a. subitem b 1. Third subitem of //second item// i. subitem 1 i. subitem 2 3. Third item 1.#17 another item 1. yet another one 4. Fourth item a.#17 another item a. yet another one 5. Fifth item i.#17 another item i. yet another one ==== Dictionary Lists ==== Terms with indented definitions: [without a blank line between term and definition] {{{ ; Term One : Definition for One (indented) ; Term Two : Definition for Two (indented) ; Term Three : Definition for Three (indented) ; Term (indented) : Definition (indented two levels) ; Term (indented twice) : Definition (indented to third level) }}} will appear as: ; Term One : Definition for One (indented) ; Term Two : Definition for Two (indented) ; Term Three : Definition for Three (indented) ; Term (indented) : Definition (indented two levels) ; Term (indented twice) : Definition (indented to third level) ==== Mixing Lists ==== You can also mix lists, for example: {{{ * First bulleted item * Second bulleted item 1. First subitem of **second item** Some more text about first subitem.... End of this subitem. 2. Second subitem of **second item** * Last bulleted item }}} will appear as: * First bulleted item * Second bulleted item 1. First subitem of **second item** Some more text about first subitem.... End of this subitem. 2. Second subitem of **second item** * Last bulleted item === Indented text === {{{ : Paragraph to be indented (quote-block) : Paragraph indented more : Paragraph indented to third level }}} will appear as: : Paragraph to be indented (quote-block) : Paragraph indented more : Paragraph indented to third level === Preformatted text === === Sourcecode === If you want to display sourcecode use the {{{<code>}}} tag or enclose the source by three acolades (e.g. <nowiki>{{{some code}}}</nowiki>). Singleline example: {{{ <nowiki>The command {{{foo := bar + 1;}}} will add 1 to bar and assign it to foo.</nowiki> }}} will appear as: The command {{{foo := bar + 1;}}} will add 1 to bar and assign it to foo. Multiline example: {{{ <nowiki>{{{ begin foo := bar + 1; end; }}}</nowiki> }}} will appear as: {{{ begin foo := bar + 1; end; }}} Note that within sourcecode most features won't work, such as: automatic hyperlinking of URLs, WikiName''''''s, making text italic, etc. What still does work within sourcecode is the ability to highlight text by using three single quotes and the ability to use the {{{<nowiki><</nowiki>nowiki>}}} tag. Example: {{{ <nowiki><code> begin '''foo := bar + 1;''' foo := foo << 1; return foo; end; </code></nowiki> }}} will appear as: <code> begin '''foo := bar + 1;''' foo := foo << 1; return foo; end; </code> === Tables === {{{ || **ID** || **Name** || **Description** || || 123 || John Foo || Some foo user || || 456 || Mary Richardson || Contact person from Foo Corp. || }}} will appear as: || **ID** || **Name** || **Description** || || 123 || John Foo || Some foo user || || 456 || Mary Richardson || Contact person from Foo Corp. || From more details about how to format tables see HelpOnTables. === Miscellaneous === ---- CategoryHelp
Include page in Recent Changes list.

Optional comment about this change: