RE: [dita] Feedback about "Lightweight DITA: An Introduction" change-marked draft

Those revision marks with the extra square brackets are eye-catching, all right.

 

There are revision marks in the middle of some hyperlink text (hence blue not red) that do not have the square brackets: right at the end of Section 4.1.

 

I confess to not giving careful consideration to every single occurrence of "content component" vs. "element type" etc. in this draft.

 

mag

 

 

 

From:  [mailto:] On Behalf Of Kristen James Eberlein
Sent: January 18, 2018 2:28 PM
To: Robert D Anderson
Cc: 
Subject: Re: [dita] Feedback about "Lightweight DITA: An Introduction" change-marked draft

 

Based on conversations with Carlos Evia, Alan Houser, and Robert Anderson, I made revisions to the LwDITA committee note.

Alan or others, can you do a sanity check?

Tom, your e-mail hit the list after I'd done the rework. I think "markup structures" is a better (and more accurate) way to refer to "LwDITA components".

Best,
Kris

Kristen James Eberlein
Chair, OASIS DITA Technical Committee
Principal consultant, Eberlein Consulting
www.eberleinconsulting.com
+1 919 682-2290; kriseberlein (skype)

On 1/18/2018 2:38 PM, Robert D Anderson wrote:

Regarding this comment from Kris:
> I think changing instances of the word "elements" to "components" makes this document read VERY strangely. I am not on-board with this change, especially when the references are to XDITA or XDITA.

I assume that was meant to say XDITA or HDITA, which both have elements. But beyond that ... I think I have to agree that while "components" sounds accurate conceptually, when I read it in context, it's kind of jarring. That's especially true where we refer to "a subset of components in DITA 1.3" and I thought DITA 1.3 components were literally the different packages + grammar zip -- see the usage under "Additional artifacts":
http://docs.oasis-open.org/dita/dita/v1.3/errata01/os/complete/part1-base/dita-v1.3-errata01-os-part1-base-complete.html

There are a few other uses -- our terminology topic lays out terms that "define components of the DITA standard". There's an actual element named <component>. Almost all remaining uses in the spec are part of examples, mostly for the delayed-conref-resolution domain. There is only one other instance I can find that seems more in line with the usage in the committee note, in the topic about single sourcing, which refers to "document components including paragraphs, lists, and tables":
http://docs.oasis-open.org/dita/dita/v1.3/errata01/os/complete/part1-base/archSpec/base/single-sourcing.html#single_sourcing

Regards, 

Robert D. Anderson 
DITA-OT lead and Co-editor DITA 1.3 specification,
Digital Services Group 

E-mail: 
Digital Services Group 

11501 BURNET RD,, TX, 78758-3400, AUSTIN, USA 

Kristen James Eberlein ---01/18/2018 01:21:58 PM---The subtitle should be "Committee Note 01" The date needs to be the date on which the TC will vote o

From: Kristen James Eberlein <>
To: 
Date: 01/18/2018 01:21 PM
Subject: [dita] Feedback about "Lightweight DITA: An Introduction" change-marked draft
Sent by: <>

 

The subtitle should be "Committee Note 01" 

The date needs to be the date on which the TC will vote on the committee note: 23 January 2018 

The file name should be "LwDITA-v1.0-cn01". (The easiest way to handle this is to rename the DITA map.) 

In "Specification URIs": 

The content currently in "This version" should move to "Previous version". 

The URLs for "This version" need to be as follows (changes indicated in red): 

http://docs.oasis-open.org/dita/LwDITA/v1.0/cnd01/LwDITA-v1.0-cn01.html (Authoritative)

http://docs.oasis-open.org/dita/LwDITA/v1.0/cnd01/LwDITA-v1.0-cn01.pdf

Use symbols for the revision marking, in addition to color. This is important for TC members who are color blind or who are printing the document out on a black and white printer. I'd look at the DITAVAL files that we use for the errata version of the spec.

There are extra spaces before some instances of the word "component".

I think changing instances of the word "elements" to "components" makes this document read VERY strangely. I am not on-board with this change, especially when the references are to XDITA or XDITA.

Best,
Kris

Kristen James Eberlein
Chair, OASIS DITA Technical Committee
Principal consultant, Eberlein Consulting
www.eberleinconsulting.com
+1 919 682-2290; kriseberlein (skype)

On 1/18/2018 1:21 PM, Carlos Evia wrote: 

Document Name: Lightweight DITA: An Introduction

Description
Marked version with changes implemented after public review #1. Thanks to
Alan Houser for the transform. 
Download Latest Revision
Public Download Link

Submitter: Dr. Carlos Evia
Group: OASIS Darwin Information Typing Architecture (DITA) TC
Folder: Drafts
Date submitted: 2018-01-18 10:20:42

--------------------------------------------------------------------- To unsubscribe from this mail list, you must leave the OASIS TC that generates this mail. Follow this link to all your TCs in OASIS at: https://www.oasis-open.org/apps/org/workgroup/portal/my_workgroups.php