oasis-tcs / dita Goto Github PK

Based on email from Deb: https://lists.oasis-open.org/archives/dita/201808/msg00043.html

Discussed at TC meeting August 21, 2018. Consensus toward moving existing <schemeref> out of subject scheme and into mapgroup; OASIS shells for subject scheme already include the mapgroup domain, but this is technically backwards incompatible with existing subject scheme shells that do not include the domain.

Also need to clean up the overall definition of <schemeref> to make it more general, right now it is only allowed at top level of subject scheme and has special rules about how to merge the referenced scheme.

The xtrc and xtrf attributes were added to all elements in DITA 1.0. They are entirely intended for processing purposes, with a DITA-OT style processing model in mind. Specifically, the expectations were that:

1. Processors would read/write DITA files as they evaluated features like @conref (as DITA-OT has done since early days in the temporary directory)
2. Processors needed to a place to track source information to enable later debugging (this has been done by some processors with @xtrf and @xtrc since DITA beta days)
3. DITA had to remain valid during every read/write in the temp directory, including with this debug information (DITA-OT has never followed this and will not in the future; I only know of one tool in beta DITA days that had this requirement)
4. Because processed DITA with debug info had to be valid, every DITA element needed to declare xtrf/xtrc.

The DITA specification (in the last couple of releases) has shied away from adding functionality or markup based on what is done with processed DITA -- that is, it uses DTD / RNG to place rules on the source, but once processors start working with it, that is up to processors.

Given that, some TC members have suggested that the xtrc / xtrf attributes are no longer appropriate for the standard itself, because the use cases that prompted them are no longer valid -- there is nothing inherent in DITA that would require applications to write out xtrf/xtrc as part of a validating DITA document.

Original email thread to TC, June 14 2016: https://lists.OASIS-open.org/archives/dita/201606/msg00013.html

Discussed as Stage 1 proposal 19 July 2017, discussed further on July 11, 2017.

Discussed Jan 9, aiming for stage 2 proposal complete by end of Jan

Discussed at TC meeting on 06 Feb 2018: https://lists.oasis-open.org/archives/dita/201802/msg00035.html

Voted to stage 3 on 13 Feb 2018.

Initial stage 3 proposal sent to TC 6 March 2018 after review from Kris and Carsten: https://lists.oasis-open.org/archives/dita/201803/msg00016.html

Based on Stage 1 proposal from @keberlein -- a collection of items previously marked as deprecated, "do not use", or "reserved for future use" in earlier versions of DITA 1.x:
https://lists.oasis-open.org/archives/dita/201706/msg00016.html

Discussed at DITA TC June 6, 2017. Assigned to Kris and moved to stage 2. Per discussion at June 6 meeting, this should also include the related housekeeping proposal to remove @locktitle from <topichead> and <topicgroup>.

Discussed Jan 9 2018: aiming for stage 2 done by Jan 22.

Stage two proposal sent to the TC on 1 February 2018.

Discussed at TC on 09 February 2018: https://lists.oasis-open.org/archives/dita/201802/msg00035.html

Stage two proposal approved 27 Feb 2018, moved to stage 3.

The DITA community has been confused in the past about what it means to use a topic reference to a composite ditabase document (that is, one that has the root element <dita> with topics inside). Links to the document with no topic ID are equivalent to links to the first topic. There has been confusion about what it means for publishing (should a reference to the doc signify an intent to publish the whole doc, or the first topic). The original expectation was that the whole document should be published, but the linking language has caused confusion. Need to clarify this in DITA 2.0, as discussed April 3 and April 10 2018

Based on proposal from Chris Nitchie here:
https://lists.oasis-open.org/archives/dita/201703/msg00033.html

Discussed at TC May 2; moved to stage 2 and assigned to Robert: https://lists.oasis-open.org/archives/dita/201705/msg00015.html

Discussed Jan 9 2018: aiming for stage 2 complete by Jan 29.

06 Feb 2018: Deb Bissantz assigned as reviewer

Stage 2 proposal submitted 28 Feb after review from Deb: https://lists.oasis-open.org/archives/dita/201802/msg00104.html

Voted to stage 3 on 27 March 2018. Reviewers Deb, Tom.

Discussed at TC meeting on 21 March 2017:
https://lists.oasis-open.org/archives/dita/201703/msg00025.html

Based on: https://lists.oasis-open.org/archives/dita/201801/msg00061.html

Discussed at TC Jan 30, 2018; primary concerns are backwards compatibility (reluctant to remove href/scope/format from <image> and force <imageref> usage for the common case), and concern from Robert about how the base topic module can include imagelabel as a specialization of data -- better to make that a new base element to go along with new imageref. Left at stage 1 for now; Eliot already at max count for later stages.

