[Date Prev] | [Thread Prev] | [Thread Next] | [Date Next] -- [Date Index] | [Thread Index] | [List Home]
Subject: RE: [dita] Issue #29: How best to handle <mapresources>? Feedback wanted.
I tend to agree with Eliot, mostly because I like the additional semantic precision and the convenience of not having to set the processing role. Bill Burns Content Architect | Healthwise bburns@healthwise.org | www.healthwise.org 208.331.6917 (office)Â |Â 208.345.1897 (fax) -----Original Message----- From: dita@lists.oasis-open.org <dita@lists.oasis-open.org> On Behalf Of Kristen James Eberlein Sent: Wednesday, October 2, 2019 5:46 PM To: DITA TC <dita@lists.oasis-open.org> Subject: Re: [dita] Issue #29: How best to handle <mapresources>? Feedback wanted. *** External email: use caution *** Eliot, in your code sample, what benefit do you get from <mapresources>? Seems as if <topicgroup> serves the basic purpose ... Best, Kris Kristen James Eberlein Chair, OASIS DITA Technical Committee Principal consultant, Eberlein Consulting https://nam02.safelinks.protection.outlook.com/?url=www.eberleinconsulting.com&data=02%7C01%7Cbburns%40healthwise.org%7C7a5e07d1ce2e4a600c3b08d74792bd5f%7Ccee5d4e942e548c28a033406fd5b9242%7C0%7C0%7C637056567895735227&sdata=wVCxdKNVYACOZfXnPNXxFw00M0%2BmQ8DFmjUlXpzr3NA%3D&reserved=0 +1 919 622-1501; kriseberlein (skype) On 10/2/2019 7:18 PM, Eliot Kimber wrote: > I vote for adding mapresources to mapgroup domain. > > My use case relative to bookmap is having submaps for chapters where > each chapter is a separate keyscope scope and has its own keydefs, e.g.: > > <chapter keyscope=" install" keys="installation" > href="topic-12355.dita"> <topicmeta> <navtitle>Installation</navtitle> > </topicmeta> <mapresources> <topicgroup> <topicmeta> > <navtitle>Images</navtitle> </topicmeta> <keydef > keys="illus-remove-cover" format="jpg" > href="media/illustrations/image-2343342.jpg" > /> > </topicgroup> > </mapresources> > <topicref keys="install-prep" href="topic-452342.dita"/> <topicref > keys="install-process" href="topic-452344.dita"/> </chapter> > > In my personal DITA use I often define a specialization named > "keydefs" and then use that as we are proposing to use mapresources. > > It would be a natural constraint to allow <mapresources> only as the > first child of specific topicref types (chapter, part, etc.) if map > authoring needs to be that constrained. > > One thing to keep in mind is that map authoring by its nature > generally requires a deeper understanding of how DITA maps work, which > usually means that the map author doesn't need as much guidance, > meaning it's usually not worth the effort to setup constraints for > maps as compared to topics, where it's usually very important. For the > typical map author a simple convention or pre-defined template > document is usually sufficient. > > Cheers, > > E. > > -- > Eliot Kimber > https://nam02.safelinks.protection.outlook.com/?url=http%3A%2F%2Fcontr > ext.com&data=02%7C01%7Cbburns%40healthwise.org%7C7a5e07d1ce2e4a600 > c3b08d74792bd5f%7Ccee5d4e942e548c28a033406fd5b9242%7C0%7C0%7C637056567 > 895735227&sdata=O6ssSe3RbLHpaWiBnzvJ39I2iaI1g4098rmqIKaZbp4%3D& > ;reserved=0 > > ïOn 10/2/19, 4:26 PM, "Kristen James Eberlein" > <dita@lists.oasis-open.org on behalf of kris@eberleinconsulting.com> > wrote: > > One of the goals of proposal #29, "Update bookmap" is to provide an > intuitive location in a bookmap for map authors to locate > resource-only objects such as: > * Key definition maps > * Subject scheme maps > * Topics that hold information for constructing PDF cover pages We > have several options for how handle the <mapresources> > element: > 1. Define this element directly in <bookmap>. (In this case, I think > it should be named <bookmapresources>). > 2. Define this element in a new domain. I don't think we want to do > this, since we have an existing map domain. > 3. Add this element to the map group domain. > So, given these two option, which is the correct choice for the TC? > I don't have the answer, but I can suggest the framework in which we > can make the answer. I think we need to focus on the user experience > for map authors and information architects and ask the following > questions: > * How useful will a <mapresources> element be in map? Will it solve > any existing problems? Make anything easier? > * Will having <mapresources> available everywhere that <topicref> is > available add to element overload for authors? Make developing maps > more difficult? > If having a <mapresources> element in the map group domain solves > problems/meets real user requirements, then I can support that. > If we only have theoretical use cases for adding <mapresources> to the > map group domain, then I'll advocate for simply adding > <bookmapresources> to bookmap.mod. We know that bookmap design has > inherent flaws, and remember that the goal of the bookmap update > proposal is "to remediate problems without breaking backwards > compatibility." > -- > Best, > Kris > Kristen James Eberlein > Chair, OASIS DITA Technical Committee > Principal consultant, Eberlein Consulting > https://nam02.safelinks.protection.outlook.com/?url=www.eberleinconsul > ting.com&data=02%7C01%7Cbburns%40healthwise.org%7C7a5e07d1ce2e4a60 > 0c3b08d74792bd5f%7Ccee5d4e942e548c28a033406fd5b9242%7C0%7C0%7C63705656 > 7895735227&sdata=wVCxdKNVYACOZfXnPNXxFw00M0%2BmQ8DFmjUlXpzr3NA%3D& > amp;reserved=0 > <https://nam02.safelinks.protection.outlook.com/?url=http%3A%2F%2Fwww. > eberleinconsulting.com&data=02%7C01%7Cbburns%40healthwise.org%7C7a > 5e07d1ce2e4a600c3b08d74792bd5f%7Ccee5d4e942e548c28a033406fd5b9242%7C0% > 7C0%7C637056567895735227&sdata=2uxKJ7n039jn1YXQEALtXORoRqU5QF0erv5 > Hsc5qa0Y%3D&reserved=0> > +1 919 622-1501; kriseberlein (skype) > --------------------------------------------------------------------- > 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://nam02.safelinks.protection.outlook.com/?url=https%3A%2F%2Fwww. > oasis-open.org%2Fapps%2Forg%2Fworkgroup%2Fportal%2Fmy_workgroups.php&a > mp;data=02%7C01%7Cbburns%40healthwise.org%7C7a5e07d1ce2e4a600c3b08d747 > 92bd5f%7Ccee5d4e942e548c28a033406fd5b9242%7C0%7C0%7C637056567895735227 > &sdata=8mufs%2BTyqjhKjw9%2BceayO4eh%2BTdkRzbqPGxZidGz4R0%3D&re > served=0 > > > > > --------------------------------------------------------------------- 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://nam02.safelinks.protection.outlook.com/?url=https%3A%2F%2Fwww.oasis-open.org%2Fapps%2Forg%2Fworkgroup%2Fportal%2Fmy_workgroups.php&data=02%7C01%7Cbburns%40healthwise.org%7C7a5e07d1ce2e4a600c3b08d74792bd5f%7Ccee5d4e942e548c28a033406fd5b9242%7C0%7C0%7C637056567895735227&sdata=8mufs%2BTyqjhKjw9%2BceayO4eh%2BTdkRzbqPGxZidGz4R0%3D&reserved=0
[Date Prev] | [Thread Prev] | [Thread Next] | [Date Next] -- [Date Index] | [Thread Index] | [List Home]