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: Stage 3 Proposal: Issue-85-AddSupSubToGlossElements


All,

 

I have had no review changes requested by my reviewers:
Bill Burns, Nancy Harrison

 

As such, I’d like to submit the stage 3 proposal for Issue-85-AddSupSubToGlossElements for your review and approval during the TC meeting tomorrow.

 

Please find the HTML version attached.

 

Thanks and best regards,

 

--Scott

 

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 Strategist, Digital Aviation Learning and Development

Jeppesen, A Boeing Company

55 Inverness Drive East

Englewood, CO  80112

303-328-6228 | Cell: 303-350-7934

 

/Users/scott.hudson/Library/Containers/com.microsoft.Outlook/Data/Library/Caches/Signatures/signature_401521775

 

This document contains only administrative, uncontrolled data under U.S. International Traffic in Arms Regulations.

Title: Stage 3 proposal: Feature #85

Stage 3 proposal: Feature #85

The <sub> and <sup> elements are not allowed in several elements from glossentry, which means that terms cannot be used properly in certain contexts. Since <sub> and <sup> are specialized from <ph>, adding the <ph> element solves the issue.

Champion

Scott Hudson

Tracking information

Event Date Links
Stage 1 proposal accepted 24 Oct 2017 https://lists.oasis-open.org/archives/dita/201711/msg00009.html
Stage 2 proposal submitted 5 Feb 2018 https://markmail.org/message/pk43srtwslyj3trd?q=Issue+85+list:org%2Eoasis-open%2Elists%2Edita
Stage 2 proposal discussed 13 Feb 2018 https://lists.oasis-open.org/archives/dita/201802/msg00050.html
Stage 2 proposal approved 20 Feb 2018 https://lists.oasis-open.org/archives/dita/201802/msg00071.html
Stage 3 proposal submitted to reviewers 22 May 2018 Bill Burns, Nancy Harrison
Stage 3 proposal (this document) submitted to TC 11 June 2018  

Approved technical requirements

Modify the content models to allow the <ph> element within the following elements:
  • <glossSurfaceForm>
  • <glossAcronym>
  • <glossSynonym>
  • <glossShortForm>
  • <glossAbbreviation>

Dependencies or interrelated proposals

None.

Modified grammar files

Renaming or refactoring elements and attributes
Content model name / location Original model Proposed model
glossSurfaceForm.content (glossentry.mod)

<!ENTITY % glossSurfaceForm.content
                       "(#PCDATA |
                         %keyword; |
                         %term; |
                         %text; |
                         %tm;)*"
>
<!ENTITY % glossSurfaceForm.content
                       "(#PCDATA |
                         %keyword; |
                         %term; |
                         %text; |
                         %tm; |
                         %ph;)*"
>
glossSurfaceForm.content (glossentryMod.rng)
<define name="glossSurfaceForm.content">
        <zeroOrMore>
          <choice>
            <text/>
            <ref name="keyword"/>
            <ref name="term"/>
            <ref name="text" dita:since="1.3"/>
            <ref name="tm"/>
          </choice>
        </zeroOrMore>
      </define>
<define name="glossSurfaceForm.content">
        <zeroOrMore>
          <choice>
            <text/>
            <ref name="keyword"/>
            <ref name="term"/>
            <ref name="text" dita:since="1.3"/>
            <ref name="tm"/>
            <ref name="ph" dita:since="2.0" />
          </choice>
        </zeroOrMore>
      </define>
glossAcronym.content (glossentry.mod)

<!ENTITY % glossAcronym.content
                       "(#PCDATA |
                         %keyword; |
                         %term; |
                         %text; |
                         %tm;)*"
>
<!ENTITY % glossAcronym.content
                       "(#PCDATA |
                         %keyword; |
                         %term; |
                         %text; |
                         %tm; |
                         %ph;)*"
>
glossAcronym.content (glossentryMod.rng)
<define name="glossAcronym.content">
           <zeroOrMore>
           <choice>
           <text/>
           <ref name="keyword"/>
           <ref name="term"/>
           <ref name="text" dita:since="1.3"/>
           <ref name="tm"/>
           </choice>
           </zeroOrMore>
           </define>