Stage one proposal based on: https://lists.oasis-open.org/archives/dita/201905/msg00024.html with quite a lot of follow up email.

Originally discussed in 2017; Kris pulled out the relevant sections of our minutes in that same thread: https://lists.oasis-open.org/archives/dita/201905/msg00036.html

Discussed at TC May 14 2019, moved to stage 2 with Robert Anderson as owner.

Discussed June 19 2019 at TC, scheduled for vote

Voted to stage 3 July 2 2019

Reviewers for stage 3 (assigned Oct 15): Carlos, Kris, Eliot

Approved at stage 3 17 December 2019.

The "Task topic (strict task)" topic of the DITA specification (see the file dita-task-topic.dita) contains an example task which contains the <context> and <prereq> elements in the wrong order.

Based on stage 1 proposal from Eliot: https://lists.oasis-open.org/archives/dita/201801/msg00056.html

Discussed at TC January 30, 2018. Much support for title-less topic, Robert expressed some concern about the reference, others expressed similar concern (intent for reference is to support legacy; concern with beginning DITA 2.0 with a new convenience element intended solely for legacy, when DITA 2.0 supports the function natively). Left at Stage 1 for now.

Discussed at TC July 10 and assigned to Dawn Stevens.

Discussed August 21, aim for proposal two weeks out.

Discussed again Sept 18: https://lists.oasis-open.org/archives/dita/201809/msg00036.html

Discussed again Dec 4.

Based on: https://lists.oasis-open.org/archives/dita/201906/msg00004.html

Discussed June 11 2019 at TC and moved to stage 2 with Robert as owner.

Discussed stage 2 proposal at TC Sept 10, 2019, and voted to stage 3 Sept 17. Stage 3 reviewers: Eliot and Scott.

Stage 3 proposal approved Oct 22, 2019

Stage 1 proposal submitted: https://lists.oasis-open.org/archives/dita/201802/msg00106.html

Discussed 13 March 2018 and moved to stage 2 with Robert as owner, Eliot Kimber and Stan Doherty as reviewers.

Discussed stage 2 proposal at TC 3 April and 10 April: https://lists.oasis-open.org/archives/dita/201804/msg00039.html

Voted from stage 2 to stage 3 at TC 17 April 2018, with Eliot and Stan as reviewers.

Stage one proposal: https://lists.oasis-open.org/archives/dita/201803/msg00012.html

Discussed 13 March 2018 and moved to stage 2 with Keith as owner, Kris Eberlein and Bob Thomas as reviewers.

Initially kicked off with this email:
https://lists.oasis-open.org/archives/dita/201906/msg00026.html

Discussed at several TC meetings, moved to stage 2 using this design at TC meeting August 13 2019, with Scott as owner:
https://lists.oasis-open.org/archives/dita/201907/msg00060.html

Voted to Stage 3 October 15, 2019

Approved Stage 3 proposal November 19 2019 https://lists.oasis-open.org/archives/dita/201911/msg00026.html

For example, if an index entry appears on 4 different pages, add a way to highlight the preferred entry.

Brought up by Eliot and first discussed as a stage one idea June 18, 2019 at TC call.

Prompted by: https://lists.oasis-open.org/archives/dita/201908/msg00084.html

Discussed Sept 3 2019, agreed to remove the language about stripping white space, so that the xml:space="preserve" attribute works as expected by the XML spec.

See full description below based on request from @ctnitchie .

Discussed Jan 9 2018 -- need input from others before continuing with stage 2. Goal of February 26 to either get input + create stage 2 proposal, or to withdraw.

06 Feb 2018: Dick Hamilton assigned as reviewer

27 Feb 2018 discussed stage 2 proposal at TC.

13 March 2018 voted on stage 2 proposal, moved to stage 3.

Discussed 1 May 2018, Eliot and Robert agreed to be reviewers for stage 3 proposal.

Based on: https://lists.oasis-open.org/archives/dita/201906/msg00004.html

Discussed June 11 2019 at TC, moved to stage 2, with Kris as owner.

Discussed June 19 2019 at TC, scheduled for vote

Voted to stage 3 July 2 2019

Proposal to remove "delayed conref domain" from DITA 2.0. The domain added three elements in DITA 1.2. Based on informal polling, it does not appear to be used, and many do not know what the three elements are for. Suggest removing from DITA 2.0 as part of effort to simplify the language and remove features that are not needed.

