Sierra Vista Community Theatre Wiki

Entertain, Educate, Empower and Inspire

User Tools

Site Tools

You are here: Welcome » wiki » Formatting Syntax
Trace: • Formatting Syntax
wiki:syntax

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Next revision		Previous revision
wiki:syntax [08/04/2024 11:28 PM (20 months ago)] – created - external edit 127.0.0.1wiki:syntax [03/31/2026 10:49 PM (8 hours ago)] (current) – noted bug in RSS feed command Chris Daley
Line 5: Line 5:
 ===== Basic Text Formatting ===== ===== Basic Text Formatting =====
  
-DokuWiki supports **bold**, //italic//, __underlined__ and ''monospaced'' texts. Of course you can **__//''combine''//__** all these.+DokuWiki supports **bold**, //italic//, __underlined__ and ''monospaced'' texts. Of course you can //**''__combine__''**// all these.
  
   DokuWiki supports **bold**, //italic//, __underlined__ and ''monospaced'' texts.   DokuWiki supports **bold**, //italic//, __underlined__ and ''monospaced'' texts.
Line 20: Line 20:
 **Paragraphs** are created from blank lines. If you want to **force a newline** without a paragraph, you can use two backslashes followed by a whitespace or the end of line. **Paragraphs** are created from blank lines. If you want to **force a newline** without a paragraph, you can use two backslashes followed by a whitespace or the end of line.
  
-This is some text with some linebreaks\\ Note that the +This is some text with some linebreaks\\ Note that the two backslashes are only recognized at the end of a line\\  or followed by\\ a whitespace \\this happens without it.
-two backslashes are only recognized at the end of a line\\ +
-or followed by\\ a whitespace \\this happens without it.+
  
   This is some text with some linebreaks\\ Note that the   This is some text with some linebreaks\\ Note that the
Line 36: Line 34:
 ==== External ==== ==== External ====
  
-External links are recognized automagically: http://www.google.com or simply www.google.com - You can set the link text as well: [[http://www.google.com|This Link points to google]]. Email addresses like this one: <andi@splitbrain.org> are recognized, too.+External links are recognized automagically: [[http://www.google.com]] or simply [[http://www.google.com|www.google.com]] - You can set the link text as well: [[http://www.google.com|This Link points to google]]. Email addresses like this one: [[andi@splitbrain.org]] are recognized, too.
  
   DokuWiki supports multiple ways of creating links. External links are recognized   DokuWiki supports multiple ways of creating links. External links are recognized
Line 107: Line 105:
 ===== Footnotes ===== ===== Footnotes =====
  
-You can add footnotes ((This is a footnote)) by using double parentheses.+You can add footnotes (( 
 +This is a footnote 
 +)) by using double parentheses.
  
   You can add footnotes ((This is a footnote)) by using double parentheses.   You can add footnotes ((This is a footnote)) by using double parentheses.
Line 113: Line 113:
 ===== Sectioning ===== ===== Sectioning =====
  
-You can use up to five different levels of headlines to structure your content. If you have more than three headlines, a table of contents is generated automatically -- this can be disabled by including the string ''<nowiki>~~NOTOC~~</nowiki>'' in the document.+You can use up to five different levels of headlines to structure your content. If you have more than three headlines, a table of contents is generated automatically -- this can be disabled by including the string ''%%~~NOTOC~~%%'' in the document.
  
 ==== Headline Level 3 ==== ==== Headline Level 3 ====
 +
 === Headline Level 4 === === Headline Level 4 ===
 +
 == Headline Level 5 == == Headline Level 5 ==
  
Line 135: Line 137:
 Resize to given width:            {{wiki:dokuwiki-128.png?50}} Resize to given width:            {{wiki:dokuwiki-128.png?50}}
  
