Changeset 8327

Timestamp:

2004-10-14T15:29:16+13:00 (20 years ago)

Author:

kjdon

Message:

added a new faq entry about format statements etc

Location:

trunk/greenorg/macros

Files:

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

trunk/greenorg/macros/english.dm

@@ -570 +570 @@
 
 _ex9d_ {
-Ulukau makes available resrouces for the use, teaching, and enhancement of the Hawaiian language. It has five collections: "Ka Hoʻoilina: Puke Pai ʻŌlelo Hawaiʻi" (The Legacy: Journal of Hawaiian Language Resources), Hawaiian Newspapers, Baibala Hemolele (The Hawaiian Bible), Hawaiian Dictionaries, and Hawaiian Books.
+Ulukau makes available resources for the use, teaching, and enhancement of the Hawaiian language. It has five collections: "Ka HoÊ»oilina: Puke Pai Ê»ÅŒlelo HawaiÊ»i" (The Legacy: Journal of Hawaiian Language Resources), Hawaiian Newspapers, Baibala Hemolele (The Hawaiian Bible), Hawaiian Dictionaries, and Hawaiian Books.
 }
 
@@ -1035 +1035 @@
 _tfaqcustomizemoreinfotitle_ {Where can I get more information about customizing my Greenstone library?}
 
+_tfaqcustomizeformattitle_ {What are the formatting options available for my collection?}
 _t207_ {FAQ Main Page}
 
@@ -1690 +1691 @@
 with an umlaut accent, LaTeX draws a "u" and then draws an umlaut accent over
 it. This means that <tt>pdftohtml</tt> will extract two separate characters
-('š' and 'u') rather than a single accented character (Ì).</li>
+('Âš' and 'u') rather than a single accented character (ÃŒ).</li>
 
 <li>PDF contains pieces of text, and coordinates for where that text
@@ -1728 +1729 @@
 }
 
