Hi Stan (and all)
The 13060 (resourceid) proposal is similar in scope to Robert Anderson’s proposal 13008, and unless I’m missing something, the structure of our proposal is pretty much identical to his. And that’s, I guess, as it should be, because his is a proposal to add attributes to resourceid, and ours is a proposal to add attributes
to resourceid. But I have a nervous feeling that I must be missing something?
13061 (ua-window) is more complicated, because it is a new element. However, it is not as complicated as 13097, which is an entire new information type. Bearing in mind I am pushing the envelope of my capabilities here, with a new ua-window element within the map element, will there be anything other than map.mod that needs to be changed in the DTDs? Unless we are going to pull ua-window out into its own module (and as I say, I don’t have the requisite DTD skills to be definitive
here), the new element should only impact that one file, shouldn’t it? I used the navref as a guide in this regard, as I thought it was a similar element in the sense that it only lives in the map and has no “contains” elements. The navref element is only mentioned in map.mod and mapgroup.mod. The ua-window element won’t be valid in the mapgroup elements (topicgroup, topichead, etc) because windows are defined way at the top of the map structure.
I went through map.mod in more detail, though, and as a result, I have expanded the modified DTD section of the
proposal to show the sections affected, and bolding our new stuff.
In Section B of the Typical Stage 3 Outline information, I think the feature.mod, feature.ent and feature.dtd are therefore not applicable for our proposal.
I wonder whether you were also suggesting that we need an Architectural Specification change topic (Secction C Part 1). My view is that we only need to make changes in the Language Reference, but
I am not firm on this either. I have found that we needed to change one of the topics in the Architectural Spec, and I’ve added this to the proposal too.
I’ve attached the latest HTML version of 13061 (windowing) so you can see what I mean.
What do you think?
And I also put together a new topic about Help and user assistance support for the Architectural Spec, and I’ve added that to the 13060 (context hook) proposal, even though it refers to both resourceid and ua-window. I
think this is a useful addition… hope you all agree.
Tony
From:
Stan Doherty [mailto:stan@modularwriting.com]
Sent: Thursday, 24 October 2013 11:51 PM
To: dita-help@lists.oasis-open.org; tself@hyperwrite.com
Cc: stan.doherty@mathworks.com
Subject: Re: [dita-help] Review of Stage 3 Proposals
Mea culpa -- I have been heads-down this past week finishing a talk (DITA and HTML5 jumpstart) for Joe's WritersUA conference
next week.
What you have in the current Stage-3 documents is all good, but there quite a bit of additional material for the complete Stage-3 package (see outline below). Most of the missing material should be relatively easy to develop and I am able to make time this weekend+Monday+Tuesday to help with *.dtd, *.mod, *.ent, doc updates -- whatever. I can do a skypecall tonight (Thursday 07:30/EST or later) or tomorrow night to coordinate if you'd like.
I have also attached a few of the submitted Stage-3 PDFs from TechComm or from other TC members.
* proposal-13097-Troubleshooting_Stage3_08oct13.pdf: Bob
Thomas' Stage-3 proposal for the new Troubleshooting
elements and topic. Perhaps the most complete of the set (including a plug-in).
* Proposal_13102_ReleaseManagement_Stage3.pdf: Tom Chiak's Stage-3 proposal for the release management
domain. It may be decent model for <ua-window>.
* Proposal_13008_resourceid_Stage3.pdf: Robert's @appid proposal for resourceid. Could be cloned in some sections
* proposal-13035-xmldomain-stage-3.dita.pdf: Eliot's xmldomain proposal. A nice clean example of Stage-3 for a set of
new elements. Perhaps a model for <ua-window>.
Sorry, again, to be late with this review. I'd be gald to help in whatever ways that I can this weekend.
--------------------------------------------------------------------------------------
A. Stage-3 Proposal Template
1. Champion <section>
2. Tracking information <section>
- <ul> or (more often) a table with columns
of Event, Date, and Links
- (Optional) Link to available DITA-OT plug-in.
3. Approved technical requirements
- Text summary of what was approved in Stage-2 (changed
or added) by way of attributes, elements, or topics --
OR
- Table specifying the changes/additions and a brief
description of each item.
4. Dependencies or inter-related
proposals:
- DITA 1.3 proposal # + one-line description
B. Structural implementation
1. (If applicable) feature.dtd listing (with optional description or
commentary. Showing a specialized version of topic.dtd with
new elements integrated seems to be sufficient.
2. (If applicable) feature.mod listing (with optional description or
commentary.
3. (If applicable) feature.ent listing (with optional description or
commentary.
C. Specification documentation
1. Changes to the Architectural
Specification
- Overview description of the changes
- Ready-to-insert <sections> or topics
- One or more examples
- Topic-by-topic updates or additions to the ArchSpec
2. Changes to the Reference Spec
- Overview description of the
changes
- Ready-to-insert <sections> or topics
- One or more examples
- Attributes table (no fancy xrefs a la the current spec)
- Topic-by-topic updates or additions to the RefSpec
> Each new element gets a ref topic
> On October 23, 2013 at 6:24 PM Tony Self <
tself@hyperwrite.com> wrote:
>
> Greetings colleagues
>
> The deadline for the Stage 3 Proposals submission is looming, and I haven't
> received any comments back yet. I think I will have to submit it as is in
> the next couple of days if I don't hear anything further, so I hope it is
> essentially correct!
>
> Regards
>
> Tony Self
>
>
>
>
>
>
> ---------------------------------------------------------------------
> 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 >
Stan Doherty
Director, Technical Publications
Verivue Inc.