typos and attribute name harmonization

git-svn-id: file:///home/ksmith/gitmigration/svn/xmpp/trunk@1770 4b5297f7-1745-476d-ba37-a9c6900126ab
This commit is contained in:
Peter Saint-Andre 2008-04-18 16:24:29 +00:00
parent f9dea23f10
commit 51fdf8c40b
1 changed files with 34 additions and 34 deletions

View File

@ -46,7 +46,7 @@
<version>0.3</version>
<date>2008-02-01</date>
<initials>kl/bf</initials>
<remark>Modified semantics to use IQ stanzas for communication with servers; changed dst_lang to destination_lang and src_lang to source_lang.</remark>
<remark>Modified semantics to use IQ stanzas for communication with servers; changed dst_lang to destination_lang and src_lang to source_lang; changed destination to destination_lang and derived_from to source_lang.</remark>
</revision>
<revision>
<version>0.2</version>
@ -86,7 +86,7 @@
</revision>
</header>
<section1 topic='Introduction' anchor='intro'>
<p>There currently exists no standard for describing language translations over a text chat protocol. While numerous products and services exist to provide translation of text, there exists no standardized protocol extension for requesting a translation and expressing the details of the translation XMPP (see &rfc3920;). This document describes how to express a translation and its components in an XMPP message as well as a method to request translation.</p>
<p>There currently exists no standard for describing language translations over a text chat protocol. While numerous products and services exist to provide translation of text, there exists no standardized protocol extension for requesting a translation and expressing the details of the translation over XMPP (see &rfc3920;). This document describes how to express a translation and its components in an XMPP message as well as a method to request translation.</p>
<p>Direct translation can be realized by either client-side translation before sending or transparent components translating messages on the fly. Discovering XMPP entities capable of translation allows for clients to request translation from them based on their capabilities. The remote XMPP entity could be either an automated translation service or a human providing translation.</p>
</section1>
<section1 topic='Glossary' anchor='glossary'>
@ -133,7 +133,7 @@
</ol>
</section1>
<section1 topic='Use Cases' anchor='usecases'>
<p>The following use cases simple scenarios for expression translation as well as requesting them from remote entities.</p>
<p>The following use cases illustrate simple scenarios for translation of expressions as well as requesting a translation from remote entities.</p>
<section2 topic='Message Delivery' anchor='delivery'>
<p>A message directly translated by the originating XMPP entity or a transparent XMPP entity delivered to a remote entity with only the required elements of source and destination language; this is the simplest case for a translation from one language to another. The source language is known because there is no &lt;translation/&gt; tag describing it. Three translation methods are supported by doing the following:</p>
<ol>
@ -148,8 +148,8 @@
<subject xml:lang='fr'>Bonjour</subject>
<body xml:lang='en'>How are you?</body>
<body xml:lang='fr'>comment allez-vous?</body>
<x xmlns='http://jabber.org/protocol/langtrans'>
<translation destination='fr' derived_from='en'/>
<x xmlns='urn:xmpp:tmp:langtrans'>
<translation destination_lang='fr' source_lang='en'/>
</x>
</message>
]]></example>
@ -164,9 +164,9 @@
<body xml:lang='fr'>comment allez-vous?</body>
<body xml:lang='en'>How are you?</body>
<body xml:lang='ru'>&#x41A;&#x430;&#x43A; &#x432;&#x44B;?</body>
<x xmlns='http://jabber.org/protocol/langtrans'>
<translation destination='en' derived_from='fr'/>
<translation destination='ru' derived_from='en'/>
<x xmlns='urn:xmpp:tmp:langtrans'>
<translation destination_lang='en' source_lang='fr'/>
<translation destination_lang='ru' source_lang='en'/>
</x>
</message>
]]></example>
@ -182,9 +182,9 @@
<body xml:lang='fr'>comment allez-vous?</body>
<body xml:lang='en'>How are you?</body>
<body xml:lang='ru'>&#x41A;&#x430;&#x43A; &#x432;&#x44B;?</body>
<x xmlns='http://jabber.org/protocol/langtrans'>
<translation destination='en' derived_from='fr' engine='SYSTRANS'/>
<translation destination='ru' derived_from='en' engine='SYSTRANS'/>
<x xmlns='urn:xmpp:tmp:langtrans'>
<translation destination_lang='en' source_lang='fr' engine='SYSTRANS'/>
<translation destination_lang='ru' source_lang='en' engine='SYSTRANS'/>
</x>
</message>
]]></example>
@ -223,7 +223,7 @@
<query xmlns='http://jabber.org/protocol/disco#info'>
...
<identity category='automation' type='translation'/>
<feature var='http://jabber.org/protocol/langtrans'/>
<feature var='urn:xmpp:tmp:langtrans'/>
...
</query>
</iq>
@ -233,12 +233,12 @@
<p>The supported languages and other details for the service must be known to use it. It is permissible for a translation service to provide multiple translation engines for the same language pairing -- if this is done, then a separate &lt;item/&gt; tag MUST be used for each pairing. A 'dictionary' attribute MAY be used to specify the dictionary for a specific &lt;item/&gt;. In order to specify more than one dictionary for a given language pairing then a separate &lt;item/&gt; tag MUST be used for each dictionary specification for that language pairing.</p>
<example caption='Entity queries service for further information'><![CDATA[
<iq type='get' to='translation.shakespeare.lit' from='bard@shakespeare.lit/globe'>
<query xmlns='http://jabber.org/protocol/langtrans#items'/>
<query xmlns='urn:xmpp:tmp:langtrans#items'/>
</iq>
]]></example>
<example caption='Service replies with language details'><![CDATA[
<iq type='result' to='bard@shakespeare.lit/globe' from=' translation.shakespeare.lit'>
<query xmlns=' http://jabber.org/protocol/langtrans#items'>
<query xmlns='urn:xmpp:tmp:langtrans#items'>
<item source_lang='en' jid='translation.shakespeare.lit' destination_lang='fr'
engine='SYSTRANS 2005 Release 2' pivotable='true'/>
<item source_lang='en' jid='translation.shakespeare.lit' destination_lang='ko'
@ -260,10 +260,10 @@
</section2>
<section2 topic='Requesting a Translation from a Service' anchor='request'>
<section3 topic='Requesting a Basic Translation' anchor='request-basic'>
<p>To request service from a translation provider you can send a message to a provider requesting translations. The lack of a 'derived_from' attribute in the &lt;translation/&gt; element indicates a request for a translation.</p>
<p>To request service from a translation provider you can send a message to a provider requesting translations. The lack of a 'source_lang' attribute in the &lt;translation/&gt; element indicates a request for a translation.</p>
<example caption='Entity requests a translation from English to French'><![CDATA[
<iq xmlns="jabber:client" from="bard@shakespeare.lt/globe" id="translationReq_2" to="translation.shakespeare.lit" type="get">
<x xmlns="http://jabber.org/protocol/langtrans">
<x xmlns="urn:xmpp:tmp:langtrans">
<source xml:lang="en">How are you?</source>
<translation destination_lang="fr"/>
</x>
@ -272,9 +272,9 @@
<example caption='Translation is returned from translation provider'><![CDATA[
<iq type="result" id="translationReq_2" from="translation.shakespeare.lit" to="bard@shakespeare.lt/globe">
<x xmlns="http://jabber.org/protocol/langtrans">
<x xmlns="urn:xmpp:tmp:langtrans">
<source xml:lang="en">hello, how are you?</source>
<translation destination_lang="fr" derived_from="en" engine="default">comment allez-vous?</translation>
<translation destination_lang="fr" source_lang="en" engine="default">comment allez-vous?</translation>
</x>
</iq>
]]></example>
@ -282,7 +282,7 @@
<section3 topic='Requesting a Translation With Multiple Destination Languages' anchor='request-multiple'>
<example caption='bard requests a translation from English to Italian and German'><![CDATA[
<iq xmlns="jabber:client" from="bard@shakespeare.lt/globe" id="translationReq_4" to="translation.shakespeare.lit" type="get">
<x xmlns="http://jabber.org/protocol/langtrans">
<x xmlns="urn:xmpp:tmp:langtrans">
<source xml:lang="en">How are you?</source>
<translation destination_lang="it"/>
<translation destination_lang="de"/>
@ -291,10 +291,10 @@
]]></example>
<example caption='Translation is returned from translation provider'><![CDATA[
<iq type="result" id="translationReq_4" from="translation.shakespeare.lit" to="bard@shakespeare.lt/globe">
<x xmlns="http://jabber.org/protocol/langtrans">
<x xmlns="urn:xmpp:tmp:langtrans">
<source xml:lang="en">How are you?</source>
<translation destination_lang="it" derived_from="en" engine="default">Come siete?</translation>
<translation destination_lang="de" derived_from="en" engine="default">Wie geht es Ihnen?</translation>
<translation destination_lang="it" source_lang="en" engine="default">Come siete?</translation>
<translation destination_lang="de" source_lang="en" engine="default">Wie geht es Ihnen?</translation>
</x>
</iq>
]]></example>
@ -303,7 +303,7 @@
<p>If a specific dictionary is required you MAY request a dictionary. This SHOULD have been returned when discoing the server although a dictionary MAY be requested which was not. The dictionaries are translation engine specific and are free form text.</p>
<example caption='Requests a translation from English to French using the &apos;medical&apos; dictionary'><![CDATA[
<iq xmlns="jabber:client" from="bard@shakespeare.lt/globe" id="translationReq_6" to="translation.shakespeare.lit" type="get">
<x xmlns="http://jabber.org/protocol/langtrans">
<x xmlns="urn:xmpp:tmp:langtrans">
<source xml:lang="en">How are you?</source>
<translation destination_lang="fr" dictionary="medical"/>
</x>
@ -311,16 +311,16 @@
]]></example>
<example caption='Translation provider returns translation with dictionary details'><![CDATA[
<iq type="result" id="translationReq_6" from="translation.shakespeare.lit" to="bard@shakespeare.lt/globe">
<x xmlns="http://jabber.org/protocol/langtrans">
<x xmlns="urn:xmpp:tmp:langtrans">
<source xml:lang="en">hello, how are you?</source>
<translation destination_lang="fr" derived_from="en" dictionary="medical" engine="default">comment allez-vous?</translation>
<translation destination_lang="fr" source_lang="en" dictionary="medical" engine="default">comment allez-vous?</translation>
</x>
</iq>
]]></example>
<p>If the translation service cannot complete the translation it SHOULD return a <item-not-found/> error indicating some part of the translation request was problematic, unless doing so would violate the privacy and security considerations in XMPP Core and XMPP IM, or local security and privacy policies.</p>
<example caption='Translation could not be completed'><![CDATA[
<iq type="error" id="translationReq_7" from="translation.shakespeare.lit" to="bard@shakespeare.lt/globe">
<x xmlns="http://jabber.org/protocol/langtrans">
<x xmlns="urn:xmpp:tmp:langtrans">
<source xml:lang="en">How are you?</source>
<translation destination_lang="dy"/>
</x>
@ -332,7 +332,7 @@
<p>If privacy or security considerations make returning an <item-not-found/> error not feasible it SHOULD return a <service-unavailable/> error.</p>
<example caption='Service unavailable'><![CDATA[
<iq type="error" id="translationReq_7" from="translation.shakespeare.lit" to="bard@shakespeare.lt/globe">
<x xmlns="http://jabber.org/protocol/langtrans">
<x xmlns="urn:xmpp:tmp:langtrans">
<source xml:lang="en">How are you?</source>
<translation destination_lang="dy"/>
</x>
@ -367,7 +367,7 @@
</section1>
<section1 topic='XMPP Registrar Considerations' anchor='registrar'>
<section2 topic='Protocol Namespaces' anchor='registrar-ns'>
<p>The &REGISTRAR; shall include 'http://jabber.org/protocol/langtrans' and 'http://jabber.org/protocol/langtrans#items' in its registry of protocol namespaces.</p>
<p>The &REGISTRAR; shall include 'urn:xmpp:tmp:langtrans' and 'urn:xmpp:tmp:langtrans#items' in its registry of protocol namespaces.</p>
</section2>
<section2 topic='Service Discovery Identities' anchor='registrar-identity'>
<p>The XMPP Registrar shall add a type of "translation" to the "automation" category in its registry of service discovery identities.</p>
@ -378,9 +378,9 @@
<code><![CDATA[
<?xml version='1.0' encoding='UTF-8'?>
<xs:schema
xmlns='http://jabber.org/protocol/langtrans'
xmlns='urn:xmpp:tmp:langtrans'
xmlns:xs='http://www.w3.org/2001/XMLSchema'
targetNamespace='http://jabber.org/protocol/langtrans'
targetNamespace='urn:xmpp:tmp:langtrans'
elementFormDefault='qualified'>
<xs:element name='x'>
@ -407,8 +407,8 @@
<xs:simpleContent>
<xs:extension base='empty'>
<xs:attribute name='charset' type='xs:string' use='optional'/>
<xs:attribute name='derived_from' type='xs:language' use='optional' />
<xs:attribute name='destination' type='xs:string' use='required'/>
<xs:attribute name='source_lang' type='xs:language' use='optional' />
<xs:attribute name='destination_lang' type='xs:string' use='required'/>
<xs:attribute name='dictionary' type='xs:string' use='required'/>
<xs:attribute name='engine' type='xs:string' use='optional' />
<xs:attribute name='reviewed' type='xs:boolean' use='optional' default='false'/>
@ -430,9 +430,9 @@
<code><![CDATA[
<?xml version='1.0' encoding='UTF-8'?>
<xs:schema
xmlns='http://jabber.org/protocol/langtrans#items'
xmlns='urn:xmpp:tmp:langtrans#items'
xmlns:xs='http://www.w3.org/2001/XMLSchema'
targetNamespace='http://jabber.org/protocol/langtrans#items'
targetNamespace='urn:xmpp:tmp:langtrans#items'
elementFormDefault='qualified'>
<xs:element name='query'>