Search results

WordPress Tip: Merging Worlds: DITA and WordPress

by Tom Johnson on Feb 8, 2009
categories: dita web-designwordpress

Sept 29, 2014 update: For an updated article on the topic of migrating DITA into WordPress, see Import DITA's XHTML Output into WordPress.

The DITA-to-WordPress importer tool allows you to import the XHTML output from the DITA Open Toolkit as pages into WordPress. This  importer (created by Mike Little, a brilliant developer who had a hand in creating WordPress itself) is available for download here, along with a sample XHTML output.

The DITA-to-WordPress tool fills a major gap with the existing DITA outputs. Currently, the DITA Open Toolkit doesn't have a webhelp output. The XHTML output provides an index of files in a left pane with the topics in the right, but it is so plain and unattractive that I can't imagine anyone actually using it.

With the DITA-to-WordPress importer, you can use WordPress as your online help format. This approach provides unique advantages over other help tools on the market.  Basically, WordPress taps into all the juicy features of Web 2.0 and gives you them for free.

For example, in your WordPress help, you can include the following:

  • Comments
  • Gravatars
  • Tag Clouds
  • Categories
  • Related Posts
  • Embedded flash (for screencasts or videocasts)
  • Blog integration
  • Calendar integration
  • Video players
  • Hundreds of attractive themes
  • Easy theme customization with CSS
  • RSS feeds and integration of RSS feeds
  • Better user tracking, such as Woopra
  • Better search engine optimization
  • AJAX
  • Tags
  • Image galleries

And hundreds of other features. For a list of the 4,000+ plugins WordPress provides, see the Plugin Directory. To browse hundreds of themes, see the Theme Directory.

Additionally, WordPress provides an attractive website format that can change the way users feel about help. The standard help file, such as a .chm or tripane webhelp, has lost much of its appeal with users. WordPress can rejuvenate your users' attitude about using help by providing a new, contemporary look.

I created a 5 minute demo of the DITA-to-WordPress importer. You can view the embedded version below or view the demo in a larger, clearer format here.

About Tom Johnson

Tom Johnson

I'm an API technical writer based in the Seattle area. On this blog, I write about topics related to technical writing and communication — such as software documentation, API documentation, AI, information architecture, content strategy, writing processes, plain language, tech comm careers, and more. Check out my API documentation course if you're looking for more info about documenting APIs. Or see my posts on AI and AI course section for more on the latest in AI and tech comm.

If you're a technical writer and want to keep on top of the latest trends in the tech comm, be sure to subscribe to email updates below. You can also learn more about me or contact me. Finally, note that the opinions I express on my blog are my own points of view, not that of my employer.