Changeset 8370

Timestamp:

2004-10-19T09:53:19+13:00 (20 years ago)

Author:

kjdon

Message:

added a new faq about using UnknownPlug

Location:

trunk/greenorg/macros

Files:

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

trunk/greenorg/macros/english.dm

@@ -1028 +1028 @@
 
 _tfaqplugins2title_ {I'm having problems with my PDF files! What's wrong?}
+
+_tfaqplugins3title_ {How do I use UnknownPlug to handle my new format?}
 
 _headingcustomize_ {Customizing Your Greenstone Library}
@@ -1587 +1589 @@
 
 <tr>
+  <td> PagedImgPlug </td>
+  <td> Image, ImageHeight, ImageSize, ImageType, ImageWidth, ScreenHeight,
+        screenicon, ScreenSize, ScreenType, ScreenWidth, Source, srclink,
+        srcicon, Thumb, ThumbHeight, ThumbType, ThumbWidth </td>
+  <td>&nbsp;</td>
+</tr>
+<tr>
   <td> PDFPlug </td>
   <td>&nbsp;</td>
@@ -1715 +1724 @@
 </ol>
 }
+
+_unknownplug_ {UnknownPlug is a simple plugin for importing files in formats 
+that Greenstone doesn't know anything about.  A dummy document will be 
+created for every such file, and the file itself will be passed to Greenstone 
+as the \"associated file\" of the document. 
+<p>
+Here's an example where it is useful: A collection has pictures and includes 
+a couple of quicktime movie files with names like DCP_0163.MOV.  
+Rather than write a new plugin for quicktime movies, add this line to the 
+collection configuration file:
+<center>
+<small><tt>plugin UnknownPlug -process_exp "*.MOV" -assoc_field "movie"</tt></small></center>
+<p>
+A document is created for each movie, with the associated movie
+file's name in the "movie" metadata field.  In the collection's
+format strings, use the \{If\} macro to output different text for
+each type of file, like this:
+
+<center>
+<small><tt> \{If\}\{[movie],&lt;HTML for displaying movie&gt;\}<br>
+\{If\}\{[Image],&lt;HTML for displaying image&gt;\}</tt></small></center>
+<p>
+ You can also add extra metadata, such as the Title, Subject, and
+ Duration, using the Librarian Interface (or with metadata.xml files and RecPlug).  
+<p>
+The <tt>-process_exp</tt> option is a regular expression that matches filenames which should be processed by UnknownPlug. You can have several UnknownPlugs specified
+for a collection, each processing a different kind of file.
+<p>
+The <tt>-assoc_field</tt> option is the name of the metadata field that will hold the
+associated file's name. This can be used to test for these files. You can also specify the mime type of the files to
+be processed using the <tt>-mime_type</tt> option. To display the original file, use <tt>[srclink][/srclink]</tt> metadata.
+}
+