Changeset 4936

Timestamp:

2003-07-16T09:04:05+12:00 (21 years ago)

Author:

sjboddie

Message:

Added new format options for [DocTOC], [DocImage], [DocumentButtonDetach],
[DocumentButtonHighlight], [DocumentButtonExpandText], and
[DocumentButtonExpandContents]. These can all be inserted in a
DocumentText format string to allow more flexible arrangement of table of
contents, document buttons, etc.

Location:

trunk/gsdl/src/recpt

Files:

• browsetools.cpp (modified) (2 diffs)
• browsetools.h (modified) (1 diff)
• documentaction.cpp (modified) (13 diffs)
• documentaction.h (modified) (2 diffs)
• formattools.cpp (modified) (3 diffs)
• formattools.h (modified) (1 diff)
• vlistbrowserclass.cpp (modified) (4 diffs)

trunk/gsdl/src/recpt/browsetools.cpp

@@ -82 +82 @@
 }
 
+text_t get_cover_image () {
+   return "_httpcollimg_/{Or}{[parent(Top):archivedir],[archivedir]}/cover.jpg";
+}
 
 // at the moment this just writes out the html to display 
@@ -94 +97 @@
   if (args["d"].empty()) return;
   
-  textout << outconvert << disp << 
-    "<img src=\"_httpcollimg_/_thisOID_/cover.jpg\"><br>\n";
+  textout << outconvert << disp << "<img src=\"" << get_cover_image() << "\"><br>\n";
 }
 

trunk/gsdl/src/recpt/browsetools.h

@@ -77 +77 @@
               outconvertclass &outconvert, ostream &textout, 
               ostream &logout);
-    
+
+text_t get_cover_image ();
+
 void output_cover_image (cgiargsclass &args, recptproto *collectproto, 
              displayclass &disp, outconvertclass &outconvert, 

trunk/gsdl/src/recpt/documentaction.cpp

@@ -25 +25 @@
 
 #include <string.h>
+#include <sstream>
+
 #include "documentaction.h"
 #include "browsetools.h"
@@ -416 +418 @@
   // _httppagehome_      overridden home url if html collections have own homepage
 
-  // _usability_ - a macro for remote usability reporting
+  // _usability_         a macro for remote usability reporting
 
   // must have a valid collection server to continue
+   
   text_t &collection = args["c"];
   if (collection.empty()) return;
@@ -630 +633 @@
 
   // must have a valid collection server to continue
-  text_t &collection = args["c"];
+
+   text_t &collection = args["c"];
   if (collection.empty()) return;
   recptproto *collectproto = protos->getrecptproto (collection, logout);
@@ -692 +696 @@
        //call function in formattools.cpp which will return the text of the 
        //related documents in a vertical list. This is the default format.
+
        if (get_info (arg_d, collection, metadata, options, false, collectproto, response, logout)) 
      relation += get_related_docs(collection, collectproto, response.docInfo[0], logout);
        
        //set macro to be the related document string
+
        disp.setmacro ("relateddoc", "document", relation); 
      }
@@ -837 +843 @@
         << "</html>\n";
       } else {
-    output_document (OID, args, collectproto, disp, outconvert, textout, logout);   
+    output_document (OID, args, collectproto, browsers, disp, outconvert, textout, logout); 
       }
       return true;
@@ -861 +867 @@
     if (!args["d"].empty()) {
       textout << outconvert << "<p>\n";
-      output_document (OID, args, collectproto, disp, outconvert, textout, logout);
+      output_document (OID, args, collectproto, browsers, disp, outconvert, textout, logout);
     }
 
@@ -872 +878 @@
                   const TermInfo_tarray &terminfo, const text_t &OID,
                   bool highlight, int hastxt, int wanttext, 
