Changeset 362e6fdfafb3125d2ca4b530a8a6b5c2c9a100b4

Show
Ignore:
Timestamp:
06/18/05 12:31:42 (3 years ago)
Author:
Clément Stenac <zorglub@videolan.org>
git-committer:
Clément Stenac <zorglub@videolan.org> 1119090702 +0000
git-parent:

[875a42b7d9a47554be3bceb9b278abedaab47643]

git-author:
Clément Stenac <zorglub@videolan.org> 1119090702 +0000
Message:

Deprecate old docs

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved

  • doc/strings.txt

    r936be79 r362e6fd  
    1 Some basic rules and guidelines for handling strings in VLC source code: 
    2  
    3 - Determine wether your string is user visible (GUI string) or not. 
    4  
    5 - _("") makes a string translatable and also actually does translation (calls gettext) 
    6 -  _NS("") is the macosx variant of _(""). it is a short of [NSApp localizedString: ""] There is also a [NSApp delocalizeString:@""] OSX is entirely UTF8 native. 
    7  
    8 - 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. 
    9  
    10 - User visible strings should start with a capital. (Module descriptions for instance) 
    11  
    12 - Sentences should end with a '.' 
    13  
    14 - Menu-items with multiple words Should Uppercase the Big Words (look at your windows/IE menus) (only menu-items) 
    15  
    16 - msg_* should not be translated and don't have strict punctuation (no . or capitals). 
    17  
    18 - Write correct american english. 
    19  
    20 - Beware of duplicity with strings that already occur in other files. Use those when possible. 
    21  
    22 - When writing descriptions (especially for config options) make the string descriptive. Think to yourself: If the user reads this, will it help him understand this? 
    23  
    24 - Config options short descriptions should contain range and unit of the option when appropriate. ( 0-360 degrees) ( Hz ) 
    25  
    26 - mms:// http:// UDP RTP are things that don't need translation, neither do variables, config options, module names and module shortcuts. 
    27  
    28 - Consistent use of terminology throughout the sourcecode 
    29  
    30 - 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. 
    31  
    32 - wxU is used for c UTF8 strings to unicode conversion. wxL2U transforms from current locale to unicode. 
    33  
    34  
     1This documentation is outdated. Please refer to the appropriate Wiki page : 
     2http://wiki.videolan.org/index.php/VideolanStringGuidelines 

  • doc/translations.txt

    r274ecfc r362e6fd  
    1 Create translations for VLC media player 
    2 ============== 
    3 The translation files are located in the "po" directory of the vlc sources. 
    4 Edit the appropriate file (for instance fr.po for French translation). 
    5 Write the translation of "msgid" strings into the "msgstr" field. 
    6 You can always ask vlc-devel@videolan.org for assistance. 
    7  
    8  
    9 Writing a new localization 
    10 ========================== 
    11 If there is no localization file for your language, send a mail to 
    12 vlc-devel@videolan.org. In return we will send you a localization file, 
    13 along with a special VLC binary for your tests. 
    14  
    15  
    16 Testing your localization on UNIX 
    17 ================================= 
    18 You must install the gettext package. See your UNIX distribution, or 
    19   http://www.gnu.org/software/gettext 
    20 Use the convert-po.sh script attached : 
    21   ./convert-po.sh <LANG>.po 
    22 Copy the resulting vlc.mo file to 
    23   /usr/local/share/locale/<LANG>/LC_MESSAGES 
    24  
    25 Launch VLC with --language <LANG> 
    26 Where <LANG> is the international shortcode for your language. 
    27  
    28  
    29 Testing your localization on Mac OS X 
    30 ===================================== 
    31 If you do not have GNU gettext installed (you'd probably know if you had 
    32 it :), you must download its binaries from our website : 
    33   http://download.videolan.org/pub/videolan/devtools/gettext-macosx.tar.gz 
    34 and extract them into the current directory : 
    35   tar xvzf gettext-macosx.tar.gz 
    36  
    37 Use the convert-po.sh script attached : 
    38   export PATH=gettext-macosx:$PATH 
    39   export DYLD_LIBRARY_PATH=gettext-macosx 
    40   ./convert-po.sh <LANG>.po 
    41 [*] 
    42  
    43 Copy the resulting vlc.mo file to 
    44   VLC.app/Contents/MacOS/locale/<LANG>/LC_MESSAGES 
    45  
    46 Launch VLC with --language <LANG> 
    47 Where <LANG> is the international shortcode for your language. 
    48  
    49  
    50 "fuzzy" translations 
    51 ==================== 
    52 A fuzzy translation is an untranslated string for which gettext did an 
    53 automatic suggestion, but needs your confirmation. They are marked with 
    54 the "#, fuzzy" comment. If you think the suggestion is OK, or if you 
    55 fixed the suggestion, do not forget to remove the "#, fuzzy" comment. 
    56  
    57  
    58 Adding a language to VLC 
    59 ======================== 
    60 When the language is added to the VLC sourcecode, remember to also edit 
    61 src/libvlc.h for the preference option, and src/misc/darwin_specific.m 
    62  
    63  
    64 [*] Step by step process to localize under Mac OS X (excerpt from a mail) : 
    65 cd ~/Desktop 
    66 curl -O http://www.videolan.org/pub/videolan/devtools/vlc-po-files.tar.gz 
    67 tar xzf vlc-po-files.tar.gz 
    68 cd vlc-po-files 
    69 curl -O http://www.videolan.org/pub/videolan/devtools/gettext-macosx.tar.gz 
    70 tar xzf gettext-macosx.tar.gz 
    71 export PATH=./gettext-macosx:$PATH 
    72 export DYLD_LIBRARY_PATH=./gettext-macosx 
    73 [here you copy your it.po file to the vlc-po-files folder on your Desktop] 
    74 ./convert-po.sh it.po 
    75 [here you copy the vlc.mo file to your 
    76 VLC.app/Contents/MacOS/locale/it/LC_MESSAGES] 
    77  
    78 --  
    79 Christophe Massiot <massiot@via.ecp.fr> 
    80 Derk-Jan Hartman <hartman at videolan dot org> 
    81 $Id$ 
     1This file is outdated. 
     2Please refer to http://developers.videolan.org/i18n/vlc-howto.html