Lightweight DITA SC

 View Only
  • 1.  LwDITA Specialization model and learning content

    Posted 03-17-2017 19:21
    Dear LW DITA SC - I've taken a fresh look at the set of LW DITA sample topics for learning, which came out some discussions we had back in 2015. See - https://www.oasis-open.org/apps/org/workgroup/dita-lightweight-dita/email/archives/201601/msg00000.html . And I've now also taken a new look at the section on LwDITA Specialization model in the draft spec. I think the specialization model holds up very well for use with the sample learning topics. Below is my take on the Overview topic. I would think that applying the template to the sample summary and assessment topics would be equally straightforward. 1) XDITA topic for a learning overview <overview id="overview_h2m_lg4_45"> <title>My LW Overview</title> <shortdesc>Here's a working sample of a LW DITA overview topic.</shortdesc> <overviewbody> <prereqs><title>Prerequisites</title> <p>Do we need a prereq section and would it always come first?</p> </prereqs> <objectives> <objectivesStem>Here's some objectives:</objectivesStem> <objectivesGroup id="objectivesGroup_llz_qg4_45"> <objective>Content of each objective is restricted to common inline</objective> <objective>Keep it easy</objective> <objective>Keep it light</objective> </objectivesGroup> </objectives> <section> <title>More sections</title> <p>And more sections as needed for additional content.</p> </section> </overviewbody> </overview> 2) XDITA specialization template for a learning overview <topic id="overview_h2m_lg4_45" specname="overview"> <title>My LW Overview</title> <shortdesc>Here's a working sample of a LW DITA overview topic.</shortdesc> <body specname="overviewbody"> <section specname="prereqs"> <title>Prerequisites</title> <p>Do we need a prereq section and would it always come first?</p> </section> <section specname="objectives"> <ph spename="objectivesStem">Here's some objectives:</ph> <ul specname="objectivesGroup"> <li specname="objective">Content of each objective is restricted to common inline</li> <li specname="objective">Keep it easy</li> <li specname="objective">Keep it simple</li> </ul> </section> <section> <title>More sections</title> <p>And more sections as needed for additional content.</p> </section> </body> </topic> I have not tried anything further, but it looks to me that what's available in the proposed LwDITA provides sufficient support for representing basic learning content, including simple assessments. Interested in what others think. Thanks. John Hunt Senior Technical Content Architect IBM Collaboration Solutions User Experience: Design and Information Excellence


  • 2.  Re: [dita-lightweight-dita] LwDITA Specialization model and learning content

    Posted 03-17-2017 20:28
      |   view attached
    Dear John and all, I updated your <objectivesStem> to a <p> instead of a <ph> (needs to be a block element), and wrapped your objectives in <p> (remember list items in XDITA need paragraphs). Then I worked some of Tim's tool magic and the attached shows the resulting topic and RNG file... looking good. Best, Carlos --  Carlos Evia, Ph.D. Director of Professional and Technical Writing Associate Professor of Technical Communication Department of English Center for Human-Computer Interaction Virginia Tech Blacksburg, VA 24061-0112 (540)200-8201 On Fri, Mar 17, 2017 at 3:20 PM, John Hunt < john_hunt@us.ibm.com > wrote: Dear LW DITA SC - I've taken a fresh look at the set of LW DITA sample topics for learning, which came out some discussions we had back in 2015. See - https://www.oasis-open.org/ apps/org/workgroup/dita- lightweight-dita/email/ archives/201601/msg00000.html . And I've now also taken a new look at the section on LwDITA Specialization model in the draft spec. I think the specialization model holds up very well for use with the sample learning topics. Below is my take on the Overview topic. I would think that applying the template to the sample summary and assessment topics would be equally straightforward. 1) XDITA topic for a learning overview <overview id="overview_h2m_lg4_45">  <title>My LW Overview</title>  <shortdesc>Here's a working sample of a LW DITA overview topic.</shortdesc>  <overviewbody>   <prereqs><title>Prerequisites< /title>     <p>Do we need a prereq section and would it always come first?</p>   </prereqs>   <objectives>    <objectivesStem>Here's some objectives:</objectivesStem>    <objectivesGroup id="objectivesGroup_llz_qg4_ 45">     <objective>Content of each objective is restricted to common inline</objective>     <objective>Keep it easy</objective>     <objective>Keep it light</objective>    </objectivesGroup>   </objectives>   <section>    <title>More sections</title>    <p>And more sections as needed for additional content.</p>   </section>  </overviewbody> </overview> 2) XDITA specialization template for a learning overview <topic id="overview_h2m_lg4_45" specname="overview">   <title>My LW Overview</title>   <shortdesc>Here's a working sample of a LW DITA overview topic.</shortdesc>   <body specname="overviewbody">     <section specname="prereqs">       <title>Prerequisites</title>       <p>Do we need a prereq section and would it always come first?</p>     </section>     <section specname="objectives">       <ph spename="objectivesStem">Here' s some objectives:</ph>       <ul specname="objectivesGroup">         <li specname="objective">Content of each objective is restricted to common inline</li>         <li specname="objective">Keep it easy</li>         <li specname="objective">Keep it simple</li>       </ul>     </section>     <section>       <title>More sections</title>       <p>And more sections as needed for additional content.</p>     </section>   </body> </topic> I have not tried anything further, but it looks to me that what's available in the proposed LwDITA provides sufficient support for representing basic learning content, including simple assessments. Interested in what others think. Thanks. John Hunt Senior Technical Content Architect IBM Collaboration Solutions User Experience: Design and Information Excellence Attachment: overview.rng Description: Binary data <?xml version="1.0" encoding="UTF-8"?> <?xml-model href="overview.rng" schematypens=" http://relaxng.org/ns/structure/1.0" ;?> <overview id="someID"> <title></title> <shortdesc>Here's a working sample of a LW DITA overview topic.</shortdesc> <overviewbody> <prereqs><title>Prerequisites</title> <p>Do we need a prereq section and would it always come first?</p> </prereqs> <objectives> <objectivesStem>Here's some objectives:</objectivesStem> <objectivesGroup id="objectivesGroup_llz_qg4_45"> <objective><p>Content of each objective is restricted to common inline</p></objective> <objective><p>Keep it easy</p></objective> <objective><p>Keep it light</p></objective> </objectivesGroup> </objectives> <section> <title>More sections</title> <p>And more sections as needed for additional content.</p> </section> </overviewbody> </overview>

    Attachment(s)

    xml
    overview.xml   1 KB 1 version