(Y29) Enhanced Commenting Support - DONE
Importance: Must Have
Category: Specification and Schema
- Allow a comment to be associated with specific content inside the source or target of a trans-unit.
- Allow a comment to be associated with content that spans across segments and trans-units.
- Allow extensible meta-data to be associated with a comment.
State: Done Core/Module: Not determined
David Spec sign-off: YES
Tom Schema sign-off: No
Spec Updated: Yes. Schema Updated: No
Items 1) and 2) can be addressed as follows:
Enhance the annotation mechanism in XLIFF 2.0 to allow a <note> to be associated with specifically marked content in the source and/or target:
Add a new value "mrk" for the annotates attribute of the <note> element.
Add a new attribute id on the <note> element, to be used when annotates="mrk". This attribute should be an ID type.
Add a new value "note" for the type attribute on the <mrk> element.
Add a new attribute nid to the <mrk> element. This attribute should be an ID reference to the id value of an existing <note> element.
Here is an example (pretty-printed for ease of reading):
<trans-unit> <source>First sentence. Interesting sentence. Last sentence.</source> <seg-source> <mrk mtype="seg" mid="1">First sentence.</mrk> <mrk mtype="seg" mid="2">Interesting sentence.</mrk> <mrk mtype="seg" mid="3">Last sentence.</mrk> </seg-source> <target> <mrk mtype="seg" mid="1">Första meningen.</mrk> <mrk mtype="seg" mid="2">En <mrk mtype="note" nid="note1">underlig</mrk> mening.</mrk> <mrk mtype="seg" mid="3">Sista meningen.</mrk> </target> <note annotates="mrk" id="note1" from="reviewer">Inappropriate in this context.</note> </trans-unit>
A single <note> can reference multiple <mrk> elements. This allows associating a single remark with multiple instances or concepts.
Using this mechansim corresponding source and target content can be associated with the note, which could be particularly useful when commenting on terminology choices. (An <mrk mtype=”note”> with the same nid value can be applied to the <seg-source> content as well as to <target> content.)
The scope of the note can also extend across more than one trans-unit, if <mrk mtype="note"> elements with the same nid are added to multiple trans-units.
Ability to associate additional information with a comment could be used for things like:
- Author, date, severity level
- Discussion threads
- Tracking status of commented issues
Allowing custom attributes on the <note> element would allow such information to be associated with comments.
Back to XLIFF2.0/FeatureTracking