source: main/trunk/greenstone2/macros/style.dm@ 27313

Last change on this file since 27313 was 27313, checked in by ak19, 11 years ago

Now the existing user comments to be displayed are all retrieved in one go using the new get_metadata_array subroutine in metadataaction.pm via the new gsajaxapi method getMetadataArray which take a JSON string and return one. This loads user comments much faster, and doesn't get that much slower if the number of comments stored in the index database gets larger. 2 bugfixes to metadataaction.pm's recently added get_metadata_array subroutine: if no metapos supplied it defaults to 0 like the other get_meta functions instead of defaulting to the keyword 'all'. The fieldnames in the JSON string returned also needed to be inside double quotes in order to be successfully parsed back into a JSON object on the Javascript side. Replaced the old loadUserComments() javascript function in style.dm, which now calls the new gsajaxapi.getMetadataArray() post method.
  • Property svn:executable set to *
  • Property svn:keywords set to Author Date Id Revision
File size: 12.4 KB
RevLine 
[7343]1# this file must be UTF-8 encoded
[148]2#######################################################################
3# PAGE STYLES
4#######################################################################
5
6package Style
7
8# to use this style system output
9# _header_
10# all your page content, then
11# _footer_
12
13# use the page parameter 'style' to choose the appropriate style
14
[12491]15# Current values: "html" and "xhtml"
16_compliance_ {html}
17
[148]18# the style system uses
19# _pagetitle_ - what gets displayed at the top of the browser window
[276]20# _pagescriptextra_ - any extra javascript you want included in the header
[148]21# _pagebannerextra_ - anything extra you want displayed in the page banner
22# _pagefooterextra_ - anything extra you want displayed in the footer
23
24# defaults for the above macros
25_pagetitle_ {_collectionname_}
[19818]26_pagescriptfileextra_ {}
[276]27_pagescriptextra_ {}
[148]28_pagebannerextra_ {}
29_pagefooterextra_ {}
30
[20597]31# collection specific style and script may be set in collection's extra.dm
32# using the following macros
33_collectionspecificstyle_ {}
34_collectionspecificscript_ {}
35
[148]36# it also relies on lots of Globals, the most important of these are:
37# _cookie_ - put in the cgi header
38# _globalscripts_ - javascript stuff
39# _imagecollection_
40# _imagehome_
41# _imagehelp_
42# _imagepref_
[11155]43# _imagethispage_ (this is now not an image, but text. should be renamed?)
[148]44# _linkotherversion_
45
[10872]46# _httpiconchalk_ - the image down the left of the page - is now done
47# by the style sheet.
48
[148]49_header_ {_cgihead_
[10872]50_htmlhead_(class="bgimage")_startspacer__pagebanner_
[148]51}
52
[548]53_header_[v=1] {_cgihead_
[148]54_htmlhead__pagebanner_
55}
56
57# _cgihead_ {Content-type: text/html
58# _cookie_
59#
60# }
61_cgihead_{}
62
[11354]63
[10919]64# any declarations relating to CSS that should go in the html head part.
65# declarations containing images are done here so the path is correct
66# at runtime.
[13429]67
68_csslink_{
69 <link rel="stylesheet" href="_cssfilelink_" type="text/css"
[12491]70 title="Greenstone Style" charset="UTF-8" _linktagend_
[19128]71 <link rel="alternate stylesheet" href="_httpstyle_/style-print.css"
[12491]72 type="text/css" title="Printer" charset="UTF-8" media="print, screen" _linktagend_
[19128]73 <link rel="stylesheet" href="_httpstyle_/style-print.css" type="text/css"
[13429]74 title="Printer" charset="UTF-8" media="print" _linktagend_
[27018]75 _cssfilelinkextra_
[13429]76}
[11354]77
[13429]78_cssheader_ {
79_csslink_
[11543]80<style type="text/css">
[19784]81body.bgimage \{ background: url("_httpimages_/chalk.gif") scroll repeat-y left top; \}
[19126]82div.navbar \{ background-image: url("_httpimages_/bg_green.png"); \}
83div.divbar \{ background-image: url("_httpimages_/bg_green.png"); \}
84a.navlink \{ background-image: url("_httpimages_/bg_off.png"); \}
85a.navlink_sel \{ background-image: url("_httpimages_/bg_green.png"); \}
86a.navlink:hover \{ background-image: url("_httpimages_/bg_on.png"); \}
87p.bannertitle \{background-image: url("_httpimages_/banner_bg.png"); \}
88p.collectiontitle \{background-image: url("_httpimages_/banner_bg.png"); \}
[11369]89</style>
[11354]90_collectionspecificstyle_
[10919]91
92}
93
[11117]94# separate macro so it can be easily overridden for customised collections
[19126]95_cssfilelink_ {_httpstyle_/style.css}
[11117]96
[27014]97# separate macro so additional stylesheets (to those included by default) can be specified
[27018]98_cssfilelinkextra_ {}
[27014]99
[13133]100# Languages that should be displayed right-to-left
101_htmlextra_ [l=ar] { dir=rtl }
102_htmlextra_ [l=fa] { dir=rtl }
103_htmlextra_ [l=he] { dir=rtl }
104_htmlextra_ [l=ur] { dir=rtl }
[14426]105_htmlextra_ [l=ps] { dir=rtl }
106_htmlextra_ [l=prs] { dir=rtl }
[13133]107
[148]108# htmlhead uses:
109# _1_ - extra parameters for the body tag
110# _pagetitle_
111# _globalscripts_
[14263]112_htmlhead_ {<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
113"http://www.w3.org/TR/html4/loose.dtd">
[10872]114
[876]115<html_htmlextra_>
[148]116<head>
117<title>_pagetitle_</title>
[12491]118<meta name="_status:textversion_" content="_versionnum_" _metatagend_
[148]119_globalscripts_
[10919]120_cssheader_
[12944]121_document:documentheader_
[276]122</head>
[148]123
[10872]124<body _1_>
[148]125}
126
[12491]127# Link and meta tags must be closed differently for HTML/XHTML validation
128_linktagend_ {_If_("_compliance_" eq "xhtml",/>,>)}
129_metatagend_ {_If_("_compliance_" eq "xhtml",/>,>)}
[148]130
[9333]131_spacerwidth_ {65}
132
133# _startspacer_ is a spacer that gives pages a left-hand margin.
[10872]134# It must eventually be closed by _endspacer_.
[148]135_startspacer_ {
[10872]136<div id="page">
[148]137}
138
[20612]139# If you want to move the home/help/pref buttons, override this to be empty
140# and then explicitly include _globallinks_ somewhere else
141# on the page
142_optgloballinks_ {_globallinks_}
143
[11156]144# _bannertitle_ is defined in nav_css/ns4.dm, and is either text or
145# a banner image
[148]146_pagebanner_ {
[276]147<!-- page banner (\_style:pagebanner\_) -->
[10872]148<div id="banner">
149<div class="pageinfo">
[20316]150<p class="bannerlinks">_optgloballinks_</p>
[11156]151_bannertitle_
[10872]152</div>
153<div class="collectimage">_imagecollection_</div>
154</div>
155<div class="bannerextra">_pagebannerextra_</div>
[276]156<!-- end of page banner -->
[23519]157_If_("_activateweb20_" eq "2",
158 _If_("_activatetalkback_" eq "1",_talkback:uploadForm_)
159)
[148]160}
161
[548]162_pagebanner_[v=1] {
[24004]163<!-- page banner - text version [v=1] (\_style:pagebanner\_) -->
[148]164<center><h2><b><u>_imagecollection_</u></b></h2></center><p>
[20316]165_optgloballinks_
[148]166_pagebannerextra_
167<p>
[276]168<!-- end of page banner -->
[23519]169_If_("_activateweb20_" eq "2",
170 _If_("_activatetalkback_" eq "1",_talkback:uploadForm_)
171)
[148]172}
173
[4830]174# note we no longer close off one of the startspacer tables here!!
[148]175_footer_ {
[23068]176_If_("_cgiargtalkback_" eq "1",_talkback:monitorUpload_)
[276]177<!-- page footer (\_style:footer\_) -->
[10872]178_pagefooterextra__endspacer__htmlfooter_
[148]179}
180
[4830]181# v=1 footer: not using startspacer in the header, so dont put it in the footer
182_footer_ [v=1]{
[23068]183_If_("_cgiargtalkback_" eq "1",_talkback:monitorUpload_)
[4830]184<!-- page footer [v=1] (\_style:footer\_) -->
185_pagefooterextra_
186_htmlfooter_
[148]187}
188
[10872]189# close off anything opened by startspacer
[4830]190_endspacer_ {
[11155]191</div> <!-- id=page -->
[4830]192}
193
[10872]194
[148]195_htmlfooter_ {
196</body>
197</html>
198}
199
[23519]200_loginscript_ {
201 function appendUsernameArgs(id,addOn)
202 \{
203 var a=document.getElementById(id);
204 var url = a.getAttribute("href");
205 if (url == "") \{
206 url = document.location.toString();
207 \}
208
209 //alert("url before = " + url);
210
211 // clear out any earlier user name/authentication values
212 url = url.replace(/(&|\\\\?)uan=\\d\{0,1\}/g,"");
213 url = url.replace(/(&|\\\\?)un=[a-z0-9:\\-]*/g,"");
214 url = url.replace(/(&|\\\\?)pw=[a-z0-9:\\-]*/g,"");
215
216 //alert("url after = " + url);
217
218 var gwcgi = "_gwcgi_";
219
220 var tailUrl = url.substr(url.length-gwcgi.length);
221
222 url += (tailUrl == "_gwcgi_") ? "?" : "&";
223 url += addOn;
224
225 //alert("url with add on = " + url);
226
227 a.setAttribute("href",url);
228 \}
229}
230
231
[11117]232# imagescript only used in nav_ns4.dm
[218]233_globalscripts_{
[23748]234 <script type="text/javascript" src="_httpscript_/gsajaxapi.js"></script>
235
236 <script language="javascript" type="text/javascript">
237 function gsdefined(val)
238 \{
239 return (typeof(val) != "undefined");
240 \}
241
242 var gsapi = new GSAjaxAPI("_gwcgi_","_cgiargc_");
[27281]243
244 // http://stackoverflow.com/questions/6312993/javascript-seconds-to-time-with-format-hhmmss
245 // Call as: alert(timestamp.printTime());
[27293]246 function formatTime(timestamp) \{
247 var int_timestamp = parseInt(timestamp, 10); // don't forget the second param
248 var date = new Date(int_timestamp);
[27281]249 return date.toLocaleDateString() + " " + date.toLocaleTimeString();
250 \}
251
252 function loadUserComments() \{
253
254 // don't bother loading comments if we're not on a document page (in which case there's no usercommentdiv)
255 var usercommentdiv = document.getElementById("usercomments");
256 if(usercommentdiv == undefined || usercommentdiv == null) \{
257 return;
258 \}
259
260 // else, if we have a usercommentdiv, we would have a docid. Get toplevel section of the docid
261 var doc_id = "_cgiargd_"; //escape("_cgiargd_");
262 var period = doc_id.indexOf(".");
263 if(period != -1) \{
264 doc_id = doc_id.substring(0, period);
265 \}
266
[27313]267 var username_rec = \{
268 metaname: "username",
269 metapos: "all"
270 \};
[27281]271
[27313]272 var timestamp_rec = \{
273 metaname: "usertimestamp",
274 metapos: "all"
275 \};
[27281]276
[27313]277 var comment_rec = \{
278 metaname: "usercomment",
279 metapos: "all"
280 \};
[27281]281
[27313]282 var doc_rec = \{
283 docid: doc_id,
284 metatable: [username_rec, timestamp_rec, comment_rec]
285 \};
[27281]286
[27313]287 var docArray = [doc_rec];
288 //alert(JSON.stringify(docArray));
[27281]289
[27313]290 var json_result_str = gsapi.getMetadataArray(docArray, "index");
291// alert(json_result_str);
292 var result = JSON.parse(json_result_str);
293 // result contains only one docrec (result[0]), since we asked for the usercomments of one docid
294 var metatable = result[0].metatable;
295// alert(JSON.stringify(metatable));
[27281]296
[27313]297 var i = 0;
298 var looping = true;
299 var print_heading = true;
[27281]300
[27313]301 // metatable[0] = list of usernames, metatable[1] = list of timestamps, metatable[2] = list of comments
302 // the 3 lists/arrays should be of even length. Assuming this, loop as long as there's another username
303 while(looping) \{
304 var metaval_rec = metatable[0].metavals[i];
305 if(metaval_rec == undefined) \{
306 looping = false;
307 \}
308 else \{
[27281]309
[27313]310 if(print_heading) \{
311 var heading=document.createElement("div");
312 var attr=document.createAttribute("class");
313 attr.nodeValue="usercommentheading";
314 heading.setAttributeNode(attr);
315 var txt=document.createTextNode("_text-usercomments-section_");
316 heading.appendChild(txt);
317 usercommentdiv.appendChild(heading);
[27281]318
[27313]319 print_heading = false;
320 \}
[27294]321
[27313]322 var username = metaval_rec.metavalue;
323 var timestamp = metatable[1].metavals[i].metavalue;
324 var comment = metatable[2].metavals[i].metavalue;
[27281]325
[27313]326 //alert("Comment: " + username + " " + timestamp + " " + comment);
[27281]327
[27313]328 // No need to sort by time, as the meta are already stored sorted
329 // and hence retrieved in the right order by using the i (metapos) counter
330 // If sorting the array of comment records, which would be by timestamp, see
331 // https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Array/sort
332
333 // for each usercomment, create a child div with the username, timestamp and comment
334 displayInUserCommentList(usercommentdiv, username, timestamp, comment);
335
336 i++;
337 \}
[27293]338 \}
[27281]339
[27293]340 \}
[27281]341
[27313]342
[27293]343 function displayInUserCommentList(usercommentdiv, username, timestamp, comment) \{
[27281]344
[27293]345 var divgroup=document.createElement("div");
346 var attr=document.createAttribute("class");
347 attr.nodeValue="usercomment";
348 divgroup.setAttributeNode(attr);
349
350 var divuser=document.createElement("div");
351 var divtime=document.createElement("div");
352 var divcomment=document.createElement("div");
353
[27281]354
[27293]355 divgroup.appendChild(divuser);
356 var txt=document.createTextNode(username);
357 divuser.appendChild(txt);
[27281]358
[27293]359 divgroup.appendChild(divtime);
360 txt=document.createTextNode(formatTime(timestamp)); // format timestamp for date/time display
361 divtime.appendChild(txt);
[27281]362
[27293]363 divgroup.appendChild(divcomment);
364 txt=document.createTextNode(comment);
365 divcomment.appendChild(txt);
[27281]366
[27293]367 usercommentdiv.appendChild(divgroup);
368
[27281]369 \}
370
371 // http://stackoverflow.com/questions/807878/javascript-that-executes-after-page-load
372 // ensure we don't replace any other onLoad() functions, but append the loadUserComments()
373 // function to the existing onLoad handlers
374
375 if(window.onload) {\
376 var curronload = window.onload;
377 var newonload = function() {\
378 curronload();
379 loadUserComments();
380 \};
381 window.onload = newonload;
382 \} else {\
383 window.onload = loadUserComments;
384 \}
[23748]385 </script>
386
[24004]387_If_("_activatejquery_" eq "1",_jqueryScriptAndStyle_)
388
[23519]389_If_("_activateweb20_" eq "2",
390 _If_("_activateseaweed_" eq "1",_seaweedscript_)
391 _If_("_activatetalkback_" eq "1",_talkbackscript_)
392)
[19818]393_If_(_pagescriptfileextra_,_pagescriptfileextra_)
[11117]394<script language="javascript" type="text/javascript">
[23519]395_loginscript_
[11117]396_If_(_pagescriptextra_,_pagescriptextra_)
[20597]397_collectionspecificscript_
[11117]398_imagescript_
[218]399</script>
400}
401
[548]402_globalscripts_ [v=1] {
[24004]403
404_If_("_activatejquery_" eq "1",_jqueryScriptAndStyle_)
405
[23519]406_If_("_activateweb20_" eq "2",
407 <script type="text/javascript" src="_httpscript_/gsajaxapi.js"></script>
408 _If_("_activateseaweed_" eq "1",_seaweedscript_)
409 _If_("_activatetalkback_" eq "1",_talkbackscript_)
410)
411_If_(_pagescriptfileextra_,_pagescriptfileextra_)
[10872]412<script language="javascript" type="text/javascript">
[276]413<!--
[23519]414_loginscript_
[283]415_If_(_cgiargx_,_scriptdetach_)
[23519]416_If_(_pagescriptextra_,_pagescriptextra_)
[20597]417_collectionspecificscript_
[276]418// -->
419</script>
[283]420}
421
422_scriptdetach_ {
423 function close\_detach() \{
424 close();
425 \}
[876]426}
[24004]427
428
429_jqueryScriptAndStyle_ {
430<link type="text/css" href="_httpstyle_/max-video/jquery-ui-1.8.4.custom.css" rel="stylesheet" />
431<script type="text/javascript" src="_httpscript_/jquery-1.4.2.min.js"></script>
432<script type="text/javascript" src="_httpscript_/jquery-ui-1.8.4.custom.min.js"></script>
433}
434
Note: See TracBrowser for help on using the repository browser.