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

 


Help: OASIS Mailing Lists Help | MarkMail Help

dita-translation message

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

Subject: Acronym samples


Hi everybody -

In preparation for Monday's acronym discussion, I took two examples from
our original proposal, and placed them side by side with matching examples
from the merged acronym/glossary proposal. My hope is that this makes it
easier to compare the actual markup and to get a clear picture of what
authors or translators will actually see. This should be handy to look at
when discussing differences between the two during our meeting.

If I've left something out or gotten an element name wrong in samples for
either proposal, that's my fault, and not intentional. If something is
wrong, please let me know, and I'll try to get a new version out before our
meeting.

(See attached file: acronymproposals.html)

Thanks -

Robert D Anderson
IBM Authoring Tools Development
Chief Architect, DITA Open Toolkit
(507) 253-8787, T/L 553-8787 (Good Monday & Thursday)
Title: Acronym markup proposals

Acronym markup proposals

Sample markup from the various proposals

Note:
  • I've tried to line up literal samples from the original and revised acronym proposals. If something is missing or incorrect in either sample, then it is my mistake.
  • The examples below are my attempt to show literal markup differences between current proposals. If an element is not required in one, then it is not required in the other. The reason I put this together was to try to see, side by side, the differences in what a translator or author would see. I've left the xml:lang attribute off of each to simplify things, but readers can assume that it is properly set.
  • I've left a third column open just to point out that the merged proposal is not a final proposal, and if something is missing then the revised proposal should certainly include it.
Table 1. Weapons of Mass Destruction
  Original proposal Erik's merged proposal Revised proposal?
Reference 
<abbreviated-form
  conref="acronyms.dita#acronyms/wmd"/>
 
<abbreviated-form keyref="wmd"/>
  

English target
expanded = glossFullForm
short = glossAcronym
surface-form = glossSurfaceForm

 
<abbreviated-form id="wmd">
  <expanded>Weapons of Mass Destruction</expanded>
  <short>WMD</short>
  <surface-form>Weapons of 
     Mass Destruction (WMD)</surface-form>
</abbreviated-form>
 
<glossentry id="wmd">
  <glossAcronym>WMD</glossAcronym>
  <glossBody>
    <glossSurfaceForm>Weapons of 
        Mass Destruction (WMD)</glossSurfaceForm>
    <glossAlt><glossFullForm>Weapons of Mass 
       Destruction</glossFullForm></glossAlt>
  </glossBody>
</glossentry>
  

Translated target
expanded = glossFullForm
short = glossAcronym
surface-form = glossSurfaceForm

 
<abbreviated-form id="wmd">
  <expanded>armas de destrucción 
     masiva</expanded>
  <short/>
  <surface-form>armas de destrucción 
     masiva</surface-form>
</abbreviated-form>
 
<glossentry id="wmd">
  <glossAcronym>armas de destrucción 
       masiva</glossAcronym>
  <glossBody>
    <glossSurfaceForm>armas de destrucción 
       masiva</glossSurfaceForm>
    <glossAlt><glossFullForm>armas de 
       destrucción masiva</glossFullForm></glossAlt>
  </glossBody>
</glossentry>
  
Table 2. AIDS
  Original proposal Erik's merged proposal Revised proposal?
Reference 
<abbreviated-form
  conref="acronyms.dita#acronyms/aids"/>
 
<abbreviated-form keyref="aids"/>
  

English target
expanded = glossFullForm
short = glossAcronym
surface-form = glossSurfaceForm

 
<abbreviated-form id="aids">
  <expanded>acquired immunodeficiency
     syndrome</expanded>
  <short>AIDS</short>
  <surface-form>acquired immunodeficiency
     syndrome (AIDS)</surface-form>
</abbreviated-form>
 
<glossentry id="aids">
  <glossAcronym>AIDS</glossAcronym>
  <glossBody>
    <glossSurfaceForm>acquired immunodeficiency
      syndrome (AIDS)</glossSurfaceForm>
    <glossAlt><glossFullForm>acquired immunodeficiency
      syndrome</glossFullForm></glossAlt>
  </glossBody>
