RE: [dita] Revised element reference topics -- Please take a look

Hi, Kris.

 

Format is easy to scan and understand, and I like the “Formatting Expectations” information. Looks good to me.

 

Bill Burns

Content Architect | Healthwise


 | www.healthwise.org

208.331.6917 (office)  |  208.345.1897 (fax)

 

Healthwise helps people make better health decisions.

 

From:  [mailto:]
On Behalf Of Kristen James Eberlein

Sent: Thursday, August 10, 2017 5:56 AM

To: DITA TC <>

Subject: [dita] Revised element reference topics -- Please take a look

 

If you were at the TC meeting on 18 July, you heard Robert report about the items regarding the DITA 2.0 spec that a small group discussed and the recommendations that they came up with.

I attach a PDF that includes some element reference topics that have been reworked to match the new format, which includes the following sections:

Title

Short description (uses natural language)

Usage information

Formatting expectations

Processing expectations

Attributes

Example

Do note that these rejigged topics do not necessarily contain appropriate content for DITA 2.0, but that existing content has been moved into the relevant section, for example, "Formatting expectations". We all thought that moving content into the
 relevant sections would make it much easier to see what content is appropriate, what is unneeded, and where we have content that should be augmented.

The attribute sections are untouched. Normative statements have been reworked so that they are complete content that could be reused in another document or appendix.

-- 

Best,

Kris

Kristen James Eberlein

Chair, OASIS DITA Technical Committee

Principal consultant, Eberlein Consulting

www.eberleinconsulting.com

+1 919 682-2290; kriseberlein (skype)