Changeset 33146 for main/trunk/greenstone3/web/interfaces/default/js/document_scripts.js

Timestamp:

2019-06-11T19:46:35+12:00 (5 years ago)

Author:

wy59

Message:

Major refactoring of map-scripts.js and classifier_scripts.js and document_scripts.js. Prior to this commit, there was some behaviour in map-scripts.js that was not straightforward: it was mimicking 'overriding' (function overrides don't exist in Javascript) and actually redefining the 2 functions httpRequest() already implemented in classifier_scripts, and toggleSection() already implemented in classifier_scripts and document_scripts. ToggleSection() was implemented differently in the 2 original js files, and the one that got called depended on whether we were in doc view or classifier view. The original solution kept to this function overriding way of doing things and was messy. But we've now gone with Dr Bainbridge's suggestion of having a global variable mapEnabled that is declared/defined at the top of map-scripts.js. We then test for its existence in classifier_scripts::toggleSection now, to determine if we can call the extra map-specific functions that map_scripts did when doing the 'overriding'. This changeover allowed us to get rid of the function overrides in map-scripts.js and cleaned up unnecessary behaviour and variables introduced into document_scripts in a recent commit merely to work with the function override way of doing things.

File:

• main/trunk/greenstone3/web/interfaces/default/js/document_scripts.js (modified) (2 diffs)

main/trunk/greenstone3/web/interfaces/default/js/document_scripts.js

@@ -1 +1 @@
 /** Javascript file for viewing documents */
-
-//-------TODO--------//
-// map-scripts.js needs these, but non-map viewing does not. Yet if we add these to map_scripts,
-// then in classifier mode, map_scripts will use classifier_scripts.js which already has these
-// So for now, we add them into this file for when map_scripts is in doc view mode and includes document_scripts.js.
-// It seems suboptimal, as these variables and function will be wasted when in regular non-map mode.
-// But unable to think of any other solution at present.
-var inProgress = new Array();
-var openClassifiers = new Array();
-var busy = false;
-
-
-
-function updateOpenClassifiers()
-{
-    var oc = "";
-    var first = true;
-    for(var key in openClassifiers)
-    {
-        if(first)
-        {
-            first = false;
-        }
-        else
-        {
-            oc += ",";
-        }
-        
-        oc += key;
-    }
-    
-    if(oc != undefined)
-    {
-        window.location.hash = oc;
-    }
-}
-
-//---------------//
 
 /** NOTE, this file uses inline templates which look for httpPath, assocfilepath, Source, Thumb, Title metadata. These need to be added into any xsl file that uses this javascript (using <gsf:metadata name="xx" hidden="true"/> if they are not already being collected. */
@@ -187 +149 @@
 }
 
-// TODO:
-// DO NOT "MERGE" _basicToggleSection into toggleSection!
-// map_scripts.js calls _basicToggleSection as it redefines toggleSection() to do (more) stuff.
+
 function toggleSection(sectionID, callback, tocDisabled)
-{
-    _basicToggleSection(sectionID, callback, tocDisabled);  
-}
-function _basicToggleSection(sectionID, callback, tocDisabled)
 {
     var docElem = gs.jqGet("doc" + sectionID);