WikiSyntax.wiki
author Wuzzy
Fri, 13 Jul 2018 04:01:53 +0100
changeset 1445 abd165fa6426
parent 1444 b5bd32ab09ed
child 1446 62a948dbdcad
permissions -rw-r--r--
WikiSyntax: Horizontal line
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
1444
b5bd32ab09ed WikiSyntax: Rebranding, remove Google stuff
Wuzzy
parents: 590
diff changeset
     1
#summary The reference to the wiki syntax for the Hedgewars Knowledge Base
590
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
     2
#labels Restrict-AddWikiComment-Commit
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
     3
= Wiki Syntax =
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
     4
<wiki:toc max_depth="2" /> 
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
     5
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
     6
= Introduction =
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
     7
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
     8
Each wiki page is stored in a .wiki file under the /wiki directory in
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
     9
a project's repository.  Each file's name is the same as the wiki page
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
    10
name.  And, each wiki file consists of optional pragma lines followed
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
    11
by the content of the page.
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
    12
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
    13
= Pragmas =
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
    14
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
    15
Optional pragma lines provide metadata about the page and how it should be
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
    16
displayed. These lines are only processed if they appear at the top of
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
    17
the file.  Each pragma line begins with a pound-sign (#) and the
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
    18
pragma name, followed by a value.
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
    19
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
    20
|| *Pragma*   || *Value*  ||
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
    21
|| #summary   || One-line summary of the page ||
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
    22
|| #labels    || Comma-separated list of labels (filled in automatically via the web UI) ||
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
    23
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
    24
= Wiki-style markup =
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
    25
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
    26
== Paragraphs ==
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
    27
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
    28
Use one or more blank lines to separate paragraphs. 
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
    29
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
    30
== Typeface ==
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
    31
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
    32
||* Name/Sample*   || * Markup *       ||
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
    33
||  _italic_       || `_italic_`       ||
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
    34
||  *bold*         || `*bold*`         ||
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
    35
||  `code`         || {{{`code`}}}     ||
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
    36
||  {{{code}}}     || `{{{code}}}`     ||
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
    37
||  ^super^script  || `^super^script`  ||
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
    38
||  ,,sub,,script  || `,,sub,,script`  ||
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
    39
|| ~~strikeout~~   || `~~strikeout~~`  ||
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
    40
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
    41
You can mix these typefaces in some ways:
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
    42
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
    43
||       *Markup*                    ||        *Result*                 ||
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
    44
|| `_*bold* in italics_`             || _*bold* in italics_             ||
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
    45
|| `*_italics_ in bold*`             || *_italics_ in bold*             ||
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
    46
|| `*~~strike~~ works too*`          || *~~strike~~ works too*          ||
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
    47
|| `~~as well as _this_ way round~~` || ~~as well as _this_ way round~~ ||
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
    48
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
    49
== Code ==
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
    50
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
    51
If you have a multiline code block that you want to display verbatim,
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
    52
use the multiline code delimiter:
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
    53
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
    54
{{{
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
    55
{{{
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
    56
def fib(n):
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
    57
  if n == 0 or n == 1:
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
    58
    return n
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
    59
  else:
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
    60
    # This recursion is not good for large numbers.
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
    61
    return fib(n-1) + fib(n-2)
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
    62
}}}
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
    63
}}}
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
    64
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
    65
Which results in:
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
    66
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
    67
{{{
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
    68
def fib(n):
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
    69
  if n == 0 or n == 1:
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
    70
    return n
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
    71
  else:
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
    72
    # This recursion is not good for large numbers.
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
    73
    return fib(n-1) + fib(n-2)
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
    74
}}}
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
    75
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
    76
For more control over the syntax higlighting, the `<code>` tag allows you to specify a file extension:
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
    77
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
    78
{{{
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
    79
<code language="xml">
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
    80
<hello target="world"/>
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
    81
</code>
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
    82
}}}
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
    83
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
    84
To disable highlighting entirely, use the `<pre>` tag.
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
    85
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
    86
== Headings ==
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
    87
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
    88
{{{
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
    89
= Heading =
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
    90
== Subheading ==
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
    91
=== Level 3 ===
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
    92
==== Level 4 ====
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
    93
===== Level 5 =====
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
    94
====== Level 6 ======
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
    95
}}}
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
    96
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
    97
== Dividers ==
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
    98
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
    99
Four or more dashes on a line by themselves results in a horizontal rule.
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   100
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   101
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   102
== Lists ==
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   103
1444
b5bd32ab09ed WikiSyntax: Rebranding, remove Google stuff
Wuzzy
parents: 590
diff changeset
   104
The HWKB wiki supports both bulleted and numbered lists. A list
590
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   105
must be indented at least one space to be recognized as such. You can
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   106
also nest lists one within the other by appropriate use of indenting:
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   107
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   108
{{{
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   109
The following is:
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   110
  * A list
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   111
  * Of bulleted items
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   112
    # This is a numbered sublist
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   113
    # Which is done by indenting further
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   114
  * And back to the main bulleted list
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   115
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   116
 * This is also a list
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   117
 * With a single leading space
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   118
 * Notice that it is rendered
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   119
  # At the same levels
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   120
  # As the above lists.
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   121
 * Despite the different indentation levels.
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   122
}}}
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   123
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   124
The following is:
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   125
  * A list
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   126
  * Of bulleted items
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   127
    # This is a numbered sublist
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   128
    # Which is done by indenting further
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   129
  * And back to the main bulleted list
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   130
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   131
 * This is also a list
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   132
 * With a single leading space
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   133
 * Notice that it is rendered
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   134
  # At the same levels
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   135
  # As the above lists.
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   136
 * Despite the different indentation levels.
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   137
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   138
== Quoting ==
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   139
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   140
Block quotes place emphasis on a particular extract of text in your
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   141
page. Block quotes are created by indenting a paragraph by at least
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   142
one space:
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   143
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   144
{{{
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   145
Someone once said:
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   146
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   147
  This sentence will be quoted in the future as the canonical example
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   148
  of a quote that is so important that it should be visually separate
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   149
  from the rest of the text in which it appears.
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   150
}}}
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   151
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   152
Someone once said:
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   153
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   154
  This sentence will be quoted in the future as the canonical example
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   155
  of a quote that is so important that it should be visually separate
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   156
  from the rest of the text in which it appears.
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   157
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   158
== Links ==
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   159
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   160
Links are central to the wiki principle, as they create the web of
1444
b5bd32ab09ed WikiSyntax: Rebranding, remove Google stuff
Wuzzy
parents: 590
diff changeset
   161
content. The HWKB wiki permits both internal (within the wiki) and
590
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   162
external links, and in some cases automatically creates a link when it
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   163
recognizes either a !WikiWord or an URL.
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   164
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   165
=== Internal wiki links ===
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   166
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   167
Internal links within a wiki are created using the syntax below. If
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   168
you add a wiki link to a page that does not exist, the link will
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   169
appear with a !LittleLink[WikiSyntax ?] to project committers and
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   170
owners. Clicking that link will take you to the page creation form
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   171
where you can enter content for that page.
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   172
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   173
If you are not logged in, wiki links that point to non-existent pages
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   174
will appear as plain text, without the link to the page creation
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   175
form. When you create the target page,
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   176
the link will become a normal hyperlink for all viewers of
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   177
the page.
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   178
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   179
{{{
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   180
WikiSyntax is identified and linked automatically
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   181
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   182
Wikipage is not identified, so if you have a page named [Wikipage] you
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   183
need to link it explicitly.
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   184
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   185
If the WikiSyntax page is actually about reindeers, you can provide a
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   186
description, so that people know you are actually linking to a page on
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   187
[WikiSyntax reindeer flotillas].
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   188
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   189
If you want to mention !WikiSyntax without it being autolinked, use an
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   190
exclamation mark to prevent linking.
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   191
}}}
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   192
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   193
WikiSyntax is identified and linked automatically
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   194
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   195
Wikipage is not identified, so if you have a page named [Wikipage] you
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   196
need to link it explicitly.
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   197
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   198
If the WikiSyntax page is actually about reindeers, you can provide a
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   199
description, so that people know you are actually linking to a page on
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   200
[WikiSyntax reindeer flotillas].
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   201
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   202
If you want to mention !WikiSyntax without it being autolinked, use an
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   203
exclamation mark to prevent linking.
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   204
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   205
=== Links to anchors within a page ===
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   206
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   207
Each heading defines a HTML anchor with the same name as the heading, but with spaces replaced by underscores. You can
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   208
create a link to a specific heading on a page like this:
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   209
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   210
{{{
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   211
[WikiSyntax#Wiki-style_markup]
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   212
}}}
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   213
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   214
And it will render as: [WikiSyntax#Wiki-style_markup].
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   215
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   216
=== Links to issues and revisions ===
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   217
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   218
You can easily link to issues and revisions using the following syntax.
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   219
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   220
  * `issue 123` will be autolinked to issue number 123 in the current project.  You can include a `#` or not.  If the issue has been closed, the link will appear as a cross-out rather than an underline.  Hovering your mouse over such a link shows the issue summary.
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   221
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   222
  * `issue PROJECTNAME:122` will be autolinked to that issue number in the specified project.  This is useful when your project depends on work being done in related projects.
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   223
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   224
  * `r123` will be autolinked to the revision detail page for that revision in the current project.
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   225
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   226
There is currently no way to disable this type of autolinking. See issue 996.
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   227
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   228
{{{
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   229
For example: Please add a comment on issue 123 rather than adding more review comments to r456. 
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   230
}}}
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   231
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   232
Renders as: Please add a comment on issue 123 rather than adding more review comments to r456.
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   233
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   234
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   235
=== Links to external pages ===
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   236
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   237
You can of course link to external pages from your own wiki pages,
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   238
using a syntax similar to that for internal links:
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   239
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   240
{{{
1444
b5bd32ab09ed WikiSyntax: Rebranding, remove Google stuff
Wuzzy
parents: 590
diff changeset
   241
Plain URLs such as https://www.example.org/ automatically made into links.
590
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   242
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   243
You can also provide some descriptive text. For example, the following
1444
b5bd32ab09ed WikiSyntax: Rebranding, remove Google stuff
Wuzzy
parents: 590
diff changeset
   244
link points to the [https://www.example.org Example homepage].
590
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   245
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   246
If your link points to an image, it will get inserted as an image tag
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   247
into the page:
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   248
1444
b5bd32ab09ed WikiSyntax: Rebranding, remove Google stuff
Wuzzy
parents: 590
diff changeset
   249
https://www.hedgewars.org/images/Static_Hat_Template.png
590
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   250
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   251
You can also make the image into a link, by setting the image URL as
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   252
the description of the URL you want to link:
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   253
1444
b5bd32ab09ed WikiSyntax: Rebranding, remove Google stuff
Wuzzy
parents: 590
diff changeset
   254
[https://www.hedgewars.org/ https://www.hedgewars.org/images/Static_Hat_Template.png]
590
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   255
}}}
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   256
1444
b5bd32ab09ed WikiSyntax: Rebranding, remove Google stuff
Wuzzy
parents: 590
diff changeset
   257
Plain URLs such as https://www.example.org/ automatically made into links.
590
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   258
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   259
You can also provide some descriptive text. For example, the following
1444
b5bd32ab09ed WikiSyntax: Rebranding, remove Google stuff
Wuzzy
parents: 590
diff changeset
   260
link points to the [https://www.example.org Example homepage].
b5bd32ab09ed WikiSyntax: Rebranding, remove Google stuff
Wuzzy
parents: 590
diff changeset
   261
b5bd32ab09ed WikiSyntax: Rebranding, remove Google stuff
Wuzzy
parents: 590
diff changeset
   262
If your link points to an image, it will get inserted as an image tag
b5bd32ab09ed WikiSyntax: Rebranding, remove Google stuff
Wuzzy
parents: 590
diff changeset
   263
into the page:
b5bd32ab09ed WikiSyntax: Rebranding, remove Google stuff
Wuzzy
parents: 590
diff changeset
   264
b5bd32ab09ed WikiSyntax: Rebranding, remove Google stuff
Wuzzy
parents: 590
diff changeset
   265
https://www.hedgewars.org/images/Static_Hat_Template.png
590
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   266
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   267
You can also make the image into a link, by setting the image URL as
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   268
the description of the URL you want to link:
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   269
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   270
{{{
1444
b5bd32ab09ed WikiSyntax: Rebranding, remove Google stuff
Wuzzy
parents: 590
diff changeset
   271
[https://www.hedgewars.org/ https://www.hedgewars.org/images/Static_Hat_Template.png]
590
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   272
}}}
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   273
1444
b5bd32ab09ed WikiSyntax: Rebranding, remove Google stuff
Wuzzy
parents: 590
diff changeset
   274
[https://www.hedgewars.org/ https://www.hedgewars.org/images/Static_Hat_Template.png]
590
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   275
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   276
=== Links to images ===
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   277
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   278
If your link points to an image (that is, if it ends in `.png`,
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   279
`.gif`, `.jpg` or `.jpeg`), it will get inserted as an image into the
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   280
page:
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   281
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   282
{{{
1444
b5bd32ab09ed WikiSyntax: Rebranding, remove Google stuff
Wuzzy
parents: 590
diff changeset
   283
https://www.hedgewars.org/images/Static_Hat_Template.png
590
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   284
}}}
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   285
1444
b5bd32ab09ed WikiSyntax: Rebranding, remove Google stuff
Wuzzy
parents: 590
diff changeset
   286
https://www.hedgewars.org/images/Static_Hat_Template.png
590
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   287
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   288
If the image is produced by a server-side script, you may need to add a nonsense query string parameter to the end so that the URL ends with a supported image filename extension.
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   289
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   290
{{{
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   291
http://chart.apis.google.com/chart?chs=200x125&chd=t:48.14,33.79,19.77|83.18,18.73,12.04&cht=bvg&nonsense=something_that_ends_with.png
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   292
}}}
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   293
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   294
http://chart.apis.google.com/chart?chs=200x125&chd=t:48.14,33.79,19.77|83.18,18.73,12.04&cht=bvg&nonsense=something_that_ends_with.png
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   295
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   296
== Tables ==
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   297
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   298
Tables are created by entering the content of each cell separated by
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   299
{{{||}}} delimiters. You can insert other inline wiki syntax in table
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   300
cells, including typeface formatting and links.
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   301
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   302
{{{
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   303
|| *Year* || *Temperature (low)* || *Temperature (high)* ||
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   304
|| 1900 || -10 || 25 ||
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   305
|| 1910 || -15 || 30 ||
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   306
|| 1920 || -10 || 32 ||
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   307
|| 1930 || _N/A_ || _N/A_ ||
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   308
|| 1940 || -2 || 40 ||
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   309
}}}
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   310
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   311
|| *Year* || *Temperature (low)* || *Temperature (high)* ||
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   312
|| 1900 || -10 || 25 ||
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   313
|| 1910 || -15 || 30 ||
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   314
|| 1920 || -10 || 32 ||
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   315
|| 1930 || _N/A_ || _N/A_ ||
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   316
|| 1940 || -2 || 40 ||
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   317
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   318
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   319
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   320
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   321
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   322
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   323
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   324
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   325
= HTML support =
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   326
To aid in the presentation of a wiki page there is some support for HTML. HTML tags are only supported in wiki pages, not in page comments.
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   327
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   328
HTML syntax can be used in conjunction with wiki syntax, but it is recommended against doing so where possible.<wiki:comment>Also, avoid blank lines between list items.</wiki:comment>
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   329
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   330
The following HTML tags and attributes are currently supported:
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   331
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   332
<table border=1>
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   333
<thead><th>HTML Tag</th><th>Supported Attributes</th></thead>
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   334
<tbody>
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   335
<tr><td>a</td><td>title dir lang href</td></tr>
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   336
<tr><td>b</td><td>title dir lang</td></tr>
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   337
<tr><td>br</td><td>title dir lang</td></tr>
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   338
<tr><td>blockquote</td><td>title dir lang</td></tr>
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   339
<tr><td>code</td><td>title dir lang language `[1]`</td></tr>      
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   340
<tr><td>dd</td><td>title dir lang</td></tr>
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   341
<tr><td>div</td><td>title dir lang</td></tr>
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   342
<tr><td>dl</td><td>title dir lang</td></tr>      
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   343
<tr><td>dt</td><td>title dir lang</td></tr>      
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   344
<tr><td>em</td><td>title dir lang</td></tr>      
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   345
<tr><td>font</td><td>title dir lang face size color</td></tr>      
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   346
<tr><td>h1</td><td>title dir lang</td></tr>      
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   347
<tr><td>h2</td><td>title dir lang</td></tr>      
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   348
<tr><td>h3</td><td>title dir lang</td></tr>      
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   349
<tr><td>h4</td><td>title dir lang</td></tr>      
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   350
<tr><td>h5</td><td>title dir lang</td></tr>      
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   351
<tr><td>i</td><td>title dir lang</td></tr>      
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   352
<tr><td>img</td><td>title dir lang src alt border height width align</td></tr>  
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   353
<tr><td>li</td><td>title dir lang</td></tr>      
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   354
<tr><td>ol</td><td>title dir lang type start</td></tr>    
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   355
<tr><td>p</td><td>title dir lang align</td></tr>     
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   356
<tr><td>pre</td><td>title dir lang</td></tr>      
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   357
<tr><td>q</td><td>title dir lang</td></tr>      
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   358
<tr><td>s</td><td>title dir lang</td></tr>      
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   359
<tr><td>span</td><td>title dir lang</td></tr>      <tr><td>strike</td><td>title dir lang</td></tr>      <tr><td>strong</td><td>title dir lang</td></tr>      
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   360
<tr><td>sub</td><td>title dir lang</td></tr>      
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   361
<tr><td>sup</td><td>title dir lang</td></tr>  
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   362
<tr><td>table</td><td>title dir lang align valign cellspacing cellpadding border width height</td></tr>  
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   363
<tr><td>tbody</td><td>title dir lang align valign cellspacing cellpadding border width height</td></tr>  
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   364
<tr><td>td</td><td>title dir lang align valign cellspacing cellpadding border width height</td></tr>  
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   365
<tr><td>tfoot</td><td>title dir lang align valign cellspacing cellpadding border width height</td></tr>  
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   366
<tr><td>th</td><td>title dir lang align valign cellspacing cellpadding border width height</td></tr>  
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   367
<tr><td>thead</td><td>title dir lang align valign cellspacing cellpadding border width height colspan rowspan</td></tr>
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   368
<tr><td>tr</td><td>title dir lang align valign cellspacing cellpadding border width height colspan rowspan</td></tr>
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   369
<tr><td>tt</td><td>title dir lang</td></tr>      
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   370
<tr><td>u</td><td>title dir lang</td></tr>      
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   371
<tr><td>ul</td><td>title dir lang type</td></tr>     
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   372
<tr><td>var</td><td>title dir lang</td></tr>      </tbody>
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   373
</table>
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   374
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   375
`[1]` The language attribute of the code tag is the file extension of the language used in the code block. It is used as a hint for the syntax highlighter.
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   376
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   377
== Escaping HTML Tags ==
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   378
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   379
When you want to display html tags directly on your wiki page (as opposed to rendered), you will need to escape each HTML tag. 
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   380
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   381
HTML tags can be escaped as shown in the table below:
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   382
<table border="1">
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   383
<thead><th>Markup</th><th>Result</th></thead>
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   384
<tbody>
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   385
<tr><td> {{{`<hr>`}}}</td><td>`<hr>`</td></tr>
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   386
<tr><td> `{{{<hr>}}}`</td><td>{{{<hr>}}}</td></tr>
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   387
</tbody>
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   388
</table>
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   389
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   390
<br/>
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   391
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   392
= Comments =
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   393
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   394
The wiki supports embedded comments to help explain the contents of a wiki page. Anything inside the comment block is removed from the rendered page, but is visible when editing or viewing the source for that page.
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   395
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   396
{{{
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   397
<wiki:comment>
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   398
This text will be removed from the rendered page.
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   399
</wiki:comment>
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   400
}}}
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   401
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   402
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   403
= Navigation =
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   404
== Table of Contents ==
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   405
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   406
An inline table of contents can be generated from page headers on a wiki page. Add the following syntax to a page in the location the table of contents should be displayed:
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   407
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   408
{{{
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   409
<wiki:toc max_depth="1" />
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   410
}}}
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   411
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   412
Valid attributes are:
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   413
 * `max_depth`: the maximum header depth to display in the table of contents
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   414
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   415
== Side navigation ==
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   416
1444
b5bd32ab09ed WikiSyntax: Rebranding, remove Google stuff
Wuzzy
parents: 590
diff changeset
   417
You can specify the sidebar for a wiki page by selecting another wiki page that defines your side navigation.
590
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   418
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   419
One way of adding a sidebar is by setting the #sidebar pragma, as shown below. Alternatively, the sidebar pragma can be left blank if no side navigation is desired. 
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   420
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   421
|| #sidebar !TableOfContents ||
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   422
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   423
The side navigation that is defined should be in the format of a simple list, as shown below. 
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   424
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   425
{{{
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   426
  * [Articles HOWTO articles]
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   427
    * [ArticlesXSS Web security]
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   428
    * [ArticlesDom DOM manipulation]
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   429
    * [ArticlesStyle CSS and style]
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   430
    * [ArticlesTips Tips and tricks]
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   431
  * [DOMReference DOM reference]
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   432
  * [HTMLElements HTML reference]
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   433
  * [CSSReference CSS reference]
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   434
}}}
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   435
1445
abd165fa6426 WikiSyntax: Horizontal line
Wuzzy
parents: 1444
diff changeset
   436
----
590
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   437
1444
b5bd32ab09ed WikiSyntax: Rebranding, remove Google stuff
Wuzzy
parents: 590
diff changeset
   438
_The content on this page is based on the old Google Code documentation for Google Code wikis and has been adapted and changed to fit the HWKB. The original document by Google is licensed under the [http://creativecommons.org/licenses/by/3.0/ Creative Commons Attribution 3.0 License].  User-generated content is not included in this license._