Discussed at TC Sept 5 2017 and assigned as stage 1 to Alan Houser.

Based on email thread begun by Kris:
https://lists.oasis-open.org/archives/dita/201708/msg00056.html

Moved to stage 2 at TC Sept 19 2017 with Alan Houser as owner.

Discussed Jan 9 2018: aiming to complete Stage 2 proposal by Jan 29

06 Feb 2018: Stan Doherty assigned as reviewer.

Voted Feb 20 to move from Stage 2 to Stage 3.

Discussed at TC meeting on 14 March 2017:
https://lists.oasis-open.org/archives/dita/201703/msg00019.html

Discussed at TC meeting on 21 March 2017:
https://lists.oasis-open.org/archives/dita/201703/msg00025.html

Discussed at TC May 9, 2017, and at some earlier meetings.

Robert suggested a goal that will give us a stronger focus on RNG as the main delivery format for modular grammar files, and remove the requirement (or even the suggestion) that DTD or XSD implementations must be modular to comply with the spec. Going into the future, best practice as laid out by the TC would be to maintain grammar files in RNG, and generate monolithic DTD or XSD as needed for applications that do not use RNG.

There are open questions remaining after the May 9 meeting:

• Should OASIS deliver modular DTD files with 2.0 (as opposed to monolithic DTDs)? Pro: it will allow existing DTD users to upgrade more easily, and shift to RNG over time. Con: additional maintenance burden on the TC could slow down development, and uncertain if tools will be able to fully automate this.
• There is general agreement on not shipping modular XSD files. Should OASIS deliver monolithic XSD versions of the grammar files? Pro: at least a few editors currently require XSD and could use it. Con: additional time to generate and test will cause some amount of delay.

Make simpletable more like "actually it's almost an HTML table": https://lists.oasis-open.org/archives/dita/201907/msg00100.html

First discussed at TC August 6 2019 and accepted as stage 1 proposal.

Discussed at TC May 30, 2017. Consensus is that these elements seem to provide very little value over ordinary <topicref> elements. In addition, they regularly suggest to authors that they should result in some sort of standard special processing (which they do not). Proposal moved to stage 2 and assigned to Eliot.

Discussed Jan 9 2018: aiming for stage 2 proposal done by Feb 26

06 Feb 2018: Tom Magliery assigned as reviewer

27 Feb 2018: move stage 2 due date to March 13

14 May 2019: discussed at TC and moved to stage 3.

Based on proposal from Chris Nitchie here, and several follow-up emails on list:
https://lists.oasis-open.org/archives/dita/201703/msg00030.html

Discussed at TC meeting May 2; moved to Stage 2 and assigned to Chris.

Discussed Jan 9 2018: aiming for stage 2 by Feb 19

06 Feb 2018: Bob Thomas assigned as reviewer

Determined by consensus at TC meeting May 15 2015, spec should be updated in 2.0 to reflect this.
https://lists.oasis-open.org/archives/dita/201505/msg00068.html

First suggested by Eliot Kimber as a way to handle metadata concerns: a new base attribute (to be named), possibly with a URI value or possibly free-form, that can be used to specify or refer to metadata values defined outside of the DITA source (such as an externally maintained taxonomy).

Original idea came out of earlier threads and meeting discussion; first discussed as a stage 1 proposal January 23, 2018, based on summary of recent metadata notes here: https://lists.oasis-open.org/archives/dita/201801/msg00048.html

The TC needs to review what domains are integrated into the shells for DITA 2.0. Changes that the TC wants to implement:

• Add glossref domain to bookmap

Because the release management domain is an official DITA domain, there should be a dedicated <booklists> element for it. This is the currently suggested solution from @robander.

<frontmatter>
    <booklists>
        <toc/>
        <booklist type="change-historylist"/>
        <tablelist/>
    </booklists>
</frontmatter>

Something like this would be more elegant:

<frontmatter>
    <booklists>
        <toc/>
        <changelist/>
        <tablelist/>
    </booklists>
</frontmatter>

Submitted as stage 1 proposal by Chris Nitchie: https://lists.oasis-open.org/archives/dita/201803/msg00030.html

First discussed at TC call 20 March 2018.

Discussed at TC May 30, 2017. Those on call currently favor removing the attribute and when similar function is needed, using key values in its place. Moved to stage 2 and assigned to Eliot.

Discussed Jan 9 2018: aiming for stage 2 proposal by March 26.

06 Feb 2018: Stan Doherty assigned as reviewer

Goal of redesign is to remediate problems but avoid breaking backward compatibility.

