DokuWiki

You've loaded an old revision of the document! If you save it, you will create a new version with this data.

====== Tips and Tricks for Dokuwiki ======
 
This is the place to collect all your Tips and Tricks for [[DokuWiki]] Usage.

:!: Steps for reorganization:
  * Add a description to each page, and categorize within this page. Almost done. 
  * Review external links to remove broken ones, maybe integrate external link to have all content on dokuwiki.org\\ If possible please rewrite content, and remove old things.

**NOTE to translators:** When updating your tips page, please use the index button to see what pages are within your locale :tips namespace. And please do include them into the tips page. Thank you.

===== Usage Tips =====

===== Extending the Syntax =====

**Most** of these tips need to be adjusted for the new [[devel:Parser]] and will not work out of the box. 
They may be better implemented by using the new [[plugin]] system though.

^ Link ^ Short Description ^
| [[tips:magnet links]]  | Show DC++ magnet links as external  |
| [[:tips:links-to-dokuwiki-commands]] | make links to "DokuWiki actions" (?do=) from within your wiki content|
| [[:tips:tex_howto]] | This patch (to 2005-05-07 version) add AMSLaTeX mathematical expression support to DokuWiki |

===== Extending Layout and Styling =====

Some of these tips may be implemented better by using the new [[template]] mechanism. You are encouraged to rewrite them accordingly.

===== Adding new Functionality =====

===== Integration with Other Software =====

==== Content Management Systems and Forums ====

