OASIS Mailing List ArchivesView the OASIS mailing list archive below
or browse/search using MarkMail.


Help: OASIS Mailing Lists Help | MarkMail Help

dita message

[Date Prev] | [Thread Prev] | [Thread Next] | [Date Next] -- [Date Index] | [Thread Index] | [List Home]

Subject: Re: [dita] Stage one proposal: Allow <example> in same locations as <div>

Example is currently defined a being logically a specialization of <section> ("The <example> element is a section...") and thus can really only be allowed where <section> is allowed. Also, in the base topic definition, <example>, like <section>, is allowed anywhere within <body> (meaning you can mix <section> with other things in generic topics). Also in <refbody>. However, <conbody> is more restrictive (see below).

For 2.0 it would make sense to have <example> be specialized from <section> (and maybe moved into the software domain or maybe into a new "example" domain.) That would allow <example> to take <sectiondiv> (it can already take <div> by way of basic.block) and would also explicitly express what the prose of the spec already says ("example is-a section").

I think the issue Scott is referring to is that in concept <example> can only occur as a peer to <section> and must follow any non-section content of <body>, which means it can't be mixed with other elements, as it can in topic/body.

The only solution I can see to that that doesn't involve relaxing the content model of <conbody> is to define a new element, i.e., <examplediv>, that carries the "this is an example" semantic but is allowed wherever <div> is allowed, including within itself.


Eliot Kimber

ïOn 6/10/19, 7:05 PM, "Scott Hudson" <dita@lists.oasis-open.org on behalf of scott.hudson@jeppesen.com> wrote:

    The content model for example is much too restrictive, limiting how and where content can be semantically marked as exemplary content. As a result, writers often hardcode paragraphs with "For example:â" or
     other non-semantic constructions.
    By allowing <example> in more places, content can be properly tagged with the <example> semantic.
    If there are too many models to change, we could also allow <example> within <div>.
    Thanks and best regards,
    Voting member:
    Boeing Data Standards Technical Advisory Board
    OASIS DocBook TC (Secretary), Publishers SC (Chair)
    OASIS DITA TC, Tech Comm SC, LwDITA SC, Learning Content SC (Secretary)
    OASIS DITA Adoption TC
    OASIS Augmented Reality in Information Products (ARIP) TC
    Scott Hudson
    Content Technology Strategist
    Information and Knowledge Services
    A Boeing Company
    ph: 303.328.6228 | Mobile : 303.350.7934 | scott.hudson@jeppesen.com
    55 Inverness Drive East | Englewood, CO  80112 | www.jeppesen.com <http://www.jeppesen.com/>
    This document contains only administrative, uncontrolled data under U.S. International Traffic in Arms Regulations.

[Date Prev] | [Thread Prev] | [Thread Next] | [Date Next] -- [Date Index] | [Thread Index] | [List Home]