-                  text_t &collection, recptproto *collectproto, 
-                  displayclass &disp, outconvertclass &outconvert, 
-                  ostream &textout, ostream &logout,
-                  cgiargsclass &args) {
+                  text_t &collection, recptproto *collectproto,
+                  browsermapclass *browsers, displayclass &disp,
+                  outconvertclass &outconvert, ostream &textout,
+                  ostream &logout, cgiargsclass &args) {
   
   DocumentRequest_t docrequest;
@@ -901 +907 @@
       text_tmap options;
       options["text"] = docresponse.doc;
+      options["DocImage"] = get_cover_image();
+
+      ostringstream tmpstr(ostringstream::binary);
+      if (args["gc"] == "1") {
+     expanded_contents (args, 0, false, browsers, formatinfo, 
+                collectproto, disp, outconvert, tmpstr,
+                logout);
+      } else {
+     contracted_contents (args, 0, false, browsers, formatinfo, 
+                  collectproto, disp, outconvert, tmpstr, logout);
+      }
+      text_t tmp = (char *)(tmpstr.str().c_str());
+      int len = tmp.size();
+      char *ctmp = tmp.getcstr();
+      utf8inconvertclass utf82text_t;
+      utf82text_t.setinput(ctmp, len);
+      convertclass::status_t status;
+      utf82text_t.convert(tmp, status);
+      options["DocTOC"] = tmp;
+      delete ctmp;
+
+      options["DocumentButtonDetach"] = "_document:imagedetach_";
+      if (args["hl"] == "1") {
+     options["DocumentButtonHighlight"] = "_document:imagenohighlight_";
+      } else {
+     options["DocumentButtonHighlight"] = "_document:imagehighlight_";
+      }
+      if (args["gc"] == "1") {
+     options["DocumentButtonExpandContents"] = "_document:imagecontracttoc_";
+      } else {
+     options["DocumentButtonExpandContents"] = "_document:imageexpandtoc_";
+      }
+      if (args["gt"] == "1") {
+     options["DocumentButtonExpandText"] = "_document:imagecontracttext_";
+      } else {
+     options["DocumentButtonExpandText"] = "_document:imageexpandtext_";
+      }
+      
       text_t doctext 
      = get_formatted_string (collection, collectproto, docinfo, disp,
@@ -916 +960 @@
 
 void documentaction::output_document (const text_t &OID, cgiargsclass &args, 
-                      recptproto *collectproto, displayclass &disp, 
-                      outconvertclass &outconvert, ostream &textout, 
-                      ostream &logout) {
+                      recptproto *collectproto, browsermapclass *browsers,
+                      displayclass &disp, outconvertclass &outconvert,
+                      ostream &textout, ostream &logout) {
   FilterResponse_t inforesponse;
   FilterResponse_t queryresponse;
@@ -930 +974 @@
   // if we have a query string and highlighting is turned on we need
   // to redo the query to get the terms for highlighting
+  
   if (!args["q"].empty() && args.getintarg("hl")) {
     FilterRequest_t request;
@@ -972 +1017 @@
       output_text (inforesponse.docInfo[0], formatlistptr, queryresponse.termInfo, 
            OID, highlight, hastxt, wanttext, collection, collectproto, 
-           disp, outconvert, textout, logout, args);
+           browsers, disp, outconvert, textout, logout, args);
 
 
@@ -1015 +1060 @@
       output_text (thisdocinfo, formatlistptr, queryresponse.termInfo, 
                OID, highlight, hastxt, wanttext, collection, 
-               collectproto, disp, outconvert, textout, logout, args);
+               collectproto, browsers, disp, outconvert, textout, logout, args);
       
     }
@@ -1032 +1077 @@
       output_text (*sechere, formatlistptr, queryresponse.termInfo, 
                (*sechere).OID, highlight, shastxt, wanttext, collection, 
-               collectproto, disp, outconvert, textout, logout, args);
+               collectproto, browsers, disp, outconvert, textout, logout, args);
       count ++;
       sechere ++;

trunk/gsdl/src/recpt/documentaction.h

@@ -32 +32 @@
 #include "formattools.h"
 #include "receptionist.h"