+_tfaqcustomizeformat_ {
+Section 2.3 of the <a href="_httppagex_(docs)">Greenstone Developer's Guide</a> discusses how to format the output of your collection. However, the list of options is incomplete. The full list of formatting options is shown here. But for more information about how to use these options, the developer's guide is the place to go.
+<p>
+<i><u>Site-wide formatting options</u></i><br>
+These should be placed in gsdl/etc/main.cfg. <br>
+Syntax: <b>SiteFormat &lt;option-name&gt; &lt;option-value&gt;</b>
+<p>
+<table class="faq-table"><tr><th width=180>Item</th><th>Description</th></tr>
+<tr><td>HomePageCols int</td><td>Set the number of columns used to display collections on the home page.<br>Default: 3</td></tr>
+<tr><td>HomePageType pulldown</td><td>Display the collection list on the home page as a pulldown menu, rather than using the default table of collection images. This alters the html that appears in the dynamically generated _homeextra_ macro. You can then move this macro around in home.dm.<br>Default: not set</td></tr>
+</table>
+<p>
+<i><u>Collection-specific formatting options</u></i><br>
+These should be placed in gsdl/collect/&lt;collname&gt;/etc/collect.cfg. <br>
+Syntax: <b>format &lt;option-name&gt; &lt;option-value&gt;</b>
+<p>
+<table class="faq-table">
+<tr><th width=220>Item</th><th>Description</th></tr>
+<tr><td>DocumentImages true/false</td><td>If true, display a cover image at the top left of the document page<br>Default: false</td></tr>
+<tr><td>DocumentTitles true/false</td><td>If DocumentImages is false, and this is true, use DocumentHeading to display the title.<br>Default: true</td></tr>
+<tr><td>DocumentHeading formatstring</td><td>This is used for a document heading at the top left if DocumentImages is false and DocumentTitles is true.<br>Default: \{Or\}\{[parent(Top):Title],[Title],untitled\} &lt;br&gt;[Title] </td></tr>
+<tr><td>DocumentContents true/false</td><td colspan=2>Display table of contents (if document is hierarchical), or next/previous section arrows and "page k of n" text (if document is paged)<br>Default: true</td></tr>
+<tr><td>DocumentButtons string</td><td colspan=2>Controls the buttons that are displayed on a document page. Valid options are Detach, Highlight, Expand Text, Expand Contents. Should be separated by |.<br>Default: "Detach|Highlight"</td></tr>
+<tr><td>DocumentText formatstring</td><td>Format of the text to be displayed on a document page<br>Default: &lt;center&gt; &lt;table width=537&gt; &lt;tr&gt;&lt;td&gt;[Text]&lt;/td&gt;&lt;/tr&gt; &lt;/table&gt; &lt;/center&gt;</td></tr>
+<tr><td>DocumentArrowsTop true/false</td><td>Display next/previous section arrows at top of document, underneath the navigation bar, on document page<br>Default: false</td></tr>
+<tr><td>DocumentArrowsBottom true/false</td><td>Display next/previous section arrows at bottom of document page<br>Default: true</td></tr>
+<tr><td>DocumentUseHTML true/false</td><td>If true, each document is displayed in a separate frame. The Preferences page will also change slightly, adding options applicable to a collection of HTML documents.<br>Default: false</td></tr>
+<!--<tr><td>RelatedDocuments string</td><td>Don't know that this gets used<br>Default: ""</td></tr>-->
+<tr><td>NavigationBar pulldown</td><td>If set, provides a drop down list in place of the usual navigation bar (that contains search and classifier options). This alters the html that appears in the dynamically generated _navigationbar_ macro.<br>Default: not set</td></tr>
+<tr><td>AllowExtendedOptions true/false</td><td>This allows the entire content of the document page to be controlled by format statements. Use DocumentHeading and DocumentText to format the document. This option prevents the other hard coded stuff (table of contents, buttons etc) from being output. It effectively disables the DocumentContents, DocumentButtons, DocumentImages format options. New format items are provided for use in format statements if AllowExtendedOptions is true (see table below)<br>Default: false</td></tr>
+</table>
+
+<p>
+<i><u>Formatting Lists</u></i><br>
+The standard use of format statements is for the lists in search results, classifiers etc. Here is a list of the various lists available for format, and what they control. Note that classifiers are numbered from 1 upwards, in the order that they appear in the config file.
+<p>
+<table class="faq-table"><tr><th align=left>Item</th><th align=left>Description</th></tr>
+<tr><td>VList</td><td>Applies to all vertical lists, unless overriden by a more specific format item. These include search results, classifier lists, and table of contents</td></tr>
+<tr><td>HList</td><td>Applies to all horizontal lists. Horizontal lists are often used in classifiers, particularly AZ[Compact][Section]Lists</td></tr>
+<tr><td>DateList</td><td>Applies to all date lists - these are the vertical lists generated by a DateList classifier.</td></tr>
+<tr><td>SearchVList</td><td>The vertical list of search results</td></tr>
+<tr><td>CL1VList</td><td>Applues only to the vertical list of classifier 1</td></tr>
+<tr><td>CL1HList</td><td>Applies only to the horizontal list of classifier 1</td></tr>
+<tr><td>CL1DateList</td><td>Applies only to the DateList in classifier 1</td></tr>
+</table>
+<p>
+<i><u>Formatstring items</u></i><br>
+<p>
+<table class="faq-table"><tr><th align=left>Item</th><th align=left>Description</th></tr>
+<tr><td>[link][/link]</td><td>Link to the document (Greenstone version)</td></tr>
+<tr><td>[srclink][/srclink]</td><td>Link to the original document (only if the original was converted to another form)</td></tr>
+<tr><td>[icon]</td><td>An appropriate icon for a classifier/document node. Eg. bookshelf, book, chapter, page</td></tr>
+<tr><td>[srcicon]</td><td>An appropriate icon for the original source document. Eg. Word, PDF, PS icon.</td></tr>
+<!--<tr><td>[href]</td><td>not sure what this does and it caused a segmentation fault when I tried to use it</td></tr>-->
+<tr><td>[num]</td><td>The document number (position in the search results - useful for debugging)</td></tr>
+<tr><td>[numleafdocs]</td><td>The number of documents below the current classifier node. This is often used as a test for classifier nodes, as numleafdocs will not be set for documents. This allows different formatting for classifier nodes and document nodes in a hierarchy.</td></tr>
+<tr><td>[Text]</td><td>The text of the current section</td></tr>
+<tr><td>[RelatedDocuments]</td><td>Related Documents info (if available). This is a vertical list of Titles (or Subjects if Titles aren't available) that link to the related documents. It is based on "relation" metadata, which is a space separated list of collection,OID pairs.</td></tr>
+<tr><td>[highlight][/highlight]</td><td>These are used for 'higlighting' (actually bolding) the selected section in a hierarchical table of contents, and the selected node in a classifier. Apart from those two cases, this has no effect. If you actually want to highlight/bold/italicise something in a list, and have it apply to all items in the list, then use actual html tags, like &lt;b&gt;&lt;/b&gt;, &lt;u&gt;&lt;/u&gt; and &lt;i&gt;&lt;/i&gt;</td></tr>
+<tr><td>[Summary]</td><td>Displays Summary metadata if available, otherwise displays a short summary created on the fly.</td></tr>
+<tr><td>[DocOID]</td><td>The internal identifier of the document</td></tr>
+<tr><td>[DocRank]</td><td>The rank of the current document - used in search results</td></tr>
+<tr><td>[metadata-name]</td><td>The value of this metadata element for the document</td></tr>
+</table>
+<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).
+<p>
+<table class="faq-table">
+<tr><td>[parent:Title]</td><td>The Title of the immediate parent section</td></tr>
+<tr><td>[parent(Top):Title]</td><td>The Title of the topmost parent section</td></tr>
+<tr><td>[parent(All):Title]</td><td>All Titles of the parent sections, separated by ", "</td></tr>
+<tr><td>[parent(All':&nbsp;'):Title]</td><td>All Titles of the parent sections, separated by ": " (or whatever appears inside the ' ')</td></tr>
+<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>
+</table>
+
+<p>
+<i><u>Extended Formatstring items</u></i><br>
+These items are only available if AllowExtendedOptions is true.
+<p>
+<table class="faq-table"><tr><th align=left>Item</th><th align=left>Description</th></tr>
+<tr><td>[DocumentButtonDetach]</td><td>The Detach button</td></tr>
+<tr><td>[DocumentButtonHighlight]</td><td>The Highlight button</td></tr>
+<tr><td>[DocumentButtonExpandText]</td><td>The Expand Text button</td></tr>
+<tr><td>[DocumentButtonExpandContents]</td><td>The Expand Contents button</td></tr>
+<tr><td>[DocImage]</td><td>The cover image of the document</td></tr>
+<tr><td>[DocTOC]</td><td>The table of contents for a hierarchical document, or the next/previous and go to page x bits for a paged document.</td></tr>
+</table>
+
+<p>
+<i><u>Conditional expressions in formatstrings</u></i><br>
+<table class="faq-table">
+<tr><td>\{If\}\{[metadata], action-if-non-null, action-if null\}</td><td>If there is a value for this metadata element, then output the first clause, otherwise output the second clause. Either clause is optional: if empty, nothing will be done for that case. <br>This is useful for displaying classifier nodes differently to document nodes: \{If\}\{[numleafdocs],format for classifier,format for document\}</td></tr>
+<tr><td>\{If\}\{"[metadata]" eq "value", action-if-equal, action-if-not-equal\}</td><td>Can do tests on metadata values: equals</td></tr>
+<tr><td>\{If\}\{"[metadata]" ne "value", action-if-not-equal, action-if-equal\}</td><td>Can do tests on metadata values: not equals</td></tr>
+<tr><td>\{Or\}\{[metadata], [metadata2], [metadata3]...\}</td><td>Each metadata is evaluated in turn, and the first one that exists is output<br>Useful for cases where there are different namespaced version of the same metadata, e.g. \{Or\}\{[dc.Title],[dls.Title],[Title],Untitled\}</td></tr>
+</table>
+}
 
 #######################################################################