Re: Spellchecking of manuals

On 05/07/07, Lübbe Onken <l.onken@rac.de> wrote:
> Hi doc writers (especially Simon)
>
> Now that Aspell is producing some output when I build the docs, it finds
> several english words that it doesn't like.
>
> Apart from obvious placeholders or examples, which should go into the common
> terms file of TortoiseSVN, most of these are combined words like
> "filedates", "checkboxes", and so on.
>
> Now I'd like to ask a native english speaker what the proper solution is.
> Separate "filedates" into "file dates" or is "filedates" officially allowed?
> If "filedates" is fine, then we should add it to the english word base. If
> "file dates" is correct, then the docs should be revised.
>
> English spellchecker log attached (duplicates and file references removed).

Hmmm. That's quite a long list, and some of them are not obvious
without context.

From your examples, checkbox is IMHO a technical term refering to a
specific GUI entity, so it should be treated as a single word, but one
that can be translated. Filedate OTOH is not, unless the context is
showing it as a structure member in some code. This should be 2 words.

Other ones: CD's and DVD's are difficult. For a start there is misuse
of the apostrophe - I would write these as CDs and DVDs. Worse than
that, they are the plural form of an acronym. When translated, the
acronym probably stays the same, but the pluralisation may be treated
differently. I guess these have to be standard translatable words that
maybe don't exist in the dictionary.

Simon

-- 
       ___
  oo  // \\      "De Chelonian Mobile"
 (_,\/ \_/ \     TortoiseSVN
   \ \_/_\_/>    The coolest Interface to (Sub)Version Control
   /_/   \_\     http://tortoisesvn.net
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@tortoisesvn.tigris.org
For additional commands, e-mail: dev-help@tortoisesvn.tigris.org