Mercurial > wikked

comparison docs/pages/04_syntax.md @ 398:0f4032dafc1f

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
docs: Adjustments to documentation.
author Ludovic Chabant <ludovic@chabant.com>
date Fri, 23 Oct 2015 23:50:18 -0700
parents dcaa41b39c23
children
comparison
equal deleted inserted replaced
397:dcaa41b39c23 398:0f4032dafc1f
1 --- 1 ---
2 title: Syntax 2 title: Syntax
3 icon: pencil 3 icon: pencil
4 header_img: melting.png 4 header_img: soldier_monkey.png
5 --- 5 ---
6 6
7 ## Formatting 7 ## Formatting
8 8
9 By default, Wikked will use [Markdown][] syntax, so that things like these: 9 By default, Wikked will use [Markdown][] syntax, so that things like these:
12 foxy, didn't you? **Well!** The last to go will see the first three go 12 foxy, didn't you? **Well!** The last to go will see the first three go
13 before her! _And your mangy little dog, too!_ 13 before her! _And your mangy little dog, too!_
14 14
15 ...turn into this: 15 ...turn into this:
16 16
17 > Ring around the rosie, a pocket full of *spears*! Thought you were pretty 17 Ring around the rosie, a pocket full of *spears*! Thought you were pretty foxy,
18 > foxy, didn't you? **Well!** The last to go will see the first three go 18 didn't you? **Well!** The last to go will see the first three go before her!
19 > before her! _And your mangy little dog, too!_ 19 _And your mangy little dog, too!_
20 20
21 [markdown]: http://daringfireball.net/projects/markdown/ 21 [markdown]: http://daringfireball.net/projects/markdown/
22 22
23 Page files that have a `.md` extension will be formatted using Markdown. Other 23 Page files that have a `.md` extension will be formatted using Markdown. Other
24 formats can be used, like Textile, by using other extensions. 24 formats can be used, like Textile, by using other extensions.
94 94
95 * `notitle`: If specified, the Wikked UI won't show the title of this page. This 95 * `notitle`: If specified, the Wikked UI won't show the title of this page. This
96 lets you use a banner graphic or some other way to present the page to 96 lets you use a banner graphic or some other way to present the page to
97 a visitor. 97 a visitor.
98 98
99 * `redirect`: Redirects to another page. 99 * `redirect`: Redirects to another page. The link resolution rules apply to the
100 redirect target.
100 101
101 * `readers`: Specifies the users who can read this page. When not present, the 102 * `readers`: Specifies the users who can read this page. When not present, the
102 default readers for the wiki will be able to read the page. See the 103 default readers for the wiki will be able to read the page. See the
103 [configuration page][1] for more information. 104 [configuration page][1] for more information.
104 105
114 115
115 {%raw%} 116 {%raw%}
116 {{include: Warning}} 117 {{include: Warning}}
117 {%endraw%} 118 {%endraw%}
118 119
119 You can supply a relative or absolute page name to the `include` meta. For 120 You can supply a relative or absolute page name to the `include` meta -- link
120 convenience, however, Wikked will first look in the `/Templates` folder for a 121 resolving rules apply. For convenience, however, if the path is not absolute,
121 page of that name to include. If it doesn't find one, it will resolve the path 122 Wikked will first look in the `/Templates` folder for a page of that name to
122 as usual. 123 include. If it doesn't find one, it will resolve the path as usual.
123 124
124 > You can make Wikked look into a different folder than `/Templates` by changing 125 > You can make Wikked look into a different folder than `/Templates` by changing
125 > the `templates_dir` option in the configuration file. See the [configuration 126 > the `templates_dir` option in the configuration file. See the [configuration
126 > documentation][1] for more information. 127 > documentation][1] for more information.
127 128