svn commit: r1613613 - /openoffice/ooo-site/trunk/content/xx/readme.txt

[ma...@apache.org]

Author: marcus
Date: Sat Jul 26 12:34:20 2014
New Revision: 1613613

URL: http://svn.apache.org/r1613613
Log:
Added a description what to do to localize the files in the .../xx/ directory

Added:
    openoffice/ooo-site/trunk/content/xx/readme.txt   (with props)

Added: openoffice/ooo-site/trunk/content/xx/readme.txt
URL: http://svn.apache.org/viewvc/openoffice/ooo-site/trunk/content/xx/readme.txt?rev=1613613&view=auto
==============================================================================
--- openoffice/ooo-site/trunk/content/xx/readme.txt (added)
+++ openoffice/ooo-site/trunk/content/xx/readme.txt Sat Jul 26 12:34:20 2014
@@ -0,0 +1,109 @@
+How to localize the homepage files?
+===================================
+The following text describes what to do to localize that webpages in the "/xx".
+
+
+1. Very important note
+2. Files in the root directory
+3. Files in the download directory
+4. Files in other directories
+5. How to find the right text for the file at the right place?
+6. I can see the variables and text but cannot find the respective file(s)?
+7. What to do if I get stuck and cannot find the text at the needed location?
+8. What to do if I still need help?
+
+
+
+1. Very important note
+----------------------
+The complete "/xx" directory and its files are used as template.
+Please always copy it to a different location first before you start any editing!
+
+
+
+2. Files in the root directory
+---------------------------
+This file controls the text and links above the navigation bar on top:
+- brand.mdtext
+
+This file controls the text and links in the navigation bar on top:
+- topnav.mdtext
+
+This file contains all strings that can be localized to show the text in your language:
+- msg_prop_l10n_xx.js
+
+At the moment it is used for the files in the current directory only and exists in the following directories:
+- .../xx/
+- .../xx/download/
+
+This file is shown as the initial homepage:
+- index.html
+
+
+
+3. Files in the download directory
+-------------------------------
+This file contains all strings that can be localized to show the text in your language:
+- msg_prop_l10n_xx.js
+
+This file is shown as the initial homepage:
+- index.html
+
+
+
+4. Files in other directories
+--------------------------
+There are more files in some other directories that can be localized.
+
+
+
+5. How to find the right text for the file at the right place?
+-----------------------------------------------------------
+All texts, mouse over titles and link URLs that can be localized are collected in the "msg_prop_l10n_xx.js" files.
+The variables are named and sorted via the sections they are displayed in and have also comments to keep the overview.
+
+Example:
+// Extensions: Strings in the blue box (top) (used in "index.html").
+Here the text for the headline in the blue box for the extensions is stored:
+l10n.dl_ext_blue_box_headline_text = "Get Apache OpenOffice Extensions and Dictionaries";
+
+Please note that not all text is always displayed. Some are only shown in case of errors to handle a special behavior.
+
+Example:
+// Download: Strings for error text in the sub-red box (used in "download.js").
+Here the text for the left download button is shown when the selected options do not lead to a correct download:
+l10n.dl_full_link_error_text = "No full installation available";
+
+
+
+6. I can see the variables and text but cannot find the respective file(s)?
+------------------------------------------------------------------------
+The "msg_prop_l10n_xx.js" files contains already a lot of strings. But it is maybe not wished to localize everything
+that is existing. So, we can keep the "/xx" example section small.
+
+For example, the following variables point to files that are not existing yet. You have to create them first:
+
+l10n.dl_analyze_headline_text = "How to report a broken download link?";
+--> "analyze.html"
+
+l10n.dl_help_link = "http://www.openoffice.org/download/full_vs_lp.html";
+--> "full_vs_lp.html"
+
+Also many links in the navigation bar referes to global webpages.
+
+
+
+7. What to do if I get stuck and cannot find the text at the needed location?
+--------------------------------------------------------------------------
+You can always refer to the global webpages at "http://www.openoffice.org/". The directory and file structure is the same.
+
+
+
+8. What to do if I still need help?
+---------------------------------
+You can get in contact with us via the L10N mailing list:
+http://openoffice.apache.org/mailing-lists.html#localization-mailing-list-public
+
+For a general explaination for what a mailing list is please see here:
+http://openoffice.apache.org/mailing-lists.html#using-mailing-lists
+

Propchange: openoffice/ooo-site/trunk/content/xx/readme.txt
------------------------------------------------------------------------------
    svn:eol-style = native