Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision Next revision Both sides next revision | ||
|
wiki:syntax [2016/02/07 18:13] vedavrata [Syntax Highlighting] |
wiki:syntax [2016/02/07 18:14] vedavrata [Control Macros] |
||
|---|---|---|---|
| Line 10: | Line 10: | ||
| - | ==== Downloadable Code Blocks ==== | ||
| - | 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> | ||
| - | <file php myexample.php> | ||
| - | <?php echo "hello world!"; ?> | ||
| - | </file> | ||
| - | </code> | ||
| - | <file php myexample.php> | ||
| - | <?php echo "hello world!"; ?> | ||
| - | </file> | ||
| - | |||
| - | If you don't want any highlighting but want a downloadable file, specify a dash (''-'') as the language code: ''%%<code - myfile.foo>%%''. | ||
| - | |||
| - | |||
| - | ===== Embedding HTML and PHP ===== | ||
| - | |||
| - | You can embed raw HTML or PHP code into your documents by using the ''%%<html>%%'' or ''%%<php>%%'' tags. (Use uppercase tags if you need to enclose block level elements.) | ||
| - | |||
| - | HTML example: | ||
| - | |||
| - | <code> | ||
| - | <html> | ||
| - | This is some <span style="color:red;font-size:150%;">inline HTML</span> | ||
| - | </html> | ||
| - | <HTML> | ||
| - | <p style="border:2px dashed red;">And this is some block HTML</p> | ||
| - | </HTML> | ||
| - | </code> | ||
| - | |||
| - | <html> | ||
| - | This is some <span style="color:red;font-size:150%;">inline HTML</span> | ||
| - | </html> | ||
| - | <HTML> | ||
| - | <p style="border:2px dashed red;">And this is some block HTML</p> | ||
| - | </HTML> | ||
| - | |||
| - | PHP example: | ||
| - | |||
| - | <code> | ||
| - | <php> | ||
| - | echo 'The PHP version: '; | ||
| - | echo phpversion(); | ||
| - | echo ' (generated inline HTML)'; | ||
| - | </php> | ||
| - | <PHP> | ||
| - | echo '<table class="inline"><tr><td>The same, but inside a block level element:</td>'; | ||
| - | echo '<td>'.phpversion().'</td>'; | ||
| - | echo '</tr></table>'; | ||
| - | </PHP> | ||
| - | </code> | ||
| - | |||
| - | <php> | ||
| - | echo 'The PHP version: '; | ||
| - | echo phpversion(); | ||
| - | echo ' (inline HTML)'; | ||
| - | </php> | ||
| - | <PHP> | ||
| - | echo '<table class="inline"><tr><td>The same, but inside a block level element:</td>'; | ||
| - | echo '<td>'.phpversion().'</td>'; | ||
| - | echo '</tr></table>'; | ||
| - | </PHP> | ||
| - | |||
| - | **Please Note**: HTML and PHP embedding is disabled by default in the configuration. If disabled, the code is displayed instead of executed. | ||
| - | |||
| - | ===== 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: | ||
| - | |||
| - | ^ Parameter ^ Description ^ | ||
| - | | any number | will be used as maximum number items to show, defaults to 8 | | ||
| - | | reverse | display the last items in the feed first | | ||
| - | | author | show item authors names | | ||
| - | | date | show item dates | | ||
| - | | description| show the item description. If [[doku>config:htmlok|HTML]] is disabled all tags will be stripped | | ||
| - | | //n//[dhm] | refresh period, where d=days, h=hours, m=minutes. (e.g. 12h = 12 hours). | | ||
| - | |||
| - | The refresh period defaults to 4 hours. Any value below 10 minutes will be treated as 10 minutes. [[wiki:DokuWiki]] will generally try to supply a cached version of a page, obviously this is inappropriate when the page contains dynamic external content. The parameter tells [[wiki:DokuWiki]] to re-render the page if it is more than //refresh period// since the page was last rendered. | ||
| - | |||
| - | **Example:** | ||
| - | |||
| - | {{rss>http://slashdot.org/index.rss 5 author date 1h }} | ||
| - | |||
| - | {{rss>http://slashdot.org/index.rss 5 author date 1h }} | ||
| - | |||
| - | |||
| - | ===== Control Macros ===== | ||
| - | |||
| - | Some syntax influences how DokuWiki renders a page without creating any output it self. The following control macros are availble: | ||
| - | |||
| - | ^ Macro ^ Description | | ||
| - | | %%~~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 | | ||
| ===== Syntax Plugins ===== | ===== Syntax Plugins ===== | ||
