core JS i18n, addition of other i18n fixes.

git-svn-id: https://kt-dms.svn.sourceforge.net/svnroot/kt-dms/trunk@5114 c91229c3-7414-0410-bfa2-8a42b809f60b

core JS i18n, addition of other i18n fixes.
git-svn-id: https://kt-dms.svn.sourceforge.net/svnroot/kt-dms/trunk@5114 c91229c3-7414-0410-bfa2-8a42b809f60b
Brad Shuttleworth
1 parent 43e73634
Showing 11 changed files with 176 additions and 19 deletions
bin/jsi18n.py
browse.php
docs/developer/i18n.txt
presentation/i18nJavascript.php
resources/js/conditional_complex_edit.js
resources/js/conditional_simple_edit.js
resources/js/conditional_usage.js
resources/js/constructed_search.js
templates/ktcore/boolean_search.smarty
templates/ktcore/javascript_i18n.smarty
templates/ktstandard/action/document_links.smarty
+#!/usr/bin/python
+#
+# JS Gettext-style extractor.
+
+import re
+import sys
+
+usage_str = '''
+   Extracts _() items in JS.
+
+   Usage:  jsi18n.py [list of files] > output.smarty
+'''
+
+baseline = '''
+/*
+ *  Javascript (actual translations);
+ */
+ 
+{literal}
+var i18n = {};
+
+function _(trans_string) {
+    var newstr = i18n[trans_string];
+    if (!isUndefinedOrNull(newstr)) { return newstr; } 
+    else {
+       return trans_string;
+    }
+}
+{/literal}
+
+
+'''
+
+peritem = "i18n['%s'] = '{i18n}%s{/i18n}';\n"
+
+# this is not the best way to do this ...
+
+class JSExtractor:
+    def __init__(self, filename):
+        self.strings = []
+        handle = file(filename, 'r')
+        self.content = handle.read()
+        handle.close()
+        
+    def process(self):
+        proc = re.compile('(_\(\'(.*?)\'\))')
+        self.strings = [i[1] for i in proc.findall(self.content)] 
+            
+    def getStrings(self):
+        out = ''
+        for l in self.strings:
+            out += peritem%(l, l)
+        return out
+        
+if __name__ == '__main__':
+    fake_po = baseline
+    
+    filelist = sys.stdin.readlines()
+    for filename in filelist:
+        processor = JSExtractor(filename[:-1])
+        processor.process()
+        fake_po += "\n// strings for file: %s\n"%(filename[:-1]);
+        fake_po += processor.getStrings()
+    
+    print fake_po
 \ No newline at end of file