-Resize to given width and height((when the aspect ratio of the given width and height doesn't match that of the image, it will be cropped to the new ratio before resizing)): {{wiki:dokuwiki-128.png?200x50}}+Resize to given width and height(( 
 +when the aspect ratio of the given width and height doesn't match that of the image, it will be cropped to the new ratio before resizing 
 +)): {{wiki:dokuwiki-128.png?200x50}}
  
 Resized external image:           {{https://www.php.net/images/php.gif?200x50}} Resized external image:           {{https://www.php.net/images/php.gif?200x50}}
Line 143: Line 147:
   Resize to given width and height: {{wiki:dokuwiki-128.png?200x50}}   Resize to given width and height: {{wiki:dokuwiki-128.png?200x50}}
   Resized external image:           {{https://www.php.net/images/php.gif?200x50}}   Resized external image:           {{https://www.php.net/images/php.gif?200x50}}
- 
  
 By using left or right whitespaces you can choose the alignment. By using left or right whitespaces you can choose the alignment.
Line 172: Line 175:
 | Video | ''webm'', ''ogv'', ''mp4'' | | Video | ''webm'', ''ogv'', ''mp4'' |
 | Audio | ''ogg'', ''mp3'', ''wav''  | | Audio | ''ogg'', ''mp3'', ''wav''  |
-| Flash | ''swf''                    |+| Flash | ''swf''  |
  
 If you specify a filename that is not a supported media format, then it will be displayed as a link instead. If you specify a filename that is not a supported media format, then it will be displayed as a link instead.
Line 208: Line 211:
   - That's it   - That's it
  
-<code>+<code ->
   * This is a list   * This is a list
   * The second item   * The second item
Line 258: Line 261:
 Typography: [[DokuWiki]] can convert simple text characters to their typographically correct entities. Here is an example of recognized characters. Typography: [[DokuWiki]] can convert simple text characters to their typographically correct entities. Here is an example of recognized characters.
  
--> <- <-> => <= <=> >> << -- --- 640x480 (c) (tm) (r) +-> <- <-> => <= <=> >> << -- --- 640x480 (c) (tm) (r) "He thought 'It's a man's world'..."
-"He thought 'It's a man's world'..."+
  
-<code>+<code ->
 -> <- <-> => <= <=> >> << -- --- 640x480 (c) (tm) (r) -> <- <-> => <= <=> >> << -- --- 640x480 (c) (tm) (r)
 "He thought 'It's a man's world'..." "He thought 'It's a man's world'..."
Line 274: Line 276:
 Some times you want to mark some text to show it's a reply or comment. You can use the following syntax: Some times you want to mark some text to show it's a reply or comment. You can use the following syntax:
  
-<code>+<code ->
 I think we should do it I think we should do it
  
Line 304: Line 306:
 DokuWiki supports a simple syntax to create tables. DokuWiki supports a simple syntax to create tables.
  
-^ Heading 1      ^ Heading 2       ^ Heading 3          ^ +^ Heading 1  ^ Heading 2  ^ Heading 3  ^ 
-| Row 1 Col 1    | Row 1 Col 2     | Row 1 Col 3        | +| Row 1 Col 1  | Row 1 Col 2  | Row 1 Col 3  | 
-| Row 2 Col 1    | some colspan (note the double pipe) || +| Row 2 Col 1  | some colspan (note the double pipe) || 
-| Row 3 Col 1    | Row 3 Col 2     | Row 3 Col 3        |+| Row 3 Col 1  | Row 3 Col 2  | Row 3 Col 3  |
  
 Table rows have to start and end with a ''|'' for normal rows or a ''^'' for headers. Table rows have to start and end with a ''|'' for normal rows or a ''^'' for headers.
Line 320: Line 322:
 Vertical tableheaders are possible, too. Vertical tableheaders are possible, too.
  
-|              ^ Heading 1            ^ Heading 2          ^ +|   ^ Heading 1  ^ Heading 2  ^ 
-^ Heading 3    | Row 1 Col 2          | Row 1 Col 3        | +^ Heading 3  | Row 1 Col 2  | Row 1 Col 3  | 
-^ Heading 4    | no colspan this time |                    | +^ Heading 4  | no colspan this time |   | 
-^ Heading 5    | Row 2 Col 2          | Row 2 Col 3        |+^ Heading 5  | Row 2 Col 2  | Row 2 Col 3  |
  
 As you can see, it's the cell separator before a cell which decides about the formatting: As you can see, it's the cell separator before a cell which decides about the formatting:
Line 334: Line 336:
 You can have rowspans (vertically connected cells) by adding ''%%:::%%'' into the cells below the one to which they should connect. You can have rowspans (vertically connected cells) by adding ''%%:::%%'' into the cells below the one to which they should connect.
  
-^ Heading 1      ^ Heading 2                  ^ Heading 3          ^ +^ Heading 1  ^ Heading 2  ^ Heading 3  ^ 
-| Row 1 Col 1    | this cell spans vertically | Row 1 Col 3        | +| Row 1 Col 1  | this cell spans vertically | Row 1 Col 3  | 
-| Row 2 Col 1    | :::                        | Row 2 Col 3        | +| Row 2 Col 1  | ::: | Row 2 Col 3  | 
-| Row 3 Col 1    | :::                        | Row 2 Col 3        |+| Row 3 Col 1  | ::: | Row 2 Col 3  |
  
 Apart from the rowspan syntax those cells should not contain anything else. Apart from the rowspan syntax those cells should not contain anything else.
Line 348: Line 350:
 You can align the table contents, too. Just add at least two whitespaces at the opposite end of your text: Add two spaces on the left to align right, two spaces on the right to align left and two spaces at least at both ends for centered text. You can align the table contents, too. Just add at least two whitespaces at the opposite end of your text: Add two spaces on the left to align right, two spaces on the right to align left and two spaces at least at both ends for centered text.
  
-^           Table with alignment           ^^^ +^  Table with alignment  ||^ 
-|         right|    center    |left          | +|  right |  center  | left  | 
-|left          |         right|    center    |+| left  |  right |  center  |
 | xxxxxxxxxxxx | xxxxxxxxxxxx | xxxxxxxxxxxx | | xxxxxxxxxxxx | xxxxxxxxxxxx | xxxxxxxxxxxx |
  
Line 366: Line 368:
 If you need to display text exactly like it is typed (without any formatting), enclose the area either with ''%%<nowiki>%%'' tags or even simpler, with double percent signs ''<nowiki>%%</nowiki>''. If you need to display text exactly like it is typed (without any formatting), enclose the area either with ''%%<nowiki>%%'' tags or even simpler, with double percent signs ''<nowiki>%%</nowiki>''.
  
-<nowiki> +%% This is some text which contains addresses like this: http://www.splitbrain.org and **formatting**, but nothing is done with it. %% The same is true for %%//__this__ text// with a smiley ;-)%%.
-This is some text which contains addresses like this: http://www.splitbrain.org and **formatting**, but nothing is done with it. +
-</nowiki> +
-The same is true for %%//__this__ text// with a smiley ;-)%%.+
  
   <nowiki>   <nowiki>
Line 382: Line 381:
   This is text is indented by two spaces.   This is text is indented by two spaces.
  
-<code>+<code ->
 This is preformatted code all spaces are preserved: like              <-this This is preformatted code all spaces are preserved: like              <-this
 </code> </code>
  
-<file>+<code ->
 This is pretty much the same, but you could use it to show that you quoted a file. This is pretty much the same, but you could use it to show that you quoted a file.
-</file>+</code>
  
 Those blocks were created by this source: Those blocks were created by this source:
Line 404: Line 403:
 ==== Syntax Highlighting ==== ==== Syntax Highlighting ====
  
-[[wiki:DokuWiki]] can highlight sourcecode, which makes it easier to read. It uses the [[http://qbnz.com/highlighter/|GeSHi]] Generic Syntax Highlighter -- so any language supported by GeSHi is supported. The syntax uses the same code and file blocks described in the previous section, but this time the name of the language syntax to be highlighted is included inside the tag, e.g. ''<nowiki><code java></nowiki>'' or ''<nowiki><file java></nowiki>''.+[[wiki:DokuWiki]] can highlight sourcecode, which makes it easier to read. It uses the [[http://qbnz.com/highlighter/|GeSHi]] Generic Syntax Highlighter -- so any language supported by GeSHi is supported. The syntax uses the same code and file blocks described in the previous section, but this time the name of the language syntax to be highlighted is included inside the tag, e.g. ''%%<code java>%%'' or ''%%<file java>%%''.
  
 <code java> <code java>
Line 426: Line 425:
 When you use the ''%%<code>%%'' or ''%%<file>%%'' syntax as above, you might want to make the shown code available for download as well. You can do this by specifying a file name after language code like this: When you use the ''%%<code>%%'' or ''%%<file>%%'' syntax as above, you might want to make the shown code available for download as well. You can do this by specifying a file name after language code like this:
  
-<code>+<code ->
 <file php myexample.php> <file php myexample.php>
 <?php echo "hello world!"; ?> <?php echo "hello world!"; ?>
Line 432: Line 431:
 </code> </code>
  
-<file php myexample.php>+<code php myexample.php>
 <?php echo "hello world!"; ?> <?php echo "hello world!"; ?>
-</file>+</code>
  
 If you don't want any highlighting but want a downloadable file, specify a dash (''-'') as the language code: ''%%<code - myfile.foo>%%''. If you don't want any highlighting but want a downloadable file, specify a dash (''-'') as the language code: ''%%<code - myfile.foo>%%''.
  
 ===== RSS/ATOM Feed Aggregation ===== ===== RSS/ATOM Feed Aggregation =====
 +
 [[DokuWiki]] can integrate data from external XML feeds. For parsing the XML feeds, [[http://simplepie.org/|SimplePie]] is used. All formats understood by SimplePie can be used in DokuWiki as well. You can influence the rendering by multiple additional space separated parameters: [[DokuWiki]] can integrate data from external XML feeds. For parsing the XML feeds, [[http://simplepie.org/|SimplePie]] is used. All formats understood by SimplePie can be used in DokuWiki as well. You can influence the rendering by multiple additional space separated parameters:
  
 ^ Parameter  ^ Description ^ ^ Parameter  ^ Description ^
 | any number | will be used as maximum number items to show, defaults to 8 | | any number | will be used as maximum number items to show, defaults to 8 |
-| reverse    | display the last items in the feed first | +| reverse  | display the last items in the feed first | 
-| author     | show item authors names | +| author  | show item authors names | 
-| date       | show item dates | +| date  | show item dates | 
-| description| show the item description. All HTML tags will be stripped | +| description | show the item description. All HTML tags will be stripped | 
-| nosort     | do not sort the items in the feed |+| nosort  | do not sort the items in the feed |
 | //n//[dhm] | refresh period, where d=days, h=hours, m=minutes. (e.g. 12h = 12 hours). | | //n//[dhm] | refresh period, where d=days, h=hours, m=minutes. (e.g. 12h = 12 hours). |
  
Line 456: Line 456:
 **Example:** **Example:**
  
-  {{rss>http://slashdot.org/index.rss 5 author date 1h }} +  {{rss>https://xkcd.com/rss.xml 5 author date 1h }}
- +
-{{rss>http://slashdot.org/index.rss 5 author date 1h }}+
  
 +{{xxxrss>https://xkcd.com/rss.xml 5 author date 1h}} -- //RSS command broken for now -- Chris//
  
 ===== Control Macros ===== ===== Control Macros =====
Line 465: Line 464:
 Some syntax influences how DokuWiki renders a page without creating any output it self. The following control macros are availble: Some syntax influences how DokuWiki renders a page without creating any output it self. The following control macros are availble:
  
-^ Macro           ^ Description | +^ Macro  ^ Description ^ 
-| %%~~NOTOC~~%%   | If this macro is found on the page, no table of contents will be created |+| %%~~NOTOC~~%%  | If this macro is found on the page, no table of contents will be created |
 | %%~~NOCACHE~~%% | DokuWiki caches all output by default. Sometimes this might not be wanted (eg. when the %%<php>%% syntax above is used), adding this macro will force DokuWiki to rerender a page on every call | | %%~~NOCACHE~~%% | DokuWiki caches all output by default. Sometimes this might not be wanted (eg. when the %%<php>%% syntax above is used), adding this macro will force DokuWiki to rerender a page on every call |
  
Line 474: Line 473:
  
 ~~INFO:syntaxplugins~~ ~~INFO:syntaxplugins~~
 +
  
wiki/syntax.1722839287.txt.gz · Last modified: by 127.0.0.1