root/documented-example-collections/trunk/pagedimg-e/etc/collect.cfg @ 18807

Revision 18807, 6.8 KB (checked in by kjdon, 10 years ago)

removed beta lines and collectionicon lines from collect.cfg files

  • Property svn:executable set to *
3public      true
5indexes     section:text
6defaultindex    section:text
8plugin      GAPlug
9# We want the two types of paged documents to be treated differently: paged
10# and hierarchical. So include two PagedImgPlug plugins and modify the process_exp.
11plugin      PagedImgPlug -screenview -minimumsize 100 -documenttype hierarchy -process_exp xml.*\.item$
12plugin      PagedImgPlug -screenview -minimumsize 100 -documenttype paged
13plugin      ArcPlug
14plugin      RecPlug -use_metadata_files
16classify    AZCompactList -metadata Series -sort Date
17classify    DateList
19# Format statements to display Series, Volume, Number and Date information
21format DocumentVList "<td valign=top>[link][icon][/link]</td>
22<td valign=top>{If}{[Series],[Series] {If}{[Volume],Vol. [Volume]} {If}{[Number],No. [Number]},[highlight]{Or}{[Title],[PageNum]}[/highlight]}</td>"
24format CL1VList "<td valign=top>[link][icon][/link]</td>
25<td valign=top>{If}{[numleafdocs],[Title],{If}{[Volume],Vol. [Volume]} {If}{[Number],No. [Number]} ([Date])}</td>"
27format SearchVList "<td valign=top>[link][icon][/link]</td>
28<td valign=top>[parent(Top):Series] {If}{[parent(Top):Volume],Vol. [parent(Top):Volume]} {If}{[parent(Top):Number],No. [parent(Top):Number]} Page [Title]</td>"
30format DateList "<td valign=top>[link][icon][/link]</td>
31<td valign=top>[Series] {If}{[Volume],Vol. [Volume]} {If}{[Number],No. [Number]}</td>"
33format HList "[link][highlight][ex.Title][/highlight][/link]"
35# We customise the document display, so use the extended options
36format AllowExtendedOptions  true
38# We want to add in fullsize/preview/text buttons to switch between the different versions of each page
40format DocumentHeading "<center><table width=_pagewidth_>
41<tr valign=top><td>{Or}{[parent(Top):Series],[Series]}</td></tr>
42<tr valign=top><td><table><tr><td>
44{If}{_cgiargp_ eq 'fullsize',{If}{[screenicon],_document:viewpreview_}
45{If}{[Text] ne \'This document has no text. \',_document:viewtext_},
46{If}{_cgiargp_ eq 'preview',{If}{[srcicon],_document:viewfullsize_}
47{If}{[Text] ne \'This document has no text. \',_document:viewtext_},
53# Document text display changes based on the p argument - this is not used
54#normally for document display, so we can use it here to switch between
55#fullsize/preview/text versions.
56format DocumentText "<center><table width=_pagewidth_><tr><td>
57{If}{_cgiargp_ eq 'fullsize',[srcicon],
58{If}{_cgiargp_ eq 'preview',[screenicon],{If}{[Text] ne \'This document has no text. \',[Text]}}}
62# -- English strings --------------------
63collectionmeta  collectionname [l=en] "Paged Image example"
64collectionmeta  .section:text [l=en] "newspaper pages"
66# -- English text -----------------------
68collectionmeta  collectionextra [l=en] "This collection contains a few newspapers from the
69<a href=';p=about&amp;c=niupepa'>
70Niupepa</a> collection of Maori newspapers.
72<h3>How the collection works</h3>
73<p>Each newspaper issue consists of a set of images, one per page, and a set
74of text files for the OCR'd text. An item file links the set of pages into a
75single newspaper document. PagedImgPlug is used to process the item files.
76<p>There are two styles of item files, and this collection demonstrates both.
77The first uses a text based format, and consists of a list of metadata for the
78document, and a list of pages. Here are some examples:
79<a href='_httpcollection_/import/09/09\_1\_1.item'>Te Waka o Te Iwi, Vol. 1, No. 1</a>,
80<a href='_httpcollection_/import/10/10\_1\_3.item'>Te Whetu o Te Tau, Vol. 1, No. 3</a>.
81This format allows specification of document level metadata, and a single list of pages.
82<p>The second style is an extended format, and uses XML. It allows a hierarchy
83of pages, and metadata specification at the page level as well as at the
84document level. An example is <a href='_httpcollection_/import/xml/23/23\_\_2.item'>Matariki 1881, No. 2</a>.
85This newspaper also has an abstract associated with it. The contents have been
86grouped into two sections: Supplementary Material, which contains the Abstract,
87 and Newspaper Pages, which contains the page images.
88<p>Paged documents can be presented with a hierarchical table of contents
89(e.g. <a href='?a=d&amp;c=pagedimg&amp;d=HASHecd552ed3c2d5f1f6a620f.2.2&p=text'>this one</a>),
90or with next and previous page arrows, and a goto page box
91(e.g. <a href='?a=d&amp;c=pagedimg&amp;d=HASH01f4f2a92e501cdfa5d243bb.2&p=preview'>this one</a>).
92This is specified by the <tt>-documenttype (hierarchy|paged)</tt> option to PagedImgPlug.
93The next and previous arrows suit the linear sequence documents, while the table of contents
94suits the hierarchically organised document. Ordinarily, a Greenstone collection
95 would have one plugin per document type, and all documents of that type get
96the same processing. In this case, we want to treat the XML-based item files
97differently from the text-based item files. We can achieve this by adding two
98PagedImgPlug plugins to the collection, and configuring them differently.
99<p><tt>plugin PagedImgPlug -screenview -minimumsize 100 -documenttype hierarchy -process_exp xml.*\.item$<br/>
100plugin  PagedImgPlug -screenview -minimumsize 100 -documenttype paged </tt>
102<p>XML based newpapers have been grouped into a folder called <tt>xml</tt>.
103This enables us to process these files differently, by utilising the
104<tt>process_exp</tt> option which all plugins support. The first PagedImgPlug
105in the list looks for item files underneath the xml folder. These documents
106will be processed as hierarchical documents. Item files that don't match the
107process expression (i.e. aren't underneath the xml folder) will be passed onto
108the second PagedImgPlug, and these are treated as paged documents.
109<p>Note that GLI will not let you add two of the same plugin (apart from
110UnknownPlug), so this must be added to the collect.cfg file manually. The
111collection must not be open in GLI while you are doing this.
113<p>We have modified the document formatting to display fullsized images,
114preview images or text, with buttons to switch between them. This involves
115modifications to the DocumentHeading and DocumentText format statements in the
116<a href='_httpcollection_/etc/collect.cfg'>collection configuration file</a>,
117and some macro definitions in the <a href='_httpcollection_/macros/'> macro file</a>.
118The macro file provides definitions for the buttons (\_viewfullsize\_,
119 \_viewpreview\_, \_viewtext\_) which are used by the format statement in the
120collect.cfg file. The format statement switches the document display and sets
121the buttons to be displayed based on the p argument, which is also set by the
122format statement.
Note: See TracBrowser for help on using the browser.