|By Mike Badger||
|January 9, 2007 03:30 AM EST||
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.
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:
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.
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.
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.
|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.
SYS-CON Events announced today that Peak 10, Inc., a national IT infrastructure and cloud services provider, will exhibit at SYS-CON's 18th International Cloud Expo®, which will take place on June 7-9, 2016, at the Javits Center in New York City, NY. Peak 10 provides reliable, tailored data center and network services, cloud and managed services. Its solutions are designed to scale and adapt to customers’ changing business needs, enabling them to lower costs, improve performance and focus inter...
May. 4, 2016 01:00 PM EDT Reads: 1,409
The demand for organizations to expand their infrastructure to multiple IT environments like the cloud, on-premise, mobile, bring your own device (BYOD) and the Internet of Things (IoT) continues to grow. As this hybrid infrastructure increases, the challenge to monitor the security of these systems increases in volume and complexity. In his session at 18th Cloud Expo, Stephen Coty, Chief Security Evangelist at Alert Logic, will show how properly configured and managed security architecture can...
May. 4, 2016 12:47 PM EDT Reads: 124
In his session at @ThingsExpo, Chris Klein, CEO and Co-founder of Rachio, will discuss next generation communities that are using IoT to create more sustainable, intelligent communities. One example is Sterling Ranch, a 10,000 home development that – with the help of Siemens – will integrate IoT technology into the community to provide residents with energy and water savings as well as intelligent security. Everything from stop lights to sprinkler systems to building infrastructures will run ef...
May. 4, 2016 12:45 PM EDT Reads: 1,242
The IoTs will challenge the status quo of how IT and development organizations operate. Or will it? Certainly the fog layer of IoT requires special insights about data ontology, security and transactional integrity. But the developmental challenges are the same: People, Process and Platform. In his session at @ThingsExpo, Craig Sproule, CEO of Metavine, will demonstrate how to move beyond today's coding paradigm and share the must-have mindsets for removing complexity from the development proc...
May. 4, 2016 12:45 PM EDT Reads: 879
We're entering the post-smartphone era, where wearable gadgets from watches and fitness bands to glasses and health aids will power the next technological revolution. With mass adoption of wearable devices comes a new data ecosystem that must be protected. Wearables open new pathways that facilitate the tracking, sharing and storing of consumers’ personal health, location and daily activity data. Consumers have some idea of the data these devices capture, but most don’t realize how revealing and...
May. 4, 2016 12:45 PM EDT Reads: 528
SYS-CON Events announced today that Ericsson has been named “Gold Sponsor” of SYS-CON's @ThingsExpo, which will take place on June 7-9, 2016, at the Javits Center in New York, New York. Ericsson is a world leader in the rapidly changing environment of communications technology – providing equipment, software and services to enable transformation through mobility. Some 40 percent of global mobile traffic runs through networks we have supplied. More than 1 billion subscribers around the world re...
May. 4, 2016 12:30 PM EDT Reads: 1,309
Artificial Intelligence has the potential to massively disrupt IoT. In his session at 18th Cloud Expo, AJ Abdallat, CEO of Beyond AI, will discuss what the five main drivers are in Artificial Intelligence that could shape the future of the Internet of Things. AJ Abdallat is CEO of Beyond AI. He has over 20 years of management experience in the fields of artificial intelligence, sensors, instruments, devices and software for telecommunications, life sciences, environmental monitoring, process...
May. 4, 2016 12:15 PM EDT Reads: 1,327
A critical component of any IoT project is the back-end systems that capture data from remote IoT devices and structure it in a way to answer useful questions. Traditional data warehouse and analytical systems are mature technologies that can be used to handle large data sets, but they are not well suited to many IoT-scale products and the need for real-time insights. At Fuze, we have developed a backend platform as part of our mobility-oriented cloud service that uses Big Data-based approache...
May. 4, 2016 12:15 PM EDT Reads: 550
trust and privacy in their ecosystem. Assurance and protection of device identity, secure data encryption and authentication are the key security challenges organizations are trying to address when integrating IoT devices. This holds true for IoT applications in a wide range of industries, for example, healthcare, consumer devices, and manufacturing. In his session at @ThingsExpo, Lancen LaChance, vice president of product management, IoT solutions at GlobalSign, will teach IoT developers how t...
May. 4, 2016 12:15 PM EDT Reads: 507
The increasing popularity of the Internet of Things necessitates that our physical and cognitive relationship with wearable technology will change rapidly in the near future. This advent means logging has become a thing of the past. Before, it was on us to track our own data, but now that data is automatically available. What does this mean for mHealth and the "connected" body? In her session at @ThingsExpo, Lisa Calkins, CEO and co-founder of Amadeus Consulting, will discuss the impact of wea...
May. 4, 2016 12:00 PM EDT Reads: 1,134
There is an ever-growing explosion of new devices that are connected to the Internet using “cloud” solutions. This rapid growth is creating a massive new demand for efficient access to data. And it’s not just about connecting to that data anymore. This new demand is bringing new issues and challenges and it is important for companies to scale for the coming growth. And with that scaling comes the need for greater security, gathering and data analysis, storage, connectivity and, of course, the...
May. 4, 2016 11:15 AM EDT Reads: 1,218
Increasing IoT connectivity is forcing enterprises to find elegant solutions to organize and visualize all incoming data from these connected devices with re-configurable dashboard widgets to effectively allow rapid decision-making for everything from immediate actions in tactical situations to strategic analysis and reporting. In his session at 18th Cloud Expo, Shikhir Singh, Senior Developer Relations Manager at Sencha, will discuss how to create HTML5 dashboards that interact with IoT devic...
May. 4, 2016 11:00 AM EDT Reads: 1,374
We’ve worked with dozens of early adopters across numerous industries and will debunk common misperceptions, which starts with understanding that many of the connected products we’ll use over the next 5 years are already products, they’re just not yet connected. With an IoT product, time-in-market provides much more essential feedback than ever before. Innovation comes from what you do with the data that the connected product provides in order to enhance the customer experience and optimize busi...
May. 4, 2016 11:00 AM EDT Reads: 1,289
So, you bought into the current machine learning craze and went on to collect millions/billions of records from this promising new data source. Now, what do you do with them? Too often, the abundance of data quickly turns into an abundance of problems. How do you extract that "magic essence" from your data without falling into the common pitfalls? In her session at @ThingsExpo, Natalia Ponomareva, Software Engineer at Google, will provide tips on how to be successful in large scale machine lear...
May. 4, 2016 10:00 AM EDT Reads: 1,500
Digital payments using wearable devices such as smart watches, fitness trackers, and payment wristbands are an increasing area of focus for industry participants, and consumer acceptance from early trials and deployments has encouraged some of the biggest names in technology and banking to continue their push to drive growth in this nascent market. Wearable payment systems may utilize near field communication (NFC), radio frequency identification (RFID), or quick response (QR) codes and barcodes...
May. 4, 2016 08:15 AM EDT Reads: 993
You think you know what’s in your data. But do you? Most organizations are now aware of the business intelligence represented by their data. Data science stands to take this to a level you never thought of – literally. The techniques of data science, when used with the capabilities of Big Data technologies, can make connections you had not yet imagined, helping you discover new insights and ask new questions of your data. In his session at @ThingsExpo, Sarbjit Sarkaria, data science team lead ...
May. 4, 2016 08:00 AM EDT Reads: 1,184
The IETF draft standard for M2M certificates is a security solution specifically designed for the demanding needs of IoT/M2M applications. In his session at @ThingsExpo, Brian Romansky, VP of Strategic Technology at TrustPoint Innovation, will explain how M2M certificates can efficiently enable confidentiality, integrity, and authenticity on highly constrained devices.
May. 4, 2016 08:00 AM EDT Reads: 1,260
Manufacturers are embracing the Industrial Internet the same way consumers are leveraging Fitbits – to improve overall health and wellness. Both can provide consistent measurement, visibility, and suggest performance improvements customized to help reach goals. Fitbit users can view real-time data and make adjustments to increase their activity. In his session at @ThingsExpo, Mark Bernardo Professional Services Leader, Americas, at GE Digital, will discuss how leveraging the Industrial Interne...
May. 4, 2016 04:45 AM EDT Reads: 1,351
Whether your IoT service is connecting cars, homes, appliances, wearable, cameras or other devices, one question hangs in the balance – how do you actually make money from this service? The ability to turn your IoT service into profit requires the ability to create a monetization strategy that is flexible, scalable and working for you in real-time. It must be a transparent, smoothly implemented strategy that all stakeholders – from customers to the board – will be able to understand and comprehe...
May. 3, 2016 12:30 PM EDT Reads: 1,224
You deployed your app with the Bluemix PaaS and it's gaining some serious traction, so it's time to make some tweaks. Did you design your application in a way that it can scale in the cloud? Were you even thinking about the cloud when you built the app? If not, chances are your app is going to break. Check out this webcast to learn various techniques for designing applications that will scale successfully in Bluemix, for the confidence you need to take your apps to the next level and beyond.
May. 3, 2016 12:15 PM EDT Reads: 1,608