^ Link ^ Short Description ^
| [[http://cruesl.um.es/wiki/doku.php?id=wiki_crue:auth_mysql_mambo|Mambo CMS]] |How to integrate DokuWiki with Mambo CMS (Spanish) |
| [[http://ruflin.com/en/hints/101-dokuwiki-mit-joomla-g-1013-verwenden|Joomla Bridge]] \\ (german) | <del>Bridge (authorization module) for using Joomla users in DokuWiki ([[http://ruflin.com/en/hints/104-dokuwiki-bridge-fafr-joomla-15|Also available for Joomla 1.5]])</del>(doesn't exist anymore)|
| [[http://extensions.joomla.org/extensions/bridges/authentication-bridges/3723|Joomla Integration]] | <del>Full User Integration of DokuWiki and Joomla with __no__ iframes! **new** ;-)</del> (doesn't exist anymore) |
| [[http://www.foolab.org/node/785|Drupal]] | Authentication backend will enable your DokuWiki to authenticate using the Drupal database. |
| [[http://blogcms.com|BLOG:CMS]] | BLOG:CMS integrates DokuWiki with Weblog, Forum and Gallery in one package |
| [[http://svn.textmate.org/trunk/Bundles/DokuWiki.tmbundle/|TextMate Bundle]] | Edit pages inside [[http://macromates.com|Textmate]] |
| [[http://www.absolutengine.com/|Absolut Engine]] | DokuWiki bridging module has been created to allow seamless integration of DokuWiki into Absolut Engine CMS. |
| [[https://www.glfusion.org/|glFusion CMS]] |DokuWiki Integration Plugin that allows seamless integration of DokuWiki into glFusion. |

==== Forum Systems only ====

==== Bug Trackers ====

==== Others ====

^ Link ^ Short Description ^
| [[tips:Synchronise with Tomboy]] | How to synchronize Tomboy with DokuWiki |
| [[http://maestric.com/wiki/doku.php?id=php:integrate-dokuwiki-to-your-website|Integrate DokuWiki to your website]] | As read-only pages |
| [[tips:Edit DokuWiki with text editors using FUSE and Python]] | Untested and potentially buggy. |
| [[http://reganmian.net/wiki/researchr:start|Researchr]] | Framework for integrating DokuWiki with BibDesk and Skim for academic note taking and citation management |

===== Interacting scripts and tools =====

^ Link ^ Short Description ^
| [[tips:DokuWiki Setup]]  | Easy/automatic installation/upgrade - also fixing safe-mode issues|
| [[tips:Maintenance]]  | Cronjobs to keep your wiki clean  |
| [[tips:Backup Script]]  | A small shellscript to backup your wiki data and media, including rotation. |
| [[tips:BackupToS3]]  | A small ruby script to backup your wiki to Amazon's data storage system S3. |
| [[tips:UpgradeScript]]  | A small script to make DokuWiki updates simpler |
| [[tips:Weblog bookmarklet]]  | A JavaScript/PHP combination to post in DokuWiki like regular weblogs |
| [[tips:imap2wiki]]  | A small PHP script to give users the opportunity to post by email|
| [[https://github.com/chimeric/dokuvimki|DokuVimKi]] | VIM Plugin that allows editing of wiki pages over XML-RPC + Syntax highlighting for DokuWiki syntax |
| [[tips:vimkeys]]  | Key Bindings for [G]Vim  |
| [[.tips:fixperms.php]]  | make webserver created files writable by everyone |
| [[tips:mail2page]]  | create pages and upload media by email |
| [[tips:romanize]]  | romanize files in datadir |
| [[http://rules-of-thumb.com/downloads#Misc|DokuWiki2HtmlHelp]] | Converts a DokuWiki website into a Compiled HTML Help file (.chm) complete with table of contents and index |
| [[tips:jEdit]]  | An edit mode for jEdit that does syntax highlighting for headlines, character formats, lists and links |
| [[cli|CLI ]] | DokuWiki command line utilities |
| [[tips:recreate wiki change log]] | How to recreate your wiki change log from individual page change logs |
| [[tips:readINIfile]]  | How to solve problem with parse_ini_file disabled |
| [[tips:fixmtime]] | Fix modification times based on timestamps (to avoid the ''external edit'' syndrome) |
| [[tips:clean_acl]] | Clean up non-existing users and pages in the ACL |
| [[tips:clean_media_directory|Clean Media Directory]] | A little Perl script to clean up orphaned files in the Media-Directory|
| [[tips:curl_login|Logging in to retrieve pages with cURL]] | Quick howto on retrieving pages that require logging in with curl.|
| [[tips:extract_links|Extract external links]] | A small PHP script to extract all external links (with surrounding context) from the wiki |
| [[tips:autolink|Add an Autolink page]] | A small Perl Script to (re)builds link on chosen words each nights |
| [[tips:build_report|Automatic build reports]] | A bash script that compiles/builds a project and reports the result to the wiki |
| [[tips:gource_analysis|GourceDoku]]|Picture of the edition of a wiki with Gource|
| [[tips:topcontributors]] | A shell snippet to create a list of the top contributors to the wiki |
| [[tips:locateorphanmedia]] | How to get a listing of all orphaned media ie.: media files that are not linked to in your wiki  |
| [[tips:pageannotate|Page Annotate]] | A script to give you idea who edited which line in page. Uses git as a tool to do the trick |
| [[tips:mysql-for-all|Mysql For All]] | An off-wiki webpage script to provide users the ability to generate mysql queries for use in wiki plugins. Users do not need to know the database structure or mysql syntax. |
| [[http://www.gab.lc/scripts/dokuwiki_orphans.php|Dokuwiki orphans]] | Help you find pages with no links towards them and links to non existant pages in order to keep your Wiki clean. |

===== Importing from External Sources =====

==== Wikis ====

==== Other ====

^ Link ^ Description ^
| [[tips:uploadcodedir]]  | Uploading a directory of code to DokuWiki  |
| [[:tips:table_editing]] | How to import your data into tables | 
| [[http://www.suttree.com/code/wikemail/|Wikemail]] | a script to import email into DokuWiki  |
| [[http://homepages.paradise.net.nz/hillview/OOo/|OpenOffice Macro]] | converts an OpenOffice document to DokuWiki format |
| [[http://www.plattsalat.de/dokuwiki/doku.php?id=wiki:openofficemacro|OpenOffice v2 Macro]] | converts an OpenOffice document to DokuWiki format, adapted for OOo v2|
| [[tips:OpenOfficeMacro]] | both of the above macros do not convert embedded pictures - this one does|
| [[http://www.ooowiki.de/Writer2DokuWiki|Writer2Dokuwiki]] | converts an OpenOffice document to DokuWiki format (doesnt fully support lists)|
| [[http://der.it-bayer.de/writer2dokuwiki-fur-openoffice-3-2-x/|Writer2Dokuwiki (IT-Bayer's version)]]  | converts an OpenOffice document to DokuWiki format  |
| [[http://www.lucsorel.com/index.php?page=downloads#calc2dokuwiki|Calc2Dokuwiki]] | Exports selected ranges of cells from OpenOffice.org Calc into tables formatted in DokuWiki code. Tool available as an extension (OOo 2.1.x) and a macro (OOo 1.x-2.x) |
| [[tips:HTMLtoWiki]]  | How to convert HTML to DokuWiki [[wiki:syntax]] |
|[[http://www.fristercons.de/fcon/doku.php?id=xls2dw:start|
Excel to DokuWiki converter]] |This makro based tool contains parameters on first worksheet to  allow the user some customization. Paste your table into another worksheet, select the cells as usual and run the makro to Export it as DW Syntax including styling. Information also available here within DokuWiki at: [[tips:Excel Macro]]  |
| [[tips:csv2dwt]]  | A script that converts Comma Separated Values (CSV) to DokuWiki's Table format (DWT) |
| [[tips:csv2dokuwiki]]  | Converts CSV input (tab separated) into DokuWiki's table syntax (in Java) |
| [[tips:xls2wiki]]  | A script that converts XLS copied data to DokuWiki's Table format (DWT) and vice versa |
|[[tips:doc_to_wiki_syntax]] | Convert folders with Ms Word Doc files to DokuWiki Syntax | 
|[[http://www.fristercons.de/fcon/doku.php?id=doc2dw:start|Word to Dokuwiki converter]] | Here you can download the latest Version of this Doc containing the makro to Export it as DW Syntax. Some Information provided here within the DokuWiki at [[tips:word_makro]]. \\ Former versions provided by Tania Hew ⇒ [[http://www.taniahew.com/word2dokuwiki.html|Word to DokuWiki Converter]] improves upon the two macros above as it is a Word template that allows one to click a button in MS Word to convert a Word document, including images, to DokuWiki format (see Portfolio section on website)|
| [[http://www.plattsalat.de/dokuwiki/doku.php?id=wiki:msofficemacro|Word Macro adaptation]] | converts an MS Word document to DokuWiki format - improved conversion (for English Word) plus adaptation for German Word |
| [[:tips:word2wiki]] | Convert Microsoft Word document content to Wiki markup |

====== Miscellaneous ======

^ Link ^ Description ^
| [[:tips:blacklist_test]] | This little script helps to check a text against the [[blacklist]] | 
| [[:tips:blogging]] | This page describes the steps necessary to get you started with blogging in DokuWiki | 
| [[:tips:bookmarklets]] | JavaScript based wiki page editing helpers |
| [[:tips:default text search]] | Add default text for the search box |
| [[:tips:disabled_functions]] | Patch if your webhost doesn't support glob or readfile | 
| [[http://sourceforge.net/projects/dwexport/|DwExport]] | DokuWiki export to static HTML pages including images and CSS formatting. => http://sourceforge.net/projects/dwexport/ //Only  v0.2// |
| [[:tips:farm]] | How to make DokuWiki a wiki farm | 
| [[:tips:htdigestauth]] | Setting up htdigest user identification | 
| [[:tips:simplegooglesearch]] | Replace DokuWiki internal search form with Google search |
| [[:tips:spell_checker_713]] | Aspell Personal Wordlists and Release 2005-07-13 (seems old) | 
| [[:tips:svg.php]] | This is a plugin to DokuWiki to allow collaborative generation of SVG images. (Make it a plugin if possible/useful) | 
| [[:tips:utf8update]] | DokuWiki UTF8 conversion |
| [[:tips:export2twiki]] | Convert DokuWiki syntax into twiki format for exporting |
| [[:tips:phpwithgd]] | This page describes how to solve issues caused by missing gdlib support in PHP |

Please fill all the letters into the box to prove you're human. H R I Z T Please keep this field empty:

Edit summary

Note: By editing this page you agree to license your content under the following license: CC Attribution-Share Alike 4.0 International