OASIS Darwin Information Typing Architecture (DITA) TC

  • 1.  Stage two: Issue #297 Allow example in more places

    Posted 10-02-2019 12:41
      |   view attached
    All, Please find attached the PDF of the stage two proposal: Issue #297 Allow example in more places I'd like to formally discuss this proposal at the next TC meeting. Corresponding DITA source at: http://tools.oasis-open.org/version-control/browse/wsvn/dita/trunk/DITA-2.0/stage-2/Issue297-AllowExampleWhereFig.dita Reviewed by: Kris Eberlein Carlos Evia Joyce Lam Thanks and best regards, --Scott Scott Hudson Content Technology Strategist, DS&A Information and Knowledge Services Jeppesen, A Boeing Company 55 Inverness Drive East Englewood, CO 80112 http://www.jeppesen.com < http://www.jeppesen.com/ > Attachment: Issue297-AllowExampleWhereFig.pdf Description: Issue297-AllowExampleWhereFig.pdf

    Attachment(s)



  • 2.  Re: [dita] Stage two: Issue #297 Allow example in more places

    Posted 10-04-2019 18:29
      |   view attached
    Hi Scott, It looks like the "Technical requirements" section could use a bit of cleanup. Specifically, the list of elements under "Add example to the following contexts" -- - It includes places you can already put <example>, so it won't actually be added; for example, <body>, <bodydiv>, <taskbody> - It doesn't include adding examples to <fig>, but that is called for explicitly in the Proposed Solution - If we are including elements from concept/task/reference in the list, then I think it's missing quite a few. If we're adding this everywhere that you can already put figures, then the list should include elements like <context>, <stepsection>, and <steptroubleshooting>; if we plan to exclude example from any of those contexts, we should make that clear. The full list of what allows <fig> -- at least in the technical content package -- is here: http://docs.oasis-open.org/dita/dita/v1.3/errata01/os/complete/part2-tech-content/contentmodels/cmtcf.html#cmtcf__fig Robert D. Anderson DITA-OT lead and Co-editor DITA 1.3 specification Marketing Services Center E-mail: robander@us.ibm.com 11501 BURNET RD,, TX, 78758-3400, AUSTIN, USA Scott Hudson ---10/02/2019 07:41:26 AM---All, Please find attached the PDF of the stage two proposal: Issue #297 Allow example in more plac From: Scott Hudson <scott.hudson@jeppesen.com> To: "dita@lists.oasis-open.org" <dita@lists.oasis-open.org> Date: 10/02/2019 07:41 AM Subject: [EXTERNAL] [dita] Stage two: Issue #297 Allow example in more places Sent by: <dita@lists.oasis-open.org> All, Please find attached the PDF of the stage two proposal: Issue #297  Allow example in more places I'd like to formally discuss this proposal at the next TC meeting. Corresponding DITA source at: http://tools.oasis-open.org/version-control/browse/wsvn/dita/trunk/DITA-2.0/stage-2/Issue297-AllowExampleWhereFig.dita   Reviewed by: Kris Eberlein Carlos Evia Joyce Lam Thanks and best regards, --Scott Scott Hudson Content Technology Strategist, DS&A Information and Knowledge Services Jeppesen, A Boeing Company 55 Inverness Drive East Englewood, CO 80112 http://www.jeppesen.com   < http://www.jeppesen.com/  >     [attachment "Issue297-AllowExampleWhereFig.pdf" deleted by Robert D Anderson/Rochester/IBM] --------------------------------------------------------------------- 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  


  • 3.  Re: [dita] Stage two: Issue #297 Allow example in more places

    Posted 10-07-2019 22:47




    All,
     
    I just posted a new update that includes Robert s feedback (thanks!) and an additional example at Kris request.
     
    Attached is the PDF. DITA source is here:
    Web View:  https://urldefense.proofpoint.com/v2/url?u=https-3A__tools.oasis-2Dopen.org_version-2Dcontrol_browse_wsvn_dita_-3Frev-3D3876-26sc-3D1&d=DwIDaQ&c=P3aKjizb3qsxp0SERaL2sw&r=YQWdLfM9mekBOdoMmoBdn9RgyqIHrveGolBbb4_uGWQ&m=Bh_pAZvN3wNHwrsjC0mnNlRe4W_wl6SEEZUjUGmEyFk&s=CzDLgoU0xvs3pjuzAx-SVGtm_dyZfISXuN1CZqCpVVA&e=
     
    Modified:
       trunk/DITA-2.0/stage-2/Issue297-AllowExampleWhereFig.dita
     
    Thanks and best regards,
     
    --Scott
     
    Scott Hudson
    Content Technology Strategist, DS&A Information and Knowledge Services
    Jeppesen, A Boeing Company
    55 Inverness Drive East
    Englewood, CO 80112
    303-328-6228  Cell: 303-350-7934
     

     
    http://www.jeppesen.com
     
     

    From:
    Robert D Anderson <robander@us.ibm.com>
    Date: Friday, October 4, 2019 at 12:28 PM
    To: Scott Hudson <scott.hudson@jeppesen.com>
    Cc: "dita@lists.oasis-open.org" <dita@lists.oasis-open.org>
    Subject: Re: [dita] Stage two: Issue #297 Allow example in more places


     


    Hi Scott,

    It looks like the "Technical requirements" section could use a bit of cleanup. Specifically, the list of elements under "Add example to the following contexts" --

    - It includes places you can already put <example>, so it won't actually be added; for example, <body>, <bodydiv>, <taskbody>
    - It doesn't include adding examples to <fig>, but that is called for explicitly in the Proposed Solution
    - If we are including elements from concept/task/reference in the list, then I think it's missing quite a few. If we're adding this everywhere that you can already put figures, then the list should include elements like <context>,
    <stepsection>, and <steptroubleshooting>; if we plan to exclude example from any of those contexts, we should make that clear. The full list of what allows <fig> -- at least in the technical content package -- is here:
    http://docs.oasis-open.org/dita/dita/v1.3/errata01/os/complete/part2-tech-content/contentmodels/cmtcf.html#cmtcf__fig






    Robert D. Anderson
    DITA-OT
    lead and Co-editor DITA 1.3 specification
    Marketing Services Center





     











    E-mail:
    robander@us.ibm.com

    11501 BURNET RD,, TX, 78758-3400, AUSTIN, USA









    Scott
    Hudson ---10/02/2019 07:41:26 AM---All, Please find attached the PDF of the stage two proposal: Issue #297 Allow example in more plac

    From: Scott Hudson <scott.hudson@jeppesen.com>
    To: "dita@lists.oasis-open.org" <dita@lists.oasis-open.org>
    Date: 10/02/2019 07:41 AM
    Subject: [EXTERNAL] [dita] Stage two: Issue #297 Allow example in more places
    Sent by: <dita@lists.oasis-open.org>






    All,

    Please find attached the PDF of the stage two proposal: Issue #297  Allow example in more places

    I'd like to formally discuss this proposal at the next TC meeting.

    Corresponding DITA source at:
    http://tools.oasis-open.org/version-control/browse/wsvn/dita/trunk/DITA-2.0/stage-2/Issue297-AllowExampleWhereFig.dita  


    Reviewed by:
    Kris Eberlein
    Carlos Evia
    Joyce Lam

    Thanks and best regards,

    --Scott

    Scott Hudson
    Content Technology Strategist, DS&A Information and Knowledge Services
    Jeppesen, A Boeing Company
    55 Inverness Drive East
    Englewood, CO 80112

    http://www.jeppesen.com   < http://www.jeppesen.com/  >
       

    [attachment "Issue297-AllowExampleWhereFig.pdf" deleted by Robert D Anderson/Rochester/IBM]

    ---------------------------------------------------------------------
    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  








    Attachment: Issue297-AllowExampleWhereFig.pdf Description: Issue297-AllowExampleWhereFig.pdf

    Attachment(s)



  • 4.  Re: [dita] Stage two: Issue #297 Allow example in more places

    Posted 10-04-2019 18:39
    Hi, Scott. I think you need to do some additional work on the Example section. At a minimum, I want to see an easy-to-understand code sample that is introduced by with text explaining what the code sample illustrates. Remember that these proposals are: Published and read by folks other than TC members Used as basis for the forthcoming spec Used as basis for presentations about DITA 2.0 If you are expecting that <example> in new places will have any auto-generated text or styling, it's good to include examples of that also. You also should consider having multiple examples, given the many new places that this proposal will permit <example>. Best, Kris Kristen James Eberlein Chair, OASIS DITA Technical Committee Principal consultant, Eberlein Consulting www.eberleinconsulting.com +1 919 622-1501; kriseberlein (skype) On 10/2/2019 8:41 AM, Scott Hudson wrote: All, Please find attached the PDF of the stage two proposal: Issue #297 Allow example in more places I'd like to formally discuss this proposal at the next TC meeting. Corresponding DITA source at: http://tools.oasis-open.org/version-control/browse/wsvn/dita/trunk/DITA-2.0/stage-2/Issue297-AllowExampleWhereFig.dita Reviewed by: Kris Eberlein Carlos Evia Joyce Lam Thanks and best regards, --Scott Scott Hudson Content Technology Strategist, DS&A Information and Knowledge Services Jeppesen, A Boeing Company 55 Inverness Drive East Englewood, CO 80112 http://www.jeppesen.com <http://www.jeppesen.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