Hier werden die Unterschiede zwischen zwei Versionen angezeigt.
Beide Seiten der vorigen RevisionVorhergehende ÜberarbeitungNächste Überarbeitung | Vorhergehende ÜberarbeitungLetzte ÜberarbeitungBeide Seiten der Revision | ||
de:syntax [2010/02/27 12:57] – OUkCOVCkydkNAv 174.34.168.242 | de:syntax [2011/09/15 06:42] – 124.6.181.179 | ||
---|---|---|---|
Zeile 1: | Zeile 1: | ||
- | DFz7Xn | + | ====== ====== Syntax |
+ | |||
+ | ===== Introduction ===== | ||
+ | |||
+ | [[Wiki: DokuWiki]] is characterized by simple formatting. This will keep the files containing the content, easy to read. \ \ | ||
+ | |||
+ | ** Describes the syntax to edit pages .** | ||
+ | |||
+ | Look at the source of this page by selecting "edit this page" press the button up or down. \ \ | ||
+ | To try something, you can use the [[playground: | ||
+ | Simple formatting can be [[http:// | ||
+ | |||
+ | |||
+ | ===== ===== For translation | ||
+ | |||
+ | This page is a translation of the [[Page http:// | ||
+ | It is not the same word translation. Some descriptions are down a little more detail. Technical terms are only used where a paraphrase more confusion than good. \ \ | ||
+ | The same applies to terms that arise from the English, for some there is no direct translation. Or they are already so well known that a translation is nonsensical. \ \ | ||
+ | The translator is not even sure if he should [[http:// | ||
+ | In some places there is a FIXME - there is something that has been referred to the translator has not been well established. | ||
+ | * Suggestions, | ||
+ | * Your Sebastian Koch => mr_snede * at * dot ~ ~ web de | ||
+ | |||
+ | ====== ====== 1 texts | ||
+ | ===== ===== 1.1 formatting | ||
+ | |||
+ | DokuWiki supports ** bold **, / / italic / /, __underlined__ and'' | ||
+ | |||
+ | DokuWiki supports ** bold **, / / italic / /, __underlined__ and'' | ||
+ | Of course, everything **__''''// | ||
+ | |||
+ | You can use <sub> subscript </ sub> and <sup> superscript </ sup>, too. | ||
+ | |||
+ | You can use <sub> subscript </ sub> and <sup> superscript </ sup>, too. | ||
+ | |||
+ | Text can be deleted as <del> deleted </ del> ((who needs added%%%% < | ||
+ | |||
+ | Text can be deleted mark something as deleted </ del>. | ||
+ | |||
+ | ===== ===== Paragraphs 1.2 | ||
+ | Paragraphs are created from blank lines. \ \ | ||
+ | < | ||
+ | |||
+ | This is some text with some linebreaks. \ \ Note that the two backslashes | ||
+ | only be detected if they are at end of line \ \ | ||
+ | or if \ \ a whitespace \ \ followed by how it looks without it. | ||
+ | |||
+ | This is some text with some linebreaks. \ \ Note that the two backslashes | ||
+ | only be detected if they are at end of line \ \ | ||
+ | or if \ \ a whitespace \ \ followed by how it looks without it. | ||
+ | |||
+ | Line breaks through two " | ||
+ | |||
+ | |||
+ | ===== ===== 1.3 About fonts | ||
+ | Structured with five different levels, separated by headings, the content of a page. \ \ | ||
+ | The headings with a maximum of six "=" framed, depending on size. H1 is the headline at the highest level. The easiest to use to generate the headlines, the toolbar and click on the button'' | ||
+ | |||
+ | It is __sinnvoll__ whenever a Level 1 heading at the beginning of an article is available. | ||
+ | |||
+ | If a page appear in more than three headlines, a table of contents is automatically created which lists all the headings. \ \ | ||
+ | Contents of this should not be created, the command:'' | ||
+ | |||
+ | ====== ====== Heading level 1 | ||
+ | ===== ===== Level 2 Headline | ||
+ | ==== Headline Level 3 ==== | ||
+ | === Headline Level 4 === | ||
+ | == Headline Level 5 == | ||
+ | |||
+ | -> Within headlines, no further formatting is done! | ||
+ | |||
+ | ===== 1.4 unformatted Sections ===== | ||
+ | |||
+ | To text to indicate how it was written, whether it contains DokuWiki formatting or other formatting, you can each | ||
+ | Line with two spaces to begin (as it was used in this page) or use one of the identifiers " | ||
+ | |||
+ | < | ||
+ | With " | ||
+ | </ Code> | ||
+ | |||
+ | < | ||
+ | With " | ||
+ | Perhaps in order to identify quotes or similar. | ||
+ | </ File> | ||
+ | |||
+ | To turn off any conversion by DokuWiki enclose the relevant area with " | ||
+ | |||
+ | < | ||
+ | This text contains links to: ** ** http://www.splitbrain.org and formatting, but they are not implemented and appear as normal text. | ||
+ | </ Nowiki> | ||
+ | |||
+ | Simply look at the source of this page (the button " | ||
+ | |||
+ | 1.5 ===== ===== Syntax Highlighting | ||
+ | |||
+ | [[DokuWiki]] knows syntax highlighting for source code to increase its readability. For [[http:// | ||
+ | It uses the same identifier as in the previous section, except that it now includes the name of the language: \ \ | ||
+ | <nowiki>''< | ||
+ | |||
+ | <code Java> | ||
+ | / ** | ||
+ | * The HelloWorldApp class implements application of that | ||
+ | * Simply displays "Hello World!" | ||
+ | * / | ||
+ | class HelloWorldApp { | ||
+ | public static void main (String [] args) { | ||
+ | System.out.println (" | ||
+ | } | ||
+ | } | ||
+ | </ Code> | ||
+ | |||
+ | It supports the following languages: \ \ / ActionScript / ActionScript FrenchPostcards, | ||
+ | |||
+ | 1.6 ===== quote / comment ===== | ||
+ | To mark a text as a quote or comment, the " | ||
+ | |||
+ | I think we should do it. | ||
+ | |||
+ | ' | ||
+ | |||
+ | >> Yes! | ||
+ | |||
+ | > Really? | ||
+ | |||
+ | >> | ||
+ | |||
+ | >>> | ||
+ | |||
+ | >>> | ||
+ | |||
+ | I think we should do it | ||
+ | |||
+ | 'No, we should not. | ||
+ | |||
+ | >> Yes! | ||
+ | |||
+ | > Really? | ||
+ | |||
+ | >> Yes! | ||
+ | |||
+ | >>> | ||
+ | |||
+ | >>> | ||
+ | |||
+ | |||
+ | ====== ====== 2 Links | ||
+ | |||
+ | DokuWiki 5 different types of links are used: | ||
+ | ===== ===== 2.1 External | ||
+ | |||
+ | External links (links to other websites or files) are recognized automagically: | ||
+ | Referrals may also be hidden behind its own terms: [[http:// | ||
+ | E-mail addresses are enclosed in angle brackets: < | ||
+ | |||
+ | External links are recognized automagically: | ||
+ | Referrals may also be hidden behind its own terms: | ||
+ | E-mail addresses are enclosed in angle brackets: < | ||
+ | |||
+ | |||
+ | ===== ===== 2.2 Internal | ||
+ | |||
+ | Internal links, ie links to pages are created by using, set in double brackets: \ \ | ||
+ | [[Doku> wiki: pagename]] \ \ | ||
+ | |||
+ | A link can also be hidden behind a term or description: | ||
+ | [[Doku> wiki: pagename | Description for a link.]] | ||
+ | |||
+ | Internal links are placed in double square brackets: | ||
+ | [[Doku> | ||
+ | |||
+ | A link can also be hidden behind a term or description: | ||
+ | [[Doku> | ||
+ | |||
+ | File names for new pages in the wiki are automatically converted to lowercase! \ \ | ||
+ | Umlauts are not equally as special characters are allowed! ([[Doku> namespaces | reference characters allowed in file names - english]]) | ||
+ | |||
+ | A colon namespaces in the wiki are resolved: [[wiki: namespaces]] | ||
+ | |||
+ | A colon namespaces in the wiki are resolved: [[wiki: namespaces]] | ||
+ | |||
+ | To name areas where further information: | ||
+ | |||
+ | Notes: | ||
+ | |||
+ | * Links to [[wiki: syntax | existing pages]] are displayed differently than links to [[wiki: nonexistent]] pages. | ||
+ | * DokuWiki does not use default [[wp> CamelCase]] for links. Can [[doku> config]] but that will change: \ \ In the settings file. ** \ \ ** NOTE: If the word: DokuWiki is displayed as a link, then this option is turned on. | ||
+ | |||
+ | |||
+ | ===== ===== 2.3 Interwiki | ||
+ | |||
+ | DokuWiki supports links to other wikis, so-called [[doku> wiki: interwiki]] links. \ \ | ||
+ | A link to Wikipedia' | ||
+ | |||
+ | DokuWiki supports links to other wikis, so-called [[doku> wiki: interwiki]] links. \ \ | ||
+ | A link to Wikipedia' | ||
+ | |||
+ | |||
+ | ===== ===== 2.4 Windows Shares | ||
+ | |||
+ | Dokuwiki also links to Windows Shares like [[\ \ server \ share | shared folder.]] \ \ | ||
+ | This only makes sense in a homogenous user group: [[wp> Intranet]]. | ||
+ | |||
+ | Dokuwiki also links to Windows Shares like [[\ \ server \ share | this]]. | ||
+ | |||
+ | Note: | ||
+ | * For security reasons direct browsing of works by the shares by default only works with Internet Explorer (... and only in the "local zone" | ||
+ | * For Mozilla and Firefox it can through the [[# file http://www.mozilla.org/ | ||
+ | * Opera ingnoriert as a safety feature since [[http:// | ||
+ | * For more information see: [[bug> 151]] | ||
+ | |||
+ | ===== ===== 2.5 pictures as links | ||
+ | |||
+ | Images can be used for a link to another internal or external file. To the syntax for links is simply combined with the display of images (see below): | ||
+ | |||
+ | [[Http: | ||
+ | |||
+ | [[Http:// | ||
+ | |||
+ | Please note: The image formatting is the only formatting syntax accepted in link names! | ||
+ | |||
+ | ====== ====== 3 images and other files | ||
+ | 3.1 Image ===== ===== install a dialog box | ||
+ | The uploading of images must be turned on in the configuration file. In addition, the website operator by the function [[wiki: acl | ACL]] limit | ||
+ | FIXME | ||
+ | |||
+ | ===== ===== 3.2 Size of images | ||
+ | With braces, both external and internal [[doku> images | Images]] are included. Optionally, whose size can be specified: | ||
+ | |||
+ | Original size: {{wiki: dokuwiki-128.png}} | ||
+ | |||
+ | Resize to given width: {{wiki: dokuwiki-128.png} 50?} | ||
+ | |||
+ | Width and height: {{wiki: dokuwiki-128.png 200x50}?} | ||
+ | |||
+ | Size for external image: {{}} http://de3.php.net/images/ | ||
+ | |||
+ | Original size: {{wiki: dokuwiki-128.png}} | ||
+ | Resize to given width: {{wiki: dokuwiki-128.png} 50?} | ||
+ | Width and height: {{wiki: dokuwiki-128.png 200x50}?} | ||
+ | Size for external image: {{}} http:// | ||
+ | |||
+ | 3.3 ===== ===== alignment of images | ||
+ | With spaces to the right and / or left inside the brackets, an image can be aligned horizontally (left, center, right). | ||
+ | |||
+ | {{Wiki: dokuwiki-128.png}} | ||
+ | |||
+ | {{Wiki: dokuwiki-128.png}} | ||
+ | |||
+ | {{Wiki: dokuwiki-128.png}} | ||
+ | |||
+ | {{Wiki: dokuwiki-128.png}} | ||
+ | {{Wiki: | ||
+ | {{Wiki: dokuwiki-128.png}} | ||
+ | |||
+ | ===== ===== 3.4 Tooltips | ||
+ | Title also appears in most browsers as a tooltip can be specified. | ||
+ | |||
+ | {{Wiki: dokuwiki-128.png | This is the caption}} | ||
+ | |||
+ | {{Wiki: dokuwiki-128.png | This is the caption}} | ||
+ | |||
+ | |||
+ | ===== ===== 3.5 File Download | ||
+ | |||
+ | When a file is specified, no pictures ('' | ||
+ | |||
+ | {{Wiki: dokuwiki-128.txt | Example}} | ||
+ | |||
+ | ====== ====== 4 lists | ||
+ | |||
+ | Dokuwiki supports ordered and unordered lists. To create a list item, indent your text by two spaces. These spaces will follow a " | ||
+ | |||
+ | * This record is an unordered list | ||
+ | * The second item | ||
+ | * Different levels of a list by adding another 2 spaces | ||
+ | * Another item | ||
+ | |||
+ | - This is a list but | ||
+ | - A second entry | ||
+ | - Different levels of a list by adding another 2 spaces | ||
+ | - Another item | ||
+ | |||
+ | < | ||
+ | * This record is an unordered list | ||
+ | * The second item | ||
+ | * Different levels of a list by adding another 2 spaces | ||
+ | * Another item | ||
+ | |||
+ | - This is a list but | ||
+ | - A second entry | ||
+ | - Different levels of a list by adding another 2 spaces | ||
+ | - Another item | ||
+ | </ Code> | ||
+ | |||
+ | ====== ====== 5 tables | ||
+ | |||
+ | DokuWiki tables are created easily: | ||
+ | |||
+ | ^ ^ ^ Heading to the example of a headline ^ | ||
+ | | Row 1 Col 1 | Row 1 Col 2 | Row 1 Col 3 | | ||
+ | | Row 2 Col 1 | double column width (note the double pipe) | | | ||
+ | | Row 3 Col 1 | Row 2 Col 2 | Row 2 Col 3 | | ||
+ | |||
+ | Table rows have to start with " | ||
+ | |||
+ | ^ ^ ^ Heading For example, for ^ headline | ||
+ | | Row 1 Col 1 | Row 1 Col 2 | Row 1 Col 3 | | ||
+ | | Row 2 Col 1 | double column width (note the double pipe) | | | ||
+ | | Row 3 Col 1 | Row 2 Col 2 | Row 2 Col 3 | | ||
+ | |||
+ | To connect cells are generated, if, as shown above, at the end of such a column as many " | ||
+ | In short, all rows of a table have the same amount of cell separators " | ||
+ | |||
+ | Highlighted fields in vertical orientation are also possible. | ||
+ | |||
+ | | ^ Heading 1 ^ 2 ^ | ||
+ | ^ Heading 3 | Row 1 Col 2 | Row 1 Col 3 | | ||
+ | ^ Heading 4 | Row 2 Col 2 | | | ||
+ | ^ Heading 5 | Row 3 Col 2 | Row 3 Col 3 | | ||
+ | |||
+ | As we see, it's the cell separator (" | ||
+ | |||
+ | | ^ Heading 1 ^ 2 ^ | ||
+ | ^ Heading 3 | Row 1 Col 2 | Row 1 Col 3 | | ||
+ | ^ Heading 4 | Row 2 Col 2 | | | ||
+ | ^ Heading 5 | Row 3 Col 2 | Row 3 Col 3 | | ||
+ | |||
+ | Note: Vertical spans multiple lines are not supported. | ||
+ | |||
+ | * The contents of a cell can be oriented horizontally. Add two spaces added: \ \ | ||
+ | * 2 spaces left of the text: right justified | ||
+ | * 2 spaces right of the text: left | ||
+ | * 2 spaces rinks and right centered text | ||
+ | |||
+ | ^ ^ ^ ^ Table with alignment | ||
+ | | Right | center | left | | ||
+ | | Left | right | center | | ||
+ | | Xxxxxxxxxxxx | xxxxxxxxxxxx | xxxxxxxxxxxx | | ||
+ | |||
+ | Here's the format: | ||
+ | |||
+ | ^ ^ ^ ^ Table with alignment | ||
+ | | Right | center | left | | ||
+ | | Left | right | center | | ||
+ | | Xxxxxxxxxxxx | xxxxxxxxxxxx | xxxxxxxxxxxx | | ||
+ | |||
+ | ====== ====== 6 Other formats | ||
+ | ===== Footnotes ===== 6.1 | ||
+ | |||
+ | |||
+ | Footnotes ((This is a footnote)) are represented by a double parenthesis ((a second footnote)). The text between the brackets will be posted at the bottom of the page. The order and thus the numbering does DokuWiki. | ||
+ | |||
+ | Footnotes ((This is a footnote)) are tracked by a double parenthesis shown ((a second footnote)) | ||
+ | |||
+ | 6.2 ===== ===== horizontal line | ||
+ | With four consecutive minus signs (alone in a row) can be generated horrizontal line: | ||
+ | ---- | ||
+ | < | ||
+ | |||
+ | ===== ===== Smileys 6.3 | ||
+ | |||
+ | DokuWiki converts commonly-used [[wp> emoticon]] s to small Smily-graphics. \ \ | ||
+ | Additional graphics can Ordener Smiley " | ||
+ | Here is a list of default is included in DokuWiki Smileys: | ||
+ | |||
+ | 8-) ^ ^ ^ 8-O :-) :-( ^ ^ =) ^: - / ^ - \ ^: -? ^: ^-D:-P ^: O ^: X ^ ^ :-| ;-) ^:: ^:: ^ ^ LOL FIXME ^ ^ DELETEME | ||
+ | |%%%% 8-) |%% 8-O%% |%% :-(%% |%% :-)%% |%% =)%% |%%: - /%% |%% : - \%% |%%: -? %% |%%: D%% |%%: P%% |%%: O%% |%%:-X%% |%%%% :-| |%%%% ;-) |%%::%% |%%?::%% |%% LOL%% |%% FIXME%% |%%%% DELETEME | | ||
+ | |||
+ | and ^ _ ^ ^ _ ^%%%% ((it is probably not displaying in a table)) | ||
+ | |||
+ | ===== 6.4 ===== Typography | ||
+ | |||
+ | [[DokuWiki]] can convert simple text characters to their typographically correct entities. \ \ | ||
+ | Here is a list of all the characters like this are recognized: | ||
+ | |||
+ | -> <- <-> => <= < | ||
+ | "He thought ' | ||
+ | |||
+ | < | ||
+ | -> <- <-> => <= < | ||
+ | "He thought ' | ||
+ | </ Code> | ||
+ | |||
+ | Please note: These conversions can be turned off in the configuration file | ||
+ | |||
+ | 6.5 HTML and PHP ===== ===== | ||
+ | |||
+ | In a side both HTML and PHP can be used directly: | ||
+ | |||
+ | < | ||
+ | This is some <font color=" | ||
+ | </ Html> | ||
+ | |||
+ | < | ||
+ | < | ||
+ | This is some <font color=" | ||
+ | </ Html> | ||
+ | </ Code> | ||
+ | |||
+ | PHP or here: | ||
+ | |||
+ | < | ||
+ | echo 'A logo generated by PHP:'; | ||
+ | echo '< | ||
+ | </ Php> | ||
+ | |||
+ | |||
+ | < | ||
+ | < | ||
+ | echo 'A logo generated by PHP:'; | ||
+ | echo '< | ||
+ | </ Php> | ||
+ | </ Code> | ||
+ | |||
+ | ** Caution **: The integration of HTML and PHP embedding is disabled in the configuration file in a page. This done, the source of these sections will be displayed as text and not executed. | ||
+ | |||
+ | ** Caution **: The integration of HTML and PHP is usually on one side of the Internet a serious security risk! This function is intended only for the intranet! | ||
+ | |||
+ | ====== ====== 7 Syntax Plugins | ||
+ | DokuWiki' | ||
+ | |||
+ | ~ ~ INFO: syntax plugins ~ ~ |