Welcome!

Open Source Cloud Authors: Pat Romanski, Liz McMillan, Dana Gardner, Mike Raia, Elizabeth White

Related Topics: Open Source Cloud, Linux Containers, Eclipse

Open Source Cloud: Article

Dokuwiki - A Practical Open Source Knowledge Base Solution

Easy-to-use, intuitive and full-featured

(SYS-CON Media) - Whether you're a company of one or 100, managing knowledge is a core concern and implementing a knowledge base is a sensible way to capture your content. Dokuwiki is a practical open source Web application for creating a knowledge base that's easy for novice Webmasters to set up but flexible and full-featured.

The Dokuwiki Web site (www.splitbrain.org/projects/dokuwiki) describes the Dokuwiki as "a simple to use wiki aimed at a small company's documentation needs. It works on plain text files and thus needs no database. It has a simple but powerful syntax which makes sure the data files remain readable outside the wiki." Dokuwiki runs on a variety of Web servers, including Apache and IIS and requires PHP 4.3.x or higher. If you do not have your own Web server, you can install Dokuwiki on a hosted Web site, as long the Web host includes PHP access.

Features
Dokuwiki has many of the features you'd expect in a Web application, such as version control, templates, and plug-ins, and for the most part, you can quickly learn about them as you use the software. However, before you deploy Dokuwiki, you should learn how to use syntax, namespaces, and Access Control Lists (ACL), which will let you organize the site layout during installation, not three months from now.

The syntax is a text mark-up that formats the content on the wiki pages for display. For example, **text** displays as text. For me, typing the extra characters is easier than using a tool bar. For the point-and-click crowd, formatting can be inserted using quick buttons on the tool bar like a word processor.

Namespaces organize the page layout and the directory structure of the raw text files and do require specific syntax knowledge to implement when editing a page. The best way to explain namespaces is with an example. Suppose I want to organize my wiki into Support Documentation and Writing Projects. I'd edit my Dokuwiki start page and add the following text:

[[Support:Support Documentation]]
[[Writing:Writing Projects]]

This is Dokuwiki's simple syntax at work. The text in the double brackets signifies a link. The text that follows the colon is the page name, and the text preceding the colon is the namespace. When I save the edits, new hyperlinks to Support Documentation and Writing Projects are created. When I follow the links, and edit the new pages, Dokuwiki creates the dokuwiki/data/pages/support and dokuwiki/data/pages/writing directories. The text files for all pages created in the Support Documentation and Writing Projects pages will be stored in their respective directories, which let you easily retrieve the text files later.

If your wiki is going to have more than one user, you need to think about access control because Dokuwiki is wide open by default, which means that anyone can create or edit pages. That's the default wiki way but not necessarily the right way for you. Dokuwiki controls access with ACL, which can be used to grant levels of access based on users, groups, pages, or namespaces. The levels of access include read, edit, create, upload, and delete. Upload and delete access refer to media files.

Installation and Configuration
Assuming you already have a Web server configured, installation is straightforward and can be summarized in three steps. Download Dokuwiki to the Web server. Unzip the download file to the Web server's root directory. Configure the installation. For specific help, consult the installation instructions at http://wiki.splitbrain.org/wiki:Install for your server platform. You can have a functioning installation in 20 minutes, less if you skip the coffee break.

File permissions are the one sticking point of the installation, and every installation or upgrade I do ends up with a permission problem at some point. Dokuwiki, however, handles its errors well and if your data directory has insufficient write permissions or you're missing the changes.log file, the error will tell you that. To help troubleshoot page problems, append ?do=check to the end of the Dokuwiki URL to display the current page's permissions along with site installation details.

Even if you don't require users to register an account, you should set up ACL so you can specify a superuser. Only the superuser can access the administration page, which provides a graphical interface to manage users, plug-ins, access, and site configurations. Setting up ACL and assigning a superuser requires several extra configuration steps, and is the most convoluted process in a Dokuwiki installation.

Much to my surprise, project founder Andreas Gohr published a release candidate as I was writing my review. The release candidate included an installer that automated the creation of a superuser login and specified a default access level. Run the install.php script in the dokuwiki installation directory, and a form like the one pictured in the screen shot will display. Enter the requested information and save the changes. Login as the superuser to access the administration page and fine-tune the configuration settings as needed. The documentation covers the configuration settings in detail.

You are now ready to add content.

Use
Dokuwiki is easy-to-use and intuitive, in part because users create, edit, and read pages from a browser. To create content, select "Edit this page" to display an editable page. When done adding and formatting content, save the page to make the changes live.

While the "Old revisions" button is easy to spot, the process to restore a previous version is not discernible while looking at the page. To go back to an old version, use the "Old revisions" button to view changes by date. Select the desired version to display it in the browser. Edit and save the page to restore the previous version.

At first glance, Dokuwiki's default view appears basic and lacks the side-navigation panels we've grown to expect from modern Web applications. Several templates are available from the Dokuwiki site, including one with a Wikipedia feel; however, I prefer the clean look of the default template because it puts the emphasis on my content, not graphics or panels.

