Changeset 37704 for main

Timestamp:

2023-04-23T22:33:27+12:00 (12 months ago)

Author:

davidb

Message:

Code/Syntax upgraded to provide better generality as to the metadata names used for usercomments; primarily done to allow a gs. prefix so it is easier to edit in GLI

Location:

main/trunk/greenstone3/web/interfaces/default

Files:

• js/user_comments.js (modified) (7 diffs)
• transform/layouts/usercomments.xsl (modified) (2 diffs)

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

@@ -20 +20 @@
 gs.usercomments = {};
 
+gs.usercomments.defaults = {
+    "metaname_username"     : "username",
+    "metaname_usertimestamp": "usertimestamp",
+    "metaname_usercomment"  : "usercomment"
+}
+
 // http://stackoverflow.com/questions/6312993/javascript-seconds-to-time-with-format-hhmmss
 // Call as: alert(timestamp.printTime());
@@ -28 +34 @@
 }
 
-gs.usercomments.loadUserComments = function() {
+gs.usercomments.loadUserComments = function(opt_metaname_username, opt_metaname_usertimestamp, opt_metaname_usercomment) {
 
     // don't bother loading comments if we're not on a document page (in which case there's no docid)
@@ -54 +60 @@
     doc_id = doc_id.substring(0, period);
     }
-    
+
+    /* The current pattern of use (from usercomments.xsl) is to globally override/redefine 
+       the metadata names in gs.usercomments.defaults{ values }.  However, anticipating 
+       future, more general use, loadUserComments() and addUserComment() have been written
+       with the ability to have optional parameters passed in the supersede the values in
+       gs.usercomments.defaults{} */
+
     var username_rec = {
-    metaname: "username",
+    metaname: opt_metaname_username || gs.usercomments.defaults.metaname_username,  // e.g. "username"
     metapos: "all"
     };
     
     var timestamp_rec = {
-    metaname: "usertimestamp",
+    metaname: opt_metaname_usertimestamp || gs.usercomments.defaults.metaname_usertimestamp, // e.g. "usertimestamp"
     metapos: "all"
     };
     
     var comment_rec = {
-    metaname: "usercomment",
+    metaname: opt_metaname_usercomment || gs.usercomments.defaults.metaname_usercomment, // e.g. "usercomment"
     metapos: "all"
     };
@@ -79 +91 @@
     //var json_result_str = gs.functions.getMetadataArray(gs.variables["c"], gs.variables["site"], docArray, "index");
 
-    gs.functions.getMetadataArray(gs.variables["c"], gs.variables["site"], docArray, "index", gs.usercomments.loadedUserComments, false); // false for asynchronous
+    gs.functions.getMetadataArray(gs.variables["c"], gs.variables["site"], docArray, "index",
+                  gs.usercomments.loadedUserComments, false); // false for asynchronous
 }
 
@@ -132 +145 @@
             var username = metaval_rec.metavalue;
         var timestamp = metatable[1].metavals[i].metavalue;  
-        var comment = metatable[2].metavals[i].metavalue; 
+        var comment   = metatable[2].metavals[i].metavalue; 
         
         // No need to sort by time, as the meta are already stored sorted 
@@ -188 +201 @@
 }
 
-gs.usercomments.addUserComment = function(_username, _comment, _docid, doc) {
+gs.usercomments.addUserComment = function(_username, _comment, _docid, doc,
+                      opt_metaname_username, opt_metaname_usertimestamp, opt_metaname_usercomment) {
     
     // don't add empty strings for name/comment     
@@ -232 +246 @@
     
     var username_rec = {
-    metaname: "username",
+    metaname: opt_metaname_username || gs.usercomments.defaults.metaname_username, // e.g. "username"
     metavals: [_username]
     };
     
     var timestamp_rec = {
-    metaname: "usertimestamp",
+    metaname: opt_metaname_usertimestamp || gs.usercomments.defaults.metaname_usertimestamp, // e.g. "usertimestamp"
     metavals: [_timestamp]
     };
     
     var comment_rec = {
-    metaname: "usercomment",
+    metaname: opt_metaname_usercomment || gs.usercomments.defaults.metaname_usercomment, // e.g. "usercomment"
     metavals: [_comment]
     };

main/trunk/greenstone3/web/interfaces/default/transform/layouts/usercomments.xsl

@@ -9 +9 @@
     exclude-result-prefixes="java util gsf">
 
+<xsl:template name="userCommentsDefineMetanames">
+  <gsf:script>
+    <!-- Older Greenstone3 installations did not use metadata namespace/prefix for usercomment metadata
+
+     From GS3.11 onwards, this is now part of the Greenstone metadata set (gs.), allowing usercomments 
+     to be edited and managed from GLI.
+
+     If you want the older way of doing things, replace the JS syntax below the commented out block
+    -->
+    
+    <!--
+    gs.usercomments.defaults.metaname_username      = "username";
+    gs.usercomments.defaults.metaname_usertimestamp = "usertimestamp";
+    gs.usercomments.defaults.metaname_usercomment   = "usercomment";    
+    -->
+    
+    gs.usercomments.defaults.metaname_username      = "gs.username";
+    gs.usercomments.defaults.metaname_usertimestamp = "gs.usertimestamp";
+    gs.usercomments.defaults.metaname_usercomment   = "gs.usercomment";    
+  </gsf:script>
+</xsl:template>
+  
 <xsl:template name="userCommentsSection">
  <xsl:if test="/page/pageResponse/format[@type='display']/gsf:option[@name='allowUserComments']/@value='true'">
@@ -23 +45 @@
   <script type="text/javascript" src="interfaces/{$interface_name}/js/gsajaxapi.js"><xsl:text> </xsl:text></script>
   <script type="text/javascript" src="interfaces/{$interface_name}/js/user_comments.js"><xsl:text> </xsl:text></script>
-
+  <xsl:call-template name="userCommentsDefineMetanames"/>
   
   <!-- 3. Set up the User comments section in the HTML -->