CRM-16172 - Add help text to Localization Settings page

diff --git a/templates/CRM/Admin/Form/Setting/Localization.hlp b/templates/CRM/Admin/Form/Setting/Localization.hlp
new file mode 100644 (file)
index 0000000..2710853
--- /dev/null
+++ b/templates/CRM/Admin/Form/Setting/Localization.hlp
@@ -0,0 +1,88 @@
+{*
+ +--------------------------------------------------------------------+
+ | CiviCRM version 4.6                                                |
+ +--------------------------------------------------------------------+
+ | Copyright CiviCRM LLC (c) 2004-2015                                |
+ +--------------------------------------------------------------------+
+ | This file is a part of CiviCRM.                                    |
+ |                                                                    |
+ | CiviCRM is free software; you can copy, modify, and distribute it  |
+ | under the terms of the GNU Affero General Public License           |
+ | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
+ |                                                                    |
+ | CiviCRM is distributed in the hope that it will be useful, but     |
+ | WITHOUT ANY WARRANTY; without even the implied warranty of         |
+ | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
+ | See the GNU Affero General Public License for more details.        |
+ |                                                                    |
+ | You should have received a copy of the GNU Affero General Public   |
+ | License and the CiviCRM Licensing Exception along                  |
+ | with this program; if not, contact CiviCRM LLC                     |
+ | at info[AT]civicrm[DOT]org. If you have questions about the        |
+ | GNU Affero General Public License or the licensing of CiviCRM,     |
+ | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
+ +--------------------------------------------------------------------+
+*}
+{capture assign="money_format_help"}
+  {ts}Special symbols include:{/ts}
+  <ul>
+    <li><strong>%c</strong> {ts}currency symbol (e.g. '$'){/ts}</li>
+    <li><strong>%C</strong> {ts}currency ISO code (e.g. 'USD'){/ts}</li>
+    <li><strong>%a</strong> {ts}monetary amount, formatted according to selected Monetary Locale{/ts}</li>
+  </ul>
+  {ts 1='href="http://php.net/manual/en/function.money-format.php"'}For a full list of options see the php <a %1>money_format documentation</a>.{/ts}
+{/capture}
+{htxt id="inheritLocale"}
+  <p>
+    {ts}If checked, CiviCRM will follow CMS language changes.{/ts}
+  </p>
+{/htxt}
+{htxt id="defaultCurrency"}
+  <p>
+    {ts}Default currency assigned to contributions and other monetary transactions.{/ts}
+  </p>
+{/htxt}
+{htxt id="moneyformat"}
+  <p>
+    {ts}Format for displaying monetary amounts with currency symbol.{/ts}
+  </p><p>
+    {$money_format_help}
+  </p>
+{/htxt}
+{htxt id="moneyvalueformat"}
+  <p>
+    {ts}Format for displaying monetary values without the currency symbol.{/ts}
+  </p><p>
+    {$money_format_help}
+  </p>
+{/htxt}
+{htxt id="customTranslateFunction"}
+  <p>
+    {ts}You may override the ts() function in CiviCRM by defining your own translation function.{/ts}
+  </p>
+{/htxt}
+{htxt id="legacyEncoding"}
+  <p>
+    {ts}If import files are NOT encoded as UTF-8, specify an alternate character encoding for these files. The default of <strong>Windows-1252</strong> will work for Excel-created .CSV files on many computers.{/ts}
+  </p>
+{/htxt}
+{htxt id="fieldSeparator"}
+  <p>
+    {ts}Global CSV separator character. Modify this setting to enable import and export of different kinds of CSV files (for example: ',' ';' ':' '|' ).{/ts}
+  </p>
+{/htxt}
+{htxt id="defaultContactCountry"}
+  <p>
+    {ts}This value is selected by default when adding a new contact address.{/ts}
+  </p>
+{/htxt}
+{htxt id="countryLimit"}
+  <p>
+    {ts}Which countries are available in the Country selection field when adding or editing contact addresses. Profile and Custom 'Country' fields also use this setting. To include ALL countries, leave the right-hand box empty.{/ts}
+  </p>
+{/htxt}
+{htxt id="provinceLimit"}
+  <p>
+    {ts}State/province listings are populated dynamically based on the selected Country for all standard contact address editing forms, as well as for <strong>Profile forms which include both a Country and a State/Province field</strong>.  This setting controls which countries' states and/or provinces are available in the State/Province selection field <strong>for Custom Fields</strong> or for Profile forms which do NOT include a Country field.{/ts}
+  </p>
+{/htxt}

