Changeset 7352 for trunk

Timestamp:

2004-05-20T09:24:38+12:00 (20 years ago)

Author:

kjdon

Message:

added a bit more to the description

File:

• trunk/gsdl/perllib/plugins/PagedImgPlug.pm (modified) (4 diffs)

trunk/gsdl/perllib/plugins/PagedImgPlug.pm

@@ -28 +28 @@
 # processes sequences of images, with optional OCR text
 #
-# This plugin takes .item files, which contain metadata and lists of image 
+# This plugin takes *.item files, which contain metadata and lists of image 
 # files, and produces a document containing sections, one for each page.
-#
-# The format of the .item file is as follows:
+# The files should be named something.item, then you can have more than one 
+# book in a directory. You will need to create these files, one for each
+# document/book.
+#
+# The format of the xxx.item file is as follows:
 # The first lines contain any metadata for the whole document
 # <metadata-name>metadata-value
@@ -38 +41 @@
 # <Date>19230102
 # Then comes a list of pages, one page per line, each line has the format
+#
 # pagenum:imagefile:textfile:r
+#
 # page num and imagefile are required. pagenum is used for the Title 
 # of the section, and in the display is shown as page <pagenum>. 
@@ -63 +68 @@
 #
 # format DocumentText "<center><table width=_pagewidth_><tr><td>[srcicon]</td></tr></table></center>"
+#
+# To have it create thumbnail size images, use the '-thumbnail' option.
+# To have it create medium size images for display, use the '-screenview'
+# option. As usual, running 
+# 'perl -S pluginfo.pl PagedImgPlug' will list all the options.
+
+# If you want the resulting documents to be presented with a table of 
+# contents, use '-documenttype hierarchy', otherwise they will have 
+# next and previous arrows, and a goto page X box. 
 
 # If you have used -screenview, you can also use [screenicon] in the format
@@ -71 +85 @@
 #
 # Additional metadata can be added into the .item files, alternatively you can 
-# use normal metadata.xml files, with the name of the .item file as the 
+# use normal metadata.xml files, with the name of the xxx.item file as the 
 # FileName.