OASIS Darwin Information Typing Architecture (DITA) TC

  • 1.  Re: [dita] RE: Overall fixes for bookmap for 2.0

    Posted 02-21-2017 17:06



    Well, the most annoying thing IMO is that even if the keys resolve, they won’t show up in output unless you specifically set print=“yes”. I’ve run into this a ton with term/abbreviated-form.


    —Scott




    From: < dita@lists.oasis-open.org > on behalf of Éric Sirois < eric.sirois@ixiasoft.com >
    Date: Tuesday, February 21, 2017 at 10:03 AM
    To: Éric Sirois < eric.sirois@ixiasoft.com >, " dita@lists.oasis-open.org " < dita@lists.oasis-open.org >
    Subject: [dita] RE: Overall fixes for bookmap for 2.0








    Specifically looking to allow Keydefs in a more natural position in the map versus the first instance were topicref is allowed in the current content model.  Are there other things that we have ignored about bookmaps in DITA 1.3?
     

    É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  

     


     


    From:
    dita@lists.oasis-open.org [ mailto:dita@lists.oasis-open.org ]
    On Behalf Of Éric Sirois
    Sent: February 21, 2017 11:33 AM
    To: dita@lists.oasis-open.org
    Subject: [dita] Overall fixes for bookmap for 2.0


     
    Hi,
     
    We have a number of clients that have hit some limitations for keyref and ditavalref in bookmaps.  I would like to work on a proposal that would address those limitations in DITA 2.0.  Would it be possible to create a project entry in the
    DITA 2.0 project?
     
    Kind regards,
     
    É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  

     

     









  • 2.  RE: [dita] RE: Overall fixes for bookmap for 2.0

    Posted 02-21-2017 17:08




    Yeah, we have run into a similar situation with glossref (it doesn’t behave like the other ref type elements).  Maybe that’s another small proposal we can fix for 2.0.
     

    É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  

     


     


    From: Scott Hudson [mailto:scott.hudson@jeppesen.com]

    Sent: February 21, 2017 12:06 PM
    To: Éric Sirois <eric.sirois@ixiasoft.com>; dita@lists.oasis-open.org
    Subject: Re: [dita] RE: Overall fixes for bookmap for 2.0


     

    Well, the most annoying thing IMO is that even if the keys resolve, they won’t show up in output unless you specifically set print=“yes”. I’ve run into this a ton with term/abbreviated-form.


     


    —Scott


     


    From: < dita@lists.oasis-open.org > on behalf of Éric Sirois < eric.sirois@ixiasoft.com >
    Date: Tuesday, February 21, 2017 at 10:03 AM
    To: Éric Sirois < eric.sirois@ixiasoft.com >, " dita@lists.oasis-open.org " < dita@lists.oasis-open.org >
    Subject: [dita] RE: Overall fixes for bookmap for 2.0


     



    Specifically looking to allow Keydefs in a more natural position in the map versus the first instance were topicref is allowed in the current content model.  Are there other things that we have ignored about bookmaps
    in DITA 1.3?
     

    É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  

     


     


    From:
    dita@lists.oasis-open.org [ mailto:dita@lists.oasis-open.org ]
    On Behalf Of Éric Sirois
    Sent: February 21, 2017 11:33 AM
    To: dita@lists.oasis-open.org
    Subject: [dita] Overall fixes for bookmap for 2.0


     
    Hi,
     
    We have a number of clients that have hit some limitations for keyref and ditavalref in bookmaps.  I would like to work on a proposal that would address those limitations in DITA 2.0.  Would it be possible to create
    a project entry in the DITA 2.0 project?
     
    Kind regards,
     
    É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  

     

     








  • 3.  Re: [dita] RE: Overall fixes for bookmap for 2.0

    Posted 02-21-2017 17:16



    +1


    —Scott




    From: Éric Sirois < eric.sirois@ixiasoft.com >
    Date: Tuesday, February 21, 2017 at 10:07 AM
    To: Scott Hudson < scott.hudson@jeppesen.com >, " dita@lists.oasis-open.org " < dita@lists.oasis-open.org >
    Subject: RE: [dita] RE: Overall fixes for bookmap for 2.0








    Yeah, we have run into a similar situation with glossref (it doesn’t behave like the other ref type elements).  Maybe that’s another small proposal we can fix for 2.0.
     

    É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  

     


     


    From: Scott Hudson [ mailto:scott.hudson@jeppesen.com ]

    Sent: February 21, 2017 12:06 PM
    To: Éric Sirois < eric.sirois@ixiasoft.com >;
    dita@lists.oasis-open.org
    Subject: Re: [dita] RE: Overall fixes for bookmap for 2.0


     

    Well, the most annoying thing IMO is that even if the keys resolve, they won’t show up in output unless you specifically set print=“yes”. I’ve run into this a ton with term/abbreviated-form.


     


    —Scott


     


    From: < dita@lists.oasis-open.org > on behalf of Éric Sirois < eric.sirois@ixiasoft.com >
    Date: Tuesday, February 21, 2017 at 10:03 AM
    To: Éric Sirois < eric.sirois@ixiasoft.com >, " dita@lists.oasis-open.org " < dita@lists.oasis-open.org >
    Subject: [dita] RE: Overall fixes for bookmap for 2.0


     



    Specifically looking to allow Keydefs in a more natural position in the map versus the first instance were topicref is allowed in the current content model.  Are there other things that we have ignored about bookmaps
    in DITA 1.3?
     

    É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  

     


     


    From: dita@lists.oasis-open.org [ mailto:dita@lists.oasis-open.org ]
    On Behalf Of Éric Sirois
    Sent: February 21, 2017 11:33 AM
    To: dita@lists.oasis-open.org
    Subject: [dita] Overall fixes for bookmap for 2.0


     
    Hi,
     
    We have a number of clients that have hit some limitations for keyref and ditavalref in bookmaps.  I would like to work on a proposal that would address those limitations in DITA 2.0.  Would it be possible to create
    a project entry in the DITA 2.0 project?
     
    Kind regards,
     
    É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  

     

     











  • 4.  Re: [dita] RE: Overall fixes for bookmap for 2.0

    Posted 02-21-2017 17:16
    The issue is only with glossref, which defaults @print to “no”.   There are a number of issues with the bookmap design.   For example, all the specialized topicref types should be a separate domain so that they can be used in other map types (although our DITA 1.3 ability to use elements from structural domains as though they were domains helps there).   There needs to be a wrapper element around the body topicrefs so that there is a consistent frontmatter/body/appendixes/backmatter structure.   Need to be able to have chapters before the first part.   The book-specific metadata needs to be a separate domain and is woefully underspecified (for example, no provision for 13-digit ISBNs, no provision for ISSNs, no provision for forms of license other than copyright, etc.   There are also places where the design doesn’t allow extension where it should although I’d have to remind myself of the details.   Need more features to enable glossary generation—current glossarylist is not sufficient. Probably need a separate glossary topicref type (from the same domain that provides glossref) to provide  clearer signal that a subtree of the map is in fact a glossary.   I’m sure there is more…   Cheers,   E. -- Eliot Kimber http://contrext.com       From: <dita@lists.oasis-open.org> on behalf of Scott Hudson <scott.hudson@jeppesen.com> Date: Tuesday, February 21, 2017 at 11:05 AM To: Eric Sirois <eric.sirois@ixiasoft.com>, "dita@lists.oasis-open.org" <dita@lists.oasis-open.org> Subject: Re: [dita] RE: Overall fixes for bookmap for 2.0   Well, the most annoying thing IMO is that even if the keys resolve, they won’t show up in output unless you specifically set print=“yes”. I’ve run into this a ton with term/abbreviated-form.   —Scott   From: < dita@lists.oasis-open.org > on behalf of Éric Sirois < eric.sirois@ixiasoft.com > Date: Tuesday, February 21, 2017 at 10:03 AM To: Éric Sirois < eric.sirois@ixiasoft.com >, " dita@lists.oasis-open.org " < dita@lists.oasis-open.org > Subject: [dita] RE: Overall fixes for bookmap for 2.0   Specifically looking to allow Keydefs in a more natural position in the map versus the first instance were topicref is allowed in the current content model.  Are there other things that we have ignored about bookmaps in DITA 1.3?   É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       From: dita@lists.oasis-open.org [ mailto:dita@lists.oasis-open.org ] On Behalf Of Éric Sirois Sent: February 21, 2017 11:33 AM To: dita@lists.oasis-open.org Subject: [dita] Overall fixes for bookmap for 2.0   Hi,   We have a number of clients that have hit some limitations for keyref and ditavalref in bookmaps.  I would like to work on a proposal that would address those limitations in DITA 2.0.  Would it be possible to create a project entry in the DITA 2.0 project?   Kind regards,   É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       --------------------------------------------------------------------- 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


  • 5.  Re: [dita] RE: Overall fixes for bookmap for 2.0

    Posted 02-21-2017 17:25
    Chapters are allowed before part in the current model: ((title booktitle)?,(bookmeta)?,(frontmatter)?,(chapter)*,(part)*,((appendices)? (appendix)*),(backmatter)?,(reltable)*) Bob On Tue, Feb 21, 2017 at 10:15 AM, Eliot Kimber < ekimber@contrext.com > wrote: The issue is only with glossref, which defaults @print to “no”.   There are a number of issues with the bookmap design.   For example, all the specialized topicref types should be a separate domain so that they can be used in other map types (although our DITA 1.3 ability to use elements from structural domains as though they were domains helps there).   There needs to be a wrapper element around the body topicrefs so that there is a consistent frontmatter/body/appendixes/ backmatter structure.   Need to be able to have chapters before the first part.   The book-specific metadata needs to be a separate domain and is woefully underspecified (for example, no provision for 13-digit ISBNs, no provision for ISSNs, no provision for forms of license other than copyright, etc.   There are also places where the design doesn’t allow extension where it should although I’d have to remind myself of the details.   Need more features to enable glossary generation—current glossarylist is not sufficient. Probably need a separate glossary topicref type (from the same domain that provides glossref) to provide  clearer signal that a subtree of the map is in fact a glossary.   I’m sure there is more…   Cheers,   E. -- Eliot Kimber http://contrext.com       From: < dita@lists.oasis-open.org > on behalf of Scott Hudson < scott.hudson@jeppesen.com > Date: Tuesday, February 21, 2017 at 11:05 AM To: Eric Sirois < eric.sirois@ixiasoft.com >, " dita@lists.oasis-open.org " < dita@lists.oasis-open.org > Subject: Re: [dita] RE: Overall fixes for bookmap for 2.0   Well, the most annoying thing IMO is that even if the keys resolve, they won’t show up in output unless you specifically set print=“yes”. I’ve run into this a ton with term/abbreviated-form.   —Scott   From: < dita@lists.oasis-open.org > on behalf of Éric Sirois < eric.sirois@ixiasoft.com > Date: Tuesday, February 21, 2017 at 10:03 AM To: Éric Sirois < eric.sirois@ixiasoft.com >, " dita@lists.oasis-open.org " < dita@lists.oasis-open.org > Subject: [dita] RE: Overall fixes for bookmap for 2.0   Specifically looking to allow Keydefs in a more natural position in the map versus the first instance were topicref is allowed in the current content model.  Are there other things that we have ignored about bookmaps in DITA 1.3?   É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       From: dita@lists.oasis-open.org [ mailto:dita@lists.oasis-open. org ] On Behalf Of Éric Sirois Sent: February 21, 2017 11:33 AM To: dita@lists.oasis-open.org Subject: [dita] Overall fixes for bookmap for 2.0   Hi,   We have a number of clients that have hit some limitations for keyref and ditavalref in bookmaps.  I would like to work on a proposal that would address those limitations in DITA 2.0.  Would it be possible to create a project entry in the DITA 2.0 project?   Kind regards,   É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       ------------------------------ ------------------------------ --------- 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 ------------------------------ ------------------------------ --------- 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 -- Bob Thomas +1 720 201 8260 Skype: bob.thomas.colorado Instant messaging: Gmail chat ( bob.thomas@tagsmiths.com ) or Skype Time zone: Mountain (GMT-7)


  • 6.  Re: [dita] RE: Overall fixes for bookmap for 2.0

    Posted 02-21-2017 17:32
    My mistake—for some reason I thought they weren’t.   Cheers,   E.   -- Eliot Kimber http://contrext.com       From: Bob Thomas <bob.thomas@tagsmiths.com> Date: Tuesday, February 21, 2017 at 11:24 AM To: Eliot Kimber <ekimber@contrext.com> Cc: Scott Hudson <scott.hudson@jeppesen.com>, Eric Sirois <eric.sirois@ixiasoft.com>, "dita@lists.oasis-open.org" <dita@lists.oasis-open.org> Subject: Re: [dita] RE: Overall fixes for bookmap for 2.0   Chapters are allowed before part in the current model:   ((title booktitle)?,(bookmeta)?,(frontmatter)?,(chapter)*,(part)*,((appendices)? (appendix)*),(backmatter)?,(reltable)*)   Bob   On Tue, Feb 21, 2017 at 10:15 AM, Eliot Kimber < ekimber@contrext.com > wrote: The issue is only with glossref, which defaults @print to “no”.   There are a number of issues with the bookmap design.   For example, all the specialized topicref types should be a separate domain so that they can be used in other map types (although our DITA 1.3 ability to use elements from structural domains as though they were domains helps there).   There needs to be a wrapper element around the body topicrefs so that there is a consistent frontmatter/body/appendixes/backmatter structure.   Need to be able to have chapters before the first part.   The book-specific metadata needs to be a separate domain and is woefully underspecified (for example, no provision for 13-digit ISBNs, no provision for ISSNs, no provision for forms of license other than copyright, etc.   There are also places where the design doesn’t allow extension where it should although I’d have to remind myself of the details.   Need more features to enable glossary generation—current glossarylist is not sufficient. Probably need a separate glossary topicref type (from the same domain that provides glossref) to provide  clearer signal that a subtree of the map is in fact a glossary.   I’m sure there is more…   Cheers,   E. -- Eliot Kimber http://contrext.com       From: < dita@lists.oasis-open.org > on behalf of Scott Hudson < scott.hudson@jeppesen.com > Date: Tuesday, February 21, 2017 at 11:05 AM To: Eric Sirois < eric.sirois@ixiasoft.com >, " dita@lists.oasis-open.org " < dita@lists.oasis-open.org > Subject: Re: [dita] RE: Overall fixes for bookmap for 2.0   Well, the most annoying thing IMO is that even if the keys resolve, they won’t show up in output unless you specifically set print=“yes”. I’ve run into this a ton with term/abbreviated-form.   —Scott   From: < dita@lists.oasis-open.org > on behalf of Éric Sirois < eric.sirois@ixiasoft.com > Date: Tuesday, February 21, 2017 at 10:03 AM To: Éric Sirois < eric.sirois@ixiasoft.com >, " dita@lists.oasis-open.org " < dita@lists.oasis-open.org > Subject: [dita] RE: Overall fixes for bookmap for 2.0   Specifically looking to allow Keydefs in a more natural position in the map versus the first instance were topicref is allowed in the current content model.  Are there other things that we have ignored about bookmaps in DITA 1.3?   É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       From: dita@lists.oasis-open.org [ mailto:dita@lists.oasis-open.org ] On Behalf Of Éric Sirois Sent: February 21, 2017 11:33 AM To: dita@lists.oasis-open.org Subject: [dita] Overall fixes for bookmap for 2.0   Hi,   We have a number of clients that have hit some limitations for keyref and ditavalref in bookmaps.  I would like to work on a proposal that would address those limitations in DITA 2.0.  Would it be possible to create a project entry in the DITA 2.0 project?   Kind regards,   É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       --------------------------------------------------------------------- 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 --------------------------------------------------------------------- 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   -- Bob Thomas +1 720 201 8260 Skype: bob.thomas.colorado Instant messaging: Gmail chat ( bob.thomas@tagsmiths.com ) or Skype Time zone: Mountain (GMT-7)  


  • 7.  RE: [dita] RE: Overall fixes for bookmap for 2.0

    Posted 02-21-2017 19:49
      |   view attached
    I agree with all the referencing-related improvements and also second the proposal to change how the bookmap metadata is structured. The deliverable metadata should not be limited only to bookmaps, is too limiting in its current structure, and doesn’t conform to any other standards (see other posts about the options for this).   As for the glossary generation, many of my clients struggle with presenting term/definition/alternative form (usually acronyms). The elements are available in the glossary topics, but there is no easy way to  structure or specify the generated list type in the deliverable map.   Thanks for starting this discussion.   Have a great day, Amber         From: dita@lists.oasis-open.org [mailto: dita@lists.oasis-open.org ] On Behalf Of Eliot Kimber Sent: Tuesday, February 21, 2017 9:16 AM To: Scott Hudson; Éric Sirois; dita@lists.oasis-open.org Subject: Re: [dita] RE: Overall fixes for bookmap for 2.0   The issue is only with glossref, which defaults @print to “no”.   There are a number of issues with the bookmap design.   For example, all the specialized topicref types should be a separate domain so that they can be used in other map types (although our DITA 1.3 ability to use elements from structural domains as though they were domains helps there).   There needs to be a wrapper element around the body topicrefs so that there is a consistent frontmatter/body/appendixes/backmatter structure.   Need to be able to have chapters before the first part.   The book-specific metadata needs to be a separate domain and is woefully underspecified (for example, no provision for 13-digit ISBNs, no provision for ISSNs, no provision for forms of license other than copyright, etc.   There are also places where the design doesn’t allow extension where it should although I’d have to remind myself of the details.   Need more features to enable glossary generation—current glossarylist is not sufficient. Probably need a separate glossary topicref type (from the same domain that provides glossref) to provide  clearer signal that a subtree of the map is in fact a glossary.   I’m sure there is more…   Cheers,   E. -- Eliot Kimber http://contrext.com       From: < dita@lists.oasis-open.org > on behalf of Scott Hudson < scott.hudson@jeppesen.com > Date: Tuesday, February 21, 2017 at 11:05 AM To: Eric Sirois < eric.sirois@ixiasoft.com >, " dita@lists.oasis-open.org " < dita@lists.oasis-open.org > Subject: Re: [dita] RE: Overall fixes for bookmap for 2.0   Well, the most annoying thing IMO is that even if the keys resolve, they won’t show up in output unless you specifically set print=“yes”. I’ve run into this a ton with term/abbreviated-form.   —Scott   From: < dita@lists.oasis-open.org > on behalf of Éric Sirois < eric.sirois@ixiasoft.com > Date: Tuesday, February 21, 2017 at 10:03 AM To: Éric Sirois < eric.sirois@ixiasoft.com >, " dita@lists.oasis-open.org " < dita@lists.oasis-open.org > Subject: [dita] RE: Overall fixes for bookmap for 2.0   Specifically looking to allow Keydefs in a more natural position in the map versus the first instance were topicref is allowed in the current content model.  Are there other things that we have ignored about bookmaps in DITA 1.3?   É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       From: dita@lists.oasis-open.org [ mailto:dita@lists.oasis-open.org ] On Behalf Of Éric Sirois Sent: February 21, 2017 11:33 AM To: dita@lists.oasis-open.org Subject: [dita] Overall fixes for bookmap for 2.0   Hi,   We have a number of clients that have hit some limitations for keyref and ditavalref in bookmaps.  I would like to work on a proposal that would address those limitations in DITA 2.0.  Would it be possible to create a project entry in the DITA 2.0 project?   Kind regards,   É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       --------------------------------------------------------------------- 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


  • 8.  Re: [dita] RE: Overall fixes for bookmap for 2.0

    Posted 02-21-2017 20:47
    The challenge is to figure out what we can do within the general framework of Breaking backward compatibility is OK, but no major disruption. Will we want to: Revise bookmap design? Deprecate bookmap and replace it with a new design? Something else? That said, I think starting with compiling the current pain points is the place to start. Keep those e-mails coming. Best, Kris Kristen James Eberlein Chair, OASIS DITA Technical Committee Principal consultant, Eberlein Consulting www.eberleinconsulting.com +1 919 682-2290; kriseberlein (skype) On 2/21/2017 2:48 PM, Amber Swope wrote: I agree with all the referencing-related improvements and also second the proposal to change how the bookmap metadata is structured. The deliverable metadata should not be limited only to bookmaps, is too limiting in its current structure, and doesn’t conform to any other standards (see other posts about the options for this).   As for the glossary generation, many of my clients struggle with presenting term/definition/alternative form (usually acronyms). The elements are available in the glossary topics, but there is no easy way to  structure or specify the generated list type in the deliverable map.   Thanks for starting this discussion.   Have a great day, Amber         From: dita@lists.oasis-open.org [mailto: dita@lists.oasis-open.org ] On Behalf Of Eliot Kimber Sent: Tuesday, February 21, 2017 9:16 AM To: Scott Hudson; Éric Sirois; dita@lists.oasis-open.org Subject: Re: [dita] RE: Overall fixes for bookmap for 2.0   The issue is only with glossref, which defaults @print to “no”.   There are a number of issues with the bookmap design.   For example, all the specialized topicref types should be a separate domain so that they can be used in other map types (although our DITA 1.3 ability to use elements from structural domains as though they were domains helps there).   There needs to be a wrapper element around the body topicrefs so that there is a consistent frontmatter/body/appendixes/backmatter structure.   Need to be able to have chapters before the first part.   The book-specific metadata needs to be a separate domain and is woefully underspecified (for example, no provision for 13-digit ISBNs, no provision for ISSNs, no provision for forms of license other than copyright, etc.   There are also places where the design doesn’t allow extension where it should although I’d have to remind myself of the details.   Need more features to enable glossary generation—current glossarylist is not sufficient. Probably need a separate glossary topicref type (from the same domain that provides glossref) to provide  clearer signal that a subtree of the map is in fact a glossary.   I’m sure there is more…   Cheers,   E. -- Eliot Kimber http://contrext.com       From: < dita@lists.oasis-open.org > on behalf of Scott Hudson < scott.hudson@jeppesen.com > Date: Tuesday, February 21, 2017 at 11:05 AM To: Eric Sirois < eric.sirois@ixiasoft.com >, dita@lists.oasis-open.org < dita@lists.oasis-open.org > Subject: Re: [dita] RE: Overall fixes for bookmap for 2.0   Well, the most annoying thing IMO is that even if the keys resolve, they won’t show up in output unless you specifically set print=“yes”. I’ve run into this a ton with term/abbreviated-form.   —Scott   From: < dita@lists.oasis-open.org > on behalf of Éric Sirois < eric.sirois@ixiasoft.com > Date: Tuesday, February 21, 2017 at 10:03 AM To: Éric Sirois < eric.sirois@ixiasoft.com >, dita@lists.oasis-open.org < dita@lists.oasis-open.org > Subject: [dita] RE: Overall fixes for bookmap for 2.0   Specifically looking to allow Keydefs in a more natural position in the map versus the first instance were topicref is allowed in the current content model.  Are there other things that we have ignored about bookmaps in DITA 1.3?   É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       From: dita@lists.oasis-open.org [ mailto:dita@lists.oasis-open.org ] On Behalf Of Éric Sirois Sent: February 21, 2017 11:33 AM To: dita@lists.oasis-open.org Subject: [dita] Overall fixes for bookmap for 2.0   Hi,   We have a number of clients that have hit some limitations for keyref and ditavalref in bookmaps.  I would like to work on a proposal that would address those limitations in DITA 2.0.  Would it be possible to create a project entry in the DITA 2.0 project?   Kind regards,   É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       --------------------------------------------------------------------- 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


  • 9.  Re: [dita] RE: Overall fixes for bookmap for 2.0

    Posted 02-21-2017 21:06
      |   view attached
    I would love to just fix Bookmap but probably doing a bookmap2 is more appropriate for DITA 2.x.   Cheers,   E. -- Eliot Kimber http://contrext.com       From: <dita@lists.oasis-open.org> on behalf of Kristen James Eberlein <kris@eberleinconsulting.com> Date: Tuesday, February 21, 2017 at 2:45 PM To: <dita@lists.oasis-open.org> Subject: Re: [dita] RE: Overall fixes for bookmap for 2.0   The challenge is to figure out what we can do within the general framework of "Breaking backward compatibility is OK, but no major disruption." Will we want to: Revise bookmap design? Deprecate bookmap and replace it with a new design? Something else? That said, I think starting with compiling the current pain points is the place to start. Keep those e-mails coming. Best, Kris Kristen James Eberlein Chair, OASIS DITA Technical Committee Principal consultant, Eberlein Consulting www.eberleinconsulting.com +1 919 682-2290; kriseberlein (skype) On 2/21/2017 2:48 PM, Amber Swope wrote: I agree with all the referencing-related improvements and also second the proposal to change how the bookmap metadata is structured. The deliverable metadata should not be limited only to bookmaps, is too limiting in its current structure, and doesn’t conform to any other standards (see other posts about the options for this).   As for the glossary generation, many of my clients struggle with presenting term/definition/alternative form (usually acronyms). The elements are available in the glossary topics, but there is no easy way to  structure or specify the generated list type in the deliverable map.   Thanks for starting this discussion.   Have a great day, Amber         From: dita@lists.oasis-open.org [mailto: dita@lists.oasis-open.org ] On Behalf Of Eliot Kimber Sent: Tuesday, February 21, 2017 9:16 AM To: Scott Hudson; Éric Sirois; dita@lists.oasis-open.org Subject: Re: [dita] RE: Overall fixes for bookmap for 2.0   The issue is only with glossref, which defaults @print to “no”.   There are a number of issues with the bookmap design.   For example, all the specialized topicref types should be a separate domain so that they can be used in other map types (although our DITA 1.3 ability to use elements from structural domains as though they were domains helps there).   There needs to be a wrapper element around the body topicrefs so that there is a consistent frontmatter/body/appendixes/backmatter structure.   Need to be able to have chapters before the first part.   The book-specific metadata needs to be a separate domain and is woefully underspecified (for example, no provision for 13-digit ISBNs, no provision for ISSNs, no provision for forms of license other than copyright, etc.   There are also places where the design doesn’t allow extension where it should although I’d have to remind myself of the details.   Need more features to enable glossary generation—current glossarylist is not sufficient. Probably need a separate glossary topicref type (from the same domain that provides glossref) to provide  clearer signal that a subtree of the map is in fact a glossary.   I’m sure there is more…   Cheers,   E. -- Eliot Kimber http://contrext.com       From: < dita@lists.oasis-open.org > on behalf of Scott Hudson < scott.hudson@jeppesen.com > Date: Tuesday, February 21, 2017 at 11:05 AM To: Eric Sirois < eric.sirois@ixiasoft.com >, " dita@lists.oasis-open.org " < dita@lists.oasis-open.org > Subject: Re: [dita] RE: Overall fixes for bookmap for 2.0   Well, the most annoying thing IMO is that even if the keys resolve, they won’t show up in output unless you specifically set print=“yes”. I’ve run into this a ton with term/abbreviated-form.   —Scott   From: < dita@lists.oasis-open.org > on behalf of Éric Sirois < eric.sirois@ixiasoft.com > Date: Tuesday, February 21, 2017 at 10:03 AM To: Éric Sirois < eric.sirois@ixiasoft.com >, " dita@lists.oasis-open.org " < dita@lists.oasis-open.org > Subject: [dita] RE: Overall fixes for bookmap for 2.0   Specifically looking to allow Keydefs in a more natural position in the map versus the first instance were topicref is allowed in the current content model.  Are there other things that we have ignored about bookmaps in DITA 1.3?   É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       From: dita@lists.oasis-open.org [ mailto:dita@lists.oasis-open.org ] On Behalf Of Éric Sirois Sent: February 21, 2017 11:33 AM To: dita@lists.oasis-open.org Subject: [dita] Overall fixes for bookmap for 2.0   Hi,   We have a number of clients that have hit some limitations for keyref and ditavalref in bookmaps.  I would like to work on a proposal that would address those limitations in DITA 2.0.  Would it be possible to create a project entry in the DITA 2.0 project?   Kind regards,   É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       --------------------------------------------------------------------- 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


  • 10.  Re: [dita] RE: Overall fixes for bookmap for 2.0

    Posted 02-21-2017 17:31
    I think there may be two different issues at work here relative to the use of keys, glossref’s default of print=”no” and the fact that you can’t reliably crossref to resource-only keys.   If you have a cross reference from a topic to a key and that key is defined only as a resource-only resource (e.g., only defined on a <keydef>) then the target topic * should not be rendered * in any rendition and the cross reference should be unresolved. If the topic is also included as a normal-role resource but the key reference is to the resource-only key topic will be rendered but the cross reference should still not resolve because the reference was to a resource-only key. That is, the processing role of the target key matters.   In HTML, depending on how your processor works, the topic may be rendered for other reasons and the key reference may work * by accident * (even though it shouldn’t).   However, in PDF the resource-only * cannot be rendered * because it has not been put in the navigational flow of the publication and therefore the cross reference cannot be resolved, even by accident.   In order to have correct key-based cross references to topics you * must * use keys on navigation topicrefs. This should be true for * all * rendition types but it is necessarily true for PDF (because it’s a monolithic rendition type and therefore there’s no way for a resource-only topic to be accidently included in the result).   That is, given this map:   <map>   <title>My publication</title> <keydef keys=”topic-02” href= > … <topicref href= > </map>   And this reference in topic-one.dita:   <p>See <xref keyref=”topic-02”/>…</p>   The link as rendered should * never * be resolvable in any rendition because the key “topic-02” binds to a resource-only topic, which by definition * is not rendered *.   To make the cross reference resolvable you need to include topic-02 in the navigation structure, e.g.:   <map>   <title>My publication</title> <topicref keys=”topic-02” href= > <topicref href= > </map>   Or:   <map>   <title>My publication</title> <keydef keys=”topic-02-resonly” href= > … <topicref href= > <topicref keys=”topic-02” keyref=”topic-02-resonly”/> </map>   Cheers,   E.   -- Eliot Kimber http://contrext.com       From: <dita@lists.oasis-open.org> on behalf of Scott Hudson <scott.hudson@jeppesen.com> Date: Tuesday, February 21, 2017 at 11:05 AM To: Eric Sirois <eric.sirois@ixiasoft.com>, "dita@lists.oasis-open.org" <dita@lists.oasis-open.org> Subject: Re: [dita] RE: Overall fixes for bookmap for 2.0   Well, the most annoying thing IMO is that even if the keys resolve, they won’t show up in output unless you specifically set print=“yes”. I’ve run into this a ton with term/abbreviated-form.   —Scott   From: < dita@lists.oasis-open.org > on behalf of Éric Sirois < eric.sirois@ixiasoft.com > Date: Tuesday, February 21, 2017 at 10:03 AM To: Éric Sirois < eric.sirois@ixiasoft.com >, " dita@lists.oasis-open.org " < dita@lists.oasis-open.org > Subject: [dita] RE: Overall fixes for bookmap for 2.0   Specifically looking to allow Keydefs in a more natural position in the map versus the first instance were topicref is allowed in the current content model.  Are there other things that we have ignored about bookmaps in DITA 1.3?   É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       From: dita@lists.oasis-open.org [ mailto:dita@lists.oasis-open.org ] On Behalf Of Éric Sirois Sent: February 21, 2017 11:33 AM To: dita@lists.oasis-open.org Subject: [dita] Overall fixes for bookmap for 2.0   Hi,   We have a number of clients that have hit some limitations for keyref and ditavalref in bookmaps.  I would like to work on a proposal that would address those limitations in DITA 2.0.  Would it be possible to create a project entry in the DITA 2.0 project?   Kind regards,   É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       --------------------------------------------------------------------- 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