Author Max: Great DITA, Great Documentation » Uncategorized http://methodm.com/blog for people who write and edit content everyday Wed, 28 Dec 2011 11:03:01 +0000 http://wordpress.org/?v=2.8.2 en hourly 1 The DITA Project #5 choices or choicetables? http://methodm.com/blog/2011/11/09/the-dita-project-5-choices-or-choicetables/ http://methodm.com/blog/2011/11/09/the-dita-project-5-choices-or-choicetables/#comments Wed, 09 Nov 2011 11:47:30 +0000 katriel http://methodm.com/blog/?p=52 Why use <choices> or <choicetables> instead of <ol> or <ul> in a task topic when you need to choose what to do next?

The benefit is that the markup is semantic! When you use <choices> or <choicetables>, the machine (and the writer!) understands explicitly if we are talking about:

  1. <choices> where the customer has reached a decision point and must choose one of the options (such as,  take Route 66 to Boston or Route 81 to Ithaca).
    or
  2. <choicetable> — where the customer has different options to get to the same result (such as CTRL+S or File > Save).

Using <ol> or <ul> eliminates semantic markup! Using <choices> or <choicetables> explicitly indicates the kind of juncture the reader has reached — and forces the writer to state if no matter what the choice, the end result will be the same (<choicetable>), or if the choice selected will lead to a different outcome (<choices>).

]]>
http://methodm.com/blog/2011/11/09/the-dita-project-5-choices-or-choicetables/feed/ 0