<define name="glossAcronym.content">
           <zeroOrMore>
           <choice>
           <text/>
           <ref name="keyword"/>
           <ref name="term"/>
           <ref name="text" dita:since="1.3"/>
           <ref name="tm"/>
           <ref name="ph" dita:since="2.0""/>
           </choice>
           </zeroOrMore>
           </define>
glossSynonym.content (glossentry.mod)

           <!ENTITY % glossSynonym.content
           "(#PCDATA |
           %keyword; |
           %term; |
           %text; |
           %tm;)*"
           >
<!ENTITY % glossSynonym.content
           "(#PCDATA |
           %keyword; |
           %term; |
           %text; |
           %tm; |
           %ph;)*"
           >
glossSynonym.content (glossentryMod.rng)
<define name="glossSynonym.content">
           <zeroOrMore>
           <choice>
           <text/>
           <ref name="keyword"/>
           <ref name="term"/>
           <ref name="text" dita:since="1.3"/>
           <ref name="tm"/>
           </choice>
           </zeroOrMore>
           </define>
<define name="glossSynonym.content">
           <zeroOrMore>
           <choice>
           <text/>
           <ref name="keyword"/>
           <ref name="term"/>
           <ref name="text" dita:since="1.3"/>
           <ref name="tm"/>
           <ref name="ph" dita:since="2.0" />
           </choice>
           </zeroOrMore>
           </define>
glossShortForm.content (glossentry.mod)

           <!ENTITY % glossShortForm.content
           "(#PCDATA |
           %keyword; |
           %term; |
           %text; |
           %tm;)*"
           >
<!ENTITY % glossShortForm.content
           "(#PCDATA |
           %keyword; |
           %term; |
           %text; |
           %tm; |
           %ph;)*"
           >
glossShortForm.content (glossentryMod.rng)
<define name="glossShortForm.content">
           <zeroOrMore>
           <choice>
           <text/>
           <ref name="keyword"/>
           <ref name="term"/>
           <ref name="text" dita:since="1.3"/>
           <ref name="tm"/>
           </choice>
           </zeroOrMore>
           </define>
<define name="glossShortForm.content">
           <zeroOrMore>
           <choice>
           <text/>
           <ref name="keyword"/>
           <ref name="term"/>
           <ref name="text" dita:since="1.3"/>
           <ref name="tm"/>
           <ref name="ph" dita:since="2.0" />
           </choice>
           </zeroOrMore>
           </define>
glossAbbreviation.content (glossentry.mod)

           <!ENTITY % glossAbbreviation.content
           "(#PCDATA |
           %keyword; |
           %term; |
           %text; |
           %tm;)*"
           >
<!ENTITY % glossAbbreviation.content
           "(#PCDATA |
           %keyword; |
           %term; |
           %text; |
           %tm; |
           %ph;)*"
           >
glossAbbreviation.content (glossentryMod.rng)
<define name="glossAbbreviation.content">
           <zeroOrMore>
           <choice>
           <text/>
           <ref name="keyword"/>
           <ref name="term"/>
           <ref name="text" dita:since="1.3"/>
           <ref name="tm"/>
           </choice>
           </zeroOrMore>
           </define>
<define name="glossAbbreviation.content">
           <zeroOrMore>
           <choice>
           <text/>
           <ref name="keyword"/>
           <ref name="term"/>
           <ref name="text" dita:since="1.3"/>
           <ref name="tm"/>
           <ref name="ph" dita:since="2.0" />
           </choice>
           </zeroOrMore>
           </define>

Modified terminology

None.

Modified specification documentation

The automatically generated content model descriptions include the <ph> for the affected content models:
  • <glossSurfaceForm>
  • <glossAcronym>
  • <glossSynonym>
  • <glossShortForm>
  • <glossAbbreviation>

No further topic changes are expected.

Migration plans for backward incompatibilities

There are no backward compatibility issues, since the <ph> element is an addition to existing content models.

No existing content needs to be migrated, since the <ph> element is an addition to existing content models.

Existing constraints or specializations might need to be adjusted or updated to remove unwanted elements from the glossary content models. One benefit, is that any elements or domains constrained in the shell DTDs (particularly from the equation, highlight, programming, software, user interface, and XML mention domains) are not allowed in the glossary models of the constrained shell.

All @domains- and @class-based processing of specialized elements and attributes continue to function exactly as before. Processors might need to be adjusted to account for the allowed children and specializations of <ph>, such as <xref>.



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