Just Write Click

Technical writing with Continuous Integration and docs-as-code

  • JustWriteClick
  • Contact
  • Books by Anne Gentle
  • Introducing Docs Like Code
You are here: Home / talk.bmc / Defining OPML and relating to DITA maps

May 31, 2006 by annegentle

Defining OPML and relating to DITA maps

I found a nice definition for OPML from whatis.com as their word of the day, and I’m starting to wonder about similarities between OPML and DITA maps

From an information design perspective, OPML is a great format for outlining information, showing information’s hierarchical structure and relationship to other entries. I had only really thought about OPML applications as advanced organizers for lists of RSS feeds, but I suppose there might be other applications as well. This definition on whatis.com alludes to multiple organizational uses for OMPL, saying “…OPML has been used to organize many kinds of data as it may be customized for each application.” But what are these other uses for OPML? Can anyone point me to examples?

I sometimes find it difficult to articulate my enthusiasm for OPML, and this definition offers a great overview. I always have seen OPML as a great way to store lists of RSS feeds in logically-named folders. Here’s another excerpt from the definition:

OPML allows a user to classify where content should be placed within a hierarchy as it is being created. This feature makes the format extremely useful for the creation of “living documents,” where relationships and content are continuously updated.

I think that OPML and DITA maps may be closely related cousins in the list family. From the DITA specificiation, DITA maps organize topics for output to a specific deliverable, including generating navigation files and links to related topics. DITA maps offer the ability for quick re-organization of topics to create multiple deliverables. I envision DITA maps as offering an alternative to single-sourcing by letting you pick and choose from a large array of topics, whittling the DITA map down to just the print book combination or just the online help combination that you want. With the power of DITA maps, you can create two subsets of documentation from the same superset of topics. I think that the “living document” description for OPML is also fitting for DITA maps. Just ask Jen Linton, who co-authored the Introduction to DITA: A User Guide to the Darwin Information Typing Architecture book using DITA. She was able to completely re-organize the book within weeks of publishing by simply changing the DITA map. Nice! Now we just need a drag-and-drop interface for editing DITA maps.

If you’d like to work with an OPML editor, there’s one you can download on the opml.org site. And remember that there’s a TalkBMC OPML file available for downloading that contains an organized list of all the blogger feeds, comment feeds, and podcast feeds for talk.bmc.com. Very handy!

Related

Filed Under: talk.bmc Tagged With: DITA, OPML

More reading

Bubble graph showing sources of developer support data

I’ve been thinking a lot about developer support at Cisco recently, especially for the way the world works today with multiple cloud providers. This post is a re-publish of my talk from over five years ago, but the techniques and tools for listening and helping others are still true today. At Rackspace, we watched several […]

Cisco DevNet is our developer program for outreach, education, and tools for developers at Cisco. From the beginning, the team has had a vision for how to run a developer program. Customers are first, and the team implements what Cisco customers need for automation, configuration, and deployment of our various offerings. Plus, the DevNet team […]

I had a great talk with Ellis Pratt of Cherryleaf Technical Writing consulting last week. Here are the show notes, full of links to all the topics we covered. Podcasts are great fun to listen to and participate in, if a bit nerve-wracking to think on your feet and make sure you answer questions succinctly […]

At the beginning of this year, I worked hard to summarize my thoughts on API documentation, continuous publishing, and technical accuracy for developer documentation. The result is an article on InfoQ.com, edited by Deepak Nadig, who also was forward-thinking in having me speak to a few teams at Intuit about API documentation coupled with code. Always […]

Recently on Just Write Click

  • A Flight of Static Site Generators: Sampling the Best for Documentation
  • Try a GPT about “Docs Like Code” to ask questions
  • Discipline and Diplomacy: Docs in the Open
  • Let’s Find Out: When Do Static Site Generators Do Rendering?
  • GitHub for Managing Tech Docs

Just Write Click in your Inbox

Enter your email address to subscribe to Just Write Click and receive notifications of new posts by email.

Read More

  • Privacy Policy
  • About Anne Gentle, developer experience expert
  • Books by Anne Gentle
    • Conversation and Community
    • Docs Like Code, a Book for Developers and Tech Writers
  • Woman in Tech Speaker Profile
  • Contact

Books

  • JustWriteClick
  • Contact
  • Books by Anne Gentle
  • Introducing Docs Like Code

Copyright © 2025 · WordPress · Log in