Discussed at TC meeting on 14 March 2017:
https://lists.oasis-open.org/archives/dita/201703/msg00019.html

Discussed at TC meeting on 21 March 2017:
https://lists.oasis-open.org/archives/dita/201703/msg00025.html

Discussed at TC meeting on 23 May 2017, moved to stage 2 and assigned to Eric Sirois; design goal is to allow <ditavalref> before front matter, as well as a <keydefs> container to hold key definitions.

06 Feb 2018: Eric designated 26 February 2018 as the date by which the proposal would be submitted

Amber Swope and Robert Anderson volunteered to serve as stage two reviewers.

Lot of discussion on the proposal at TC 27 March 2018.

Official stage 1 proposal: https://lists.oasis-open.org/archives/dita/201803/msg00029.html

Discussed 13 March 2018 and moved to stage 2 with Robert as owner, Bob Thomas + Scott Hudson + Bill Burns as reviewers.

After reviews by all 3, submitted to TC as Stage 2 proposal 19 March 2018: https://lists.oasis-open.org/archives/dita/201803/msg00054.html
DITA copy: https://tools.oasis-open.org/version-control/browse/wsvn/dita/trunk/DITA-2.0/stage-2/Issue106-NestSteps.dita

Discussed at TC March 20 2018, scheduled for a vote March 27.

Voted to stage 3 on 27 March 2018. Reviewers Nancy, Bob, and Carsten.

Sent stage 3 first draft to reviewers 17 April 2018, stored in SVN: https://tools.oasis-open.org/version-control/browse/wsvn/dita/trunk/DITA-2.0/stage-3/Issue106-stage3-NestSteps.dita

Discussed at the DITA TC meeting on 16 May 2017 and assigned to Carlos. Link to minutes: https://lists.oasis-open.org/archives/dita/201705/msg00048.html

Chris Nitchie submitted stage 2 proposal; DITA source: https://tools.oasis-open.org/version-control/svn/dita/trunk/DITA-2.0/stage-2/Issue27-multimedia.dita

HTML version, reviewed June 27: https://www.oasis-open.org/committees/download.php/61092/Issue27-multimedia.html

Notes from small group meeting on multimedia: https://lists.oasis-open.org/archives/dita/201708/msg00036.html

August 22: stage 2 proposal queued for vote based on latest version: https://www.oasis-open.org/apps/org/workgroup/dita/download.php/61409/Issue27-multimedia.html

Approved stage 2 proposal August 29 2017, moved to stage 3.

Discussed at TC Jan 9 2018: aiming for stage 3 proposal by Feb 26.

Bill Burns, Eliot Kimber, and Keith S-R assigned as reviewers.

Discussed July 31 and Alan volunteered to take this on.

Discussed August 21 and Alan plans to have a proposal by September 17.

