Serendipity: bundled-libs/docs/SamplePage.wiki.txt

"Fossies" - the Fresh Open Source Software Archive

Member "serendipity/bundled-libs/docs/SamplePage.wiki.txt" (20 Nov 2022, 9368 Bytes) of package /linux/www/serendipity-2.4.0.zip:

As a special service "Fossies" has tried to format the requested text file into HTML format (style: standard) with prefixed line numbers. Alternatively you can here view or download the uninterpreted source code file.

1 + Sample Page for Text_Wiki Default Markup 2 3 %%TOC%% 4 5 ---- 6 7 ++ General Notes 8 9 The markup described on this page is for the default {{Text_Wiki}} rules; \ 10 it is a combination of the [http://tavi.sourceforge.net WikkTikkiTavi] \ 11 and [http://develnet.org/ coWiki] markup styles. 12 13 All text is entered as plain text, and will be converted to HTML entities as \ 14 necessary. This means that {{<}}, {{>}}, {{&}}, and so on are converted for \ 15 you (except in special situations where the characters are Wiki markup; \ 16 Text_Wiki is generally smart enough to know when to convert and when not to). 17 18 Just hit "return" twice to make a paragraph break. If you want \ 19 to keep the same logical line but have to split it across \ 20 two physical lines (such as when your editor only shows a certain number \ 21 of characters per line), end the line with a backslash {{\}} and hit \ 22 return once. This will cause the two lines to be joined on display, and the \ 23 backslash will not show. (If you end a line with a backslash and a tab \ 24 or space, it will ''not'' be joined with the next line, and the backslash \ 25 will be printed.) 26 27 28 ---- 29 30 ++ Inline Formatting 31 32 || {{```''italic text''```}} || ''italic text'' || 33 || {{```'''bold text'''```}} || '''bold text''' || 34 || {{```'''''italic and bold'''''```}} || '''''italic and bold''''' || 35 || {{```//emphasis//```}} || //emphasis// || 36 || {{```**strong**```}} || **strong** || 37 || {{```//**emphasis and strong**//```}} || //**emphasis and strong**// || 38 || {{```**//strong and emphasis//**```}} || **//strong and emphasis//** || 39 || {{```{{teletype text}}```}} || {{teletype text}} || 40 || {{<```php:function()```>}} || <php:function()> || 41 || {{```@@--- delete text +++ insert text @@```}} || @@--- delete text +++ insert text @@ || 42 || {{```@@--- delete only @@```}} || @@--- delete only @@ || 43 || {{```@@+++ insert only @@```}} || @@+++ insert only @@ || 44 || {{```super ^^1^^ script```}} || super ^^1^^ script || 45 46 ---- 47 48 ++ Literal Text 49 50 If you don't want Text_Wiki to parse some text, enclose it in 3 backticks (not 3 single-quotes). 51 52 <code> 53 54 This '''text''' gets {{parsed}}. 55 56 ```This '''text''' does not get {{parsed}}.``` 57 58 </code> 59 60 This '''text''' gets {{parsed}}. 61 62 ```This '''text''' does not get {{parsed}}.``` 63 64 ---- 65 66 ++ Headings 67 68 You can make various levels of heading by putting \ 69 equals-signs before and after the text (all on its \ 70 own line): 71 72 <code> 73 +++ Level 3 Heading 74 ++++ Level 4 Heading 75 +++++ Level 5 Heading 76 ++++++ Level 6 Heading 77 </code> 78 79 +++ Level 3 Heading 80 ++++ Level 4 Heading 81 +++++ Level 5 Heading 82 ++++++ Level 6 Heading 83 84 ---- 85 86 ++ Table of Contents 87 88 To create a list of every heading, with a link to that heading, put a table of contents tag on its own line. 89 90 <code> 91 %%TOC%% 92 </code> 93 ---- 94 95 ++ Horizontal Rules 96 97 Use four dashes ({{```----```}}) to create a horizontal rule. 98 99 ---- 100 101 ++ Lists 102 103 +++ Bullet Lists 104 105 You can create bullet lists by starting a paragraph with one or \ 106 more asterisks. 107 108 <code> 109 * Bullet one 110 * Sub-bullet 111 </code> 112 113 * Bullet one 114 * Sub-bullet 115 116 +++ Numbered Lists 117 118 Similarly, you can create numbered lists by starting a paragraph \ 119 with one or more hashes. 120 121 <code> 122 # Numero uno 123 # Number two 124 # Sub-item 125 </code> 126 127 # Numero uno 128 # Number two 129 # Sub-item 130 131 132 +++ Mixing Bullet and Number List Items 133 134 You can mix and match bullet and number lists: 135 136 <code> 137 # Number one 138 * Bullet 139 * Bullet 140 # Number two 141 * Bullet 142 * Bullet 143 * Sub-bullet 144 # Sub-sub-number 145 # Sub-sub-number 146 # Number three 147 * Bullet 148 * Bullet 149 </code> 150 151 # Number one 152 * Bullet 153 * Bullet 154 # Number two 155 * Bullet 156 * Bullet 157 * Sub-bullet 158 # Sub-sub-number 159 # Sub-sub-number 160 # Number three 161 * Bullet 162 * Bullet 163 164 165 166 +++ Definition Lists 167 168 You can create a definition (description) list with the following syntax: 169 170 <code> 171 :Item 1: Something 172 :Item 2: Something else 173 </code> 174 175 :Item 1: Something 176 :Item 2: Something else 177 178 ---- 179 180 ++ Block Quotes 181 182 You can mark a blockquote by starting a line with one or more '>' \ 183 characters, followed by a space and the text to be quoted. 184 185 <code> 186 This is normal text here. 187 188 > Indent me! The quick brown fox jumps over the lazy dog. \ 189 Now this the time for all good men to come to the aid of \ 190 their country. Notice how we can continue the block-quote \ 191 in the same "paragraph" by using a backslash at the end of \ 192 the line. 193 > 194 > Another block, leading to... 195 >> Second level of indenting. This second is indented even \ 196 more than the previous one. 197 198 Back to normal text. 199 </code> 200 201 This is normal text here. 202 203 > Indent me! The quick brown fox jumps over the lazy dog. \ 204 Now this the time for all good men to come to the aid of \ 205 their country. Notice how we can continue the block-quote \ 206 in the same "paragraph" by using a backslash at the end of \ 207 the line. 208 > 209 > Another block, leading to... 210 >> Second level of indenting. This second is indented even \ 211 more than the previous one. 212 213 Back to normal text. 214 215 216 ---- 217 218 ++ Links and Images 219 220 +++ Wiki Links 221 222 SmashWordsTogether to create a page link. 223 224 You can force a WikiPage name '''not''' to be clickable by putting \ 225 an exclamation mark in front of it. 226 227 <code> 228 WikiPage !WikiPage 229 </code> 230 231 WikiPage !WikiPage 232 233 (Note: existing wiki pages must be in the Text_Wiki {{pages}} option array, \ 234 and the {{view_url}} option must be set for the linking to work.) 235 236 +++ Free Links 237 238 Freelinks are "non-standard" Wiki links. 239 240 * You can refer to named anchors within pages like this: \ 241 {{```((WikiPage#NamedAnchor))```}} becomes ((WikiPage#NamedAnchor)). 242 * You can create nice-looking links from WordsSmashedTogether like this: \ 243 {{```((WordsSmashedTogether|Nice Link))```}} becomes \ 244 ((WordsSmashedTogether|Nice Link)). 245 * Refer to named anchors within nice-looking links like this: \ 246 {{```((WikiPage|Nice Link#Anchor))```}} becomes \ 247 ((WikiPage|Nice Link#Anchor)). 248 * You can also create links that aren't WordsSmashedTogether \ 249 (i.e., that have spaces) like this: {{```((free links))```}} \ 250 becomes ((free links)). 251 252 (Note: existing wiki pages must be in the Text_Wiki {{pages}} option array, \ 253 and the {{view_url}} option must be set for the linking to work.) 254 255 +++ Interwiki Links 256 257 Interwiki links are links to pages on other Wiki sites. \ 258 Type the {{```SiteName:PageName```}} like this: 259 260 * MeatBall:RecentChanges 261 * Advogato:proj/WikkiTikkiTavi 262 * Wiki:WorseIsBetter 263 264 (Note: the interwiki site must be in the Text_Wiki {{interwiki}} option array.) 265 266 +++ URLs 267 268 Create a remote link simply by typing its URL: http://ciaweb.net. 269 270 If you like, enclose it in brackets to create a numbered reference \ 271 and avoid cluttering the page; {{```[http://ciaweb.net/free/]```}} becomes [http://ciaweb.net/free/]. 272 273 Or you can have a described-reference instead of a numbered reference: 274 <code> 275 [http://pear.php.net PEAR] 276 </code> 277 [http://pear.php.net PEAR] 278 279 +++ Images 280 281 You can put a picture in a page by typing the URL to the picture \ 282 (it must end in gif, jpg, or png). 283 <code> 284 http://c2.com/sig/wiki.gif 285 </code> 286 287 http://c2.com/sig/wiki.gif 288 289 You can use the described-reference URL markup to give the image an ALT tag: 290 <code> 291 [http://www.netropolisusa.biz/billthemarmet/MT/index/images/sunset_07_10_03.jpg Sunset] 292 </code> 293 294 [http://www.netropolisusa.biz/billthemarmet/MT/index/images/sunset_07_10_03.jpg Sunset] 295 296 297 ---- 298 ++ Code Blocks 299 300 Create code blocks by using {{<code>...</code>}} tags (each on its own line). 301 302 <code> 303 This is an example code block! 304 </code> 305 306 307 To create PHP blocks that get automatically colorized when you use PHP tags, \ 308 simply surround the code with {{<php>...</php>}} tags (the tags themselves \ 309 should each be on their own lines, and no need for the {{<?php ... ?>}} tags). 310 311 <code> 312 <php> 313 // Set up the wiki options 314 $options = array(); 315 $options['view_url'] = "index.php?page="; 316 317 // load the text for the requested page 318 $text = implode('', file($page . '.wiki.txt')); 319 320 // create a Wiki objext with the loaded options 321 $wiki = new Text_Wiki($options); 322 323 // transform the wiki text. 324 echo $wiki->transform($text); 325 </php> 326 </code> 327 328 <php> 329 // Set up the wiki options 330 $options = array(); 331 $options['view_url'] = "index.php?page="; 332 333 // load the text for the requested page 334 $text = implode('', file($page . '.wiki.txt')); 335 336 // create a Wiki objext with the loaded options 337 $wiki = new Text_Wiki($options); 338 339 // transform the wiki text. 340 echo $wiki->transform($text); 341 </php> 342 343 ---- 344 345 ++ Tables 346 347 You can create tables using pairs of vertical bars: 348 349 <code> 350 || cell one || cell two || 351 |||| big ol' line || 352 || cell four || cell five || 353 || cell six || here's a very long cell || 354 </code> 355 356 || cell one || cell two || 357 |||| big ol' line || 358 || cell four || cell five || 359 || cell six || here's a very long cell || 360 361 <code> 362 || lines must start and end || with double vertical bars || nothing || 363 || cells are separated by || double vertical bars || nothing || 364 |||| you can span multiple columns by || starting each cell || 365 || with extra cell |||| separators || 366 |||||| but perhaps an example is the easiest way to see || 367 </code> 368 369 || lines must start and end || with double vertical bars || nothing || 370 || cells are separated by || double vertical bars || nothing || 371 |||| you can span multiple columns by || starting each cell || 372 || with extra cell |||| separators || 373 |||||| but perhaps an example is the easiest way to see || 374