[Openstack-docs] Glossary usage in manuals

Lana Brindley openstack at lanabrindley.com
Tue Jan 14 23:04:32 UTC 2014


How do glossaries impact on our translation toolchain?

L

On 15/01/14 07:34, Nermina Miller wrote:
> Awesome ideas! Let me know if you need any help. - Nermina
>
> On Jan 14, 2014, at 4:26 PM, Andreas Jaeger <aj at suse.com> wrote:
>
>> I had some discussion with Diane and David about glossary usage and
>> summarize my understanding and a proposal here.
>>
>> We have a great glossary (see
>> http://docs.openstack.org/glossary/content/glossary.html)  and only the
>> Security Guide uses it to produce some entries:
>> http://docs.openstack.org/security-guide/content/go01.html
>>
>> We use in some places firstterm which is related to the glossary but
>> does not use it. I propose that we should not use firstterm at all and
>> use glossterm and include a glossary.
>>
>> I'd also like to investigate a nice Rackspace maven plug-in that allows
>> to use HTML popups for Glossary definitions.
>>
>> We can add the glossary to each book we build - either the complete
>> glossary or just the entries that use "glossterm" in the guide.
>>
>> My proposal is to make better use of the great glossary we have and thus:
>> * Deprecate firstterm usage, ask for glossterm
>> * Add glossterm to some terms
>> * Add the glossary to our manuals
>> * Display as glossary only the entries that are in the documented
>> * Evaluate the Rackspace glossary plug-in
>>
>> I propose to start with the Install Guide and then add further guides.
>>
>> What do you think?
>>
>> 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-docs mailing list
>> Openstack-docs at lists.openstack.org
>> http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs
>
>
> _______________________________________________
> Openstack-docs mailing list
> Openstack-docs at lists.openstack.org
> http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs
>


-- 
Lana Brindley
Technical Writer
Rackspace Cloud Builders Australia
http://lanabrindley.com



More information about the Openstack-docs mailing list