View source for VideolanStringGuidelines

Draft 0.1

These goal of these guidelines is to ensure that all configuration and interface strings will be consistent, well-written and well-translated, ensuring a better user experience (bwahaha)

= Developers =

== Write correct English ==

Many VLC developers are not native English speakers, which often leads
to badly written strings. 

Please always have your strings proofread, preferably by a native English 
speaker (even if you are one yourself).


== Avoid technical jargon as much as possible ==

If some terms sound common to you, they may be impossible to understand 
for others. If you cannot avoid using them, try explaining them 
(for configuration options, use the extended descriptions, for interfaces, 
use tooltips). Try not being too verbose either.

Of course, some advanced concepts are quite hard to explain. Don't try too much explaining things, and don't hesitate to ask the user to read the documentation.


== Make your string translatable if needed ==

Only strings that can be visible in the GUI must be translated:
* interface description 
* module descriptions / longnames
* configuration options
* "mms://", "http://", "UDP", "RTP" don't need to be translated
* module shortcuts and shortnames must not be made translatable
* Debug messages must not be made translatable.

* _("") makes a string translatable and also actually does translation (calls gettext)
* _NS("") is the macosx variant of _(""). it is a short of [NSApp localizedString: ""] There is also a [NSApp delocalizeString:@""] OSX is entirely UTF8 native.
* N_() only makes a string translatable. it is safe to use it in #defines and in arrays. Also use this when translating strings during the creation of config variables.
* Try to keep strings UTF8 where possible, to make sure a string can be displayed in chinese just as easily as in english in your window.
* wxU is used for c UTF8 strings to unicode conversion. wxL2U transforms from current locale to unicode.


== Use correct syntax ==
  
* Sentences must end with a '.'
* All GUI strings should begin with a Capital letter : 
 - module names   
 - short and long descriptions
 - menu items
* Debug messages don't start with a capital
* For menu items, put a Capital At Each Word.
* Put a space after ',' ';' ':' '.' '?' and '!'
* ...


== Configuration option descriptions specifics ==

Configuration option descriptions have two parts: a short description and a long one.

=== The short description ===

The short description must be kept short (40 characters seems to be a maximum). Don't forget that translations are often longer than the english version.

The short description should be self-understanding for an advanced user. 
The short description must not be a full sentence.

=== The long description ===

The long description should not just repeat the short description (and in most cases, not repeat it at all). This is pointless and probably proves that your descriptions are not properly thought.

The extended description should _generally_ use complete sentences. Use of paragraphs is encouraged to improve readbility and separate ideas.

Don't be too verbose. This would clutter the help output and the interfaces.

Avoid using structures like : "Please choose", "select", "specify"

Bad: "Please specify an integer for foo"
Good: "An integer for foo, which is ..."

=== c. Specifics ===

* String, integer, float: 
   The short description should be a prompt, never a question
    - Bad : "IP Address ?" or "Which channel ?"
    - Good: "IP Address: " or "Channel: "
  The short description must include range and unit, if available
  Exemple: "Frequency (1000-20000 Hz)"
  The long description should rather explain what the user should enter rather
  than merely rephrasing the short description
 
* Multi-select choices:
   Use a prompt. Do not use "please choose" or "please select", the user can 
   guess that...

* Booleans
  The short description should be a question
   "Video overlay ?"
   For the long description, please prefer "Enable foo to get bar" rather than
  "If you enable foo, you will get bar" (which produces long heavy sentences)
  
== Misc ==

*  msg_Dbg can be quite cryptic. msg_Warn, msg_Info and msg_Err MUST be 
    explicit and understandable 
* All strings in all languages should be gender-neutral
* You should never use the first person (neither "I" nor "we"). 
   Computers don't speak and our strings don't speak for the VideoLAN team
* Passive voice should be prefered over second person:
   Use "If this option is enabled" rather "If you enable this option"
* Try reusing strings. This avoids translation efforts and improves consistency
* Don't make assumptions on the way interfaces are organized. Don't forget
   your strings should apply to the command line and to the GUI.
   So don't use "If you choose yes", "If you tick this checkbox"


== Common translations ==

[TODO: Gather them in the wiki]


= Translators =

All user-visible strings are translated. Debug messages are not.


== Don't desperately try to translate ==

Many video specific terms have no equivalent in other langages. Don't desperately try to translate them. It often leads to quite ridiculous expressions.

What you can do is quote the english word in the short description / menu item and explain it in your own words in the long description / tooltip, without trying to translate word for word.


== Test your translation ==

Compile your translation and enable it (this is explained on the developers page). You should particularly look for overflows (too long translated strings).

If you feel you can't reduce the size of your string, you should contact the developer(s) so that the problem can be solved smoothly

== Consistency ==

It is recommended to choose translations for command terms and to use them everywhere. You should probably use the wiki [TODO]