mods/wiki/init-pages/ExtendedWikiMarkup

   1 You really should learn what the basic WikiMarkup can do for you, before you
   2 start to read about more complex features.
   3
   4
   5 !! Image markup
   6
   7 Images can be inlined into a page using square brackets around the absolute
   8 www-address of the image file, like ![http://www/image.png].
   9
  10 To align an image (define how the following text flows around it) one
  11 can add space characters inside the square brackets before and/or after
  12 its !http://-address:
  13 * text flows around on the right ![http://example.com/image.png  ]
  14 * left aligned image ![  http://example.com/image.png]
  15 * with spaces on the left and right, a image will display centred
  16
  17 One can also specify to which size a image shall be rescaled by the browser,
  18 if this is added as parameters with a query string like appendation; for
  19 example ![http://www.example.com/image.png?x=200&y=100] would scale the
  20 image to 200 pixels width and 100 pixels height. One can also use width= and
  21 height= parameters to do so.
  22
  23
  24 !! Anchors [#AnchOrs]
  25
  26 Instead of linking from page to page, one can also create inner page links
  27 using so called anchors. Anchors are defined and referenced using the hash
  28 sign inside square brackets. ![#anchorname] for example creates an anchor,
  29 to reference it one must put the page name in front of the hash sign,
  30 like ![ThisPage#anchorname].
  31
  32 Requiring a pagename in front of the anchor name to reference to it is some
  33 overhead but the only senseful way to create valid links. So to create
  34 links to an anchor on the current page one must write ![CurrentPage#anchor].
  35 But there is also the special dot notation, which allows to write
  36 ~[.#anchor] for a jump to an anchor inside of the current page.
  37
  38 Anchors and anchor references can and should also be entitled using
  39 quotation marks or the dash sign:
  40 * ![#anchor "Title for this anchor"].
  41 * ![anchors title | #anchor2]
  42
  43 If you ever happen to have a page name including the hash # sign as part of
  44 its name, then you must escape this one by appending another hash at the end
  45 of links to that page, like ~[PageAboutThe#Sign#] for example.
  46
  47 Please also note, that this behaviour is configurable, so defining anchors
  48 and referencing them may work differently on other sites.
  49
  50
  51 !! footnotes
  52
  53 To create a footnote {{ a footnote can contain additional information snippets}}
  54 use double curly brackets. Usually creating a new page to explain something
  55 in more detail is a much better approach, so the footnotes extension is a
  56 plugin in ErfurtWiki and thus not available per default.
  57
  58 !! Links
  59
  60 * a WikiWord will form a hyperlink
  61 * any valid www-address like http://www.example.com/ will do too
  62 * many nonvalid addresses will do too, see file://localhost/etc/passwd
  63 * [square brackets around text] makes a hyperlink
  64 ** adding (more) [[square brackets around it]] is more [[[[intuitive]]]] than with other wikis
  65 ** a ![title | for square bracket links ] can be added using the | character
  66 *** the title should be on the left to the linked WikiWord
  67 *** but for ewiki it can be on either side, because a http://www can be easily distinguished
  68 ** a !["title" for square bracket links] can also be assigned using quotation marks
  69 *** the title inside the quotation marks can be on either side of the !["..." wiki link] or ![http:// "URL"]
  70 *** you can use this too for image links
  71 *** this scheme is useful, but incompatible with other !WikiSoftware
  72 * the ! exclamation mark or the tilde ~ can be used to escape a !!WikiWord or a !!http://www.address.net/ and of course escapes !![square brackets] as easily
  73 ** this is more understandable than escaping with "[" like in other wikis (like [PhpWiki|PhpWiki:])
  74 * instead of square brackets, one may utilize the ^ character to make a ^^wikilink of !NotBumpyWords
  75
  76
  77 !! Lists
  78
  79 * one can create lists by writing an asterisk at the beginning of a line
  80 *# or enumerated lists by using a hash sign instead
  81 *# instead of the asterisk the - minus character can be used sometimes
  82 * definition lists can be created using :: at the line start or as sublist
  83 *:definition: explanation
  84 *:anotherdef: another description
  85 * there are some more rules
  86 *# lists should be separated with an empty line from other text
  87 *# put a space behind the list bullet (*, #, -, ::)
  88 *# a space in front of a list bullet escapes it (the line won't become a list entry)
  89
  90
  91 !! Paragraphs
  92
  93 Every block of text (without empty lines) will form a paragraph.
  94
  95       Text can be indented using spaces or TABs at the start of a line.
  96       Lists, Tables and headlines cannot be indented. (Indentation is
  97       counted in steps of ''nearly'' 3 spaces.)
  98
  99 You can right align text by using two minus characters at the beginning of a
 100 line, which is often used to sign a bracket of text.
 101 -- author
 102
 103
 104 !! Text style
 105
 106 * text can be made __bold__ or **bold**
 107 * or ''italic''
 108 * ##big## and µµsmallµµ
 109 * up^^set^^
 110
 111 But there exist equivalents in old style WikiMarkup:
 112
 113 * '''bold'''
 114 * '''''bold and italic'''''
 115
 116 And ##most## of µµtheseµµ things **can** be __''combined''__.
 117
 118
 119 !! hidden comments
 120
 121 * you can add hidden comments to your page
 122 ** users just viewing the page won't notice it
 123 ** it can only be seen, when the page gets edited
 124 * click on EditThisPage to see, how the standard HTML comment escape is used for this
 125
 126 <!-- I'm a hidden comment -->
 127
 128
 129 !! !InterWiki:Links
 130
 131 * there exist abbreviations for concurrent wikis on the web
 132 * to reference a page from another wiki, just prepend the Wikis name and a colon before the remote !WikiPageName
 133 ** ErfurtWiki:ErfurtWiki
 134 ** WardsWiki:WikiClones
 135 ** WardsWiki:InterWiki
 136 * that's why you should avoid the colon inside of square brackets
 137
 138
 139 !!! page blocks
 140
 141 <block>
 142      There can be some special areas within a Wiki page. And they are often
 143      enclosed in so called <block> tags, which look much like the ones of
 144      [HTML|HyperTextMarkupLanguage]. You however must write them
 145      all-lowercase, or else they won't work.
 146 </block>
 147
 148
 149 ! PRE-formatted text
 150
 151 If you wish text to appear as you type it - that is, all spaces remain
 152 where they are, and lines stay as long as you inserted it - then you need
 153 a block of "pre-formatted" text.
 154 * use the <pr&#101;> ... </pre> 'tags' for a paragraph of preformatted text,
 155   that still allowed to use [WikiWord]s and simple markup
 156 * with <cod&#101;>...</code> instead you would really see text as you typed it,
 157   with square brackets and other escapes not garbaging your text
 158
 159 <pre>
 160    This    fragment is        a  ''pre-formatted''
 161       paragraph.
 162 </pre>
 163
 164
 165 ! inline HTML
 166
 167 Per default most HTML won't work in a Wiki (using the rescuehtml plugin at
 168 least the simple tags would be allowed). So to use HTML in a Wiki page, it
 169 must be specifically configured (the _DB_F_HTML flag) or this needed to be
 170 globally allowed for your Wiki.
 171
 172 * you can however designate blocks of HTML using
 173 ** <htm&#108;>...</html> (all lowercase!)
 174 ** <ht&#109;>...</htm> which still allowed [WikiWord]s and most markup
 175
 176
 177
 178 !! in-page plugins (macros)
 179
 180 If configured, this wiki also allows to activate plugins inside of pages, which are called MpiPlugins.