====== 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 =====

^ Link                                                                       ^ Short Description                                                     ^
| [[tips:TailorWikiRules]]                                                   | Best-practices to follow after installing DokuWiki                    |
| [[http://www.robmeerman.co.uk/unix:unison|Syncing with Unison]]            | Sync two wikis using unison                                           |
| [[tips:timezone]]                                                          | Set the server's Timezone                                             |
| [[tips:mailconfig]]                                                        | Tips on making mail work                                              |
| [[tips:commonlogin]]                                                       | Sharing authentication data between wikis on the same server          |
| [[:tips:displaying-blank-rows-in-tables|Displaying blank rows in tables]]  | Displaying blank rows in tables                                       |
| [[:tips:good_style|Good Style]]                                            | Hints on how to have good styles on DokuWiki                          |
| [[:tips:upgrading_old_versions]]                                           | How to upgrade from old DokuWiki (2005-*)                             |
| [[:tips:ShowMediaFromExternalUpload]]                                      | How to make files uploaded by other ways than mediamanager to appear  |


===== 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, aka. Action Modes, aka. Action Links (in general, URL tags)  |
|                                                                                                                                                                                                    | 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.

^ Link                                                                                         ^ Short Description                                                                                              ^
| [[tips:topbar|Top Bar]]                                                                      | Add a topbar like on dokuwiki.org                                                                              |
| [[tips:CustomQuoting]]                                                                       | Change the style of Quoting                                                                                    |
| [[tips:format_user]]                                                                         | Using CN from client certificate when displaying username                                                      |
| [[tips:Disabling link icons]]                                                                | Disables interwiki and non-wiki link icons                                                                     |
| [[tips:rss_description|Descriptions in RSS aggregator]]                                      | Add the beginning of every RSS article in the list                                                             |
| [[tips:code_css|Code CSS]]                                                                   | CSS for use with Syntax Highlighting                                                                           |
| [[tips:geshi_style_builder]]                                                                 | Geshi Style builder                                                                                            |
| [[tips:XHTML5]]                                                                              | How to switch to XHTML 5                                                                                       |
| [[tips:XHTML Strict]]                                                                        | How to switch to XHTML 1.0 Strict                                                                              |
| [[tips:Toc use position fixed]]                                                              | When the user scrolls the page, the TOC does not scroll with it, the TOC is fixed.                             |
| [[tips:numbered headings]]        | Numbered headings per CSS only         |
| [[tips:back to top]]              | back to top before every header        |
| [[tips:local-links-with-icons|Local links with icons]]       | Local links with icons      |
| [[tips:svg_icons|Custom SVG icons]]  | Create your custom multi-color SVG icons for your DokuWiki   |
| [[tips:image-in-the-upper-right-corner]]       | replace top right DokuWiki logo by your own   |
| [[tips:code-in-ordered-lists]]                                                               | Including Code in Ordered Lists                                                                                |
| [[tips:tableswithrowspans2]]                                                                 | Tables with Rowspan Support                                                                                    |
| [[tips:Tables with Rowspan]]                                                                 | Another way of providing Rowspan support in tables.                                                            |
| [[tips:rowspansfix]]                                                                         | Yet another way to make rowspan possible                                                                       |
| [[tips:rowspansfix2]]                                                                        | Yet another way to make rowspan possible                                                                       |
| [[tips:resizeiframes|Adjust iframe heights]]                                                 | An additional JavaScript for the [[plugin:iframe]] plugin to make iframes as high as needed for their content  |
| [[tips:styling-headers|Using CSS to Style Headers]]                                          | General tips, case uses and structure info for styling headers with CSS.                                       |
| [[tips:show_changes_in_recents_list|Display the changes for each entry in the recent list]]  | Display a diff of the last and the current version for each entry in the recent list]]                         |
| [[tips:printpreview]]                                                                        | Preview of the wiki body; Usage for printing or fullscreen-mode                                                |
| [[tips:double-click-to-edit]]                                                                | Double Click to Open a Section Edit (improved)                                                                 |
| [[tips:simple_columns|Simple Columns]]                                                       | Implementation of columns without plugins                                                                      |
| [[tips:button_align|Button Align]]                                                           | How to align a <button> element?                                                                               |
| [[tips:interwiki_shortcuts|Additional InterWiki Shortcuts]]                                  | Share Your InterWiki Shortcuts                                                                                 |
| [[https://forum.dokuwiki.org/d/20773|Hyphenations within headings and link texts]] (sorry, German only :-( )  | Hyphenations within headings and link texts \\ (German: Worttrennungen innerhalb von Überschriften und Linktexten)  |
===== Adding new Functionality =====

^ Link                                                                                                                   ^ Short Description                                                                                                                     ^
| [[tips:autosubscribemailinglist|Auto Subscribe a Mailinglist]]                                                         | Auto Subscribe a user to a mailinglist after registration                                                                             |
| [[tips:betteremailnotifications|Better Email Notifications]]                                                           | Receive HTML-formatted email notifications for page changes                                                                           |
| [[tips:CleanNotificationScheme|Clean Notification Scheme]]                                                             | Clarify notification scheme: namespace subscribers on new page, page subscribers on update                                            |
| [[tips:IPACL|IP-based ACLs]]                                                                                           | Assign access rights based on IP or network of the connecting client.                                                                 |
| [[tips:BrowserLanguageDetection]]                                                                                      | Change the UI language automatically                                                                                                  |
| [[tips:transliteration]]                                                                                               | Transliterate Cyrillic texts to Latin                                                                                                 |
| [[tips:pdfexport|PDF Export]]                                                                                          | PDF export using html2ps and pstopdf                                                                                                  |
| [[http://wiki.erazor-zone.de/doku.php?id=wiki:projects:php:dokuwiki:print_view|Print View Button]] FIXME Login needed  | make use of ?do=export_html                                                                                                           |
| [[tips:printview|tpl_button for print view]]                                                                           | Adds an tpl_button for print_view                                                                                                     |
| [[http://wiki.erazor-zone.de/doku.php?id=wiki:projects:php:dokuwiki:user_link|User Link]] FIXME Login needed           | use an extra wiki-page for users                                                                                                      |
| [[tips:StickyExportHtml]]                                                                                              | Make do=export_html "sticky" for HTML-only browsing                                                                                   |
| [[tips:HtmlOnly|Html only view]]                                                                                       | Similar to previous. uses .htaccess rewrite for that                                                                                  |
| [[tips:discussion]]                                                                                                    | Creates a link or button in your template that leads to a separate discussion-page (like e.g. Wikipedia does provide)                 |
| [[tips:safely include php code]]                                                                                       | Allow PHP code to be included in pages created by superuser only                                                                      |
| [[tips:logging|Page Statistics]]                                                                                       | Add page and media file logging to DokuWiki                                                                                           |
| [[tips:tinylogging|Tiny Page Logging]]                                                                                 | Add simple logging to DokuWiki                                                                                                        |
| [[tips:nls|NLS]]                                                                                                       | Adding unofficial National Language Support (NLS) for DokuWiki                                                                        |
| [[tips:Summary Enforcement]]                                                                                           | Require the user to enter a summary (or check minor edit)                                                                             |
| [[devel:toolbar#extending_the_toolbar|ToolbarButton]]                                                                  | How to add your own button to the toolbar                                                                                             |
| [[tips:homepages]]                                                                                                     | Autocreate user homepages when add/modify user accounts                                                                               |
| [[tips:wordcounter]]                                                                                                   | Add a word-/charcounter to the edit form                                                                                              |
| [[tips:mediamanager_filesize|mediamanager and filesize]]                                                               | Append the size of the mediamanager selected file to the wikilink                                                                     |
| [[tips:media_attached]]                                                                                                | media upload is attached to each page                                                                                                 |
| [[tips:template_chooser]]                                                                                              | A simple dropdown box in editmode allows you to paste content from a template into the current document                               |
| [[tips:login_instead_of_forbidden]]                                                                                    | Show the login form when accessing a restricted page                                                                                  |
| [[tips:display_acls]]                                                                                                  | Display ACLs in page footer                                                                                                           |
| [[tips:action_menu]]                                                                                                   | Action menu like in MoinMoin Wiki                                                                                                     |
| [[tips:export_html]]                                                                                                   | Export multiple pages to HTML                                                                                                         |
| [[tips:newssystem]]                                                                                                    | A News System. Based on this a plugin was developed: [[plugin:anewssystem|a NEWS System]].                                            |
| [[:tips:subscription]]                                                                                                 | Prevent Email Of Changes to Subscribed Author                                                                                         |
| [[:tips:phashLogin]]                                                                                                   | Allows "GET" login with a phash password. Useful with RSS readers for example.                                                        |
| [[tips:tinyurl|Integrate TinyURL]]                                                                                     | Automatically create a short URL for every page                                                                                       |
| [[:tips:recent_changes_by_user_2009-02-14|Filter Recent Changes]]                                                      | Allows you to filter the list of 'Recent Changes' by username (for version 2009-02-14)                                                |
| [[:tips:Separate Admin Login]]                                                                                         | Use a special admin login, which cannot read or edit pages                                                                            |
| [[:tips:User Pages]]                                                                                                   | Give everyone AUTH_EDIT on a page within a special namespace, where that page is their name                                           |
| [[:tips:clicknshow|ClickNShow]]                                                                                        | Hide/Show Headers clicking on them                                                                                                    |
| [[:tips:autominor|Minor Edit by default]]                                                                              | Set the "Minor Edit" check mark by default                                                                                            |
| [[:tips:viewcounter]]                                                                                                  | Adds a simple pageview counter                                                                                                        |
| [[tips:book|Make a book]]                                                                                              | How to make a book with DokuWiki                                                                                                      |
| [[:tips:Namespace Clouds]]                                                                                             | DokuWiki Cloud Plugin Namespace Discrimination Patch                                                                                  |
| [[:tips:Copy Section Link]]                                                                                            | An easy way to copy each section link (with JavaScript)                                                                               |
| [[:tips:pageaccueil]]                                                                                                  | Creates a home page that lists categories of wiki to create a new page in the category chosen. Also allows to Create a new category.  |

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

Auth Plugins let you authenticate in DokuWiki with credentials of other software platforms. Look for available [[plugintype>128#extension__table|Auth Plugins]] in the plugin repository.


==== 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]] FIXME (broken)                                              | 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/kynan/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/DokuWiki2HtmlHelp|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]] FIXME (broken)  | 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 ====

^ Source Wiki                                         ^ Description                                                ^
| [[tips:chu2doku|ChuWiki]]                           | A Python script for ChuWiki conversion                     |
| [[tips:ewiki2doku|ErfurtWiki]]                      | A PHP script for ewiki (ErfurtWiki) conversion             |
| [[plugin:jspwiki_import|JSPWiki]]                   | A plugin to import JSPWiki pages                           |
| [[tips:jspwiki_convert|JSPWiki (again)]]            | A pair of scripts to convert a directory of JSPWiki pages  |
| [[tips:MediaWiki to DokuWiki Converter|MediaWiki]]  | Converts MediaWiki to DokuWiki                             |
| [[tips:moinmoin2doku|MoinMoin]]                     | Python and PHP scripts for MoinMoin conversion.            |
| [[tips:perspective|Perspective]]                    | A python script, must be run from Windows                  |
| [[tips:Tikiwiki2Dokuwiki|TikiWiki]]                 | A PHP script for TikiWiki conversion.                      |
| [[tips:TracWiki2DokuWiki|trac]]                     | A PHP script for trac's wiki conversion                    |
| [[tips:TWiki to DokuWiki Conversion|TWiki]]         | A TWiki to DokuWiki conversion script                      |
| [[tips:wakka2doku|Wakka Wiki]]                      | A Perl script for Wakka Wiki conversion                    |
| [[tips:zwiki2dokuwiki|Zwiki]]                       | A Perl script for Zwiki conversion                         |
| [[tips:docpdf2dokuwiki]]                            | A Perl script for importing pdf and doc                    |
| [[tips:confluence2dokuwiki|Atlassian Confluence]]   | A Perl script for Atlassian Confluence conversion          |


==== Other ====

^ Link                                                                                                                                                          ^ Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     ^
| [[~:uploadcodedir]]                                                                                                                                           | Uploading a directory of code to DokuWiki                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| [[~: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)                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| [[https://web.archive.org/web/20111228224456/http://der.it-bayer.de/writer2dokuwiki-fur-openoffice-3-2-x/|Writer2Dokuwiki (IT-Bayer's version)]] (in German)  | 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)                                                                                                                                                                                                                                                                                                                                          |
| [[~: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: [[~:Excel Macro]]                                                                                                                                                                                                     |
| [[~:csv2dwt]]                                                                                                                                                 | A script that converts Comma Separated Values (CSV) to DokuWiki's Table format (DWT)                                                                                                                                                                                                                                                                                                                                                                                                                            |
| [[~:csv2dokuwiki]]                                                                                                                                            | Converts CSV input (tab separated) into DokuWiki's table syntax (in Java)                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| [[~:xls2wiki]]                                                                                                                                                | A script that converts XLS copied data to DokuWiki's Table format (DWT) and vice versa                                                                                                                                                                                                                                                                                                                                                                                                                          |
| [[~: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 [[~: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                                                                                                                                                                                                                                                                                                                                                                                        |
| [[~:word2wiki]]                                                                                                                                               | Convert Microsoft Word document content to Wiki markup                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
| [[~:google sheets macro]]                                                                                                                                     | Google Apps Script for exporting a selected cell range to DokuWiki                                                                                                                                                                                                                                                                                                                                                                                                                                              |
| [[~:wordpress user export]]                                                                                                                                   | How to run a query to export users from Wordpress that can be imported in DokuWiki                                                                                                                                                                                                                                                                                                                                                                                                                              |

====== 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: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 |

====== How To ======

//No plugin or modifications needed.//
^ Link               ^ Description                              ^
| [[:tips:weather]]  | Show weather info from https://wttr.in/  |