Changeset 8936

Timestamp:

2005-02-01T14:26:20+13:00 (19 years ago)

Author:

kjdon

Message:

first draft of hyperlinking metadata elements faq entry. Michael has promised to tidy this up.

Location:

trunk/greenorg/macros

Files:

• english.dm (modified) (4 diffs)
• faq.dm (modified) ( previous)

trunk/greenorg/macros/english.dm

@@ -1043 +1043 @@
 
 _tfaqcustomizeformattitle_ {What are the formatting options available for my collection?}
+
+_tfaqcustomizemetadatalinkingtitle_ {How can I hyperlink individual metadata elements?}
+
 _t207_ {FAQ Main Page}
 
@@ -1861 +1864 @@
 <p>
 <i><u>Extended metadata names</u></i><br>
-There are a few options for displaying metadata. The basic way is to specify e.g. [Title] or [dc.Title]: this displays the value of that particular metadata element for the current document/section. Metadata names can be prefixed by parent: or sibling. The following examples all use Title or Subject metadata, but any metadata could be used, including ones with namespaces (e.g. dc.Title).
+There are a few options for displaying metadata. The basic way is to specify e.g. [Title] or [dc.Title]: this displays the value of that particular metadata element for the current document/section. Metadata names can be prefixed by parent: or sibling. The following examples all use Title or Subject metadata, but any metadata could be used, including ones with namespaces (e.g. dc.Title). Any metadata name can also be prefixed by "cgisafe:". This results in the value being formatted so that it is safe to put in a URL.
 <p>
 <table class="faq-table">
@@ -1870 +1873 @@
 <tr><td>[sibling:Subject]</td><td>All Subjects of the current section, separated by ", ". This is used for displaying metadata where there is more than one value. [Subject] will just display the first value.</td></tr>
 <tr><td>[sibling(All:'&lt;br&gt;'):Subject]</td><td>All Subjects of the current section, separated by &lt;br&gt;. </td></tr>
+<tr><td>[cgisafe:parent(Top):Title]</td><td>The Title of the topmost parent section, made safe for URLs.</td></tr>
+<tr><td>[cgisafe:sibling(All:'&lt;br&gt;'):Subject]</td><td>All Subjects of the current section, separated by &lt;br&gt;, made safe for URLs.</td></tr>
 </table>
 
@@ -1895 +1900 @@
 }
 
+_tfaqcustomizemetadatalinking_ {
+<i>[contributed by Axel Schild]</i><br/>
+When a metadata element has only one value, it is easy to make a hyperlink out of the value. In the format statement, you just put an &lt;a&gt; tag around the metadata item, for example: 
+<br><small><tt>&lt;a href="url to link to"&gt;[dc.Subject]&lt;/a&gt;</tt></small><br>
+When the metadata item has multiple values, and you want to link each one separately, it is a bit more difficult. The following is Axel's solution to his particular problem: display all the Creator elements, each one hyperlinked to a search of that Creator, in the Creators index.  
+<p>
+Use the format string below in the collect.cfg file (for my collection I put this string in "format DocumentText" statement)
+<br><small><tt><pre>
+\{If\}\{[dc.Creator],
+&lt;tr&gt;
+&lt;td align=right valign=top&gt;&lt;b&gt;Authors:&lt;/b&gt;&lt;/td&gt;
+&lt;td align=left valign=bottom&gt;&lt;label name=AuthorField id=AuthorField&gt;
+\_httpquery\_;[cgisafe:sibling(All:\\' ; \\'):dc.Creator];[sibling(All:\\'\_\\'):dc.Creator]
+&lt;/label&gt;&lt;/td&gt;
+&lt;/tr&gt;\}
+</pre></tt></small>
+This statement includes a label definition with the name "AuthorField". "\_httpquery\_" is a macro which resolves into the http-address of query page of the collection. "[cgisafe:sibling(All:\\' ; \\'):dc.Creator]" displays all Creators, separated by ; with all special characters replaced with UTF-8 encoding, so that it can be used  within a web address. [sibling(All:\\'\_\\'):dc.Creator] produces a similar string without replaced special characters. Notice the different separation symbols, these are needed later on.
+<p>
+Additional changes have to be made in order to make this whole thing work. You further need to change the \_header\_ or \_textheader\_ macro in the package of the page the format string will be displayed in (in my case the document package). The change is that \_htmlhead has to be parametrized with
+
+<small><tt>\_htmlhead\_(onload="ExtractAuthors();")</tt></small>, where ExtractAuthors(); is a Javascipt function, which is called on loading the corresponding page (the document display page). Since you do not want to mess in the standard macro files, create an extra.dm file (should be placed in gsdl/collect/&lt;collnanme&gt;/macros) and override the chosen macro with a collection specific macro. In my example this is done by the code sequence
+
+<br><small><tt><pre>
+package document
+
+###document display
+
+###HTML-Page Header
+\_textheader\_ [c=exacol] \{\_cgihead\_
+\_htmlhead\_(onload="ExtractSubjects();ExtractAuthors();")
+&lt;center&gt;
+&lt;table width=_pagewidth_&gt;&lt;tr&gt;&lt;td align=right&gt;
+\_icontab\_\_javalinks\_&lt;/td&gt;&lt;/tr&gt;&lt;/table&gt;
+&lt;/center&gt;
+\}
+</pre></tt></small>
+Now all that is missing is the Javascript function which has to be included into the \_pagescriptextra\_ macro of the same package. Copy this macro out of the corresponding standard macro file and paste it into your extra.dm file. Make the neccessary modification which is in my case
+<br><small><tt><pre>
+### Self-made Javascript functions
+\_pagescriptextra\_\{
+function ExtractAuthors() \\\{
+  var res;
+  a = AuthorField.outerText.split(";");
+  resolver = a[0]+"&q=";
+  b = a[1].split("+%3b+");
+  c = a[2].split("\_");
+  res = "";
+  for (i = 0; i &lt; b.length ;i++)
+    \\{
+       res = res + "&lt;a href=" + resolver + b[i]+ "&h=dd0&t=0&gt;" + c[i] + "&lt;/a&gt;&lt;br/&gt;";
+    \\}
+  AuthorField.outerHTML = res;
+\\}
+\}
+</pre></tt></small>
+This Javascript function evaluates the string of the defined label, splits it into several strings and composes a string out of thoses values, which is then set to the "outerHTML" element of the label. "&h=dd0" indicates which index to search in, and dd0 should be replaced with the name of the appropriate index. The file gsdl/collect/&lt;collname&gt;/index/build.cfg gives the names of the various indexes.
+                  
+}
+
 #######################################################################