meta data for this page
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
start [2023/01/08 11:36] – [Links] 45.227.255.148 | start [2023/02/06 17:28] (current) – Mike Steele | ||
---|---|---|---|
Line 1: | Line 1: | ||
- | 1&# | + | ====== OPD Knowledegebase ====== |
- | ===== Text Conversions | + | |
- | DokuWiki can convert certain pre-defined characters or strings into images or other text or HTML. | + | Welcome |
- | + | ||
- | 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-) %% 8-) %% | + | |
- | * 8-O %% 8-O %% | + | |
- | * :-( %% :-( %% | + | |
- | * :-) %% :-) %% | + | |
- | * =) %% =) %% | + | |
- | * :-/ %% :-/ %% | + | |
- | * :-\ %% :-\ %% | + | |
- | * :-? %% :-? %% | + | |
- | * :-D %% :-D %% | + | |
- | * :-P %% :-P %% | + | |
- | * :-O %% :-O %% | + | |
- | * :-X %% :-X %% | + | |
- | * :-| %% :-| %% | + | |
- | * ;-) %% ;-) %% | + | |
- | * ^_^ %% ^_^ %% | + | |
- | * m( %% m( %% | + | |
- | * :?: %% :?: %% | + | |
- | * :!: %% :!: %% | + | |
- | * LOL %% LOL %% | + | |
- | * FIXME %% FIXME %% | + | |
- | * DELETEME %% DELETEME %% | + | |
- | + | ||
- | ==== Text to HTML Conversions ==== | + | |
- | + | ||
- | Typography: [[DokuWiki]] can convert simple text characters to their typographically correct entities. Here is an example of recognized characters. | + | |
- | + | ||
- | -> <- & | + | |
- | & | + | |
- | + | ||
- | & | + | |
- | -> <- & | + | |
- | & | + | |
- | & | + | |
- | + | ||
- | 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 (640x480), &# | + | |
- | + | ||
- | ===== Quoting ===== | + | |
- | + | ||
- | Some times you want to mark some text to show it&# | + | |
- | + | ||
- | & | + | |
- | I think we should do it | + | |
- | + | ||
- | > No we shouldn&# | + | |
- | + | ||
- | & | + | |
- | + | ||
- | > Really? | + | |
- | + | ||
- | & | + | |
- | + | ||
- | & | + | |
- | & | + | |
- | + | ||
- | I think we should do it | + | |
- | + | ||
- | > No we shouldn&# | + | |
- | + | ||
- | & | + | |
- | + | ||
- | > Really? | + | |
- | + | ||
- | & | + | |
- | + | ||
- | & | + | |
- | + | ||
- | ===== 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 &# | + | |
- | + | ||
- | ^ 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&# | + | |
- | + | ||
- | | ^ 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 | + | |
- | + | ||
- | ^ 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 %%// | + | |
- | + | ||
- | & | + | |
- | 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 text is indented by two spaces. | + | |
- | + | ||
- | & | + | |
- | This is preformatted code all spaces are preserved: like & | + | |
- | & | + | |
- | + | ||
- | & | + | |
- | 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 is pretty much the same, but you could use it to show that you quoted | + | |
- | & | + | |
- | + | ||
- | ==== Syntax Highlighting ==== | + | |
- | + | ||
- | [[wiki: | + | |
- | + | ||
- | & | + | |
- | /** | + | |
- | * The HelloWorldApp class implements an application that | + | |
- | * simply displays & | + | |
- | */ | + | |
- | class HelloWorldApp { | + | |
- | public static void main(String[] args) { | + | |
- | System.out.println(& | + | |
- | } | + | |
- | } | + | |
- | & | + | |
- | + | ||
- | 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 | + | |
- | + | ||
- | There are additional [[doku& | + | |
- | + | ||
- | ==== Downloadable Code Blocks ==== | + | |
- | + | ||
- | When you use the &# | + | |
- | + | ||
- | & | + | |
- | & | + | |
- | & | + | |
- | & | + | |
- | & | + | |
- | + | ||
- | & | + | |
- | & | + | |
- | & | + | |
- | + | ||
- | If you don&# | + | |
- | + | ||
- | + | ||
- | ===== Embedding HTML and PHP ===== | + | |
- | + | ||
- | You can embed raw HTML or PHP code into your documents by using the &# | + | |
- | + | ||
- | HTML example: | + | |
- | + | ||
- | & | + | |
- | & | + | |
- | This is some & | + | |
- | & | + | |
- | & | + | |
- | <p style=& | + | |
- | & | + | |
- | & | + | |
- | + | ||
- | & | + | |
- | This is some & | + | |
- | & | + | |
- | & | + | |
- | <p style=& | + | |
- | & | + | |
- | + | ||
- | PHP example: | + | |
- | + | ||
- | & | + | |
- | & | + | |
- | echo &# | + | |
- | echo phpversion(); | + | |
- | echo ' (generated inline HTML)&# | + | |
- | & | + | |
- | & | + | |
- | echo &# | + | |
- | echo &# | + | |
- | echo &# | + | |
- | & | + | |
- | & | + | |
- | + | ||
- | & | + | |
- | echo &# | + | |
- | echo phpversion(); | + | |
- | echo ' (inline HTML)&# | + | |
- | & | + | |
- | & | + | |
- | echo &# | + | |
- | echo &# | + | |
- | echo &# | + | |
- | & | + | |
- | + | ||
- | **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:// | + | |
- | + | ||
- | ^ Parameter | + | |
- | | any number | will be used as maximum number items to show, defaults to 8 | | + | |
- | | reverse | + | |
- | | author | + | |
- | | date | show item dates | | + | |
- | | description| show the item description. If [[doku& | + | |
- | | nosort | + | |
- | | //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: | + | |
- | + | ||
- | By default the feed will be sorted by date, newest items first. You can sort it by oldest first using the &# | + | |
- | + | ||
- | **Example: | + | |
- | + | ||
- | {{rss& | + | |
- | + | ||
- | {{rss& | + | |
- | + | ||
- | + | ||
- | ===== 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~~%% | + | |
- | | %%~~NOCACHE~~%% | DokuWiki caches all output by default. Sometimes this might not be wanted (eg. when the %%& | + | |
- | + | ||
- | ===== Syntax Plugins ===== | + | |
- | + | ||
- | DokuWiki&# | + | |
- | + | ||
- | ~~INFO: | + | |
- | 1 | + |