Changeset 1941 for trunk/gsdl/src/recpt/documentaction.cpp

Timestamp:

2001-02-09T15:41:33+13:00 (23 years ago)

Author:

jmt14

Message:

Modified files:

browsetools.cpp documentaction.cpp formattools.cpp
formattools.h

File:

• trunk/gsdl/src/recpt/documentaction.cpp (modified) (10 diffs)

trunk/gsdl/src/recpt/documentaction.cpp

@@ -144 +144 @@
   arg_ainfo.savedarginfo = cgiarginfo::must;
   argsinfo.addarginfo (NULL, arg_ainfo);
+
+  //rd is whether a document will be displayed
+  //with a relevant document list
+  arg_ainfo.shortname = "rd";
+  arg_ainfo.longname = "include relevant documents";
+  arg_ainfo.multiplechar = false;
+  arg_ainfo.defaultstatus = cgiarginfo::weak;
+  arg_ainfo.argdefault = "0";
+  arg_ainfo.savedarginfo = cgiarginfo::must;
+  argsinfo.addarginfo (NULL, arg_ainfo);
+
 }
 
@@ -183 +194 @@
     if (xinfo != NULL) args["x"] = xinfo->argdefault;
   }
+
+  //checks whether rd arg is valid
+  int arg_rd = args.getintarg("rd");
+  if (arg_rd != 0 && arg_rd != 1) {
+    logout << "Warning: \"rd\" argument out of range (" << arg_rd << ")\n";
+    cgiarginfo *rdinfo = argsinfo.getarginfo ("rd");
+    if (rdinfo != NULL) args["rd"] = rdinfo->argdefault;
+  }
+
 
   return true;
@@ -490 +510 @@
          '|', formatinfo.DocumentButtons);
     else if ((*format_here).first == "DocumentText") 
-      formatinfo.DocumentText = (*format_here).second;
+      formatinfo.DocumentText = (*format_here).second;  
+    else if ((*format_here).first == "RelatedDocuments")
+      formatinfo.RelatedDocuments = (*format_here).second; 
     else if (((*format_here).first == "DocumentUseHTML") && 
          ((*format_here).second == "true"))
@@ -565 +587 @@
       options.push_back(opt);
     }
-
+    
+    //do not display relation metadata
+    disp.setmacro ("relateddoc", "document", "");  
+       
+    //if preferences indicate relevant docs should be collected
+    //and there is no particular format specified then display
+    //this default format.
+     if(args["rd"] == "1" && formatinfo.RelatedDocuments.empty()){
+
+       text_t relation = ""; //string for displaying relation metadata
+
+       //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); 
+     }
+     
+  
     // get metadata for this document and it's parents
     if (get_info (arg_d, collection, metadata, options, 
           true, collectproto, response, logout)) {
+
       disp.setmacro ("header", "document", "_textheader_");
-
+      
       text_tarray pagetitlearray;
       if (!response.docInfo[0].metadata["Title"].values[0].empty())
     pagetitlearray.push_back (response.docInfo[0].metadata["Title"].values[0]);
+      
       if (args["gt"] != "1") {
     MetadataInfo_t *parenttitle = response.docInfo[0].metadata["Title"].parent;
@@ -627 +671 @@
     }
 
-        // Add a macro to display the phind classifier (if appropriate)
+        //if the document is not a document from a collection
+    //we must set the macro to be an empty string
+    disp.setmacro ("relateddoc", "document", ""); 
+
+    // Add a macro to display the phind classifier (if appropriate)
     text_t &childtype = response.docInfo[0].metadata["childtype"].values[0];
     if (childtype == "Phind") {
@@ -642 +690 @@
                 outconvertclass &outconvert, ostream &textout, 
                 ostream &logout) {
-
-
+ 
   // must have a valid collection server
   recptproto *collectproto = protos->getrecptproto (args["c"], logout);
@@ -660 +707 @@
     }
 
+  
     if (formatinfo.DocumentUseHTML) {
       
@@ -682 +730 @@
     }
 
+   
     textout << outconvert << disp << "_document:header_\n"
         << "_document:content_\n";
       
     // output the table of contents
+    logout << "formatinfo.RelatedDocs: " << formatinfo.RelatedDocuments.getcstr() << endl;
     output_toc (args, browsers, formatinfo, collectproto, 
         disp, outconvert, textout, logout);
-    
+   
+    //output the related documents (may be the empty string)
+    //will not output the docs if a format string is specified
+    textout << outconvert << disp << "_document:relateddoc_\n";
+
     // output the document text
     textout << "<p>\n";
@@ -774 +828 @@
   }
 
+
   format_t *formatlistptr = new format_t();
   parse_formatstring (formatinfo.DocumentText, formatlistptr, metadata, getParents);
@@ -779 +834 @@
   metadata.insert ("hastxt");
   metadata.insert ("haschildren");
-  
+ 
   if (formatinfo.DocumentText == "[Text]")
     wanttext = 1;