Dokuwiki's navigation aids include backlinks, the wiki title, breadcrumbs, and a table of contents. Click on the page name to get a list of backlinks, or pages that refer to the current page. The page name displays left-aligned at the top of the page such as [[start]]. The wiki title displays right-aligned at the top of the page such as "Wiki on Coyote" (the current name of my site) and is a link that takes you back to the default start page, while the pages viewed most recently are available as "breadcrumbs" letting you trace the last few pages in your history. Each page builds a table of contents based on the header levels defined in the page, which facilitates navigation within the page itself.

Not all navigation is done with a mouse, and Dokuwiki includes several access keys that you can use as keyboard shortcuts. For example, use ALT + E to edit a page and ALT + H to return to the start page; use ALT + B to make text bold. Check out the documentation or hover your mouse over a button to get more access keys.

Final Review
As I leave you to build your knowledge base, remember that Dokuwiki is only a tool. It will not make your documentation better, but I've focused on the features that will help you deploy a well-organized and easy-to-manage knowledge base. Your wiki needs human attention and editorial control to grow into a useful resource for you, your teams, and your customers.

More Stories By Mike Badger

Mike Badger is a technical Ccmmunicator and author of 2 books - Zenoss Core Network and System Monitoring and Scratch 1.4 Beginner's Guide, available from Packt Publishing. He's also a project manager for MoJo Active, an marketing and web design firm in Central Pennsylvania.

He raise honeybees, pigs, and a family.

Michael Badger is a technical communicator who has devoted his career to translating technical concepts in a way that helps people learn, adapt, and troubleshoot their computer software. He wrote two books with Packt Publishing: Zenoss Core Network and System Monitoring and Scratch 1.4 Beginner's Guide.

For fun, he grows pigs, raises honeybees, fishes, and spends time with his family.

For more information visit, badgerfiles.com.

Comments (1) View Comments

Share your thoughts on this story.

Add your comment
You must be signed in to add a comment. Sign-in | Register

In accordance with our Comment Policy, we encourage comments that are on topic, relevant and to-the-point. We will remove comments that include profanity, personal attacks, racial slurs, threats of violence, or other inappropriate material that violates our Terms and Conditions, and will block users who make repeated violations. We ask all readers to expect diversity of opinion and to treat one another with dignity and respect.


Most Recent Comments
imho 01/04/07 03:12:33 PM EST

Dukowiki has a simple syntax which makes sure the datafiles remain readable outside the Wiki and eases the creation of structured texts.

