[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: [libreoffice-documentation] Indexing Clarification Needed


Hi Cathy,
Several people contributed to the Contributor Guide, and some parts of
it are out of date, as you know.

Some comments inline below.

On Thu, Nov 8, 2018 at 3:18 PM Cathy Crumbley <catcrumb@gmail.com> wrote:
>
> Hi All,
>
> The Contributor Guide is extremely helpful and I deeply appreciate that
> someone --presumably Jean--invested the time and energy to create it. I
> would just like a little bit of clarification.
>
> Chapter 2 provides guidelines for indexing. On page 11, the guidelines
> say: "The translators have requested that we do NOT create index entries
> that surround words or phrases in the text. Instead, we need to create
> entries that are embedded before or after the words or phrases to be
> included in the index."
>
> What is the rationale for not creating index entries that surround words
> or phrases? How does this help the translators?

Olivier or Sophie or someone can provide the technical explanation. My
understanding is that it interferes with the translation software
somehow.

> Then, in the next paragraph, it says "Either highlight the word or
> phrase to add to the index or place the cursor at the beginning of the
> word."
>
> This appears to contradict the previous paragraph, where it says to not
> highlight entire words and phrases. What should the guideline be?

This is ambiguous wording on my part. There is a difference between
"highlighting" the word or phrase before indexing it and "surrounding"
the word or phrase with the index entry itself, but it's hard to
explain.

> Two lines later, it says: "DO NOT simply accept the word or phrase shown
> in the Entry box. Instead, first change the word or phrase in some way,
> for example by typing a blank space at the end or (if appropriate)
> changing an initial uppercase letter to lowercase.
>
> This requirement seems puzzling. I am sure that there are good reasons
> for changing the word or phrase and would appreciate some insight.

That is simply an effective way to ensure that the index entry does
NOT "surround" the word or phrase, but instead is embedded just before
it. There are other ways, which might be better.

BTW, I think some of the indexing may have changed in the software;
I've recently noticed some things working differently (at least some
of the time) than they did when I wrote those instructions. If so, the
instructions may be out of date and need rewriting to match reality.

> Thanks for whatever clarification people can provide.
>
> Cathy
>

Regards, Jean

--
To unsubscribe e-mail to: documentation+unsubscribe@global.libreoffice.org
Problems? https://www.libreoffice.org/get-help/mailing-lists/how-to-unsubscribe/
Posting guidelines + more: https://wiki.documentfoundation.org/Netiquette
List archive: https://listarchives.libreoffice.org/global/documentation/
Privacy Policy: https://www.documentfoundation.org/privacy

Follow-Ups:
Re: [libreoffice-documentation] Indexing Clarification NeededOlivier Hallot <olivier.hallot@libreoffice.org>
References:
[libreoffice-documentation] Indexing Clarification NeededCathy Crumbley <catcrumb@gmail.com>
Privacy Policy | Impressum (Legal Info) | Copyright information: Unless otherwise specified, all text and images on this website are licensed under the Creative Commons Attribution-Share Alike 3.0 License. This does not include the source code of LibreOffice, which is licensed under the Mozilla Public License (MPLv2). "LibreOffice" and "The Document Foundation" are registered trademarks of their corresponding registered owners or are in actual use as trademarks in one or more countries. Their respective logos and icons are also subject to international copyright laws. Use thereof is explained in our trademark policy.