</glossentry>
  

Translated target
expanded = glossFullForm
short = glossAcronym
surface-form = glossSurfaceForm

 
<abbreviated-form id="aids">
  <expanded>síndrome de inmuno-deficiencia
     adquirida</expanded>
  <short>SIDA</short>
  <surface-form>síndrome de inmuno-deficiencia
     adquirida (SIDA)</surface-form>
</abbreviated-form>
 
<glossentry id="aids">
  <glossAcronym>SIDA</glossAcronym>
  <glossBody>
    <glossSurfaceForm>síndrome de
      inmuno-deficiencia adquirida
      (SIDA)</glossSurfaceForm>
    <glossAlt><glossFullForm>síndrome de
      inmuno-deficiencia adquirida</glossFullForm>
    </glossAlt>
  </glossBody>
</glossentry>
  
Table 3. The common file, all together
Original Proposal (English in the first row, Spanish in the next) Merged Proposal (English in the first row, Spanish in the next) 
<topic id="acronyms" xml:lang="en">
 <title>Title (ignored)</title>
 <body>
  <section>

   <abbreviated-form id="wmd">
    <expanded>Weapons of Mass Destruction</expanded>
    <short>WMD</short>
    <surface-form>Weapons of Mass Destruction (WMD)</surface-form>
   </abbreviated-form>

   <abbreviated-form id="aids">
    <expanded>acquired immunodeficiency syndrome</expanded>
    <short>AIDS</short>
    <surface-form>acquired immunodeficiency syndrome (AIDS)</surface-form>
   </abbreviated-form>

  </section>
 </body>
</topic>
 
<dita xml:lang="en">

 <glossentry id="wmd">
  <glossAcronym>WMD</glossAcronym>
  <glossBody>
   <glossSurfaceForm>Weapons of Mass Destruction (WMD)</glossSurfaceForm>
   <glossAlt>
    <glossFullForm>Weapons of Mass Destruction</glossFullForm>
   </glossAlt>
  </glossBody>
 </glossentry>

 <glossentry id="aids">
  <glossAcronym>AIDS</glossAcronym>
  <glossBody>
   <glossSurfaceForm>acquired immunodeficiency syndrome (AIDS)</glossSurfaceForm>
   <glossAlt>
    <glossFullForm>acquired immunodeficiency syndrome</glossFullForm>
   </glossAlt>
  </glossBody>
 </glossentry>

</dita>
 
<topic id="acronyms" xml:lang="es">
 <title>Title (ignored)</title>
 <body>
  <section>

   <abbreviated-form id="wmd">
    <expanded>armas de destrucción masiva</expanded>
    <short/>
    <surface-form>armas de destrucción masiva</surface-form>
   </abbreviated-form>

   <abbreviated-form id="aids">
    <expanded>síndrome de inmuno-deficiencia adquirida</expanded>
    <short>SIDA</short>
    <surface-form>síndrome de inmuno-deficiencia adquirida (SIDA)</surface-form>
   </abbreviated-form>

  </section>
 </body>
</topic>
 
<dita xml:lang="es">

 <glossentry id="wmd">
  <glossAcronym>armas de destrucción masiva</glossAcronym>
  <glossBody>
   <glossSurfaceForm>armas de destrucción masiva</glossSurfaceForm>
   <glossAlt>
    <glossFullForm>armas de destrucción masiva</glossFullForm>
   </glossAlt>
  </glossBody>
 </glossentry>

 <glossentry id="aids">
  <glossAcronym>SIDA</glossAcronym>
  <glossBody>
    <glossSurfaceForm>síndrome de inmuno-deficiencia adquirida (SIDA)</glossSurfaceForm>
   <glossAlt>
    <glossFullForm>síndrome de inmuno-deficiencia adquirida</glossFullForm>
   </glossAlt>
  </glossBody>
 </glossentry>

</dita>

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