diff --git a/templates/CRM/Admin/Form/Setting/Localization.tpl b/templates/CRM/Admin/Form/Setting/Localization.tpl
index eb0c9315352e4f971bf59ad9c04fb87c0acb0e7c..b2bfa9b3807fd28d300a8ae745c4f0ec02ff694f 100644 (file)
--- a/templates/CRM/Admin/Form/Setting/Localization.tpl
+++ b/templates/CRM/Admin/Form/Setting/Localization.tpl
@@ -24,13 +24,16 @@
  +--------------------------------------------------------------------+
 *}
 <div class="crm-block crm-form-block crm-localization-form-block">
-<div class="crm-submit-buttons">{include file="CRM/common/formButtons.tpl" location="top"} </div>
+  <div class="help">
+    {ts}Configure CiviCRM for your country and language.{/ts}
+    {docURL page="i18n Administrator's Guide: Using CiviCRM in your own language" resource="wiki"}
+  </div>
+  <div class="crm-submit-buttons">{include file="CRM/common/formButtons.tpl" location="top"} </div>
     <h3>{ts}Language and Currency{/ts}</h3>
         <table class="form-layout-compressed">
             <tr class="crm-localization-form-block-lcMessages">
                 <td class="label">{$form.lcMessages.label}</td>
-                <td>{$form.lcMessages.html}<br />
-                <span class="description">{ts}Default language used for this installation.{/ts}</span></td>
+                <td>{$form.lcMessages.html}</td>
             </tr>
            {if $form.languageLimit}
              <tr class="crm-localization-form-block-languageLimit">
@@ -45,14 +48,12 @@
              </tr>
           {/if}
             <tr class="crm-localization-form-block-inheritLocale">
-                <td class="label">{$form.inheritLocale.label}</td>
-                <td>{$form.inheritLocale.html}<br />
-                <span class="description">{ts}If checked, CiviCRM will follow CMS language changes.{/ts}</span></td>
+                <td class="label">{$form.inheritLocale.label} {help id='inheritLocale' title=$form.inheritLocale.label}</td>
+                <td>{$form.inheritLocale.html}</td>
             </tr>
             <tr class="crm-localization-form-block-defaultCurrency">
-                <td class="label">{$form.defaultCurrency.label}</td>
-                <td>{$form.defaultCurrency.html}<br />
-                <span class="description">{ts}Default currency assigned to contributions and other monetary transactions.{/ts}</span></td>
+                <td class="label">{$form.defaultCurrency.label} {help id='defaultCurrency' title=$form.defaultCurrency.label}</td>
+                <td>{$form.defaultCurrency.html}</td>
             </tr>
             <tr class="crm-localization-form-block-monetaryThousandSeparator">
                 <td class="label">{$form.monetaryThousandSeparator.label}</td>
@@ -67,52 +68,43 @@
                 <td>{$form.currencyLimit.html}</td>
             </tr>
             <tr class="crm-localization-form-block-moneyformat">
-                <td class="label">{$form.moneyformat.label}</td>
-                <td>{$form.moneyformat.html}<br />
-                <span class="description">{ts}Format for displaying monetary amounts.{/ts}</span></td>
+                <td class="label">{$form.moneyformat.label} {help id='moneyformat' title=$form.moneyformat.label}</td>
+                <td>{$form.moneyformat.html}</td>
             </tr>
             <tr class="crm-localization-form-block-moneyvalueformat">
-                <td class="label">{$form.moneyvalueformat.label}</td>
-                <td>{$form.moneyvalueformat.html}<br />
-                <span class="description">{ts}Format for displaying monetary values.{/ts}</span></td>
+                <td class="label">{$form.moneyvalueformat.label} {help id='moneyvalueformat' title=$form.moneyvalueformat.label}</td>
+                <td>{$form.moneyvalueformat.html}</td>
             </tr>
             <tr class="crm-localization-form-block-customTranslateFunction">
