OASIS XML Localisation Interchange File Format (XLIFF) TC

  • 1.  Definition of "core" and "modules"

    Posted 11-15-2011 21:10
    Hi,   Here’s a proposal for defining core and modules:   The core of XLIFF 2.0 is the minimum set of XML elements and attributes required to prepare a document that contains text extracted from one or more files for localization, can be enhanced with the translation of  the extracted text and allows the generation of translated versions of the original documents.   The namespace that corresponds to the core of XLIFF 2.0 is "urn:oasis:names:tc:xliff:document:2.0". All elements and attributes that belong to the core will be documented in the body of the XLIFF 2.0 specification   A module is an optional  set of XML elements and attributes that stores information about a process applied to an XLIFF document and the data incorporated to the document as result of that process.   Each module defined for XLIFF 2.0 must have its grammar defined in an independent XML Schema with a separate namespace. All elements and attributes that belong to a module will be documented in a dedicated annex of the XLIFF 2.0 specification.   Opinions?   Regards, Rodolfo -- Rodolfo M. Raya       rmraya@maxprograms.com Maxprograms       http://www.maxprograms.com  


  • 2.  Re: [xliff] Definition of "core" and "modules"

    Posted 11-15-2011 22:45
    Hi all, I think that Rodolfo's suggestion is a good start with this. It starts to address the problems about imprecision I've mentioned before about the core purpose of XLIFF. Here are few comments: The core of XLIFF 2.0 is the minimum set of XML elements and attributes required to prepare a document that contains text extracted from one or more files “for localization… My question is if we need to specify the kinds of localization we intend this to cover. For example, if we want to support localization of variable text for games that required mechanisms for including things like gender and number agreement and so forth, the core will have a bunch of things that won't exist if we're more limited. It seems to me that the core should cover items common to many types of localization, while leaving things like gaming, multimedia or other more specialized areas for modules. (But see my question about the intention of modules below.) As a result I would suggest that the core specify that we are going to support localization of documentation and general software, not everything that might be called localization. … can be enhanced with… Not certain that “enhanced” is the right term. How about “, can be completed with…”? …the translation of  the extracted text and allows the generation of translated versions of the original documents.   The namespace that corresponds to the core of XLIFF 2.0 is urn:oasis:names:tc:xliff:document:2.0 . All elements and attributes that belong to the core will be documented in the body of the XLIFF 2.0 specification Perfect. A module is an optional  set of XML elements and attributes that stores information about a process applied to an XLIFF document and the data incorporated to the document as result of that process.   Do modules only store information about a process applied to an XLIFF document ? Let's say that I create a module for variable text for games. Such a module may add additional constructs to the XLIFF document that are fundamental to the data to be translated, not a representation of a process applied to the document. I’m not trying to be pedantic with this question, because I think it's rather important: is a module only something applied to a core, or can it be a specialization of the core for a particular purpose from the beginning? This language might imply that the starting point is always a pure-core XLIFF file. If, however, the module can represent a specialization for something like gaming with requirements that cannot be represented in a core-only format, it has implications for interoperability and they may not be optional at all: you couldn't just ignore the modules in the file and do some processing and the module would go beyond just embedding some tool-specific data in the XLIFF file. So if I create a variable text module like this, have I violated the fundamentals of XLIFF? Each module defined for XLIFF 2.0 must have its grammar defined in an independent XML Schema with a separate namespace. Good. All elements and attributes that belong to a module will be documented in a dedicated annex of the XLIFF 2.0 specification. Can we change “that belong to a module” to “that belong to officially recognized modules”? We don't want anything that might appear to obligate us to include private modules in an annex to XLIFF 2.0. While I would hope people would document their modules publicly, we cannot make them do so. Opinions? Despite my questions, I think this is an excellent start of something very important. Thank you Rodolfo. -Arle


  • 3.  RE: [xliff] Definition of "core" and "modules"

    Posted 11-16-2011 13:02
    Hi all, One more note: >> The namespace that corresponds to the core of XLIFF >> 2.0 is "urn:oasis:names:tc:xliff:document:2.0". All >> elements and attributes that belong to the core >> will be documented in the body of the XLIFF 2.0 >> specification > > Perfect. > ... >> Each module defined for XLIFF 2.0 must have its >> grammar defined in an independent XML Schema with >> a separate namespace. > > Good. I think using different namespaces for the core and the various modules is fine. It will make things more strict, which is good. And more clear, which is also good. But this is also going to make implementation more complex for the tools, not more simple (one of the 2.0 goals). It will force tools to actually implement namespaces, not assume one like many do today. And remember that many users (e.g. localization engineers who may have to tinker with XLIFF files) simply don't understand namespaces very well. I agree with Rodolfo on using namespaces, but I just want to be sure everyone realizes the trade-offs. Cheers, -yves


  • 4.  RE: [xliff] Definition of "core" and "modules"

    Posted 11-16-2011 15:05
    Hi Yves, How would you separate core from modules without using namespaces? Regards, Rodolfo -- Rodolfo M. Raya rmraya@maxprograms.com Maxprograms http://www.maxprograms.com >


  • 5.  RE: [xliff] Definition of "core" and "modules"

    Posted 11-16-2011 15:32
    Hi Rodolfo, > How would you separate core from > modules without using namespaces? No very well. I suppose everything could be in the same namespace and the validation tool would know which element/attribute belongs to core, or which module. But, like you, I think using the different namespace is the way to go. I just wanted to be sure everyone is aware of the possible implications early on so we don't see anyone surprised by the possible drawbacks later on, when people start implementing. Cheers, -ys


  • 6.  RE: [xliff] Definition of "core" and "modules"

    Posted 11-16-2011 16:39
    Dave, Steven and I chatted quickly about this and we are in agreement with the discussion and the clarification. Bryan, I suggest post the final wording based on this thread and ask everyone to be ready to vote on the criteria definition in our next TC meeting. Thank you. Best regards, Helena Shih Chapman Globalization Technologies and Architecture +1-720-396-6323 or T/L 938-6323 Waltham, Massachusetts From:         "Rodolfo M. Raya" <rmraya@maxprograms.com> To:         "'XLIFF TC'" <xliff@lists.oasis-open.org> Date:         11/16/2011 10:07 AM Subject:         RE: [xliff] Definition of "core" and "modules" Sent by:         <xliff@lists.oasis-open.org> Hi Yves, How would you separate core from modules without using namespaces? Regards, Rodolfo -- Rodolfo M. Raya       rmraya@maxprograms.com Maxprograms       http://www.maxprograms.com >


  • 7.  Re: [xliff] Definition of "core" and "modules"

    Posted 11-17-2011 20:45
    After discussion with Rodolfo, here is the proposed text for voting. I've made a few minor grammatical corrections and given letters to the clauses in the first sentence for clarity: The core of XLIFF 2.0 consists of the minimum set of XML elements and attributes required to (a) prepare a document that contains text extracted from one or more files for localization, (b) allow it to be completed with the translation of  the extracted text, and (c) allow the generation of translated versions of the original document. The namespace that corresponds to the core of XLIFF 2.0 is urn:oasis:names:tc:xliff:document:2.0 . All elements and attributes that belong to the core will be documented in the body of the XLIFF 2.0 specification A module is an optional  set of XML elements and attributes that stores information about a process applied to an XLIFF document and the data incorporated into the document as result of that process. Each official module defined for XLIFF 2.0 must have its grammar defined in an independent XML Schema with a separate namespace. All elements and attributes that belong to a module will be documented in a dedicated annex of the XLIFF 2.0 specification. Unless there are other comment, I believe this is ready. -Arle


  • 8.  RE: [xliff] Definition of "core" and "modules"

    Posted 11-17-2011 21:31
    > Unless there are other comments, > I believe this is ready. I have one minor comment: I think there is no need to say how the core and the modules will be documented in the specification. This would give Rodolfo more leeway to do as needed later on. So the two parts: "All elements and attributes that belong to the core will be documented in the body of the XLIFF 2.0 specification" and "All elements and attributes that belong to a module will be documented in a dedicated annex of the XLIFF 2.0 specification." could be removed. But it's minor, and not a problem for me if they stay. Cheers, -yves