====== DokuWiki Setup ====== == Core == # download and extract $ wget http://www.splitbrain.org/_media/projects/dokuwiki/dokuwiki-2009-12-25c.tgz $ cd /path/to/basedir/webapps $ tar -xzf /root/install/2010/dokuwiki-2009-12-25c.tgz $ chown -R :www-data dokuwiki-2009-12-25/ $ cd dokuwiki-2009-12-25 # make some directories writable for webserver $ chmod -R g+w conf data $ cp .htaccess.dist .htaccess # track changes with mercurial $ hg init $ hg add $ hg commit -m 'initial commit of dokuwiki 2009-12-25c' # activate $ cd /path/to/basedir/htdocs $ ln -s ../webapps/dokuwiki-2009-12-25 wiki http://www.example.net/wiki/install.php == Check == http://www.example.net/wiki/?do=check == Templates == See also [[doku>update check|DokuWiki Templates]]. $ wget http://www.kleinewebsitesdieeinwikialscmsverwenden.de/_media/a_free_worldic.zip $ cd /path/to/basedir/webapps/dokuwiki-2009-12-25/lib/tpl $ unzip /root/install/2010/a_free_worldic.zip http://www.example.net/wiki/?do=admin&page=config \\ => Change //Design/Template// $ hg add A_Free_Worldic $ hg commit -m 'enabled design "A Free World"' == Plugins == If according links are provided, they can be installed via the //plugin manager//:\\ http://www.example.net/wiki/?do=admin&page=plugin ++++ Multi line lists plugin: Allows a list item to break into multiple lines with indentation on non-bullet lines | * [[doku>plugin:mllist|Multi line lists plugin]] ++++ ++++ Ditaa-Plugin: Converts ascii-Flowcharts to png-Graphics using ditaa | * Links:\\ [[doku>plugin:ditaa|Ditaa-Plugin]]\\ [[http://ditaa.sourceforge.net/|ditaa - DIagrams Through Ascii Art]]\\ [[http://www.dieploegers.de/files/plugin-ditaa.zip|URL for plugin manager]] * Usage:\\ {width= height=}> ... (some ditaa-code) ... * Setup:\\ aptitude install sun-java6-jre+ avahi-daemon- libnss-mdns- hg diff diff -r 33293cf81187 lib/plugins/ditaa/syntax.php --- a/lib/plugins/ditaa/syntax.php Thu Jan 28 02:50:34 2010 +0100 +++ b/lib/plugins/ditaa/syntax.php Thu Jan 28 03:10:17 2010 +0100 @@ -22,11 +22,11 @@ var $ditaa_data = ''; - var $pathToJava = "/opt/blackdown-jdk-1.4.2.02/bin/java"; + var $pathToJava = "/usr/bin/java"; - var $pathToDitaa = "/var/www/sst.intern.editable/dokuwiki/htdocs/ditaa.jar"; + var $pathToDitaa = "/srv/www/server.example.net/htdocs/wiki/lib/plugins/ditaa/ditaa.jar"; - var $tempdir = "/tmp"; + var $tempdir = '/srv/www/server.example.net/htdocs/wiki/data/tmp'; /** * return some info hg commit -m 'configured ditaa plugin' ++++ ++++ Note Plugin: This plugin allows you to create nice «notes» like this in your DokuWiki pages | * Links:\\ [[doku>plugin:note|Note Plugin]]\\ [[http://gauret.free.fr/fichiers/dokuwiki/dokuwiki-note-20090615.tgz|URL for plugin manager]] * Usage:\\ ++++ ++++ Folded Plugin: Foldable page sections | * Links:\\ [[doku>plugin:folded|Folded Plugin]]\\ [[http://dokuwiki.jalakai.co.uk/plugin-folded.tar.gz|URL for plugin manager]] * Usage:\\ **Inline:** This is example ++text | with some of it only shown when you unfold it++. And after that the text just continues to flow in the same paragraph. **Block:** This is example text. ++++ Title | | This table | is only shown | when you unfold the block | {{page>some other wiki page}} ++++ ++++ ++++ keyboard plugin: Marks text as keyboard keys | * Links:\\ [[doku>plugin:keyboard|keyboard plugin]]\\ [[http://foosel.org/snippets/dokuwiki/keyboard|Keyboard Plugin]]\\ [[http://foosel.org/_media/snippets/dokuwiki/plugin-keyboard.tar.gz|URL for plugin manager]] * Usage:\\ C-x * Result:\\ C-x ++++ ++++ Tag Plugin: Assign category tags to wiki pages | * Links:\\ [[doku>plugin:pagelist|Pagelist Plugin]] [[http://cloud.github.com/downloads/dokufreaks/plugin-pagelist/plugin-pagelist.tgz|URL for plugin manager]] (prerequisite)\\ [[doku>plugin:tag|Tag Plugin]] [[http://www.chimeric.de/_src/plugin-tag.tgz|URL for plugin manager]]\\ [[doku>plugin:tagentry|tagentry plugin]] [[http://mir.dnsalias.com/_media/oss/dokutagentry/tagentry.zip|URL for plugin manager]]\\ * Usage:\\ w/o namespaces: {{tag>tag1 tag2 tag3}} with namespaces: {{tag>:ns1:tag1 ns1:tag2 ns2:subns1:tag3}} ++++ ++++ Box Plugin: Highlight particularly important parts of your wiki in boxes that stand out | * Links:\\ [[doku>plugin:box|Box Plugin]]\\ [[http://dokuwiki.jalakai.co.uk/plugin-box.tar.gz|URL for plugin manager]] * Usage:\\ the box contents the box contents * Result:\\ the box contents the box contents ++++ == Regular maintenance == Please read [[doku>tips:maintenance|DokuWiki Maintenance]] and [[doku>update check|DokuWiki Update Check]] (update checks should be enabled by default). ====== More resources ====== == Interesting plugins == [[doku>plugin|Plugins]] ++++ show... | * "Web 2.0" features * [[doku>plugin:blog|Blog Plugin]]: Use DokuWiki as blogging tool * [[http://foosel.org/blog/2008/04/new_release_of_the_dokuwiki_blogsuite|New release of the Dokuwiki BlogSuite]] * [[http://dokuwiki.foosel.org/blogsuite/|DokuWiki Blogsuite BundleHub]] * [[doku>plugin:blogtng|BlogTNG Plugin]]: A next generation blog plugin for DokuWiki * [[doku>plugin:tag|Tag Plugin]]: Assign category tags to wiki pages * [[doku>plugin:tagentry|tagentry plugin]]: Assign tags using checkboxes * [[doku>plugin:cloud|Cloud Plugin]]: Show a cloud of the most frequently used words in your wiki * [[doku>plugin:cumulus|Cumulus plugin]]: Plugin for displaying Flash movie navigation clouds * [[doku>plugin:keywordvoting|keywordvoting plugin]]: This AJAX based plugin enables the users to append words/sentences to a "tag cloud", or vote for existing words already part of the cloud by clicking the tag * [[doku>plugin:starred|starred plugin]]: Personal bookmarking for pages * [[doku>plugin:stars|stars plugin]]: Show stars for ratings/difficulty/etc * [[doku>plugin:poll|Poll Plugin]]: Lets you add polls to a wiki page * [[doku>plugin:vote|vote plugin]]: Similar to poll plugin * [[doku>plugin:discussion|Discussion Plugin]]: Add a comments section to Wiki pages * [[doku>plugin:userannotations|userannotations plugin]]: Create annotations below the regular wiki text. Each user creates his own annotation and can decide for himself if other users can read them or not. * [[doku>plugin:bookmarkme|BookmarkMe plugin]]: Creates links to various social bookmark services * "Web 3.0" features * [[doku>plugin:dokusioc|DokuSIOC Plugin]]: [[http://eye48.com/dokuwiki/doku.php?id=en:dokuwiki:sioc-plugin|DokuSIOC - SIOC plugin for DokuWiki]] integrates SIOC Ontology within DokuWiki, provides alternate RDF/XML views of the wiki documents and can ping pingthesemanticweb.com * Groupware-/Management features * [[doku>plugin:task|Task Plugin]]: Integrates a simple task management tool into your wiki * [[doku>plugin:timeline|timeline plugin]]: Add TimeLine capability to DokuWiki * [[doku>plugin:todo|todo plugin]]: Create a simple, Checkbox based Todo List * Navigation / Content structure * [[doku>plugin:navi|navi plugin]]: Build a navigation menu from a list - This plugin allows you to create a nested navigation menu based on a list defined in a Wiki page. Lower navigation levels are shown or hidden dependent on the current page. It is intended for the use in the sidebar of a template supporting one (tested on Arctic). A notable feature is that it allows you to create hierarchical menus without the need of a hierarchical namespace structure. * [[doku>plugin:navilevel|navilevel plugin]]: A navigation tree that adapts to the page that hosts it * [[doku>plugin:nsrelation|NSRelation Plugin]]: Shows links to the same page but in related namespaces * [[doku>plugin:nstoc|NsToC Syntax PlugIn]]: Namespace Table-of-Content * [[doku>plugin:pagenav|Page Navigation Plugin]]: Displays links to the next or previous alphabetically ordered page * [[doku>plugin:relativelinks|relativelinks plugin]]: Replaces standard wiki-base-centric links with relative ones (anything which doesn't start with . or : is assumed to be relative to the current namespace) * [[doku>plugin:relativens|relativens plugin]]: Links & media that don't start with / or : default to being relative to the namespace in which the current page is * [[doku>plugin:sidebar|sidebar plugin]]: Based on sidebar template by ChrisS - but works as a plugin with any template * [[doku>plugin:sidebarng|sidebarng plugin]]: Adds a flexible sidebar to your Wiki * [[doku>plugin:tabinclude|tabinclude plugin]]: Tab container for other DokuWiki pages using AJAX * Formatting * [[doku>plugin:box|box plugin]]: Highlight particularly important parts of your wiki in boxes that stand out * [[doku>plugin:boxes_mod|Modified Boxes Plugin]]: Just an example to prove the point * [[doku>plugin:boxwh|boxwh plugin]]: Extension of Christopher Smiths box plugin: includes now a height parameter * [[doku>plugin:div_span_shorthand|div_span_shorthand plugin]]: Shorthand for HTML divs and spans * [[doku>plugin:folded|Folded Plugin]]: Foldable page sections * [[doku>plugin:side_note|Definition Side Note]]: Allow sidenotes including image caption * [[doku>plugin:important_paragraf|Mark a Paragraf]]: Start a paragraph with two exclamation marks, and it generates a
around it * [[doku>plugin:important_text|Mark a Text]]: Enclose a text within hashes and it generates a around it * [[doku>plugin:wrap|Wrap Plugin]]: Universal plugin which combines functionalities of many other plugins. Wrap wiki text inside containers (divs or spans) and give them a class (choose from a variety of preset classes), a width and/or a language with its associated text direction. * [[doku>plugin:note|Note Plugin]]: This plugin allows you to create nice «notes» in your DokuWiki pages * [[doku>plugin:tip|Tip Syntax PlugIn]]: Use small notes/hints * [[doku>plugin:tooltip|tooltip plugin]]: This plugin lets you mark some text with a tooltip * [[doku>plugin:keyboard|keyboard plugin]]: Marks text as keyboard keys * [[doku>plugin:nbsp|Non-breaking Space Syntax PlugIn]]: Use non-breaking spaces * [[doku>plugin:space|space plugin]]: Inserts 1 non-breaking spaced to 'force' a space (based on the tab plugin syntax) * [[doku>plugin:tab|tab plugin]]: Inserts 5 non-breaking spaced to 'force' a tab * [[doku>plugin:linebreak|linebreak plugin]]: Generate line breaks in output for line breaks in raw wiki data * [[doku>plugin:pagebreak|Pagebreak]]: Forces ('suggests') a pagebreak after the line where a tag is inserted * [[doku>plugin:refnotes|RefNotes plugin]]: Extended syntax for footnotes and references * [[doku>plugin:mllist|Multi line lists plugin]]: Allows a list item to break into multiple lines with indentation on non-bullet lines * [[doku>plugin:complex_lists|Complex Lists Plugin]]: Create complex multi-level lists with cross-references - suitable for writing legal documents such as contracts and statutes * [[doku>plugin:numberedheadings|Plugin Numbered Headings]]: Adds numbered headings to DokuWiki without changing the actual behavior of the standard headings * [[doku>plugin:tablewidth|Table Width plugin]]: Allows to specify width of table columns * [[doku>plugin:qna|QnA plugin]]: Custom formatting for Q&A (FAQ) sections * [[doku>plugin:recent|Changelog Plugin]]: Allows you to show the changelog in a page * [[doku>plugin:imagebox|imagebox plugin]]: Syntax for display an image with a caption, like Wikipedia.org * [[doku>plugin:menu|menu plugin]]: This plugins displays links as nice looking menu cards * [[doku>plugin:s5|S5 Presentations]]: Create slideshow presentations from a DokuWiki page * [[doku>plugin:loadskin|Plugin Loadskin]]: Allows to specify different templates for different wiki pages or namespaces * [[doku>plugin:toc|TOC Plugin]]: Allows to move TOC to the specified place in the page content * [[doku>plugin:uparrow|Uparrow Plugin]]: This simple plugin shows an arrow-image which links to the top of the current page * Indexing / Listing * [[doku>plugin:alphaindex|Plugin Alphaindex]]: Allows you to insert the alphabetical index of a namespace in a page * [[doku>plugin:filelist|filelist plugin]]: Provides a syntax for adding linked and sorted lists of files as selected by wildcard based glob patterns to a wiki page\\ [[http://foosel.org/snippets/dokuwiki/filelist|filelist plugin]] * [[doku>plugin:medialist|Medialist Plugin]]: This plugin shows a list of media files for a given wikipage which are either linked in the page itself or belong to its namespace. If there is no media directory named like the page the plugin looks for media in the next upper namespace * [[doku>plugin:fullindex|fullindex plugin]]: A replacement for the built in index action * [[doku>plugin:nslist|nslist plugin]]: List all pages in a given namespace * [[doku>plugin:nspages|nspages plugin]]: Present a table of content of the pages of a selected namespace * [[doku>plugin:pageindex|pageindex plugin]]: Bulleted list of pages within a namespace * [[doku>plugin:pagelist|pagelist plugin]]: Lists pages in a nice looking table or unordered list * [[doku>plugin:querychangelog|querychangelog plugin]]: Access the full changelog and filter the results * [[doku>plugin:searchresults|searchresults plugin]]: List of page links from search criteria * [[doku>plugin:searchpattern|SearchPattern Plugin]]: Search a specified pattern inside wiki pages (standard or regex) and display the results as a table inside a wiki page * [[doku>plugin:searchtext|searchtext plugin]]: Searches pages rendered as text instead of raw wiki. Displays search result snippets from rendered text. * [[doku>plugin:top10|top10 plugin]]: Top ten most viewed pages on DokuWiki * Embedding/referencing external resources and other media types * [[doku>plugin:upload|upload plugin]]: Includes file upload into wikipages depending on the user rights * [[doku>plugin:dirlisting|Directory Listing Syntax PlugIn]]: Show content of server directories * [[doku>plugin:showfile|showfile plugin]]: A basic plugin to display the content of files present on the server's disks * [[doku>plugin:source|source plugin]]: Allows you to include all or part of the contents of another file, with syntax highlighting, into the current page * [[doku>plugin:repo|Repository Plugin]]: Include syntax highlighted source code from code repositories * [[doku>plugin:websvn|websvn plugin]]: A convenience plugin for linking (and iframe-inlining) files in a WebSVN repository * [[doku>plugin:runcommand|runcommand plugin]]: Execute a program on the fly and show its output * [[doku>plugin:phpinc|phpinc plugin]]: This plugin allows you to include a PHP/HTML file into your wikipage * [[doku>plugin:phpwikify|PHP Wikify]]: Allows one the possibility of having output of php scripts parsed * [[doku>plugin:draw|Draw Plugin]]: Draw and edit diagrams using a Java Applet * [[doku>plugin:freemind|Freemind Extension for Command Plugin]]: Display Freemind Mindmaps in your wiki * [[doku>plugin:graphviz|Graphviz-plugin]]: Graph Visualization (from text with links between objects to image) * [[doku>plugin:graphgear|Graph Gear plugin]]: Visualize directed and undirected graphs in flash using Graphviz notation * [[doku>plugin:ditaa|Ditaa-Plugin]]: Converts ascii-Flowcharts to png-Graphics using ditaa. [[http://ditaa.sourceforge.net/|ditaa]] is //DIagrams Through Ascii Art// * [[doku>plugin:yuml|yuml plugin]]: [[http://yuml.me/|yUML]] is //Create and share simple UML diagrams in your blogs, wikis, forums, bug-trackers and emails// * [[doku>plugin:wikindx|wikindx plugin]]: Interact with a wikindx site (see wikindx.sf.net) * [[doku>plugin:wikipediasnippet|WikipediaSnippet Plugin]]: Includes a snippet from a Wikipedia article * Export * Static content * [[doku>plugin:offline|offline plugin]]: Generates a static version of your wiki that will be browseable offline * [[doku>plugin:siteexport|Site Export plugin]]: Export your site or a namespace to standalone HTML pages - including images and media. This plugin is capable of creating an Eclipse Plugin help including the ''context.xml''. You can also select the template to which you want to export your content * [[doku>plugin:text|text (export/renderer) plugin]]: Exports or Renders a page as plain text * PDF * [[doku>plugin:dw2pdf|dw2pdf plugin]]: Export DokuWiki content to PDF * [[doku>plugin:html2pdf|html2pdf plugin]]: Exports HTML to PDF * [[doku>plugin:pdfex|PDFex - export PDF via Action Plugin]]: Exporting a wiki page as PDF * [[doku>tips:pdfexport|Export DokuWiki Page to PDFs]]: Several users proposed a way how to convert your HTML wiki pages to PDFs. Therefore you'll find 3 different solutions to the same problem on this page and another one on: * [[doku>plugin:pdfdownload|Download as PDF]]: Extracting the content of a page as PDF * Misc * [[doku>plugin:mailto|mailto plugin]]: Mail the current page to several people * [[doku>plugin:recommend|recommend plugin]]: Allows to recommend a page via email * [[doku>plugin:noprint|noprint plugin]]: Hides parts of a page on printout * Content editing * [[doku>plugin:fckg|fckg plugin]]: WYSIWYG editor. Fully Functional Front end to FCKeditor * [[doku>plugin:fckglite|fckglite plugin]]: WYSIWYG editor. JavaScript Front end to FCKeditor * [[doku>plugin:fckw|fckw plugin]]: Integrates the FCK Editor into DokuWiki * [[doku>plugin:wysiwyg|WYSIWYG Plugin]]: A WYSIWYG editor * [[doku>plugin:wysiwyg_nicedit|WYSIWYG nicedit plugin]]: WYSIWYG-type editor adaptation for DokuWiki * [[doku>plugin:snippets|snippets plugin]]: Adds a button to the editor toolbar which allows to easily insert templates while editing a page * [[doku>plugin:tableedit|tableedit plugin]]: Manipulate with table columns order in a simple way * [[doku>plugin:mediamanager|Plugin - Media Manager]]: Media Manager - This plugin is intended to provide document management capabilities to DokuWiki. Essentially it rides on top of the regular media capabilities of DokuWiki, but with a much friendlier interface and some more usability. Users can browse and download the media directory, upload files, create directories, and lock files to indicate that they are being modified and that nobody else can upload over them. * [[doku>plugin:dokubookmark|dokubookmark plugin]]: Bookmarklet to submit content to DokuWiki\\ [[http://mir.dnsalias.com/wiki/dokubookmark|Dokubookmark - Website Tagger]] * Syntax highlighting * [[doku>plugin:code2|Code Syntax PlugIn]]: Syntax highlighting with optional line numbers * [[doku>plugin:diff|Diff Syntax PlugIn]]: Format diff output * [[doku>plugin:xterm|xterm plugin]]: Documenting xterminal output without forcing linefeeds * [[doku>plugin:xterm2|xterm2 plugin]]: * [[doku>plugin:xtermrtf|xtermrtf plugin]]: xterm that supports (basic) RTF formatting (to use with PuTTY) * Synchronization * [[doku>plugin:sync|Synchronization Plugin]]: Synchronize two Wiki installs via XMLRPC * [[doku>plugin:freesync|freesync plugin]]: Similar to sync * Metadata * [[doku>plugin:keywords|Keywords Plugin]]: Adds keywords to the page meta header * [[doku>plugin:meta|meta plugin]]: Set Metadata * [[doku>plugin:metaheaders|Plugin MetaHeaders]]: Lets you add/remove meta headers dynamically * Maintenance * [[doku>plugin:pagemove|Pagemove plugin]]: Move and rename pages whilst maintaining the links * [[doku>plugin:securelogin|securelogin plugin]]: This plugin let you login securely without HTTPS * [[doku>plugin:swiftmail|SwiftMailer plugin]]: This plugin uses the SwiftMailer class to send DokuWiki mails and supports using a remote SMTP (with optional auth) without relying on PHP's mail() function * [[doku>plugin:timer|Timer Plugin]]: Show portion of page at specified time ++++ == Tips and Tricks == [[doku>tips|Tips and Tricks]] ++++ show... | * [[doku>tips:show_changes_in_recents_list|Show changes in the recents list]]: Using this hack you can easily see what has been changed from one version to another right there in the recents list. It provides you with a small javascript link that will show or hide a diff between the current and the previous version of the page. * [[doku>tips:synchronise_with_tomboy|How to synchronise Tomboy with Dokuwiki]]: "I wrote a little script which synchronises Tomboy notes (one-way) with a Dokuwiki installation" * [[doku>tips:excel_macro|Excel macro]]: Excel macro for exporting a selected cell range to Dokuwiki * [[doku>tips:openofficemacro|Open Office macro]]: I just started to use DokuWiki and was looking for an OpenOffice to DokuWiki Converter, so after searching the web and trying I noticed that none of the existing converters was converting embedded pictures (using OpenOffice 3 and Windows XP)! * [[doku>tips:htmltowiki|Convert HTML to DokuWiki]]: An idea for converting existing documents to text files with DokuWiki syntax using an HTML to Text converter * [[doku>tips:httpauth-passthru|HTTP-Auth-Passthru]]: If you have already configured a working acl-setup but need http-auth-functionality ++++ == Other Links == * [[doku>development|DokuWiki Development]] * [[doku>Template|Templates]] * [[http://planet.dokuwiki.org/|Planet DokuWiki]] {{tag>dokuwiki}}