Extensibility in Modules

[Ryan King <ryanki@microsoft.com>]

Hello, TC members. As a follow-up to the TC call this morning, I would like some direction on encapsulating terminology in XLIFF 2.0. As stated in the spec:

 

http://docs.oasis-open.org/xliff/xliff-core/v2.0/xliff-core-v2.0.html#glossary-module

*Simple* glossaries, consisting of a list of terms with a definition or translation, can be optionally embedded in an XLIFF document using the namespace mechanism to include elements from the Glossary module.

 

We have some *complex* terminology needs that cannot be encapsulated currently in the <gls:glossary> module. We have chosen, therefore, to use <mda:metadata> to encapsulate this data for better chance of interoperability instead of writing our own extension. Currently, this <mda:metadata> block is found at <unit> level. However, David Filip mentioned on the call that since <gls:glossary> was made extensible, it could contain <mda:metadata>. I want to confirm if the consensus is that this is indeed the case. The spec isn’t clear on this from my point of view. Here is what the spec says about extensibility:

 

http://docs.oasis-open.org/xliff/xliff-core/v2.0/xliff-core-v2.0.html#extensions

4.9.1 Extension Points

The following XLIFF Core elements allow storing custom data in <mda:metadata> elements or in elements from a custom XML namespace:

- <file>

- <group>

- <unit>

[…]

4.9.1.1 Extensibility of XLIFF Modules

For extensibility of XLIFF Modules please refer to the relevant Module Sections.

 

So, it is explicit in 4.9.1 that <mda:metadata> can only be used in <file>, <group>. And <unit> in core. To determine, the use of <mda:metadata> in modules, 4.9.1.1 refers me to the relevant module. In this case, <gls:glossary>, which does NOT explicitly state that <mda:metadata> can be used:

 

<glossary>

|

+---<glossEntry> +

  |

  +---<term> 1

  |

  +---<translation> *

  |

  +---<definition> ?

  |

  +---<other> *

 

However, <mtc:matches> does explicitly state it, and in fact, it is the only module that does:

 

<matches>

|

+---<match> +

  |

  +---<mda:metadata> ?

  |

  +---<xlf:originalData> ?

  |

  +---<xlf:source> 1

  |

  +---<xlf:target> 1

  |

  +---<other> *

 

So, does the use of <mda:metadata> in a module require it to be explicitly called out as it is in core and <mtc:matches> or can <mda:metadata> be treated like any extension and be found where <other> is specified?

 

Thanks,

Ryan