Glossary clarification?
I see on: https://wiki.openstack.org/wiki/I18nTeam/docs-translation "08/21/2014 - Waiting for a feedback from the doc team about the content of the Glossary " What exactly is your question? could you give some background, please? Andreas -- Andreas Jaeger aj@{suse.com,opensuse.org} Twitter/Identica: jaegerandi SUSE LINUX Products GmbH, Maxfeldstr. 5, 90409 Nürnberg, Germany GF: Jeff Hawn,Jennifer Guild,Felix Imendörffer,HRB16746 (AG Nürnberg) GPG fingerprint = 93A3 365E CE47 B889 DF7F FED1 389A 563C C272 A126
Hi, Andreas Thank you for asking. My question is: I see glossary is a part of documents, not a single document. If we translate glossary, could it be published alone? How could translators see their results of work? I had a talk with Tom Fifiled. He helped to address these questions: There is one XML file that includes all glossary terms. When a book uses a glossary term inside, doc authors mark it with some special syntax, eg. <glossterm>account</glossterm>, This generates a custom glossary for each book. This is why I see a different glossary for each book. That entire file is actually published to http://docs.openstack.org/glossary/. If glossary-terms.xml is translated (https://github.com/openstack/openstack-manuals/tree/master/doc/glossary), then all books will have a translated glossary and that particular special page will also be translated. Note also: the operations guide has a copy of the glossary. This is automatically copied. It is an identical file. (https://github.com/openstack/operations-guide/tree/master/doc/glossary) So only glossary-terms.xml in the openstack-manuals/doc/glossary folder needs translation. Translations will also be automatically copied to operations-guide repository. I also talked with Tom about how to display the localized glossary. If the localized glossary could be displayed with both English terms and localized terms, it will be wonderful. i.e. English term is ahead, localized term is followed in a same line, Below is the explanation, completed localized. The localized glossary page will include the mapping information between English term to localized term. And the terms could be sorted in English alphabetical order. That will be display a great localized glossary. But we need write some scripts to implement such function. Any thoughts or comments? Best regards Ying Chun Guo (Daisy) Andreas Jaeger <aj@suse.com> wrote on 2014/08/22 00:59:58:
Andreas Jaeger <aj@suse.com> 2014/08/22 00:59
To
"openstack-i18n@lists.openstack.org" <openstack-i18n@lists.openstack.org>,
cc
Subject
[Openstack-i18n] Glossary clarification?
I see on: https://wiki.openstack.org/wiki/I18nTeam/docs-translation "08/21/2014 - Waiting for a feedback from the doc team about the content of the Glossary "
What exactly is your question? could you give some background, please?
Andreas -- Andreas Jaeger aj@{suse.com,opensuse.org} Twitter/Identica: jaegerandi SUSE LINUX Products GmbH, Maxfeldstr. 5, 90409 Nürnberg, Germany GF: Jeff Hawn,Jennifer Guild,Felix Imendörffer,HRB16746 (AG Nürnberg) GPG fingerprint = 93A3 365E CE47 B889 DF7F FED1 389A 563C C272 A126
_______________________________________________ Openstack-i18n mailing list Openstack-i18n@lists.openstack.org http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-i18n
On 08/22/2014 07:39 AM, Ying Chun Guo wrote:
Hi, Andreas
Thank you for asking. My question is: I see glossary is a part of documents, not a single document.
It's published on its own as reference in a "hidden" way: http://docs.openstack.org/glossary/
If we translate glossary, could it be published alone? How could translators see their results of work?
We can always use the drafts-i18n page to publish it.
I had a talk with Tom Fifiled. He helped to address these questions:
Great.
There is one XML file that includes all glossary terms. When a book uses a glossary term inside, doc authors mark it with some special syntax, eg. <glossterm>account</glossterm>, This generates a custom glossary for each book. This is why I see a different glossary for each book.
Also, the glossary entries are shown directly if you hover over them, see http://docs.openstack.org/trunk/install-guide/install/zypper/content/ch_over... and look at the amber boxes.
That entire file is actually published to http://docs.openstack.org/glossary/. If glossary-terms.xml is translated (https://github.com/openstack/openstack-manuals/tree/master/doc/glossary), then all books will have a translated glossary and that particular special page will also be translated. Note also: the operations guide has a copy of the glossary. This is automatically copied. It is an identical file. (https://github.com/openstack/operations-guide/tree/master/doc/glossary) So only glossary-terms.xml in the openstack-manuals/doc/glossary folder needs translation. Translations will also be automatically copied to operations-guide repository.
I also talked with Tom about how to display the localized glossary. If the localized glossary could be displayed with both English terms and localized terms, it will be wonderful. i.e. English term is ahead, localized term is followed in a same line, Below is the explanation, completed localized.
The localized glossary page will include the mapping information between English term to localized term. And the terms could be sorted in English alphabetical order. That will be display a great localized glossary. But we need write some scripts to implement such function.
Yeah, this might need some extra scripting.
Any thoughts or comments?
I'm not sure how to do this glossary translation best - but you should be aware of it since it will give you only partial translated manuals... Andreas -- Andreas Jaeger aj@{suse.com,opensuse.org} Twitter/Identica: jaegerandi SUSE LINUX Products GmbH, Maxfeldstr. 5, 90409 Nürnberg, Germany GF: Jeff Hawn,Jennifer Guild,Felix Imendörffer,HRB16746 (AG Nürnberg) GPG fingerprint = 93A3 365E CE47 B889 DF7F FED1 389A 563C C272 A126
Andreas Jaeger <aj@suse.com> wrote on 2014/08/22 15:16:30:
Andreas Jaeger <aj@suse.com> 2014/08/22 15:16
To
Ying Chun Guo/China/IBM@IBMCN,
cc
"openstack-i18n@lists.openstack.org" <openstack-i18n@lists.openstack.org>
Subject
Re: [Openstack-i18n] Glossary clarification?
On 08/22/2014 07:39 AM, Ying Chun Guo wrote:
Hi, Andreas
Thank you for asking. My question is: I see glossary is a part of documents, not a single document.
It's published on its own as reference in a "hidden" way: http://docs.openstack.org/glossary/
If we translate glossary, could it be published alone? How could translators see their results of work?
We can always use the drafts-i18n page to publish it.
I had a talk with Tom Fifiled. He helped to address these questions:
Great.
There is one XML file that includes all glossary terms. When a book uses a glossary term inside, doc authors mark it with some special syntax, eg. <glossterm>account</glossterm>, This generates a custom glossary for each book. This is why I see a different glossary for each book.
Also, the glossary entries are shown directly if you hover over them, see http://docs.openstack.org/trunk/install-guide/install/zypper/ content/ch_overview.html and look at the amber boxes.
That entire file is actually published to http://docs.openstack.org/glossary/. If glossary-terms.xml is translated
(https://github.com/openstack/openstack-manuals/tree/master/doc/glossary),
then all books will have a translated glossary and that particular special page will also be translated. Note also: the operations guide has a copy of the glossary. This is automatically copied. It is an identical file.
(https://github.com/openstack/operations-guide/tree/master/doc/glossary)
So only glossary-terms.xml in the openstack-manuals/doc/glossary folder needs translation. Translations will also be automatically copied to operations-guide repository.
I also talked with Tom about how to display the localized glossary. If the localized glossary could be displayed with both English terms and localized terms, it will be wonderful. i.e. English term is ahead, localized term is followed in a same line, Below is the explanation, completed localized.
The localized glossary page will include the mapping information between English term to localized term. And the terms could be sorted in English alphabetical order. That will be display a great localized glossary. But we need write some scripts to implement such function.
Yeah, this might need some extra scripting.
Any thoughts or comments?
I'm not sure how to do this glossary translation best - but you should be aware of it since it will give you only partial translated manuals...
What do you mean by "partial translated manuals" ?
Andreas -- Andreas Jaeger aj@{suse.com,opensuse.org} Twitter/Identica: jaegerandi SUSE LINUX Products GmbH, Maxfeldstr. 5, 90409 Nürnberg, Germany GF: Jeff Hawn,Jennifer Guild,Felix Imendörffer,HRB16746 (AG Nürnberg) GPG fingerprint = 93A3 365E CE47 B889 DF7F FED1 389A 563C C272 A126
On 08/22/2014 10:51 AM, Ying Chun Guo wrote:
Andreas Jaeger <aj@suse.com> wrote on 2014/08/22 15:16:30:
Andreas Jaeger <aj@suse.com> 2014/08/22 15:16
To
Ying Chun Guo/China/IBM@IBMCN,
cc
"openstack-i18n@lists.openstack.org" <openstack-i18n@lists.openstack.org>
Subject
Re: [Openstack-i18n] Glossary clarification?
On 08/22/2014 07:39 AM, Ying Chun Guo wrote:
Hi, Andreas
Thank you for asking. My question is: I see glossary is a part of documents, not a single document.
It's published on its own as reference in a "hidden" way: http://docs.openstack.org/glossary/
If we translate glossary, could it be published alone? How could translators see their results of work?
We can always use the drafts-i18n page to publish it.
I had a talk with Tom Fifiled. He helped to address these questions:
Great.
There is one XML file that includes all glossary terms. When a book uses a glossary term inside, doc authors mark it with some special syntax, eg. <glossterm>account</glossterm>, This generates a custom glossary for each book. This is why I see a different glossary for each book.
Also, the glossary entries are shown directly if you hover over them, see http://docs.openstack.org/trunk/install-guide/install/zypper/ content/ch_overview.html and look at the amber boxes.
That entire file is actually published to http://docs.openstack.org/glossary/. If glossary-terms.xml is translated
(https://github.com/openstack/openstack-manuals/tree/master/doc/glossary),
then all books will have a translated glossary and that particular special page will also be translated. Note also: the operations guide has a copy of the glossary. This is automatically copied. It is an identical file. (https://github.com/openstack/operations-guide/tree/master/doc/glossary) So only glossary-terms.xml in the openstack-manuals/doc/glossary folder needs translation. Translations will also be automatically copied to operations-guide repository.
I also talked with Tom about how to display the localized glossary. If the localized glossary could be displayed with both English terms and localized terms, it will be wonderful. i.e. English term is ahead, localized term is followed in a same line, Below is the explanation, completed localized.
The localized glossary page will include the mapping information between English term to localized term. And the terms could be sorted in English alphabetical order. That will be display a great localized glossary. But we need write some scripts to implement such function.
Yeah, this might need some extra scripting.
Any thoughts or comments?
I'm not sure how to do this glossary translation best - but you should be aware of it since it will give you only partial translated manuals...
What do you mean by "partial translated manuals" ?
I mean that a document without glossary translations will have an English only chapter "Glossary" - and the popups will be in English as well. We could also consider removing the glossary for translated manuals completely, Andreas -- Andreas Jaeger aj@{suse.com,opensuse.org} Twitter/Identica: jaegerandi SUSE LINUX Products GmbH, Maxfeldstr. 5, 90409 Nürnberg, Germany GF: Jeff Hawn,Jennifer Guild,Felix Imendörffer,HRB16746 (AG Nürnberg) GPG fingerprint = 93A3 365E CE47 B889 DF7F FED1 389A 563C C272 A126
participants (2)
-
Andreas Jaeger
-
Ying Chun Guo