@ThingsExpo Stories
Internet of @ThingsExpo, taking place November 1-3, 2016, at the Santa Clara Convention Center in Santa Clara, CA, is co-located with 19th Cloud Expo and will feature technical sessions from a rock star conference faculty and the leading industry players in the world. The Internet of Things (IoT) is the most profound change in personal and enterprise IT since the creation of the Worldwide Web more than 20 years ago. All major researchers estimate there will be tens of billions devices - comp...
DevOps at Cloud Expo, taking place Nov 1-3, 2016, at the Santa Clara Convention Center in Santa Clara, CA, is co-located with 19th Cloud Expo and will feature technical sessions from a rock star conference faculty and the leading industry players in the world. The widespread success of cloud computing is driving the DevOps revolution in enterprise IT. Now as never before, development teams must communicate and collaborate in a dynamic, 24/7/365 environment. There is no time to wait for long dev...
Almost two-thirds of companies either have or soon will have IoT as the backbone of their business in 2016. However, IoT is far more complex than most firms expected. How can you not get trapped in the pitfalls? In his session at @ThingsExpo, Tony Shan, a renowned visionary and thought leader, will introduce a holistic method of IoTification, which is the process of IoTifying the existing technology and business models to adopt and leverage IoT. He will drill down to the components in this fra...
Data is the fuel that drives the machine learning algorithmic engines and ultimately provides the business value. In his session at Cloud Expo, Ed Featherston, a director and senior enterprise architect at Collaborative Consulting, will discuss the key considerations around quality, volume, timeliness, and pedigree that must be dealt with in order to properly fuel that engine.
There is growing need for data-driven applications and the need for digital platforms to build these apps. In his session at 19th Cloud Expo, Muddu Sudhakar, VP and GM of Security & IoT at Splunk, will cover different PaaS solutions and Big Data platforms that are available to build applications. In addition, AI and machine learning are creating new requirements that developers need in the building of next-gen apps. The next-generation digital platforms have some of the past platform needs a...
19th Cloud Expo, taking place November 1-3, 2016, at the Santa Clara Convention Center in Santa Clara, CA, will feature technical sessions from a rock star conference faculty and the leading industry players in the world. Cloud computing is now being embraced by a majority of enterprises of all sizes. Yesterday's debate about public vs. private has transformed into the reality of hybrid cloud: a recent survey shows that 74% of enterprises have a hybrid cloud strategy. Meanwhile, 94% of enterpri...
SYS-CON Events announced today Telecom Reseller has been named “Media Sponsor” of SYS-CON's 19th International Cloud Expo, which will take place on November 1–3, 2016, at the Santa Clara Convention Center in Santa Clara, CA. Telecom Reseller reports on Unified Communications, UCaaS, BPaaS for enterprise and SMBs. They report extensively on both customer premises based solutions such as IP-PBX as well as cloud based and hosted platforms.
Pulzze Systems was happy to participate in such a premier event and thankful to be receiving the winning investment and global network support from G-Startup Worldwide. It is an exciting time for Pulzze to showcase the effectiveness of innovative technologies and enable them to make the world smarter and better. The reputable contest is held to identify promising startups around the globe that are assured to change the world through their innovative products and disruptive technologies. There w...
With so much going on in this space you could be forgiven for thinking you were always working with yesterday’s technologies. So much change, so quickly. What do you do if you have to build a solution from the ground up that is expected to live in the field for at least 5-10 years? This is the challenge we faced when we looked to refresh our existing 10-year-old custom hardware stack to measure the fullness of trash cans and compactors.
The emerging Internet of Everything creates tremendous new opportunities for customer engagement and business model innovation. However, enterprises must overcome a number of critical challenges to bring these new solutions to market. In his session at @ThingsExpo, Michael Martin, CTO/CIO at nfrastructure, outlined these key challenges and recommended approaches for overcoming them to achieve speed and agility in the design, development and implementation of Internet of Everything solutions wi...
Cloud computing is being adopted in one form or another by 94% of enterprises today. Tens of billions of new devices are being connected to The Internet of Things. And Big Data is driving this bus. An exponential increase is expected in the amount of information being processed, managed, analyzed, and acted upon by enterprise IT. This amazing is not part of some distant future - it is happening today. One report shows a 650% increase in enterprise data by 2020. Other estimates are even higher....
Today we can collect lots and lots of performance data. We build beautiful dashboards and even have fancy query languages to access and transform the data. Still performance data is a secret language only a couple of people understand. The more business becomes digital the more stakeholders are interested in this data including how it relates to business. Some of these people have never used a monitoring tool before. They have a question on their mind like “How is my application doing” but no id...
The 19th International Cloud Expo has announced that its Call for Papers is open. Cloud Expo, to be held November 1-3, 2016, at the Santa Clara Convention Center in Santa Clara, CA, brings together Cloud Computing, Big Data, Internet of Things, DevOps, Digital Transformation, Microservices and WebRTC to one location. With cloud computing driving a higher percentage of enterprise IT budgets every year, it becomes increasingly important to plant your flag in this fast-expanding business opportuni...
Smart Cities are here to stay, but for their promise to be delivered, the data they produce must not be put in new siloes. In his session at @ThingsExpo, Mathias Herberts, Co-founder and CTO of Cityzen Data, will deep dive into best practices that will ensure a successful smart city journey.
SYS-CON Events announced today that 910Telecom will exhibit at the 19th International Cloud Expo, which will take place on November 1–3, 2016, at the Santa Clara Convention Center in Santa Clara, CA. Housed in the classic Denver Gas & Electric Building, 910 15th St., 910Telecom is a carrier-neutral telecom hotel located in the heart of Denver. Adjacent to CenturyLink, AT&T, and Denver Main, 910Telecom offers connectivity to all major carriers, Internet service providers, Internet backbones and ...
Identity is in everything and customers are looking to their providers to ensure the security of their identities, transactions and data. With the increased reliance on cloud-based services, service providers must build security and trust into their offerings, adding value to customers and improving the user experience. Making identity, security and privacy easy for customers provides a unique advantage over the competition.
I wanted to gather all of my Internet of Things (IOT) blogs into a single blog (that I could later use with my University of San Francisco (USF) Big Data “MBA” course). However as I started to pull these blogs together, I realized that my IOT discussion lacked a vision; it lacked an end point towards which an organization could drive their IOT envisioning, proof of value, app dev, data engineering and data science efforts. And I think that the IOT end point is really quite simple…
Personalization has long been the holy grail of marketing. Simply stated, communicate the most relevant offer to the right person and you will increase sales. To achieve this, you must understand the individual. Consequently, digital marketers developed many ways to gather and leverage customer information to deliver targeted experiences. In his session at @ThingsExpo, Lou Casal, Founder and Principal Consultant at Practicala, discussed how the Internet of Things (IoT) has accelerated our abil...
Is the ongoing quest for agility in the data center forcing you to evaluate how to be a part of infrastructure automation efforts? As organizations evolve toward bimodal IT operations, they are embracing new service delivery models and leveraging virtualization to increase infrastructure agility. Therefore, the network must evolve in parallel to become equally agile. Read this essential piece of Gartner research for recommendations on achieving greater agility.
SYS-CON Events announced today that Venafi, the Immune System for the Internet™ and the leading provider of Next Generation Trust Protection, will exhibit at @DevOpsSummit at 19th International Cloud Expo, which will take place on November 1–3, 2016, at the Santa Clara Convention Center in Santa Clara, CA. Venafi is the Immune System for the Internet™ that protects the foundation of all cybersecurity – cryptographic keys and digital certificates – so they can’t be misused by bad guys in attacks...