@@ -261,7 +261,7 @@ class BrowseDispatcher extends KTStandardDispatcher {
         $aFields = DocumentField::getList('has_lookup = 1');
  
         if (empty($aFields)) {
-            $this->errorRedirectToMain('No lookup fields available.');
+            $this->errorRedirectToMain(_('No lookup fields available.'));
             exit(0);
         } 
  
@@ -6,6 +6,9 @@ Testing
 - install gettext command line utilities
 - Run the following to extract translatable text from the templates:
   $ rm -f i18n/templates.c
+- run custom python to generate i18n for js
+  $ find resources -name "*.js" | python ./bin/jsi18n.py > templates/ktcore/javascript_i18n.smarty
+
   $ php bin/smarty_to_gettext.php . > i18n/templates.c
 - run xgettext to generate .po files eg.
   $ find . -type f -name "*.php" -o -name "*.inc" | xgettext --no-wrap -d knowledgeTree -L PHP -s -f - -o i18n/knowledgeTree.po
+<?php
+
+require_once('../config/dmsDefaults.php');
+require_once(KT_LIB_DIR . '/dispatcher.inc.php');
+require_once(KT_LIB_DIR . '/templating/templating.inc.php');
+
+class JavascriptTranslationDispatcher extends KTDispatcher {
+
+    function check() {
+	    if (!parent::check()) { return false; }
+		
+		return true;
+	}
+
+    function do_main() {
+	    header('Content-Type: application/javascript; charset=UTF-8');		        
+	
+        $oTemplating =& KTTemplating::getSingleton();
+		$oTemplate = $oTemplating->loadTemplate("ktcore/javascript_i18n");
+
+		return $oTemplate->render();	        
+    }
+}
+
+$oD =& new JavascriptTranslationDispatcher();
+$oD->dispatch();
+
+?>
 \ No newline at end of file
@@ -80,7 +80,7 @@ function placeFinishButton() {
     }
     var column = getColumnForField(active_field);
  
-    var finish_button = INPUT({'type':'button', 'value':'Finish with this column\'s behaviours.','id':'global-stack-popper-button'});
+    var finish_button = INPUT({'type':'button', 'value':_('Finish with this column\'s behaviours.'),'id':'global-stack-popper-button'});
     simpleLog('DEBUG','placing stack-popper with function popFixedStack in field '+active_field);
     addEvent(finish_button, 'click', popFixedStack);
     simpleLog('DEBUG','added listener.');
@@ -155,7 +155,7 @@ function setFixedValueForField(field_id, value, label) {
     var column = getColumnForField(field_id);
     simpleLog('DEBUG','fixing value for field '+field_id+' to '+label+' ('+value+')');
     addElementClass(column, 'fixed');
-    setMessageForField(field_id,'fixed_message', 'Assuming this field has behaviour "'+label+'".');
+    setMessageForField(field_id,'fixed_message', _('Assuming this field has behaviour "')+label+'".');
  
     // now we need to check if this field _is_ fixed.
     var fixed_source = getElementsByTagAndClassName('input','fixed_value',column);
@@ -163,7 +163,7 @@ function storeRelationship(selected_lookup, child_lookups) {
  
   // inform the user that something has happened.
   // FIXME this isn't i18n friendly.
-  addInformationNote('Dependencies saved. (at ' + new Date() + ')');
+  addInformationNote(_('Dependencies saved. (at ') + new Date() + ')');
  
   deferred.addCallback(do_updateActiveLookups);
   deferred.addErrback(partial(do_handleAjaxError, 'storeRelationship'));
@@ -223,7 +223,7 @@ function do_updateActiveLookups(label, req) {
         }
    }
  
-   addInformationNote('Dependencies for value "'+label+' loaded."(at ' + new Date() + ')');
+   addInformationNote(_('Dependencies for value "')+label+('" loaded.(at ') + new Date() + ')');
 }
  
  
@@ -269,7 +269,7 @@ function editSimpleField(field_id) {
     setExclusiveEditing(field_id);
     updateActiveFields(); // trigger an update of the backend.
     // rest is asynchronous.
-    addInformationNote('Now editing field "'+getNameForField(field_id)+'".');
+    addInformationNote(_('Now editing field "')+getNameForField(field_id)+'".');
 }
  
  
@@ -301,7 +301,7 @@ function finishSimpleField(field_id) {
  
 // called when a single-view dropdown is activated.
 function handleChangedSelection(field_id, select_input) {
-    addInformationNote('Loading Dependencies for value "'+scrapeText(select_input.options[select_input.selectedIndex])+'"(at ' + new Date() + ')');
+    addInformationNote(_('Loading Dependencies for value "')+scrapeText(select_input.options[select_input.selectedIndex])+'"(at ' + new Date() + ')');
     updateActiveLookups(select_input.value, scrapeText(select_input.options[select_input.selectedIndex]));    // handles everything for us.
 }
  
@@ -329,7 +329,7 @@ function reviseConditional(buttonsource) {
     var fieldset = breadcrumbFind(buttonsource, 'FIELDSET');
 	setElementClass(fieldset, 'conditional_metadata');
         if (!checkStackForFieldset(fieldset)) {
-        var undo_button = INPUT({'type':'button','value':'undo'},null);
+        var undo_button = INPUT({'type':'button','value':_('Undo')},null);
         attachToElementEvent(undo_button,'click',partial(popStack, fieldset));
         fieldset.appendChild(undo_button);
         // initialise the stack.
@@ -352,7 +352,7 @@ function initialiseConditionalFieldsets() {
     // and insert the initial (master) field. 
     for (var i=0; i<fieldsets.length; i++) {
         if (!checkStackForFieldset(fieldsets[i])) {
-        var undo_button = INPUT({'type':'button','value':'undo'},null);
+        var undo_button = INPUT({'type':'button','value':_('Undo')},null);
         attachToElementEvent(undo_button,'click',partial(popStack, fieldsets[i]));
         fieldsets[i].appendChild(undo_button);
         // initialise the stack.
@@ -86,7 +86,7 @@ function addNewCriteria(add_button) {
     var newCriteriaText = scrapeText(select.options[select.selectedIndex])+' '; // FIXME insert the "input" here.
     replaceChildNodes(select.parentNode, newCriteriaText, INPUT({'type':'hidden', 'name':'boolean_search[subgroup]['+tableId+'][values]['+critId+'][type]','value':select.value}));           // works thanks to DOM co-ercion.
     createAdditionalCriteriaOption(parent_table);
-    var removeButton = INPUT({'type':'button', 'value':'Remove'});
+    var removeButton = INPUT({'type':'button', 'value':_('Remove')});
     attachToElementEvent(removeButton, 'click', partial(removeCriteria, removeButton));
     add_button.parentNode.replaceChild(removeButton, add_button);
  
@@ -159,8 +159,8 @@ function createAdditionalCriteriaOption(parent_table) {
     // clone, and append.
     var clonedObject = master_div.getElementsByTagName('select')[0].cloneNode(true);
     var select_entry = TD(null, clonedObject);
-    var notification_entry = TD(null, createDOM('P',{'class':'helpText'},'first select a type of query'));
-    var add_button = INPUT({'type':'button', 'value':'Add'});
+    var notification_entry = TD(null, createDOM('P',{'class':'helpText'},_('first select a type of query')));
+    var add_button = INPUT({'type':'button', 'value':_('Add')});
     attachToElementEvent(add_button, 'click', partial(addNewCriteria, add_button));
     var add_entry = TD(null, add_button);
     tbody.appendChild(TR(null, select_entry, notification_entry, add_entry));
@@ -191,7 +191,7 @@ function addBooleanGroup(addbutton) {
     simpleLog('DEBUG','adding boolean group to '+bodyObj);
  
     // i hate me.  i also want sane multiline
-    sourceString = ' <fieldset> <legend>Criteria Group</legend> <table class="advanced-search-form"> <tbody> <tr> <th>Criteria</th> <th>Values</th> </tr></tbody></table> </fieldset>';
+    sourceString = ' <fieldset> <legend>' + _('Criteria Group') + '</legend> <table class="advanced-search-form"> <tbody> <tr> <th>'+_('Criteria')+'</th> <th>'+_('Values')+'</th> </tr></tbody></table> </fieldset>';
  
  
     // add the fieldset
@@ -203,7 +203,7 @@ function addBooleanGroup(addbutton) {
     // get an id for the table.
     var table_id = getBooleanGroupId(tableObj);
     // add the grouping string
-    groupingString = '<p class="helpText">Return items which match &nbsp;<select name="boolean_search['+table_id+'][join]"><option value="AND">all</option><option value="OR">any</option></select> of the criteria specified.</p>';    
+    groupingString = '<p class="helpText">' + _('Return items which match')+' &nbsp;<select name="boolean_search['+table_id+'][join]"><option value="AND">'+_('all')+'</option><option value="OR">'+_('any')+'</option></select>'+_('of the criteria specified.')+'</p>';    
     t = DIV(null);
     t.innerHTML = groupingString;
     var paraObj = t.getElementsByTagName('P')[0];
@@ -63,7 +63,7 @@ legend { border: 1px dotted #999;}
 {/if}
  
 {capture assign=options}
-<select name="boolean_search[join]"><option value="AND">all</option><option value="OR">any</option></select>
+<select name="boolean_search[join]"><option value="AND">{i18n}all{/i18n}</option><option value="OR">{i18n}any{/i18n}</option></select>
 {/capture}
  
    <p class="helpText">{i18n arg_options=$options}Return items which match &nbsp;#options# of the <strong>criteria groups</strong> specified.{/i18n}</p>    
+
+/*
+ *  Javascript (actual translations);
+ */
+ 
+{literal}
+var i18n = {};
+
+function _(trans_string) {
+    var newstr = i18n[trans_string];
+    if (!isUndefinedOrNull(newstr)) { return newstr; } 
+    else {
+       return trans_string;
+    }
+}
+{/literal}
+
+
+
+// strings for file: resources/js/kt3calendar.js
+
+// strings for file: resources/js/conditional_complex_edit.js
+i18n['Finish with this column\'s behaviours.'] = '{i18n}Finish with this column\'s behaviours.{/i18n}';
+i18n['Assuming this field has behaviour "'] = '{i18n}Assuming this field has behaviour "{/i18n}';
+
+// strings for file: resources/js/conditional_simple_edit.js
+i18n['Dependencies saved. (at '] = '{i18n}Dependencies saved. (at {/i18n}';
+i18n['Dependencies for value "'] = '{i18n}Dependencies for value "{/i18n}';
+i18n['Now editing field "'] = '{i18n}Now editing field "{/i18n}';
+i18n['Loading Dependencies for value "'] = '{i18n}Loading Dependencies for value "{/i18n}';
+
+// strings for file: resources/js/translate.js
+
+// strings for file: resources/js/constructed_search.js
+i18n['Remove'] = '{i18n}Remove{/i18n}';
+i18n['first select a type of query'] = '{i18n}first select a type of query{/i18n}';
+i18n['Add'] = '{i18n}Add{/i18n}';
+i18n['Criteria Group'] = '{i18n}Criteria Group{/i18n}';
+i18n['Criteria'] = '{i18n}Criteria{/i18n}';
+i18n['Values'] = '{i18n}Values{/i18n}';
+i18n['Return items which match'] = '{i18n}Return items which match{/i18n}';
+i18n['all'] = '{i18n}all{/i18n}';
+i18n['any'] = '{i18n}any{/i18n}';
+i18n['of the criteria specified.'] = '{i18n}of the criteria specified.{/i18n}';
+
+// strings for file: resources/js/taillog.js
+
+// strings for file: resources/js/add_document.js
+
+// strings for file: resources/js/constructed_search_postprocess.js
+
+// strings for file: resources/js/toggleselect.js
+
+// strings for file: resources/js/kt-utility.js
+
+// strings for file: resources/js/help.js
+
+// strings for file: resources/js/conditional_usage.js
+i18n['Undo'] = '{i18n}Undo{/i18n}';
+i18n['Undo'] = '{i18n}Undo{/i18n}';
+
@@ -30,7 +30,7 @@
         <tr>
             <td>
             {if $write_permission}
-                <a href="{addQS}action=delete&fDocumentId={$context->oDocument->getId()}&fDocumentLinkId={$link->getId()}{/addQS}" class="ktAction ktDelete">Delete</a>
+                <a href="{addQS}action=delete&fDocumentId={$context->oDocument->getId()}&fDocumentLinkId={$link->getId()}{/addQS}" class="ktAction ktDelete">{i18n}Delete{/i18n}</a>
             {else}
                 &nbsp;
             {/if}
@@ -66,7 +66,7 @@
  
  
 {else}
-<tr><td colspan="4" align="center">There are no links to or from this document.</td></tr>
+<tr><td colspan="4" align="center">{i18n}There are no links to or from this document.{/i18n}</td></tr>
 {/if}
  
  
@@ -77,8 +77,8 @@
  
  
 {if $write_permission}
-<a class="ktAction ktAdd ktInline" href="{addQS}action=new&fDocumentId={$context->oDocument->getId()}{/addQS}">Add a new link</a>
+<a class="ktAction ktAdd ktInline" href="{addQS}action=new&fDocumentId={$context->oDocument->getId()}{/addQS}">{i18n}Add a new link{/i18n}</a>
 <a
-href="{addQS}action=new&fDocumentId={$context->oDocument->getId()}&fFolderId={$context->oDocument->getFolderId()}{/addQS}">Add a new link</a>.
+href="{addQS}action=new&fDocumentId={$context->oDocument->getId()}&fFolderId={$context->oDocument->getFolderId()}{/addQS}">{i18n}Add a new link{/i18n}</a>.
 {/if}