Differences
This shows you the differences between two versions of the page.
Both sides previous revision Previous revision Next revision | Previous revision | ||
wiki:syntax [2023/09/23 14:47] – removed gabriek1 | wiki:syntax [2023/10/14 23:43] (current) – [Tables] gabriek1 | ||
---|---|---|---|
Line 1: | Line 1: | ||
+ | ====== Formatting Syntax ====== | ||
+ | |||
+ | This wiki supports some simple markup language, which tries to make the datafiles to be as readable as possible. This page contains all possible syntax you may use when editing the pages. Simply have a look at the source of this page by pressing "Edit this page". | ||
+ | |||
+ | ===== Basic Text Formatting ===== | ||
+ | |||
+ | **Bold**, //italic//, __underlined__ and '' | ||
+ | < | ||
+ | **Bold**, //italic//, __underlined__ and '' | ||
+ | Of course you can **__//'' | ||
+ | |||
+ | </ | ||
+ | |||
+ | You can use < | ||
+ | < | ||
+ | You can use < | ||
+ | |||
+ | </ | ||
+ | |||
+ | You can mark something as < | ||
+ | < | ||
+ | You can mark something as < | ||
+ | |||
+ | </ | ||
+ | |||
+ | **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 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 | ||
+ | two backslashes are only recognized at the end of a line\ | ||
+ | or followed by\\ a whitespace \\this happens without it. | ||
+ | |||
+ | </ | ||
+ | |||
+ | You should use forced newlines only if really needed. | ||
+ | |||
+ | ===== Links ===== | ||
+ | |||
+ | ==== External ==== | ||
+ | |||
+ | External links are recognized automagically: | ||
+ | < | ||
+ | |||
+ | External links are recognized automagically: | ||
+ | link text as well: [[http:// | ||
+ | addresses like this one: < | ||
+ | |||
+ | </ | ||
+ | |||
+ | ==== Internal ==== | ||
+ | |||
+ | Internal links are created by using square brackets. You can either just give a [[: | ||
+ | < | ||
+ | |||
+ | Internal links are created by using square brackets. You can either just give | ||
+ | a [[pagename|]] or use an additional [[pagename|link text]]. | ||
+ | |||
+ | </ | ||
+ | |||
+ | Wiki pagenames are converted to lowercase automatically, | ||
+ | |||
+ | You can use [[: | ||
+ | < | ||
+ | |||
+ | You can use [[some: | ||
+ | |||
+ | </ | ||
+ | |||
+ | For details about namespaces see [[doku> | ||
+ | |||
+ | Linking to a specific section is possible, too. Just add the section name behind a hash character as known from HTML. This links to [[: | ||
+ | < | ||
+ | |||
+ | This links to [[syntax# | ||
+ | |||
+ | </ | ||
+ | |||
+ | Notes: | ||
+ | |||
+ | * Links to [[: | ||
+ | |||
+ | ==== Interwiki ==== | ||
+ | |||
+ | You can use[[doku> | ||
+ | < | ||
+ | |||
+ | You can use Interwiki links. These are quick links to other Wikis. | ||
+ | For example this is a link to Wikipedia' | ||
+ | |||
+ | </ | ||
+ | |||
+ | ==== Windows Shares ==== | ||
+ | |||
+ | Windows shares like [[\\server\share|this]] are recognized, too. Please note that these only make sense in a homogeneous user group like a corporate [[wp> | ||
+ | |||
+ | Windows Shares like [[\\server\share|this]] are recognized, too. | ||
+ | |||
+ | Notes: | ||
+ | |||
+ | * For security reasons direct browsing of windows shares only works in Microsoft Internet Explorer per default (and only in the "local zone" | ||
+ | |||
+ | conf/ | ||
+ | < | ||
+ | |||
+ | \ | ||
+ | <?php\ | ||
+ | /**\ | ||
+ | * Customization of the english language file\ | ||
+ | * Copy only the strings that needs to be modified\ | ||
+ | */\ | ||
+ | $lang[' | ||
+ | |||
+ | </ | ||
+ | |||
+ | ==== Image Links ==== | ||
+ | |||
+ | You can also use an image to link to another internal or external page by combining the syntax for links and images (see below) like this: | ||
+ | |||
+ | < | ||
+ | {{https:// | ||
+ | |||
+ | </ | ||
+ | |||
+ | {{https:// | ||
+ | |||
+ | Please note: The image formatting is the only formatting syntax accepted in link names. | ||
+ | |||
+ | The whole [[# | ||
+ | |||
+ | |||
+ | ===== Footnotes ===== | ||
+ | |||
+ | You can add footnotes ((This is a footnote)) | ||
+ | < | ||
+ | |||
+ | You can add footnotes ((This is a footnote)) by using double parentheses. | ||
+ | |||
+ | </ | ||
+ | |||
+ | ---- | ||
+ | |||
+ | ===== 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 ''< | ||
+ | ==== Headline Level 3 ==== | ||
+ | |||
+ | === Headline Level 4 === | ||
+ | |||
+ | == Headline Level 5 == | ||
+ | |||
+ | < | ||
+ | ==== Headline Level 3 ==== | ||
+ | === Headline Level 4 === | ||
+ | == Headline Level 5 == | ||
+ | |||
+ | </ | ||
+ | |||
+ | == == | ||
+ | |||
+ | By using four or more dashes, you can make a horizontal line: | ||
+ | |||
+ | ---- | ||
+ | |||
+ | ===== Media Files ===== | ||
+ | |||
+ | You can include external and internal images, videos and audio files with curly brackets. Optionally you can specify the size of them. | ||
+ | |||
+ | Real size: {{: | ||
+ | |||
+ | Resize to given width: {{: | ||
+ | |||
+ | Resize to given width and height((when the aspect ratio of the given width and height doesn' | ||
+ | |||
+ | External image: {{https:// | ||
+ | < | ||
+ | |||
+ | Real size: {{wiki: | ||
+ | Resize to given width: | ||
+ | Resize to given width and height: {{wiki: | ||
+ | External image: | ||
+ | |||
+ | </ | ||
+ | |||
+ | By using left or right whitespaces you can choose the alignment. | ||
+ | |||
+ | {{ : | ||
+ | |||
+ | {{: | ||
+ | |||
+ | {{ : | ||
+ | |||
+ | < | ||
+ | {{ wiki: | ||
+ | |||
+ | {{wiki: | ||
+ | |||
+ | {{ wiki: | ||
+ | |||
+ | </ | ||
+ | |||
+ | Of course, you can add a title (displayed as a tooltip by most browsers), too. | ||
+ | |||
+ | {{ : | ||
+ | < | ||
+ | |||
+ | {{ wiki: | ||
+ | |||
+ | </ | ||
+ | |||
+ | For linking an image to another page see [[# | ||
+ | |||
+ | ---- | ||
+ | |||
+ | ---- | ||
+ | |||
+ | ---- | ||
+ | |||
+ | ---- | ||
+ | |||
+ | ---- | ||
+ | |||
+ | ---- | ||
+ | |||
+ | ---- | ||
+ | |||
+ | ---- | ||
+ | |||
+ | ---- | ||
+ | |||
+ | ---- | ||
+ | |||
+ | ---- | ||
+ | |||
+ | |||
+ | ==== Supported Media Formats ==== | ||
+ | |||
+ | DokuWiki can embed the following media formats directly. | ||
+ | |||
+ | |Image|'' | ||
+ | |||
+ | If you specify a filename that is not a supported media format, then it will be displayed as a link instead. | ||
+ | |||
+ | By adding ''? | ||
+ | < | ||
+ | |||
+ | {{wiki: | ||
+ | |||
+ | </ | ||
+ | |||
+ | {{: | ||
+ | |||
+ | ==== Fallback Formats ==== | ||
+ | |||
+ | Unfortunately not all browsers understand all video and audio formats. To mitigate the problem, you can upload your file in different formats for maximum browser compatibility. | ||
+ | |||
+ | For example consider this embedded mp4 video: | ||
+ | < | ||
+ | |||
+ | {{video.mp4|A funny video}} | ||
+ | |||
+ | </ | ||
+ | |||
+ | When you upload a '' | ||
+ | |||
+ | Additionally you can use a " | ||
+ | ===== Lists ===== | ||
+ | |||
+ | You can create ordered and unordered lists. To create a list item, indent your text by two spaces and use a '' | ||
+ | |||
+ | * This is a \list * The second \item * You may have different \levels * Another item | ||
+ | |||
+ | - The same list but \ordered - Another \item - Just use indention for deeper \levels - That's it | ||
+ | < | ||
+ | |||
+ | \ | ||
+ | * This is a list\ | ||
+ | * The second item\ | ||
+ | * You may have different levels\ | ||
+ | * Another item | ||
+ | |||
+ | - The same list but ordered\ | ||
+ | - Another item\ | ||
+ | - Just use indention for deeper levels\ | ||
+ | - That's it\ | ||
+ | |||
+ | </ | ||
+ | |||
+ | Also take a look at the [[doku> | ||
+ | |||
+ | ===== Text Conversions ===== | ||
+ | |||
+ | You can convert certain pre-defined characters or strings into images or other text or HTML. | ||
+ | |||
+ | The text to image conversion is mainly done for smileys. And the text to HTML conversion is used for typography replacements, | ||
+ | |||
+ | ==== Text to Image Conversions ==== | ||
+ | |||
+ | DokuWiki converts commonly used [[wp> | ||
+ | |||
+ | * 8-) < | ||
+ | |||
+ | ==== Text to HTML Conversions ==== | ||
+ | |||
+ | Typography: can convert simple text characters to their typographically correct entities. Here is an example of recognized characters. | ||
+ | |||
+ | → <- <→ ⇒ <= <⇒ >> << – — 640×480 © ™ ® "He thought ' | ||
+ | < | ||
+ | |||
+ | -> <- <-> => <= < | ||
+ | "He thought ' | ||
+ | |||
+ | </ | ||
+ | |||
+ | The same can be done to produce any kind of HTML, it just needs to be added to the [[doku> | ||
+ | |||
+ | There are three exceptions which do not come from that pattern file: multiplication entity (640×480), ' | ||
+ | |||
+ | ===== Quoting ===== | ||
+ | |||
+ | Some times you want to mark some text to show it's a reply or comment. You can use the following syntax: | ||
+ | < | ||
+ | |||
+ | I think we should do it> No we shouldn' | ||
+ | |||
+ | >> Well, I say we should | ||
+ | |||
+ | > Really? | ||
+ | |||
+ | >> Yes! | ||
+ | |||
+ | >>> | ||
+ | |||
+ | </ | ||
+ | |||
+ | I think we should do it | ||
+ | |||
+ | > No we shouldn' | ||
+ | |||
+ | >> Well, I say we should | ||
+ | |||
+ | > Really? | ||
+ | |||
+ | >> Yes! | ||
+ | |||
+ | >>> | ||
+ | |||
+ | ===== Tables ===== | ||
+ | |||
+ | DokuWiki supports a simple syntax to create tables. | ||
+ | |||
+ | ^ Heading 1 ^ Heading 2 ^ Heading 3 ^ | ||
+ | | Row 1 Col 1 | Row 1 Col 2 | Row 1 Col 3 | | ||
+ | | Row 2 Col 1 | some colspan (note the double pipe) || | ||
+ | | 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. | ||
+ | < | ||
+ | |||
+ | ^ Heading 1 ^ Heading 2 ^ Heading 3 ^ | ||
+ | | Row 1 Col 1 | Row 1 Col 2 | Row 1 Col 3 | | ||
+ | | Row 2 Col 1 | some colspan (note the double pipe) || | ||
+ | | Row 3 Col 1 | Row 3 Col 2 | Row 3 Col 3 | | ||
+ | |||
+ | </ | ||
+ | |||
+ | To connect cells horizontally, | ||
+ | |||
+ | Vertical tableheaders are possible, too. | ||
+ | |||
+ | | Heading 1 ^ Heading 2 ^ | ||
+ | ^ Heading 3 | Row 1 Col 2 | Row 1 Col 3 | | ||
+ | ^ Heading 4 | no colspan this time | | ||
+ | ^ 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: | ||
+ | < | ||
+ | |||
+ | | Heading 1 ^ Heading 2 ^ | ||
+ | ^ Heading 3 | Row 1 Col 2 | Row 1 Col 3 | | ||
+ | ^ Heading 4 | no colspan this time | | ||
+ | ^ Heading 5 | Row 2 Col 2 | Row 2 Col 3 | | ||
+ | |||
+ | </ | ||
+ | |||
+ | You can have rowspans (vertically connected cells) by adding ''< | ||
+ | |||
+ | ^ Heading 1 ^ Heading 2 ^ Heading 3 ^ | ||
+ | | Row 1 Col 1 | this cell spans vertically | Row 1 Col 3 | | ||
+ | | Row 2 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. | ||
+ | < | ||
+ | |||
+ | ^ Heading 1 ^ Heading 2 ^ Heading 3 ^ | ||
+ | | Row 1 Col 1 | this cell spans vertically | Row 1 Col 3 | | ||
+ | | Row 2 Col 1 | ::: | Row 2 Col 3 | | ||
+ | | Row 3 Col 1 | ::: | Row 2 Col 3 | | ||
+ | |||
+ | </ | ||
+ | |||
+ | 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 | ||
+ | | | ||
+ | |left | | ||
+ | | xxxxxxxxxxxx | xxxxxxxxxxxx | xxxxxxxxxxxx | | ||
+ | |||
+ | This is how it looks in the source: | ||
+ | < | ||
+ | |||
+ | ^ Table with alignment | ||
+ | | | ||
+ | |left | | ||
+ | | xxxxxxxxxxxx | xxxxxxxxxxxx | xxxxxxxxxxxx | | ||
+ | |||
+ | </ | ||
+ | |||
+ | Note: Vertical alignment is not supported. | ||
+ | |||
+ | ===== No Formatting ===== | ||
+ | |||
+ | If you need to display text exactly like it is typed (without any formatting), | ||
+ | |||
+ | < | ||
+ | < | ||
+ | |||
+ | < | ||
+ | This is some text which contains addresses like this: http:// | ||
+ | </ | ||
+ | The same is true for < | ||
+ | |||
+ | </ | ||
+ | |||
+ | ===== Code Blocks ===== | ||
+ | |||
+ | You can include code blocks into your documents by either indenting them by at least two spaces (like used for the previous examples) or by using the tags '' | ||
+ | < | ||
+ | '' | ||
+ | |||
+ | < | ||
+ | This is preformatted code all spaces are preserved: like <-this | ||
+ | |||
+ | |||
+ | </ | ||
+ | |||
+ | < | ||
+ | This is pretty much the same, but you could use it to show that you quoted a file. | ||
+ | |||
+ | </ | ||
+ | |||
+ | Those blocks were created by this source: | ||
+ | |||
+ | < | ||
+ | This is text is indented by two spaces. | ||
+ | |||
+ | </ | ||
+ | |||
+ | < | ||
+ | < | ||
+ | This is preformatted code all spaces are preserved: like <-this | ||
+ | |||
+ | </ | ||
+ | |||
+ | < | ||
+ | < | ||
+ | This is pretty much the same, but you could use it to show that you quoted a file. | ||
+ | |||
+ | |||
+ | </ | ||
+ | </ | ||
+ | |||
+ | ==== Syntax Highlighting ==== | ||
+ | |||
+ | Sourcecode can be highlighted, | ||
+ | <code java> | ||
+ | /** | ||
+ | * The HelloWorldApp class implements an application \that | ||
+ | * simply displays "Hello World!" | ||
+ | */ | ||
+ | class HelloWorldApp { | ||
+ | public static void main(String[] args) { | ||
+ | System.out.println(" | ||
+ | } | ||
+ | } | ||
+ | |||
+ | |||
+ | </ | ||
+ | |||
+ | There are additional [[doku> | ||
+ | |||
+ | ===== Control Macros ===== | ||
+ | |||
+ | Some syntax influences how the wiki renders a page without creating any output it self. The following control macros are availble: | ||
+ | |||
+ | ^Macro | ||
+ | |||
+ | ===== Math ===== | ||
+ | |||
+ | There is support for math rendering using TeX syntax. You can use [[https:// | ||
+ | |||
+ | You can create inline f(x)=12π∫∞−∞e−x22dx notation | ||
+ | < | ||
+ | |||
+ | You can create inline f(x)=12π∫∞−∞e−x22dx notation | ||
+ | |||
+ | </ | ||
+ | |||
+ | And you can create block f(x)=12π∫∞−∞e−x22dx notation. | ||
+ | |||
+ | < | ||
+ | And you can create block f(x)=12π∫∞−∞e−x22dx notation. | ||
+ | |||
+ | </ | ||
+ | |||
+ | ---- | ||
+ | |||
+ | ---- | ||
+ | |||