[Date Prev] | [Thread Prev] | [Thread Next] | [Date Next] -- [Date Index] | [Thread Index] | [List Home]
Subject: Re: [dita] Updated: Stage 2 proposal - bookmap update.
The proposal says “mapresources” is a “placeholder” but it doesn’t seem to be a placeholder, rather it’s just a container for resource-only topicrefs that is perfectly usable as is. “Placeholder” implies it’s expected to be replaced with something else, but I don’t see a reason to need anything other than “mapresources” itself. I like to define the topicref type “keydefs” in my map specializations and I could easily use “mapresources” as the specialization base but I don’t see that that would be required by this proposal. Given the existence of “mapresources” as a TC-provided domain I would probably just use that as is. Cheers, E. -- Eliot Kimber http://contrext.com From: <dita@lists.oasis-open.org> on behalf of Eric Sirois <eric.sirois@ixiasoft.com> Here is the updated bookmap proposal based on the discussion with the TC. DITA 2.0 proposed feature #29The goal of the redesign is to remediate problems but avoid breaking backward compatibility. Modify bookmap designProposal version 1.1 Completion date TBD Champion of the proposal Initial Suggestion https://lists.oasis-open.org/archives/dita/201703/msg00019.html Links to minutes where this proposal was discussed at stage 1 and moved to stage 2 https://lists.oasis-open.org/archives/dita/201705/msg00091.html GitHub Issue https://github.com/oasis-tcs/dita/issues/29 Original requirement or use caseOverall the bookmap DTD has not been updated as part general DITA releases for a couple releases. It is missing some convenient key features that were added as part of DITA 1.2 and 1.3. The proposal will make it easier to make use of Use cases
The current version of the DITA Bookmap does allow keydefs to be created, but you need to do it inside one of the main top level elements. like
The current version of the DITA Bookmap does not allow Proposed solutionThe purpose of the proposal is to add some enhancements to bookmap, with a minimal amount of impact at the processing end of the pipeline but will make things a bit easier for the end user.
Benefits
Technical requirementsThis change is adding two elements, that already supported in DITA 1.3, to the root content model of the bookmap DTD and as such, will have essentially no technical impact. Provide a detailed description of how the solution will work. Be sure to include the following details: DTD and Schema modifications. New domain · Map resources o Add a domain specializations that will allow the definition of a wrapper element to define New element · o This element is a placeholder that would allow specializations of o The element is optional after the · o This is an existing element that is available in the base o The element is optional after the Processing impact None. Overall usability Current DITA users and current document type shells will be unaffected. Usability of authoring will ultimately be improved due to better management of keydefs and use of ditavalrefs in the bookmap. Costs
ExamplesSample usage in a bookmap:
Element definition in the bookmap DTD:
Element override in the bookmap shell:
Domain definition:
Domain entity definition:
Éric Sirois DITA Toolsmith IXIASOFT 825 Querbes, Suite 200, Montréal, Québec, Canada, H2V 3X1 tel + 1 514 279-4942 / toll free + 1 877 279-4942 mobile + 1 647 462-3620 eric.sirois@ixiasoft.com / www.ixiasoft.com |
[Date Prev] | [Thread Prev] | [Thread Next] | [Date Next] -- [Date Index] | [Thread Index] | [List Home]