Table of Contents
Editing The Wiki
Editing an Existing Page
- Have an account created by a KUISC member.
- Find an error in a page or search 'FIX ME' no space to find a page that needs fixing.
- To the left of the search bar click on edit.
- Edit the page.
- Click Preview to see if changes done to page are correct.
- Add an edit summary.
- Click Save and done!
- Find more errors.
Creating a new page
- Have an account.
- Create a link to a non-existing page.
[[wikiNamespace:page name|text to be displayed]]
- Click new red link.
- Click create page on upper right next to search bar.
- Then create the page
- Add an edit summary.
- Click Save and done!
Media Management
Media Manager
The Media Manager is the place to add a supported format to the wiki to be used on a wiki page. The steps to do this are:
- Have a supported file to upload.
- Identify the page the media will be posted to.
- On the Media Manager page under 'Media Manager' in the center collom switch to the upload tab.
- Drag and drop or path to the file you wish to upload.
- Append 1) a namespace/s seperated with colons2), this namespace should not be root or wiki please create a namespace/s corrosponding to the path to the page on wich the file will be added to.
- For adding a file to this page the namespace should be wiki:editing
- Upload and use on page.
Supported Media Formats
DokuWiki can embed the following media formats directly after uploading the media to the media manager.
Extension | Mime type |
---|---|
jpg | image/jpeg |
jpeg | image/jpeg |
gif | image/gif |
png | image/png |
swf | application/x-shockwave-flash |
mp3 | audio/mpeg |
ogg | audio/ogg |
wav | audio/wav |
tgz | !application/octet-stream |
tar | !application/x-gtar |
gz | !application/octet-stream |
bz2 | !application/octet-stream |
zip | !application/zip |
rar | !application/rar |
7z | !application/x-7z-compressed |
application/pdf | |
ps | !application/postscript |
rpm | !application/octet-stream |
deb | !application/octet-stream |
doc | !application/msword |
xls | !application/msexcel |
ppt | !application/mspowerpoint |
rtf | !application/msword |
docx | !application/vnd.openxmlformats-officedocument.wordprocessingml.document |
xlsx | !application/vnd.openxmlformats-officedocument.spreadsheetml.sheet |
pptx | !application/vnd.openxmlformats-officedocument.presentationml.presentation |
sxw | !application/soffice |
sxc | !application/soffice |
sxi | !application/soffice |
sxd | !application/soffice |
odc | !application/vnd.oasis.opendocument.chart |
odf | !application/vnd.oasis.opendocument.formula |
odg | !application/vnd.oasis.opendocument.graphics |
odi | !application/vnd.oasis.opendocument.image |
odp | !application/vnd.oasis.opendocument.presentation |
ods | !application/vnd.oasis.opendocument.spreadsheet |
odt | !application/vnd.oasis.opendocument.text |
The following text types are commented by default, because spammers are known to upload spam pages through unprotected Wikis using text type files.
html | text/html |
htm | text/html |
txt | text/plain |
conf | text/plain |
xml | text/xml |
csv | text/csv |
If you specify a filename that is not a supported media format, then it will be displayed as a link instead.
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 video.webm and video.ogv next to the referenced video.mp4, DokuWiki will automatically add them as alternatives so that one of the three files is understood by your browser.
Additionally DokuWiki supports a “poster” image which will be shown before the video has started. That image needs to have the same filename as the video and be either a jpg or png file. In the example above a video.jpg file would work.
Editing Syntax
Text Formatting
Bold: **bold** Italic: //italic// Underlined: __underlined__ Monospaced: ''monospaced'' Subscript <sub>subscript</sub> Superscript <sup>superscript</sup> Deleted: <del>deleted</del> Forced new line: \\ Footnotes ((This is a footnote))
bold
italic
underlined
monospaced
subscript
superscript
deleted
3)
External links
DokuWiki recognized external URLs automatically. Link w/name: [[http://www.google.com|Go to Google]] Email address: <dmpop@openoffice.org> RSS feed: {{rss>http://rss.slashdot.org/Slashdot/slashdot}}
Internal links
DokuWiki page: [[pagename]] DokuWiki page w/name: [[pagename|Page name]] DokuWiki page in the specified namespace: [[wiki:pagename]] Link to the specified section: [[page#section|Section]] Interwiki link: [[doku>wiki:interwiki|Interwiki]] Link to a page on Wikipedia: [[wp>pagename]] Link to a Google search: [[google>pagename]] Link to a page on Meatball: [[Meatball>pagename]] Image link: [[http://www.php.net|{{wiki:dokuwiki-128.png}}]] Windows share: [[\\server\share|Windows share]]
Images
Original size: {{wiki:image.png}} Resized to the specified width: {{wiki:image .png?50}} Resized to the specified width and height: {{wiki:image.png?200x50}} Resized external image: {{http://url/image.png?200x50}} Aligned left: {{ wiki:image.png}} Aligned right: {{wiki:image.png }} Centered: {{ wiki:image.png }} Caption: {{ wiki:image.png|Caption goes here}} Example: [[http://www.kuisc.com|{{ wiki:kuisc-logo-128.gif?60x60 |A 128x128 image re-sized to 60x60, centered, with caption, and an external link to our website }}]]
Headlines
DokuWiki automatically generates a table of contents when the page contains more than three headlines. To disable the table of contents, insert the ~~NOTOC~~ markup somewhere in the page. ====== Level 1 Headline ====== ===== Level 2 Headline ===== ==== Level 3 Headline ==== === Level 4 Headline === == Level 5 Headline ==
Un-ordered Lists
To create an unordered list, indent your text by two spaces and use the * character for each list item. * Level 1 list item * Level 2 list item * Level 1 list item
Numbered Lists
To create a numbered list, indent your text by two spaces and use the - character for each list item. - Level 1 list item - Level 2 list item - Level 1 list item
Quotes
> Quote 1 >> Quote 2 >>> Quote 3
Knock KnockWho's There?GET BACK TO WORK!
Tables
^ Heading 1 ^ Heading 2 ^ | Row 1 Col 1 | Row 1 Col 2 | | Colspan || | Row 3 Col 1 | Row 2 Col 2 | | ^ Heading 1 ^ Heading 2 ^ ^ Heading 3 | Row 1 Col 2 | Row 1 Col 3 | ^ Heading 4 | Row 2 Col 2 | Row 2 Col 3 | ^ Heading 5 | Row 2 Col 2 | Row 2 Col 3 |
Heading 1 | Heading 2 | |
---|---|---|
Row 1 Col 1 | Row 1 Col 2 | |
Colspan | ||
Row 3 Col 1 | Row 2 Col 2 | |
Heading 1 | Heading 2 | |
Heading 3 | Row 1 Col 2 | Row 1 Col 3 |
Heading 4 | Row 2 Col 2 | Row 2 Col 3 |
Heading 5 | Row 2 Col 2 | Row 2 Col 3 |
Non-parsed Blocks
To include a non-parsed block into a page, indent it by at least two spaces or use the code or file tags.
Syntax Highlighting Code Block
DokuWiki supports code highlighting. It uses the GeSHi Generic Syntax Highlighter (http://qbnz.com/highlighter/), and recognizes any language supported by GeSHi. The code must be includes between tagsthat identify the programming language, for example: <code oobas> Code HERE </ code> <code java> Code HERE </ code> General code block syntax <code Language File> Code HERE </ code> Note: Examples have a space in the </ code> line remove this to use!
Syntax Highlighting File Block
Nearly excally the same as a code block but allows users to download the file ready to use. <file Language FileName.Extension> Code HERE </file>
- PentagonHack.exe
Thanks Obama!
The following language strings are currently recognized: 4cs, 6502acme, 6502kickass, 6502tasm, 68000devpac, abap, actionscript-french, actionscript, actionscript3, ada, algol68, apache, applescript, asm, asp, autoconf, autohotkey, autoit, avisynth, awk, bascomavr, bash, basic4gl, bf, bibtex, blitzbasic, bnf, boo, c, c_loadrunner, c_mac, caddcl, cadlisp, cfdg, cfm, chaiscript, cil, clojure, cmake, cobol, coffeescript, cpp, cpp-qt, csharp, css, cuesheet, d, dcs, delphi, diff, div, dos, dot, e, epc, ecmascript, eiffel, email, erlang, euphoria, f1, falcon, fo, fortran, freebasic, fsharp, gambas, genero, genie, gdb, glsl, gml, gnuplot, go, groovy, gettext, gwbasic, haskell, hicest, hq9plus, html, html5, icon, idl, ini, inno, intercal, io, j, java5, java, javascript, jquery, kixtart, klonec, klonecpp, latex, lb, lisp, llvm, locobasic, logtalk, lolcode, lotusformulas, lotusscript, lscript, lsl2, lua, m68k, magiksf, make, mapbasic, matlab, mirc, modula2, modula3, mmix, mpasm, mxml, mysql, newlisp, nsis, oberon2, objc, objeck, ocaml-brief, ocaml, oobas, oracle8, oracle11, oxygene, oz, pascal, pcre, perl, perl6, per, pf, php-brief, php, pike, pic16, pixelbender, pli, plsql, postgresql, povray, powerbuilder, powershell, proftpd, progress, prolog, properties, providex, purebasic, pycon, python, q, qbasic, rails, rebol, reg, robots, rpmspec, rsplus, ruby, sas, scala, scheme, scilab, sdlbasic, smalltalk, smarty, sql, systemverilog, tcl, teraterm, text, thinbasic, tsql, typoscript, unicon, uscript, vala, vbnet, vb, verilog, vhdl, vim, visualfoxpro, visualprolog, whitespace, winbatch, whois, xbasic, xml, xorg_conf, xpp, yaml, z80, zxbasic.
Page Export
Single page can be exported to different formats by adding an appropriate do parameter to the URL: http://wiki.splitbrain.org/wiki:export?do=export_raw The following export options are available: export_raw (returns the pages source as text/plain ) export_xhtml (returns the rendered page as simple XHTML without any navigational elements) export_xhtmlbody (returns the rendered XHTML of the page only)
Configuration Files
conf/dokuwiki.php DokuWiki default settings conf/local.php DokuWiki user-defined settings conf/entities.conf Custom typography conversion rules
Keyboard Shortcuts
On Mac, use Ctrl instead of Alt. In Firefox, use Alt+Shift Alt+E Open the current page in edit mode Alt+V Open the current page in view mode Alt+O Show old revisions of the current page Alt+R Show recent changes Alt+F Set the cursor to the search field Alt+H Open the start page Alt+X Open the index page
RSS/ATOM Feeds
DokuWiki can integrate data from external XML feeds. For parsing the XML feeds, 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 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. 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.