<?xml version="1.0" encoding="UTF-8"?>
<rss version="2.0"
	xmlns:content="http://purl.org/rss/1.0/modules/content/"
	xmlns:wfw="http://wellformedweb.org/CommentAPI/"
	xmlns:dc="http://purl.org/dc/elements/1.1/"
	xmlns:atom="http://www.w3.org/2005/Atom"
	xmlns:sy="http://purl.org/rss/1.0/modules/syndication/"
	xmlns:slash="http://purl.org/rss/1.0/modules/slash/"
	>

<channel>
	<title>Grantovich.net &#187; dokuwiki</title>
	<atom:link href="http://grantovich.net/posts/tag/dokuwiki/feed/" rel="self" type="application/rss+xml" />
	<link>http://grantovich.net</link>
	<description>Updated with astounding infrequency</description>
	<lastBuildDate>Tue, 29 Jun 2010 01:38:03 +0000</lastBuildDate>
	<language>en</language>
	<sy:updatePeriod>hourly</sy:updatePeriod>
	<sy:updateFrequency>1</sy:updateFrequency>
	<generator>http://wordpress.org/?v=3.0.1</generator>
		<item>
		<title>Dokumenting with DokuWiki</title>
		<link>http://grantovich.net/posts/2009/06/dokumenting-with-dokuwiki/</link>
		<comments>http://grantovich.net/posts/2009/06/dokumenting-with-dokuwiki/#comments</comments>
		<pubDate>Sat, 27 Jun 2009 02:34:18 +0000</pubDate>
		<dc:creator>Grantovich</dc:creator>
				<category><![CDATA[Uncategorized]]></category>
		<category><![CDATA[content management]]></category>
		<category><![CDATA[dokuwiki]]></category>
		<category><![CDATA[webs]]></category>
		<category><![CDATA[wikis]]></category>

		<guid isPermaLink="false">http://grantovich.net/?p=328</guid>
		<description><![CDATA[At my current summer co-op, I&#8217;ve been tasked with setting up a wiki on the company intranet to make a variety of internal documentation more accessible, editable, and revision-trackable. As far as wikis go, MediaWiki tends to be the default choice; it&#8217;s reliable, extensible, and has vastly greater mindshare than any other wiki platform thanks to the omnipresent [...]]]></description>
			<content:encoded><![CDATA[<p>At my current summer co-op, I&#8217;ve been tasked with setting up a wiki on the company intranet to make a variety of internal documentation more accessible, editable, and revision-trackable. As far as wikis go, <a href="http://www.mediawiki.org/">MediaWiki</a> tends to be the default choice; it&#8217;s reliable, extensible, and has vastly greater mindshare than any other wiki platform thanks to the omnipresent hive-mind of infallible factoids<sup style="color: #002bb8;">[citation needed]</sup> that is Wikipedia.</p>
<p>Figuring that MediaWiki was probably overkill for this project, I struck out in search of something that would be easier to install and configure for me, and easier for non-technical users to maintain. What I found was <a href="http://www.dokuwiki.org/dokuwiki">DokuWiki</a>, a somewhat minimalistic wiki platform that explicitly aims to fulfill the documentation needs of &#8220;developer teams, workgroups, and small companies.&#8221; Perfect!</p>
<p>As I soon discovered, one of DokuWiki&#8217;s distinguishing features is that it does <em>not</em> make use of a database for storage, as so many other wikis and content management systems do. This makes installation incredibly simple right off the bat: Just drop the files in a directory on your web server and go. All of your pages are stored as plain text files (e.g. another_wiki_page.txt)  in a directory hierarchy that matches the hierarchy of &#8220;namespaces&#8221; you create on the wiki. In this way, your content remains organized and perfectly readable even when you take the wiki software out of the equation.</p>
<p>For the most part, DokuWiki&#8217;s <a href="http://www.dokuwiki.org/syntax">syntax</a> is pleasant and sensical. Instead of MediaWiki&#8217;s odd multiple-single-quotes scheme, you have //slashes// for emphasis and **asterisks** for strong emphasis, which feels more intuitive. Instead of MediaWiki&#8217;s bizarre syntax differences between internal and external links, DokuWiki treats them all the same: [[link_target|Link Text]]. But then again, there are some strange and arbitrary syntax decisions on DokuWiki&#8217;s side, like the fact that the largest headings are surrounded by ======Six Equals Signs======, and the number of equals signs goes <em>down</em> by one for each sub-heading level. Weird, though I suppose it&#8217;s in the name of plain-text readability.</p>
<p>Uploading images and other files to DokuWiki is a breeze, thanks to a pop-up media manager that includes a multi-file Flash uploader and can insert wiki-links to your files with a click. Nifty media icons abound in DokuWiki&#8217;s output, with PDF files, Word documents, and more each getting their own instantly-recognizable icons. External links and email addresses also get unique icons, making them stand out nicely on the page. The &#8220;pretty by default&#8221; approach extends to text, which gets automatic curly quotes and various other typographic entities in much the same way that WordPress output does.</p>
<p>Given that I&#8217;m using DokuWiki for documentation on a company intranet, I would be remiss if I didn&#8217;t mention what an absolute cakewalk it is to integrate your own authentication scheme into it. If you already have a table of users in a database somewhere, as I did, you can set up DokuWiki to authenticate against it in the time it takes you to write a couple of SQL queries. There are other built-in authentication modules you can use, and if none of them meet your needs, writing your own is surprisingly easy (and well-documented) if you have a decent knowledge of PHP. There is also a fairly comprehensive ACL system that becomes much more useful if you set up your authentication scheme to provide &#8220;groups&#8221; to DokuWiki, or if you&#8217;re using the built-in mechanism.</p>
<p>One downside I&#8217;ve encountered in terms of usability is DokuWiki&#8217;s strict adherence to a particular naming convention for both page names and media file names: Only lowercase letters, periods, dashes, and underscores are permitted. The aesthetics of this decision leave something to be desired, especially since the name of the page you&#8217;re on is (at least in the default theme) displayed at the top in very large text, and <strong>probably:looks:ugly_as_sin</strong>. I&#8217;m not sure why capital letters and spaces are disallowed, since they are both quite safe to put in a filename. You can set an option to superficially replace the ugly page names with the contents of the first heading on the page in question, but this just makes the page&#8217;s &#8220;real name&#8221; harder to discover when you have to link to it, and the visual duplication of the page title and the first heading is far from nice-looking.</p>
<p>Thankfully, DokuWiki presents itself very well in all other aspects, and the overall package has so many good things going for it that I can&#8217;t help but give it my recommendation. If you want a lightweight, documentation-oriented wiki that feels almost as slick as WordPress but gives off a more techy vibe, DokuWiki can definitely take you there.</p>
]]></content:encoded>
			<wfw:commentRss>http://grantovich.net/posts/2009/06/dokumenting-with-dokuwiki/feed/</wfw:commentRss>
		<slash:comments>0</slash:comments>
		</item>
	</channel>
</rss>
