**bold**
//italic//
__underlined__
''monospaced''
deleted
**__//''any combination''//__**
Somesuperscript andsubscript
colors
Serif
Sans-serif
really small
really big
Same
line
New paragraph \\
New line
New paragraph \\ New line
Roses are red,
violets are blue,
these jokes are getting old,
and so are you.
https://www.google.com
[[https://www.google.com|This Link points to google]]
[[andi@splitbrain.org]]
[[./newpage/]]
[[./newpage/ |New Page Name]]
[[./home |This Page]]
[[./home#internal |This Section]]
[[doku>Interwiki |Interwiki]]
[[wp>Amateur_radio]]
You can add footnotes((This is a footnote)).
==== Headline Level 3 ====
=== Headline Level 4 ===
== Headline Level 5 ==
----
Real size: {{dokuwiki-128.png}}
Resize to given width: {{dokuwiki-128.png?50}}
Resize to given width and height: {{dokuwiki-128.png?200x50}}
Resized external image: {{https://php.net/images/php.gif?200x50}}
{{ dokuwiki-128.png}}
{{dokuwiki-128.png }}
{{ dokuwiki-128.png }}
Of course, you can add a title (displayed as a tooltip by most browsers), too.
{{dokuwiki-128.png|This is the caption}}
[[https://php.net|{{dokuwiki-128.png}}]]
{{dokuwiki-128.png?linkonly}}
* 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
-> <- <-> => <= <=> >> << -- --- 640x480 (c) (tm) (r)
I think we should do it
> No we shouldn't
>> Well, I say we should
> Really?
>> Yes!
>>> Then lets do it!
inline quote.
This is a block quote.
This is an inline quote.
This is a block quote.
|< 100% 10px 10em 50% - >|
|10px |10em |50%|the rest |
===== No Formatting =====
If you need to display text exactly like it is typed (without any formatting), enclose the area either with ''%%
This is some text which contains addresses like this:
https://www.splitbrain.org and
**formatting**, but nothing is done with it.
The same is true for %%//__this__ text// with a smiley ;-)%%.
%%'' or ''%%%%''.
This is text is indented by two spaces.
This is text is indented by two spaces.
This is preformatted code all spaces are preserved:
like <-this
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.
This is pretty much the same, but you could
use it to show that you quoted a file.
==== Syntax Highlighting ====
Dokuwiki can highlight sourcecode, which makes it easier to read. It uses the [[https://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. ''
/**
* The HelloWorldApp class implements an application that
* simply displays "Hello World!" to the standard output.
*/
class HelloWorldApp {
public static void main(String[] args) {
System.out.println("Hello World!"); //Display the string.
}
}
/**
* The HelloWorldApp class implements an application that
* simply displays "Hello World!" to the standard output.
*/
class HelloWorldApp {
public static void main(String[] args) {
System.out.println("Hello World!"); //Display the string.
}
}
You can also add the file name, which allows easy download of the file:
echo "hello world"
echo "hello world"
The following language strings are currently recognized:
''4cs \\ 6502acme \\ 6502kickass \\ 6502tasm \\ 68000devpac \\ abap \\ actionscript3 \\ actionscript \\ ada \\ aimms \\ algol68 \\ apache \\ applescript \\ apt_sources \\ arm \\ asm \\ asp \\ asymptote \\ autoconf \\ autohotkey \\ autoit \\ avisynth \\ awk \\ bascomavr \\ bash \\ basic4gl \\ batch \\ bf \\ biblatex \\ bibtex \\ blitzbasic \\ bnf \\ boo \\ caddcl \\ cadlisp \\ ceylon \\ cfdg \\ cfm \\ chaiscript \\ chapel \\ cil \\ c_loadrunner \\ clojure \\ c_mac \\ cmake \\ cobol \\ coffeescript \\ c \\ cpp \\ cpp-qt \\ cpp-winapi \\ csharp \\ css \\ cuesheet \\ c_winapi \\ dart \\ dcl \\ dcpu16 \\ dcs \\ delphi \\ diff \\ div \\ dos \\ dot \\ d \\ ecmascript \\ eiffel \\ email \\ epc \\ e \\ erlang \\ euphoria \\ ezt \\ f1 \\ falcon \\ fo \\ fortran \\ freebasic \\ freeswitch \\ fsharp \\ gambas \\ gdb \\ genero \\ genie \\ gettext \\ glsl \\ gml \\ gnuplot \\ go \\ groovy \\ gwbasic \\ haskell \\ haxe \\ hicest \\ hq9plus \\ html \\ html4strict \\ html5 \\ icon \\ idl \\ ini \\ inno \\ intercal \\ io \\ ispfpanel \\ java5 \\ java \\ javascript \\ jcl \\ j \\ jquery \\ julia \\ kixtart \\ klonec \\ klonecpp \\ kotlin \\ latex \\ lb \\ ldif \\ lisp \\ llvm \\ locobasic \\ logtalk \\ lolcode \\ lotusformulas \\ lotusscript \\ lscript \\ lsl2 \\ lua \\ m68k \\ magiksf \\ make \\ mapbasic \\ mathematica \\ matlab \\ mercury \\ metapost \\ mirc \\ mk-61 \\ mmix \\ modula2 \\ modula3 \\ mpasm \\ mxml \\ mysql \\ nagios \\ netrexx \\ newlisp \\ nginx \\ nimrod \\ nsis \\ oberon2 \\ objc \\ objeck \\ ocaml-brief \\ ocaml \\ octave \\ oobas \\ oorexx \\ oracle11 \\ oracle8 \\ oxygene \\ oz \\ parasail \\ parigp \\ pascal \\ pcre \\ perl6 \\ perl \\ per \\ pf \\ phix \\ php-brief \\ php \\ pic16 \\ pike \\ pixelbender \\ pli \\ plsql \\ postgresql \\ postscript \\ povray \\ powerbuilder \\ powershell \\ proftpd \\ progress \\ prolog \\ properties \\ providex \\ purebasic \\ pycon \\ pys60 \\ python \\ qbasic \\ qml \\ q \\ racket \\ rails \\ rbs \\ rebol \\ reg \\ rexx \\ robots \\ rpmspec \\ rsplus \\ ruby \\ rust \\ sas \\ sass \\ scala \\ scheme \\ scilab \\ scl \\ sdlbasic \\ smalltalk \\ smarty \\ spark \\ sparql \\ sql \\ standardml \\ stonescript \\ swift \\ systemverilog \\ tclegg \\ tcl \\ teraterm \\ texgraph \\ text \\ thinbasic \\ tsql \\ twig \\ typoscript \\ unicon \\ upc \\ urbi \\ uscript \\ vala \\ vbnet \\ vb \\ vbscript \\ vedit \\ verilog \\ vhdl \\ vim \\ visualfoxpro \\ visualprolog \\ whitespace \\ whois \\ winbatch \\ xbasic \\ xml \\ xojo \\ xorg_conf \\ xpp \\ yaml \\ z80 \\ zxbasic''
\\
There are additional [[doku>syntax_highlighting|advanced options]] available for syntax highlighting, such as highlighting lines or adding line numbers.
===== Embedding HTML and PHP =====
You can embed raw HTML or PHP code into your documents by using the ''%%%%'' tag. (Use uppercase tags if you need to enclose block level elements.)
HTML example:
This is some inline HTML
And this is some block HTML
This is some inline HTML
And this is some block HTML
PHP example:
===== RSS/ATOM Feed Aggregation =====
Dokuwiki can integrate data from external XML feeds. For parsing the XML feeds, [[https://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 |
| 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). |
The refresh period defaults to 4 hours. Any value below 10 minutes will be treated as 10 minutes. 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 DokuWiki to re-render the page if it is more than //refresh period// since the page was last rendered.
By default the feed will be sorted by date, newest items first. You can sort it by oldest first using the ''reverse'' parameter, or display the feed as is with ''nosort''.
**Example:**
{{rss>https://slashdot.org/index.rss 5 author date 1h }}
{{rss>https://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, adding this macro will force DokuWiki to rerender a page on every call |
===== Wrap Plugin Examples =====
The Wrap plugin has some of its most commonly used wraps in the tool bar:
{{ wrap.png }}
More info [[https://www.dokuwiki.org/plugin:wrap |here]]
==== Columns ====
%%%%
This is text in the left column.
%%%%
This is text in the right column.
==== Alignment ====
%%%%
All this text is aligned to the right.
%%%%
All this text is aligned in the centre.
%%%%
This text is aligned to the left as per usual.
%%%%
This text is justified, which means that the lines are stretched so that they all end at the end.
==== Boxes ====
%%%%
%%%%
%%%%
%%%%
%%%%
%%%%
%%%%
%%%% is not technically a box, but it acts like one.
%%%%
%%%%
%%%%
%%%%
%%%%
%%%%
%%%%
Also note that the width can be set as: ''%, px, em, rem, ex, ch, vw, vh, pt, pc, cm, mm, in''
==== Misc ====
For embedded text, use ''wrap'' in lower case:
* %%%%
* %%%%
* %%%%
* %%%%
* %%%%
* %%%%
* %%%%
* %%[[link]]%%[[wrap]]
==== Test ====
=== test ===
%%%%
=== A Heading ===
So here's a sample wrap containing what I hope to eventually be a nicely formatted, visually appealing bit of content.
===== LaTeX =====
\$LaTeX\$ (pronounced lay-tek or lah-tek, but never lay-teks) is the standard method for laying out scientific and mathematical manuscripts. According to [[wp>LaTeX|Wikipedia]]:
\$LaTeX\$ is most widely used by mathematicians, scientists, engineers, philosophers, scholars in academia and the commercial world, and other professionals [...] because of the high quality of typesetting achievable [which] offers programmable desktop publishing features and extensive facilities for automating most aspects of typesetting and desktop publishing, including numbering and cross-referencing, tables and figures, page layout and bibliographies. It was originally written in the early 1980s by Leslie Lamport at SRI International.
Here is how to call the \$LaTeX\$ package in this wiki:
* Inline expressions are sandwiched between two ''%%\$%%'' and
* block expressions are sandwiched between two ''%%\$$%%''.
This is inline:
\$ \frac{d}{dx}f(x) \triangleq \lim_{\Delta x \rightarrow 0} \frac{f(x+\Delta x) - f(x)}{\Delta x}\$
This is block:
\$$ \frac{d}{dx}f(x) \triangleq \lim_{\Delta x \rightarrow 0} \frac{f(x+\Delta x) - f(x)}{\Delta x}\$$
This is inline:
\$ \frac{d}{dx}f(x) \triangleq \lim_{\Delta x \rightarrow 0} \frac{f(x+\Delta x) - f(x)}{\Delta x}\$
This is block:
\$$ \frac{d}{dx}f(x) \triangleq \lim_{\Delta x \rightarrow 0} \frac{f(x+\Delta x) - f(x)}{\Delta x}\$$
For more information on how to use \$LaTeX\$, download [[https://tobi.oetiker.ch/lshort/|lshort.pdf]].
===== Syntax Plugins =====
DokuWiki's syntax can be extended by [[doku>plugins|Plugins]]. How the installed plugins are used is described on their appropriate description pages. The following syntax plugins are available in this particular DokuWiki installation:
~~INFO:syntaxplugins~~