+#include "browserclass.h"
 
 class documentaction : public action {
@@ -55 +56 @@
                 bool highlight, int hastxt, int wanttext, 
                 text_t &collection, recptproto *collectproto,
-                displayclass &disp, outconvertclass &outconvert,
-                ostream &textout, ostream &logout,
-                cgiargsclass &args);
+                browsermapclass *browsers, displayclass &disp,
+                outconvertclass &outconvert, ostream &textout,
+                ostream &logout, cgiargsclass &args);
 
   virtual void output_document (const text_t &OID, cgiargsclass &args, 
-                recptproto *collectproto, displayclass &disp, 
-                outconvertclass &outconvert, ostream &textout, 
-                ostream &logout);
+                recptproto *collectproto, browsermapclass *browsers,
+                displayclass &disp,  outconvertclass &outconvert,
+                ostream &textout,  ostream &logout);
 
   void set_arrow_macros (cgiargsclass &args, recptproto *collectproto,

trunk/gsdl/src/recpt/formattools.cpp

@@ -540 +540 @@
     formatlistptr->command = comSummary;
 
+  else if (meta == "DocImage")
+    formatlistptr->command = comImage; 
+
+  else if (meta == "DocTOC")
+    formatlistptr->command = comTOC; 
+
+  else if (meta == "DocumentButtonDetach")
+     formatlistptr->command = comDocumentButtonDetach;
+  
+  else if (meta == "DocumentButtonHighlight")
+     formatlistptr->command = comDocumentButtonHighlight;
+  
+  else if (meta == "DocumentButtonExpandContents")
+    formatlistptr->command = comDocumentButtonExpandContents; 
+
+  else if (meta == "DocumentButtonExpandText")
+     formatlistptr->command = comDocumentButtonExpandText; 
+  
   else {
     formatlistptr->command = comMeta;
@@ -939 +957 @@
 }
 
-
+static text_t expand_metadata(const text_t &metavalue, const text_t& collection,
+                  recptproto* collectproto, ResultDocInfo_t &docinfo,
+                  displayclass &disp, text_tmap &options,
+                  ostream &logout) {
+      
+   if (includes_metadata(metavalue))
+      {
+     // text has embedded metadata in it => expand it
+     FilterRequest_t request;
+     FilterResponse_t response;
+
+     request.getParents = false;
+      
+     format_t *expanded_formatlistptr = new format_t();
+     parse_formatstring (metavalue, expanded_formatlistptr, 
+                 request.fields, request.getParents);
+      
+     // retrieve metadata
+     get_info(docinfo.OID, collection, request.fields, request.getParents,
+          collectproto, response, logout);
+     
+     if (!response.docInfo.empty())
+        {
+           text_t expanded_metavalue
+          = get_formatted_string(collection, collectproto, 
+                     response.docInfo[0], disp, expanded_formatlistptr, 
+                     options, logout);
+          
+           return expanded_metavalue;
+        }
+     else
+        {
+           return metavalue;
+        }
+      }
+   else
+      {
+     return metavalue;
+      }
+}
 
 text_t format_string (const text_t& collection, recptproto* collectproto,
@@ -949 +1006 @@
 
   switch (formatlistptr->command) {
-  case comText:
-    return formatlistptr->text;
-  case comLink:
-    return options["link"];
-  case comEndLink:
-    if (options["link"].empty()) return "";
-    else return "</a>";
-  case comHref:
-    return get_href(options["link"]);
-  case comIcon:
-    return options["icon"];
-  case comNum:
-    return docinfo.result_num;
-  case comRel: //if [RelatedDocuments] appears in format string, collect relation data
-    return get_related_docs(collection, collectproto, docinfo, logout);
-  case comSummary:
-    return format_summary(collection, collectproto, docinfo, disp, options, logout);
-  case comMeta:
-
-    {
-      const text_t& metavalue =  get_meta (docinfo, formatlistptr->meta);
-
-      if (includes_metadata(metavalue))
+     case comText:
+    return formatlistptr->text;
+     case comLink:
+    return options["link"];
+     case comEndLink:
+    if (options["link"].empty()) return "";
+    else return "</a>";
+     case comHref:
+    return get_href(options["link"]);
+     case comIcon:
+    return options["icon"];
+     case comNum:
+    return docinfo.result_num;
+     case comRel: //if [RelatedDocuments] appears in format string, collect relation data
+    return get_related_docs(collection, collectproto, docinfo, logout);
+     case comSummary:
+    return format_summary(collection, collectproto, docinfo, disp, options, logout);
+     case comMeta:
     {
-      // text has embedded metadata in it => expand it
-      FilterRequest_t request;
-      FilterResponse_t response;
-
-      request.getParents = false;
-      
-      format_t *expanded_formatlistptr = new format_t();
-      parse_formatstring (metavalue, expanded_formatlistptr, 
-                  request.fields, request.getParents);
-      
-      // retrieve metadata
-      get_info(docinfo.OID, collection, request.fields, request.getParents,
-           collectproto, response, logout);
-      
-      if (!response.docInfo.empty())
-        {
-          text_t expanded_metavalue
-        = get_formatted_string(collection, collectproto, 
-                       response.docInfo[0], disp, expanded_formatlistptr, 
-                       options, logout);
-          
-          return expanded_metavalue;
-        }
-      else
-        {
-          return metavalue;
-        }
+       const text_t& metavalue =  get_meta (docinfo, formatlistptr->meta);
+       return expand_metadata(metavalue, collection, collectproto, docinfo, disp, options, logout);
     }
-      else
-    {
-      return metavalue;
-    }
-    }
-  case comDoc:
-    return options["text"];
-  case comHighlight:
-    if (options["highlight"] == "1") return "<b>";
-    break;
-  case comEndHighlight:
-    if (options["highlight"] == "1") return "</b>";
-    break;
-  case comIf:
-    return get_if (collection, collectproto, docinfo, disp, 
-           formatlistptr->decision, formatlistptr->ifptr, 
-           formatlistptr->elseptr, options, logout);
-  case comOr:
-    return get_or (collection,collectproto, docinfo, disp, formatlistptr->orptr, 
-           options, logout);
+     case comDoc:
+    return options["text"];
+     case comImage:
+    return expand_metadata(options["DocImage"], collection, collectproto, docinfo, disp, options, logout);
+     case comTOC:
+    return options["DocTOC"];
+     case comDocumentButtonDetach:
+    return options["DocumentButtonDetach"];
+     case comDocumentButtonHighlight:
+    return options["DocumentButtonHighlight"];
+     case comDocumentButtonExpandContents:
+    return options["DocumentButtonExpandContents"];
+     case comDocumentButtonExpandText:
+    return options["DocumentButtonExpandText"];
+     case comHighlight:
+    if (options["highlight"] == "1") return "<b>";
+    break;
+     case comEndHighlight:
+    if (options["highlight"] == "1") return "</b>";
+    break;
+     case comIf:
+    return get_if (collection, collectproto, docinfo, disp, 
+               formatlistptr->decision, formatlistptr->ifptr, 
+               formatlistptr->elseptr, options, logout);
+     case comOr:
+    return get_or (collection,collectproto, docinfo, disp, formatlistptr->orptr, 
+               options, logout);
   }
   return "";

trunk/gsdl/src/recpt/formattools.h

@@ -34 +34 @@
 
 enum command_t {comIf, comOr, comMeta, comText, comLink, comEndLink, comNum, comIcon, 
-        comDoc, comHighlight, comEndHighlight, comRel, comHref, comSummary, comTOC, comImage};
+        comDoc, comHighlight, comEndHighlight, comRel, comHref, comSummary,
+        comTOC, comImage, comDocumentButtonDetach, comDocumentButtonHighlight,
+        comDocumentButtonExpandContents, comDocumentButtonExpandText};
 enum pcommand_t {pNone, pImmediate, pTop, pAll};
 enum dcommand_t {dMeta, dText};

trunk/gsdl/src/recpt/vlistbrowserclass.cpp

@@ -27 +27 @@
 #include <assert.h>
 #include "OIDtools.h"
+#include "browsetools.h"
 
 vlistbrowserclass::vlistbrowserclass () {
@@ -88 +89 @@
   if (highlight) options["highlight"] = "1";
   else options["highlight"] = "0";
+  options["DocImage"] = get_cover_image();
   textout << outconvert << disp 
       << get_formatted_string (collection, collectproto, 
@@ -137 +139 @@
   options["icon"] = icon;
   options["highlight"] = "0";
-
+  options["DocImage"] = get_cover_image();
+  
   if ( thissection != endsection ) { // only if there are results (else corrupts display)
     fstring = get_formatted_string (collection, collectproto, *thissection,
@@ -166 +169 @@
     if (highlight) options["highlight"] = "1";
     else options["highlight"] = "0";
+    options["DocImage"] = get_cover_image();
     
     textout << outconvert << disp