-                <td class="label">{$form.customTranslateFunction.label}</td>
-                <td>{$form.customTranslateFunction.html}<br />
-                <span class="description">{ts}Function name to use for translation inplace of the default CiviCRM translate function. {/ts}</span></td>
+                <td class="label">{$form.customTranslateFunction.label} {help id='customTranslateFunction' title=$form.customTranslateFunction.label}</td>
+                <td>{$form.customTranslateFunction.html}</td>
             </tr>
             <tr class="crm-localization-form-block-legacyEncoding">
-                <td class="label">{$form.legacyEncoding.label}</td>
-                <td>{$form.legacyEncoding.html}<br />
-                <span class="description">{ts}If import files are NOT encoded as UTF-8, specify an alternate character encoding for these files. The default of <strong>Windows-1252</strong> will work for Excel-created .CSV files on many computers.{/ts}</span></td>
+                <td class="label">{$form.legacyEncoding.label} {help id='legacyEncoding' title=$form.legacyEncoding.label}</td>
+                <td>{$form.legacyEncoding.html}</td>
             </tr>
             <tr class="crm-localization-form-block-fieldSeparator">
-                <td class="label">{$form.fieldSeparator.label}</td>
-                <td>{$form.fieldSeparator.html}<br />
-                <span class="description">{ts}Global CSV separator character. Modify this setting to enable import and export of different kinds of CSV files (for example: ',' ';' ':' '|' ).{/ts}</span></td>
+                <td class="label">{$form.fieldSeparator.label} {help id='fieldSeparator' title=$form.fieldSeparator.label}</td>
+                <td>{$form.fieldSeparator.html}</td>
             </tr>
         </table>
     <h3>{ts}Contact Address Fields - Selection Values{/ts}</h3>
         <table class="form-layout-compressed">
             <tr class="crm-localization-form-block-defaultContactCountry">
-                <td class="label">{$form.defaultContactCountry.label}</td>
-                <td>{$form.defaultContactCountry.html}<br />
-                <span class="description">{ts}This value is selected by default when adding a new contact address.{/ts}</span></td>
+                <td class="label">{$form.defaultContactCountry.label} {help id='defaultContactCountry' title=$form.defaultContactCountry.label}</td>
+                <td>{$form.defaultContactCountry.html}</td>
             </tr>
            <tr class="crm-localization-form-block-defaultContactStateProvince">
-                <td class="label">{$form.defaultContactStateProvince.label}</td>
-                <td>{$form.defaultContactStateProvince.html}<br />
-                <span class="description">{ts}This value is selected by default when adding a new contact address.{/ts}</span></td>
+                <td class="label">{$form.defaultContactStateProvince.label} {help id='defaultContactCountry' title=$form.defaultContactStateProvince.label}</td>
+                <td>{$form.defaultContactStateProvince.html}</td>
             </tr>
             <tr class="crm-localization-form-block-countryLimit">
-                <td class="label">{$form.countryLimit.label}</td>
-                <td>{$form.countryLimit.html}<br />
-                <span class="description">{ts}Which countries are available in the Country selection field when adding or editing contact addresses. Profile and Custom 'Country' fields also use this setting. To include ALL countries, leave the right-hand box empty.{/ts}</span></td>
+                <td class="label">{$form.countryLimit.label} {help id='countryLimit' title=$form.countryLimit.label}</td>
+                <td>{$form.countryLimit.html}</td>
             </tr>
             <tr class="crm-localization-form-block-provinceLimit">
-                <td class="label">{$form.provinceLimit.label}</td>
-                <td>{$form.provinceLimit.html}<br />
-                <span class="description">{ts}State/province listings are populated dynamically based on the selected Country for all standard contact address editing forms, as well as for <strong>Profile forms which include both a Country and a State/Province field</strong>.  This setting controls which countries' states and/or provinces are available in the State/Province selection field <strong>for Custom Fields</strong> or for Profile forms which do NOT include a Country field.{/ts}</span></td>
+                <td class="label">{$form.provinceLimit.label} {help id='provinceLimit' title=$form.provinceLimit.label}</td>
+                <td>{$form.provinceLimit.html}</td>
             </tr>
         </table>
     <h3>{ts}Multiple Languages Support{/ts}</h3>