WikiSyntax.wiki
author Wuzzy
Fri, 19 Apr 2019 15:47:17 +0100
changeset 1826 24b348e89a57
parent 1737 60b8b33c0392
child 1851 e478f27e9976
permissions -rw-r--r--
LuaLibraryUtils: Add four upcoming 1.0.0 functions
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
= Wiki Syntax =
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
     3
<wiki:toc max_depth="2" /> 
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
     4
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
     5
= Introduction =
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
     6
1448
d5675d69b286 WikiSyntax: Update introduction for HWKB
Wuzzy
parents: 1447
diff changeset
     7
This page describes the wiki syntax of the Hedgewars Knowledge Base.
d5675d69b286 WikiSyntax: Update introduction for HWKB
Wuzzy
parents: 1447
diff changeset
     8
d5675d69b286 WikiSyntax: Update introduction for HWKB
Wuzzy
parents: 1447
diff changeset
     9
Each wiki page is stored in a `.wiki` file in the [https://hg.hedgewars.org/hwkb/ hwkb repository].
d5675d69b286 WikiSyntax: Update introduction for HWKB
Wuzzy
parents: 1447
diff changeset
    10
There are just text files with some simple markup.
d5675d69b286 WikiSyntax: Update introduction for HWKB
Wuzzy
parents: 1447
diff changeset
    11
Each file's name is the same as the wiki page name.  And, each wiki file consists of optional
d5675d69b286 WikiSyntax: Update introduction for HWKB
Wuzzy
parents: 1447
diff changeset
    12
pragma lines followed by the content of the page.
590
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
    13
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
    14
= Pragmas =
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
    15
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
    16
Optional pragma lines provide metadata about the page and how it should be
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
    17
displayed. These lines are only processed if they appear at the top of
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
    18
the file.  Each pragma line begins with a pound-sign (#) and the
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
    19
pragma name, followed by a value.
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
    20
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
    21
|| *Pragma*   || *Value*  ||
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
    22
|| #summary   || One-line summary of the page ||
1458
729a59e18c7d WikiSyntax: labels are not auto-filled
Wuzzy
parents: 1457
diff changeset
    23
|| #labels    || Comma-separated list of labels ||
590
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
    24
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
    25
= Wiki-style markup =
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
    26
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
    27
== Paragraphs ==
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
    28
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
    29
Use one or more blank lines to separate paragraphs. 
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
    30
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
    31
== Typeface ==
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
    32
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
    33
||* Name/Sample*   || * Markup *       ||
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
    34
||  _italic_       || `_italic_`       ||
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
    35
||  *bold*         || `*bold*`         ||
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
||  {{{code}}}     || `{{{code}}}`     ||
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
    38
||  ^super^script  || `^super^script`  ||
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
    39
||  ,,sub,,script  || `,,sub,,script`  ||
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
    40
|| ~~strikeout~~   || `~~strikeout~~`  ||
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
    41
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
    42
You can mix these typefaces in some ways:
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
    43
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
    44
||       *Markup*                    ||        *Result*                 ||
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
    45
|| `_*bold* in italics_`             || _*bold* in italics_             ||
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
    46
|| `*_italics_ in bold*`             || *_italics_ in bold*             ||
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
    47
|| `*~~strike~~ works too*`          || *~~strike~~ works too*          ||
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
    48
|| `~~as well as _this_ way round~~` || ~~as well as _this_ way round~~ ||
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
    49
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
    50
== Code ==
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
    51
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
    52
If you have a multiline code block that you want to display verbatim,
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
    53
use the multiline code delimiter:
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
{{{
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
    57
def fib(n):
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
    58
  if n == 0 or n == 1:
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
    59
    return n
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
    60
  else:
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
    61
    # This recursion is not good for large numbers.
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
    62
    return fib(n-1) + fib(n-2)
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
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
    66
Which results in:
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
    67
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
    68
{{{
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
    69
def fib(n):
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
    70
  if n == 0 or n == 1:
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
    71
    return n
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
    72
  else:
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
    73
    # This recursion is not good for large numbers.
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
    74
    return fib(n-1) + fib(n-2)
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
    75
}}}
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
    76
1453
a48722ae24fa WikiSyntax: about syntax highlighting
Wuzzy
parents: 1452
diff changeset
    77
The `<code>` tag allows you to specify a file extension (note: syntax highlighting is not implemented yet):
590
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
    78
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
    79
{{{
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
    80
<code language="xml">
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
    81
<hello target="world"/>
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
    82
</code>
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
    83
}}}
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
    84
1453
a48722ae24fa WikiSyntax: about syntax highlighting
Wuzzy
parents: 1452
diff changeset
    85
The `<pre>` tag is like the code tag, but will never use syntax highlighting.
590
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
    86
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
    87
== Headings ==
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
    88
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
    89
{{{
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
    90
= Heading =
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
    91
== Subheading ==
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
    92
=== Level 3 ===
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
    93
==== Level 4 ====
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
    94
===== Level 5 =====
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
    95
====== Level 6 ======
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
    96
}}}
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
    97
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
    98
== Dividers ==
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
    99
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   100
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
   101
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   102
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   103
== Lists ==
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   104
1444
b5bd32ab09ed WikiSyntax: Rebranding, remove Google stuff
Wuzzy
parents: 590
diff changeset
   105
The HWKB wiki supports both bulleted and numbered lists. A list
590
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   106
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
   107
also nest lists one within the other by appropriate use of indenting:
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   108
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   109
{{{
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   110
The following is:
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   111
  * A list
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   112
  * Of bulleted items
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   113
    # This is a numbered sublist
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   114
    # Which is done by indenting further
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   115
  * And back to the main bulleted list
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   116
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   117
 * This is also a list
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   118
 * With a single leading space
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   119
 * Notice that it is rendered
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   120
  # At the same levels
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   121
  # As the above lists.
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   122
 * Despite the different indentation levels.
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   123
}}}
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   124
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   125
The following is:
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   126
  * A list
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   127
  * Of bulleted items
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   128
    # This is a numbered sublist
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   129
    # Which is done by indenting further
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   130
  * And back to the main bulleted list
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   131
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   132
 * This is also a list
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   133
 * With a single leading space
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   134
 * Notice that it is rendered
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   135
  # At the same levels
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   136
  # As the above lists.
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   137
 * Despite the different indentation levels.
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   138
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   139
== Links ==
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   140
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   141
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
   142
content. The HWKB wiki permits both internal (within the wiki) and
590
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   143
external links, and in some cases automatically creates a link when it
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   144
recognizes either a !WikiWord or an URL.
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   145
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   146
=== Internal wiki links ===
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   147
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   148
Internal links within a wiki are created using the syntax below. If
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   149
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
   150
appear with a !LittleLink[WikiSyntax ?] to project committers and
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   151
owners. Clicking that link will take you to the page creation form
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   152
where you can enter content for that page.
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   153
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   154
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
   155
will appear as plain text, without the link to the page creation
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   156
form. When you create the target page,
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   157
the link will become a normal hyperlink for all viewers of
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   158
the page.
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   159
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   160
{{{
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   161
WikiSyntax is identified and linked automatically
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   162
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   163
Wikipage is not identified, so if you have a page named [Wikipage] you
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   164
need to link it explicitly.
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   165
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   166
If the WikiSyntax page is actually about reindeers, you can provide a
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   167
description, so that people know you are actually linking to a page on
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   168
[WikiSyntax reindeer flotillas].
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   169
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   170
If you want to mention !WikiSyntax without it being autolinked, use an
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   171
exclamation mark to prevent linking.
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   172
}}}
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   173
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   174
WikiSyntax is identified and linked automatically
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   175
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   176
Wikipage is not identified, so if you have a page named [Wikipage] you
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   177
need to link it explicitly.
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   178
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   179
If the WikiSyntax page is actually about reindeers, you can provide a
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   180
description, so that people know you are actually linking to a page on
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   181
[WikiSyntax reindeer flotillas].
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   182
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   183
If you want to mention !WikiSyntax without it being autolinked, use an
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   184
exclamation mark to prevent linking.
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   185
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   186
=== Links to anchors within a page ===
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   187
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   188
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
   189
create a link to a specific heading on a page like this:
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   190
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   191
{{{
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   192
[WikiSyntax#Wiki-style_markup]
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   193
}}}
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   194
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   195
And it will render as: [WikiSyntax#Wiki-style_markup].
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   196
1736
a44311807172 WikiSyntax: Add header disambiguation
Wuzzy
parents: 1461
diff changeset
   197
==== Header disambiguation ====
a44311807172 WikiSyntax: Add header disambiguation
Wuzzy
parents: 1461
diff changeset
   198
a44311807172 WikiSyntax: Add header disambiguation
Wuzzy
parents: 1461
diff changeset
   199
Sometimes the page needs multiple headers with the same name. In this case, the normal header link will always lead to the first header. If you want to link to the *n*th header (starting with 2), append two underscores and the number *n*.
a44311807172 WikiSyntax: Add header disambiguation
Wuzzy
parents: 1461
diff changeset
   200
1737
60b8b33c0392 WikiSyntax: fix header counter
Wuzzy
parents: 1736
diff changeset
   201
For example, to link to the third header named “Header” in the page “!WikiSyntax”, use `[WikiSyntax#Header__3]`.
1736
a44311807172 WikiSyntax: Add header disambiguation
Wuzzy
parents: 1461
diff changeset
   202
590
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   203
=== Links to external pages ===
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   204
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   205
You can of course link to external pages from your own wiki pages,
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   206
using a syntax similar to that for internal links:
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   207
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   208
{{{
1444
b5bd32ab09ed WikiSyntax: Rebranding, remove Google stuff
Wuzzy
parents: 590
diff changeset
   209
Plain URLs such as https://www.example.org/ automatically made into links.
590
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   210
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   211
You can also provide some descriptive text. For example, the following
1444
b5bd32ab09ed WikiSyntax: Rebranding, remove Google stuff
Wuzzy
parents: 590
diff changeset
   212
link points to the [https://www.example.org Example homepage].
590
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   213
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   214
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
   215
into the page:
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   216
1454
b984777b8269 WikiSyntax: Update links to external pages preview
Wuzzy
parents: 1453
diff changeset
   217
https://www.hedgewars.org/images/hwkb_example.png
590
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   218
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   219
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
   220
the description of the URL you want to link:
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   221
1454
b984777b8269 WikiSyntax: Update links to external pages preview
Wuzzy
parents: 1453
diff changeset
   222
[https://www.hedgewars.org/ https://www.hedgewars.org/images/hwkb_example.png]
590
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   223
}}}
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   224
1444
b5bd32ab09ed WikiSyntax: Rebranding, remove Google stuff
Wuzzy
parents: 590
diff changeset
   225
Plain URLs such as https://www.example.org/ automatically made into links.
590
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   226
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   227
You can also provide some descriptive text. For example, the following
1444
b5bd32ab09ed WikiSyntax: Rebranding, remove Google stuff
Wuzzy
parents: 590
diff changeset
   228
link points to the [https://www.example.org Example homepage].
b5bd32ab09ed WikiSyntax: Rebranding, remove Google stuff
Wuzzy
parents: 590
diff changeset
   229
b5bd32ab09ed WikiSyntax: Rebranding, remove Google stuff
Wuzzy
parents: 590
diff changeset
   230
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
   231
into the page:
b5bd32ab09ed WikiSyntax: Rebranding, remove Google stuff
Wuzzy
parents: 590
diff changeset
   232
1449
102830fb1c4d WikiSyntax: Replace example images
Wuzzy
parents: 1448
diff changeset
   233
https://www.hedgewars.org/images/hwkb_example.png
590
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   234
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   235
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
   236
the description of the URL you want to link:
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   237
1449
102830fb1c4d WikiSyntax: Replace example images
Wuzzy
parents: 1448
diff changeset
   238
[https://www.hedgewars.org/ https://www.hedgewars.org/images/hwkb_example.png]
590
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   239
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   240
=== Links to images ===
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   241
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   242
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
   243
`.gif`, `.jpg` or `.jpeg`), it will get inserted as an image into the
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   244
page:
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   245
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   246
{{{
1449
102830fb1c4d WikiSyntax: Replace example images
Wuzzy
parents: 1448
diff changeset
   247
https://www.hedgewars.org/images/hwkb_example.png
590
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   248
}}}
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   249
1449
102830fb1c4d WikiSyntax: Replace example images
Wuzzy
parents: 1448
diff changeset
   250
https://www.hedgewars.org/images/hwkb_example.png
590
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   251
1451
dbeae3841e1d WikiSyntax: Update example image for nonsense url
Wuzzy
parents: 1450
diff changeset
   252
If the URL of the image does not end with a standard file name suffix such as `.png`, you may need to add a `nonsense` query string parameter to the end so that the URL ends with a supported image filename extension. For example, for the URL `https://www.hedgewars.org/images/hwkb_example_weird_suffix.foo` (which refers to a PNG image), you could write instead:
590
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   253
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   254
{{{
1451
dbeae3841e1d WikiSyntax: Update example image for nonsense url
Wuzzy
parents: 1450
diff changeset
   255
https://www.hedgewars.org/images/hwkb_example_weird_suffix.foo?nonsense=something_that_ends_with.png
590
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   256
}}}
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   257
1451
dbeae3841e1d WikiSyntax: Update example image for nonsense url
Wuzzy
parents: 1450
diff changeset
   258
https://www.hedgewars.org/images/hwkb_example_weird_suffix.foo?nonsense=something_that_ends_with.png
590
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   259
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   260
== Tables ==
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   261
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   262
Tables are created by entering the content of each cell separated by
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   263
{{{||}}} delimiters. You can insert other inline wiki syntax in table
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   264
cells, including typeface formatting and links.
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   265
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   266
{{{
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   267
|| *Year* || *Temperature (low)* || *Temperature (high)* ||
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   268
|| 1900 || -10 || 25 ||
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   269
|| 1910 || -15 || 30 ||
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   270
|| 1920 || -10 || 32 ||
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   271
|| 1930 || _N/A_ || _N/A_ ||
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   272
|| 1940 || -2 || 40 ||
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   273
}}}
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   274
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   275
|| *Year* || *Temperature (low)* || *Temperature (high)* ||
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   276
|| 1900 || -10 || 25 ||
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   277
|| 1910 || -15 || 30 ||
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   278
|| 1920 || -10 || 32 ||
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   279
|| 1930 || _N/A_ || _N/A_ ||
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   280
|| 1940 || -2 || 40 ||
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   281
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   282
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   283
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   284
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   285
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   286
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   287
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   288
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   289
= HTML support =
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   290
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
   291
1460
867e9278315d WikiSyntax: Remove un-needed wiki:comment
Wuzzy
parents: 1459
diff changeset
   292
HTML syntax can be used in conjunction with wiki syntax, but it is recommended against doing so where possible.
590
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   293
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   294
The following HTML tags and attributes are currently supported:
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   295
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   296
<table border=1>
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   297
<thead><th>HTML Tag</th><th>Supported Attributes</th></thead>
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   298
<tbody>
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   299
<tr><td>a</td><td>title dir lang href</td></tr>
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   300
<tr><td>b</td><td>title dir lang</td></tr>
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   301
<tr><td>br</td><td>title dir lang</td></tr>
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   302
<tr><td>blockquote</td><td>title dir lang</td></tr>
1453
a48722ae24fa WikiSyntax: about syntax highlighting
Wuzzy
parents: 1452
diff changeset
   303
<tr><td>code</td><td>title dir lang</td></tr>      
590
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   304
<tr><td>dd</td><td>title dir lang</td></tr>
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   305
<tr><td>div</td><td>title dir lang</td></tr>
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   306
<tr><td>dl</td><td>title dir lang</td></tr>      
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   307
<tr><td>dt</td><td>title dir lang</td></tr>      
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   308
<tr><td>em</td><td>title dir lang</td></tr>      
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   309
<tr><td>font</td><td>title dir lang face size color</td></tr>      
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   310
<tr><td>h1</td><td>title dir lang</td></tr>      
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   311
<tr><td>h2</td><td>title dir lang</td></tr>      
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   312
<tr><td>h3</td><td>title dir lang</td></tr>      
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   313
<tr><td>h4</td><td>title dir lang</td></tr>      
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   314
<tr><td>h5</td><td>title dir lang</td></tr>      
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   315
<tr><td>i</td><td>title dir lang</td></tr>      
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   316
<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
   317
<tr><td>li</td><td>title dir lang</td></tr>      
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   318
<tr><td>ol</td><td>title dir lang type start</td></tr>    
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   319
<tr><td>p</td><td>title dir lang align</td></tr>     
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   320
<tr><td>pre</td><td>title dir lang</td></tr>      
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   321
<tr><td>q</td><td>title dir lang</td></tr>      
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   322
<tr><td>s</td><td>title dir lang</td></tr>      
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   323
<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
   324
<tr><td>sub</td><td>title dir lang</td></tr>      
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   325
<tr><td>sup</td><td>title dir lang</td></tr>  
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   326
<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
   327
<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
   328
<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
   329
<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
   330
<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
   331
<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
   332
<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
   333
<tr><td>tt</td><td>title dir lang</td></tr>      
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   334
<tr><td>u</td><td>title dir lang</td></tr>      
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   335
<tr><td>ul</td><td>title dir lang type</td></tr>     
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   336
<tr><td>var</td><td>title dir lang</td></tr>      </tbody>
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   337
</table>
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   338
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   339
== Escaping HTML Tags ==
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   340
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   341
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
   342
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   343
HTML tags can be escaped as shown in the table below:
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   344
<table border="1">
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   345
<thead><th>Markup</th><th>Result</th></thead>
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   346
<tbody>
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   347
<tr><td> {{{`<hr>`}}}</td><td>`<hr>`</td></tr>
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   348
<tr><td> `{{{<hr>}}}`</td><td>{{{<hr>}}}</td></tr>
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   349
</tbody>
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   350
</table>
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   351
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   352
= Navigation =
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   353
== Table of Contents ==
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   354
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   355
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
   356
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   357
{{{
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   358
<wiki:toc max_depth="1" />
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   359
}}}
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   360
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   361
Valid attributes are:
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   362
 * `max_depth`: the maximum header depth to display in the table of contents
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   363
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   364
== Side navigation ==
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   365
1446
62a948dbdcad WikiSyntax: Update sidebar stuff
Wuzzy
parents: 1445
diff changeset
   366
The sidebar is just another wiki page and defined in the special page [TableOfContents].
590
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   367
1446
62a948dbdcad WikiSyntax: Update sidebar stuff
Wuzzy
parents: 1445
diff changeset
   368
The side navigation that is defined should be in the format of a simple list, as shown below:
590
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   369
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   370
{{{
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   371
  * [Articles HOWTO articles]
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   372
    * [ArticlesXSS Web security]
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   373
    * [ArticlesDom DOM manipulation]
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   374
    * [ArticlesStyle CSS and style]
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   375
    * [ArticlesTips Tips and tricks]
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   376
  * [DOMReference DOM reference]
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   377
  * [HTMLElements HTML reference]
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   378
  * [CSSReference CSS reference]
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   379
}}}
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   380
1445
abd165fa6426 WikiSyntax: Horizontal line
Wuzzy
parents: 1444
diff changeset
   381
----
590
3e416a17f6b9 add GC's wiki syntax page
sheepluva
parents:
diff changeset
   382
1448
d5675d69b286 WikiSyntax: Update introduction for HWKB
Wuzzy
parents: 1447
diff changeset
   383
_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 Hedgewars Knowledge Base. 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._