FW: Markup error in conref range article

["Gershon Joseph (gerjosep)" <gerjosep@cisco.com>]

The email below lists the items I asked to change in the conref range article.

 

--

Gershon

 

---

From: Gershon Joseph (gerjosep)
Sent: Thursday, November 19, 2009 1:56 PM
To: Kristen James Eberlein; Joe Gelb
Subject: Markup error in conref range article

Hi Joe,

 

I'm about to add a link to your article from our CMS project Wiki page. I read the article and noticed the following issues:

 

Issue 1

 

The first example includes the following markup:

<step><cmd>Start the engine. This will stir up any dirt
in the oil pan so that it will come out with the used oil.</cmd></step>

 

This is incorrect. The <cmd> should contain only the command (action) the user performs, not the result. The result should be marked up as <stepresult>, though in this case one could argue the second sentence is information, in which case it should be marked up as <info>

 

Issue 2

 

In example 3, the concept filename is current lawnmower.ditamap, but this is NOT a map, so it should be either lawnmower.dita or lawnmower.xml.

 

Other than these, this really is a superb article.

 

I tried to log in and change the Wiki page, but there is no edit option (I suspect this was uploaded as a PDF). Please could one of you fix the source and post a corrected version (essentially replacing the attachment on this Wiki page, I assume).

 

Thanks,

Gershon

 

Gershon Joseph Technical Leader, Engineering Product Development Services gerjosep@cisco.com Phone: +972 9 892-7157 Mobile: +972 57 314-1170	Cisco Systems, Inc. Israel Cisco home page

Think before you print.

This e-mail may contain confidential and privileged material for the sole use of the intended recipient. Any review, use, distribution or disclosure by others is strictly prohibited. If you are not the intended recipient (or authorized to receive for the recipient), please contact the sender by reply e-mail and delete all copies of this message.

Cisco Systems Limited (Company Number: 02558939), is registered in England and Wales with its registered office at 1 Callaghan Square, Cardiff, South Glamorgan CF10 5BT