Adding inline codes

[Yves Savourel <ysavourel@enlaso.com>]

Hi all,

Working on the specification for representing added codes I've identified 3 ways to do additions:

1. Duplicating an existing code.
2. Add a new code from scratch.
3. Convert a section of the XLIFF text content into an inline code.

I've tried to described these cases below.
Could you please comment on this (especially the questions between brackets)?

Thanks,
-yves


General expectations:

- User agents may add new inline codes

- Merging tools may ignore added inline codes when creating the translated content in its original format.


=== For #1 (Duplicating an existing code):

- The base code must be cloneable.

- The id value of the new code must be different from any of the existing inline codes

[[QUESTION: what if an original code id=2 was deleted, and such value not being listed anymore, the new code is taking the value 2? This may cause the merger to think the new code is actually the deleted code. We can't keep track of the deletions. Should the id of the new code have a special reserved prefix? This would ensure unique id and identify added codes.]]

- If the base code is associated with some original data: the new code simply use these data.

- If the base code has no associated data, the new code must use the copyOf attribute to indicate the base code it is derived from. This allows the merging tool to know what original data to re-use.

[[QUESTION What happens if the base code is deleted after the new code is added? The copyOf would point to no-where. I suppose a processing expectation when deleting a code could be to check for added codes created from it and delete them as well, but this is getting quite complex again. Maybe new code should be created only if the original data can be duplicated (i.e. if the base code has some original data)?]]


=== For #2 (New code from scratch)

- The id value of the new code must be different from any of the existing inline codes. (same question as for #1)

- The original code may be added to the new inline code if the tool knows what such original code should be.

Or a type attribute must be provided to indicate to the merging tool what original data to generate when creating the output in the original format.


=== For #3 (New code from text content)

- The id value of the new code must be different from any of the existing inline codes. (same question as for #1)

- The original data is the part of text content that is identified as inline code.

Example, initial XLIFF: "Click <ui>Next</ui>"

Changed to: "Click <sc id="1">&lt;ui></sc>Next<ec rid="1">&lt;/ui></ec>"

Note: Converting XLIFF text content into original data for inline code may require tool-specific process as the tool which did the initial extraction may have applied some conversion to the original content to create the XLIFF content (e.g. un-escape special characters)