[Edited to add the actual issue, taken from Eliot's first comment below]

The global issue across our catalogs is that in 1.2 we provided three Public IDs for every module:

• A version-agnostic copy, meaning "The latest version"
• A 1.x copy, meaning "The latest in DITA 1.x", allowing for easy upgrades across 1.x without automatic upgrade to 2.x
• A version-specific copy, "This module as shipped in DITA 1.2"

For example:

<public publicId="-//OASIS//DTD DITA Base Topic//EN" uri="basetopic.dtd"/>
<public publicId="-//OASIS//DTD DITA 1.x Base Topic//EN" uri="basetopic.dtd"/>
<public publicId="-//OASIS//DTD DITA 1.2 Base Topic//EN" uri="basetopic.dtd"/>
<system systemId="urn:oasis:names:tc:dita:xsd:basetopic.xsd" uri="basetopic.xsd" />
<system systemId="urn:oasis:names:tc:dita:xsd:basetopic.xsd:1.x" uri="basetopic.xsd" />
<system systemId="urn:oasis:names:tc:dita:xsd:basetopic.xsd:1.2" uri="basetopic.xsd" />

In DITA 1.3, all of the 1.x copies are missing across all versions of the grammar. We should restore these in the errata.

Request from Dawn, submitted back in May. May be combined with (or overlap) general redesign work on hazard domain that Jang has proposed.

Kris and Dawn likely to end up working on this together.

For historical reasons, the three elements have duplicate @class attribute definitions. Details and original stage 1 proposal to fix this are here:
https://lists.oasis-open.org/archives/dita/201705/msg00006.html

Discussed at TC meeting May 9, 2017; agreed to move forward to stage 2 and assigned to Eliot Kimber. Expecting that the map/* class attributes will be removed in 2.0, so that each of these three uses only the topic/* variant in all cases.

Discussed Jan 9 2018: aiming for stage 2 complete by February 26.

06 Feb 2018: Robert Anderson assigned as reviewer

27 Feb 2018: move stage 2 due date to March 13

14 May 2019: discussed at TC and moved to stage 3.

Stage 1 proposal from Jang: https://lists.oasis-open.org/archives/dita/201803/msg00072.html

Discussed April 3 2018, left at stage 1 until a voting member is able to take this on as a stage two proposal.

Make @outputclass into a universal attribute; just because an element does not typically result in rendered output should not prevent us from defining the attribute.

Discussed at TC meeting Jan 24 2017; moved to stage 2 and assigned to Robert. Meeting minutes:
https://lists.oasis-open.org/archives/dita/201701/msg00097.html

Stage 2 proposal: https://tools.oasis-open.org/version-control/svn/dita/trunk/DITA-2.0/stage-2/Issue17-universalOutputclass.dita

Stage 2 HTML version discussed at meeting July 11 2017, and queued for vote: https://www.oasis-open.org/apps/org/workgroup/dita/download.php/60973/Issue17-universalOutputclass.html

Stage 2 proposal approved July 18, and moved to stage 3.

Discussed at TC Jan 9 2018, aiming for stage 3 proposal by Jan 29.

06 Feb 2018: Dawn Stevens and Scott Hudson assigned as stage 3 reviewers

Stage 3 proposal sent to TC 28 Feb 2018 after review from Dawn and Scott: https://lists.oasis-open.org/archives/dita/201802/msg00105.html

Discussed February 21, 2017:
https://lists.oasis-open.org/archives/dita/201702/msg00054.html

Discussed again May 30, 2017.

This value is very rarely used and often seen as an odd part of DITA, that does not fit with other values for note/@type. There was a wider question about whether or not we should examine other values, and/or remove the enumerated values so that anybody could create new note/@type values (and would optionally need to use a subject scheme to restore the current standard values), but the original focus is on fastpath.

Along with this, improve quality of technical content architectural topics (from DITA 2.0 backlog).

Discussed Jan 9 2018: aiming for stage 2 proposal by Feb 12.

06 Feb 2018: Nancy Harrison assigned as reviewer

The <ph> element is not allowed in several elements from glossentry, which means that terms cannot be used properly. See original request: https://lists.oasis-open.org/archives/dita/201710/msg00042.html

Discussed November 7 2017 and moved to Stage 2 with Scott leading. Minutes: https://lists.oasis-open.org/archives/dita/201711/msg00009.html

Discussed Jan 9 2018: hoping for stage 2 completion by January 29.

Voted Feb 20 to move from Stage 2 to Stage 3.

We have extra / redundant directory names like dtd/base/dtd/ and rng/technicalContent/rng/ in the grammar files we deliver. We should simplify this, presumably by dropping the final part of the path that matches the first part of the path in the examples above.

Eliot is working on coming up with an additional list of file names that are inconsistent, such as modules that do not follow the same pattern as other modules; it would be good to clean those up with 2.0 as well.

https://lists.oasis-open.org/archives/dita/201906/msg00033.html

Stage one idea discussed in detail June 18 2019; moved to stage 2 with several questions still to be resolved. Stage two reviewers are Bill Burns and Keith

Based on this question https://lists.oasis-open.org/archives/dita/201907/msg00047.html

And this follow up https://lists.oasis-open.org/archives/dita/201907/msg00050.html

Discussed at TC July 16 2019, moved to stage 2 with Bill Burns as owner.

Approved stage 2 proposal August 27.

Stage 3 proposal approved Oct 22, 2019

Based on proposal from Chris Nitchie here:
https://lists.oasis-open.org/archives/dita/201703/msg00035.html

Discussed at TC meeting May 2; moved to stage 2 and assigned to Chris.

Stage 2 proposal: https://tools.oasis-open.org/version-control/svn/dita/trunk/DITA-2.0/stage-2/Issue15-LoosenSpecializationRules.dita

Stage 2 HTML version discussed at meeting July 11 2017, and queued for vote: https://www.oasis-open.org/committees/download.php/60964/Issue15-LoosenSpecializationRules.html

Stage 2 proposal approved July 18, and moved to stage 3.

Discussed Jan 9 2018: stage 3 proposal post-February.

Consensus from TC meeting July 16 2019 was that the ideal way to manage this is to change the specialization base of image maps from figure to div (and nested area elements from figgroup to div).

Moved to stage 2 July 16 with Kris as owner.

Approved stage 3 proposal August 27.