Changeset 9486
- Timestamp:
- 2005-03-23T13:47:51+12:00 (19 years ago)
- File:
-
- 1 edited
Legend:
- Unmodified
- Added
- Removed
-
trunk/greenorg/macros/english.dm
r9483 r9486 6 6 } 7 7 8 9 8 _textimagepref_ {Preferences page} 10 9 … … 12 11 _textimagedownload_ {Download} 13 12 _textimageexamples_ {Examples} 14 15 # These are not translated because the pages themselves are not translated16 _textimagefaq_ {FAQ}17 13 _textimagesupport_ {Support} 18 19 14 20 15 #------------------------------------------------------------ … … 39 34 _httpicontexmplon_ {_httpimg_/exmplon.gif} 40 35 41 # These are not translated because the pages themselves are not translated42 43 ## "faq" ## nav_bar_button ## tfaq ##44 _httpicontfaqof_ {_httpimg_/faqof.gif}45 _httpicontfaqon_ {_httpimg_/faqon.gif}46 47 36 ## "support" ## nav_bar_button ## tsup ## 48 37 _httpicontsupof_ {_httpimg_/supof.gif} 49 38 _httpicontsupon_ {_httpimg_/supon.gif} 50 51 39 52 40 ####################################################################### … … 840 828 Alternatively, if your department/organization is willing to organise and fund a Greenstone workshop in your area, we might be able to run it (depending on what other commitments we have). We would require our air travel and basic accomodation to be paid for, and if you're feeling generous, a donation towards our research costs would be appreciated. 841 829 } 842 #######################################################################843 844 package supportform845 846 _tsupportformintro_ {847 To send a query to the Greenstone support staff, please fill in the form848 below and click the "Submit Query" button to submit the query. Please fill in849 the form as fully as possible to aid our staff in giving the best possible850 service.851 852 }853 _t113_ {PERSONAL INFORMATION}854 855 _t114_ {Name}856 857 _t115_ {E-mail address}858 859 _t116_ {SYSTEM INFORMATION}860 861 _t117_ {Operating System}862 863 _t118_ {Windows 95}864 865 _t119_ {Windows 98}866 867 _t120_ {Windows ME}868 869 _t121_ {Windows NT 4}870 871 _t122_ {Windows 2000}872 873 _t123_ {Windows XP}874 875 _t124_ {Windows 3.11}876 877 _t125_ {Windows 3.1}878 879 _t126_ {Linux}880 881 _t127_ {Other (please specify below)}882 883 _t128_ {Other OS}884 885 _t129_ {CPU (type and speed)}886 887 _t130_ {Memory (RAM) in MB}888 889 _t131_ {Web browser}890 891 _t132_ {Netscape 4}892 893 _t133_ {Netscape 4.5}894 895 _t134_ {Netscape 6}896 897 _t135_ {Mozilla}898 899 _t136_ {Internet Explorer 4}900 901 _t137_ {Internet Explorer 5}902 903 _t138_ {Internet Explorer 6}904 905 _t139_ {Other web browser}906 907 _t140_ {Was your browser provided by your internet service provider?}908 909 _t141_ {no}910 911 _t142_ {yes}912 913 _t143_ {don't know}914 915 _t144_ {Is your browser configured to use a proxy?}916 917 _t145_ {Web server}918 919 _t146_ {not applicable}920 921 _t147_ {Apache 1.3}922 923 _t148_ {Apache 2.0}924 925 _t149_ {Microsoft IIS 4.0}926 927 _t150_ {Microsoft IIS 5.0}928 929 _t151_ {Microsoft PWS}930 931 _t152_ {Other server}932 933 _t153_ {GREENSTONE INFORMATION}934 935 _t154_ {Version}936 937 _t155_ {CD-ROM distribution}938 939 _t156_ {Installation type}940 941 _t157_ {local library}942 943 _t158_ {web library}944 945 _t159_ {PROBLEM DESCRIPTION}946 947 _t160_ {Problem type}948 949 _t161_ {question}950 951 _t162_ {problem/error}952 953 _t163_ {suggested enhancement}954 955 _t164_ {other}956 957 _t165_ {Can the problem be reproduced at will?}958 959 _t166_ {Short description}960 961 _t167_ {Long description}962 963 _t168_ {964 (If you are reporting a problem, please go into as much detail as possible.965 Make sure you describe all steps leading up to the problem and include any966 relevant URLs.)967 }968 969 970 #######################################################################971 972 package faq973 974 _greenstonefaq_ {Greenstone FAQ}975 976 _headinggeneral_ {General Information}977 978 _t171_ {What is Greenstone?}979 980 _t172_ {How is Greenstone licensed?}981 982 _t173_ {What platforms will Greenstone run on?}983 984 _t174_ {Are there any mailing lists concerned with Greenstone?}985 986 _t175_ {Are the mailing lists archived anywhere?}987 988 _t176_ {How do I contribute to Greenstone?}989 990 _headingobtaining_ {Obtaining Greenstone}991 992 _t178_ {Where do I get Greenstone from?}993 994 _t179_ {Are there binary distributions of Greenstone available?}995 996 _t180_ {Is Greenstone available on CD-ROM?}997 998 _t181_ {Is the Greenstone source code available via CVS?}999 1000 _headinginstalling_ {Installing Greenstone}1001 1002 _t183_ {How do I compile Greenstone from a source or CVS distribution?}1003 1004 _t184_ {What is the difference between Greenstone's <i>local library</i> and <i>web library</i>?}1005 1006 _tfaqgliapplettitle_ {How do I install the Greenstone Librarian Interface as an applet?}1007 1008 _headingrunning_ {Running Greenstone}1009 1010 _t186_ {OK, I've installed Greenstone. Now how do I make it go?}1011 1012 _t187_ {What web browser do I need to view Greenstone collections?}1013 1014 _t188_ {When I start the Windows local library there are two buttons in the1015 dialog box, "Enter Library" and "Restricted1016 Version". They both seem to do the same thing, what's the difference?}1017 1018 _t189_ {So when should I use the "Restricted Version" of the local library?}1019 1020 _t190_ {When I start the Windows local library my computer asks me to dial1021 up my Internet Service Provider. Do I really need to be online to run1022 Greenstone?}1023 1024 _t191_ {I'm trying to use the Windows local library. My web browser is1025 starting up as expected but the Greenstone home page never gets loaded or gives an error message. What's wrong?}1026 1027 _t192_ {Where can I get more Greenstone collections?}1028 1029 _t193_ {When I attempt to access certain parts of Greenstone I'm asked for1030 a username and password. What do I enter?}1031 1032 _t194_ {When I use the <i>large query box</i> function I occassionally get1033 a <i>Not Found</i> error.}1034 1035 _headingbuilding_ {Building Greenstone Collections}1036 1037 _tfaqbuildglititle_ {What is the "Greenstone Librarian Interface"?}1038 1039 _t196_ {What is "the Collector"?}1040 1041 _t197_ {How do I build a collection from the command line or DOS prompt?}1042 1043 _t198_ {I built a new Greenstone collection on my Windows1044 machine. Everything appeared to work fine while building, however when I1045 tried to view the collection some of the documents contained no1046 text. Sometimes Greenstone appeared to crash completely. What have I done1047 wrong?}1048 1049 _t199_ {Why won't the Collector's "export to CD-ROM" function work?}1050 1051 _t200_ {I'm trying to use the Collector on Windows 2000 but it's running1052 extremely slowly. Is this normal?}1053 1054 _t201_ {What is "the Organizer"?}1055 1056 _t202_ {Where do I get the Organizer?}1057 1058 _t203_ {I'm attempting to build a collection with the collector but it1059 keeps failing with an error. What am I doing wrong?}1060 1061 _t204_ {Where can I find some example collect.cfg configuration files?}1062 1063 _t205_ {How can I build my collection using MGPP?}1064 1065 _tfaqbuild11title_ {I've added a new type of classification to my collection. How do I create and add the navigation bar images?}1066 1067 _tfaqbuildexpattitle_ {How do I fix XML::Parser errors during import.pl?}1068 1069 _tfaqbuildsizelimittitle_ {Are there any limits to the size of collections?}1070 1071 _headingplugins_ {More About Plugins}1072 1073 _tfaqplugins0title_ {Does Greenstone have a plugin for my data format?}1074 1075 _tfaqplugins1title_ {What metadata is available for each plugin?}1076 1077 _tfaqplugins2title_ {I'm having problems with my PDF files! What's wrong?}1078 1079 _tfaqplugins3title_ {How do I use UnknownPlug to handle my new format?}1080 1081 _headingcustomize_ {Customizing Your Greenstone Library}1082 1083 _tfaqcustomizefrontpagelogotitle_ {How do I change the logo on the front page of my library ("greenstone digital library software")?}1084 1085 _tfaqcustomizemoreinfotitle_ {Where can I get more information about customizing my Greenstone library?}1086 1087 _tfaqcustomizeformattitle_ {What are the formatting options available for my collection?}1088 1089 _tfaqcustomizemetadatalinkingtitle_ {How can I hyperlink individual metadata elements?}1090 1091 _t207_ {FAQ Main Page}1092 1093 _t372_ {Show entire FAQ on a single page}1094 1095 _t373_ {Show FAQ on multiple pages}1096 1097 #######################################################################1098 1099 package faqgen1100 1101 _t208_ {1102 Greenstone is a suite of software which has the ability to serve digital1103 library collections and build new collections. It provides a new way of1104 organizing information and publishing it on the Internet or on CD-ROM.1105 For more information, read the <a href="_httppagex_(factsheet)">Greenstone Fact Sheet</a>.}1106 1107 _t209_ {1108 Greenstone is open-source software, distributed under the terms of the <a1109 href="http://www.gnu.org/copyleft/gpl.html">GNU General Public License</a>.1110 }1111 1112 _t210_ {1113 Greenstone has been tested on Windows 3.1/3.11/95/98/Me/NT/2000, most1114 distributions of GNU/Linux, Darwin (Mac OS X), Solaris, and FreeBSD. It1115 should in fact work on any Windows or Unix system. If you use a system1116 other than those mentioned and you find Greenstone doesn't run, please <a1117 href="_httppagex_(support)">contact</a> us.1118 <p>Please note that the downloadable Windows distribution of Greenstone1119 comes with an installer that will not work on 16 bit Windows. If you need1120 to use Greenstone on Windows 3.1/3.11 please <a1121 href="_httppagex_(support)">contact</a> us.</p>1122 }1123 1124 _t211_ {1125 There are two Greenstone mailing lists. You can subscribe to them from the1126 <a href="_httppagex_(docs)#mailing-lists">documentation</a> page.1127 }1128 1129 _t212_ {1130 The most popular mailing list ([email protected]) is1131 archived as a Greenstone collection at <a1132 href="http://www.nzdl.org/cgi-bin/library?a=p&p=about&c=gsarch">www.nzdl.org</a>.1133 Note that this collection is updated only sporadically so may not always be1134 completely up to date.1135 }1136 1137 _t213_ {1138 We welcome contributions or improvements to the Greenstone software!1139 <br />Before you send in any contribution, you first need to make sure that1140 your changes are compatible with the latest snapshop of the Greenstone1141 source code. To get the latest code you'll need to use CVS (see <a1142 href="_httppagex_(cvs)">here</a> for details).1143 <br />You should then send the modified files, along with details of the1144 modifications you've made, to <a1145 href="mailto:[email protected]">[email protected]</a>.1146 1147 <p>Before beginning work, you should announce what you're doing on the <a1148 href="mailto:[email protected]">greenstone developer's list</a>1149 to tell us what you plan to do and get some feedback.</p>1150 }1151 1152 1153 #######################################################################1154 1155 package faqob1156 1157 _t215_ {1158 From the greenstone.org <a href="_httppagex_(download)">download</a> page.1159 }1160 1161 _t216_ {1162 Yes. At present there are binary distributions for 32 bit Windows, PowerPC1163 Mac OS X, and i386 linux. They can be downloaded from the <a1164 href="_httppagex_(download)">download</a> page.1165 }1166 1167 _t217_ {1168 While some version 2.37 and 2.38 CD-ROMs have been produced they're not1169 currently being made widely available. You are encouraged to download the1170 latest release of Greenstone from the <a1171 href="_httppagex_(download)">download</a> page. If your internet connection1172 is such that downloading Greenstone isn't possible please <a1173 href="_httppagex_(support)">contact</a> us and we may be able to arrange1174 for a CD-ROM to be sent out.1175 }1176 1177 _t218_ {1178 Yes, see our <a href="_httppagex_(cvs)">CVS page</a> for details.1179 }1180 1181 1182 #######################################################################1183 1184 package faqinst1185 1186 _t220_ {1187 See our <a href="_httpdocsdir_/compiling.html">compiling page</a>.1188 }1189 1190 _t221_ {1191 Firstly, the <i>local library</i> is only available if you're running1192 Greenstone under Windows. It's not yet available on Unix.1193 1194 <p>The major difference between the two is that the <i>local library</i>1195 contains it's own built-in webserver. The <i>web library</i> however,1196 requires an external webserver like Apache or Microsoft IIS. This makes the1197 <i>local library</i> much easier to install and configure than the web1198 library.</p>1199 1200 <p>For this reason, it's recommended that Windows users install the1201 <i>local library</i> unless they're sure that they need the <i>web1202 library</i>. Even if you think you might need the <i>web library</i>, try1203 installing the <i>local library</i> first. You can always uninstall it1204 later and install the <i>web library</i> if you then decide you need1205 it.</p>1206 1207 <p>A situation where the <i>web library</i> may be preferable is if you1208 plan to serve your Greenstone collections as a full-time service on the1209 web. In this case you'll probably want the added stability that running the1210 <i>web library</i> in conjunction with an external webserver can1211 provide.</p>1212 1213 <p>Please note that the <i>local library</i> is quite capable of serving1214 Greenstone collections over a local area network or the web (despite its1215 rather misleading name).</p>1216 }1217 1218 _tfaqgliapplet_ {1219 <p>To get the GLI applet running, please do the following:1220 <ol>1221 <li>Install Greenstone and the GLI on your server computer. Currently, this must be a GNU/Linux or Unix machine.</li>1222 <li>Set up your web server (eg. Apache) for Greenstone. Check that standard Greenstone works.</li>1223 <li>The following four steps require the Java SDK. If you don't already have this it is available for download from <a href="http://java.sun.com/j2se/1.4.2/download.html">http://java.sun.com/j2se/1.4.2/download.html</a>.1224 <li>In the gsdl/gli directory, run1225 1226 <br><small><tt>keytool -genkey -alias privateKey -keystore appletstore -storepass greenstone</tt></small><br>1227 1228 Enter the appropriate details for your organization. When it asks to enter the key password for <privateKey>, choose your own password or hit Enter to use "greenstone".</li>1229 1230 <li>Run makegli.sh.</li>1231 <li>Run makejar.sh.</li>1232 <li>Run1233 1234 <br><small><tt>jarsigner -keystore appletstore -signedjar SignedGatherer.jar GLI.jar privateKey</tt></small><br>1235 1236 When it prompts, enter the password you used above.</li>1237 1238 <li>Move the SignedGatherer.jar file created into the gsdl/bin/java directory.</li>1239 <li>Edit the gsdl/etc/main.cfg file and set the "gliapplet" field to "enabled".</li>1240 <li>Visit your Greenstone homepage and click "The Librarian Interface" button. The applet should load and appear on this page, producing a button that says "Launch Greenstone Librarian Interface...". Clicking this will run the GLI as an applet, allowing users to build collections on your server without having Greenstone installed on their machines.</li>1241 </ol>1242 <p>Note that the applet transfers a lot of data between the machine it is running on and the server. This makes using the GLI applet impractical if you don't have a high speed connection between your machine and the server.1243 </p>1244 }1245 #######################################################################1246 1247 package faqrun1248 1249 _t223_ {1250 If you're using the Windows <i>local library</i> you should be able to1251 simply select "Greenstone Digital Library" from within the1252 programs in your <i>start</i> menu.1253 1254 <p>If you're using the <i>web library</i> things are a little less obvious1255 however. First make sure your webserver is configured correctly and is1256 running (see the <a href="_httppagex_(docs)">Greenstone Installer's1257 Guide</a> and your webserver's documentation for details). You can then1258 simply open your web browser and point it at the URL of Greenstone's1259 library executable. This is dependant on the way you configured Greenstone1260 and your webserver. Typically it might be something like1261 http://localhost/gsdl/cgi-bin/library.exe.</p>1262 }1263 1264 _t224_ {1265 Greenstone relies on a web browser that supports tables, javascript, and in1266 some places, frames. Any reasonably modern browser will do. Examples are1267 Microsoft Internet Explorer 4, Netscape 4, and Mozilla. Newer releases of1268 all these browsers will also work.1269 1270 <p>If you find that your favourite web browser does not work with1271 Greenstone, please <a href="_httppagex_(support)">contact us</a>.</p>1272 1273 <p>Note that there is an exception to the rule that any modern browser will1274 do when running Greenstone. That is when you're using the restricted1275 version of the Windows local library when you must use Netscape. See the1276 discussion below on the differences between the "Restricted1277 Version" and the standard "Enter Library" version of the1278 local library for details.</p>1279 }1280 1281 _t225_ {1282 The webserver built into the local library uses the networking software1283 built into your Windows operating system in order to function. If your1284 computer has never been connected to a network this networking software may1285 not be installed however. For this reason Greenstone comes with some1286 networking software of it's own that it will use if it can't find any1287 installed on your computer.1288 1289 <p>When you click the "Enter Library" button, Greenstone first1290 checks to see if your computer has it's own networking software. If it1291 does, it starts up using that, if not it starts up using it's own1292 networking software.</p>1293 1294 <p>When you click the "Restricted Version" button, Greenstone1295 doesn't bother checking your system for networking software, it just goes1296 ahead and uses it's own.</p>1297 1298 <p>The catch is that there are several limitations with using the1299 Greenstone supplied networking software. The most important limitations are1300 that the local library won't be accessible from the network if run in this1301 way (that is, it really will be "local" to the machine on which1302 it's running) and that it must use a Netscape web browser. Using your1303 computer's built-in networking software is therefore the prefered1304 option.</p>1305 }1306 1307 _t226_ {1308 Since Greenstone will automatically use it's own networking software if it1309 can't find any installed on your computer it should not normally be1310 necessary to run the "Restricted Version" explicitly.1311 1312 <p>Times when it may be necessary are.</p>1313 <ul>1314 <li>If your computer's networking software has been installed incorrectly.</li>1315 <li>If Windows keeps attempting to dial up your internet service provider1316 when you click the "Enter Library" button.</li>1317 </ul>1318 }1319 1320 _t227_ {1321 No you don't need to be online. This is caused by the webserver built into1322 Greenstone's local library sending a message to your computer's networking1323 software to make sure it's functioning correctly. On many Windows systems1324 this causes the familiar dial up dialog box to appear. In most situations1325 you can simply cancel the dialog box and (if required) press your browser's1326 <i>reload</i> button to continue.1327 1328 <p>If this does not solve the problem, try starting the local library by1329 clicking the "Restricted Version" button rather than the1330 "Enter Library" button. See the discussion above on the1331 differences between the standard and restricted versions of the local1332 library for further details.</p>1333 }1334 1335 _t228_ {1336 <ol>1337 <li>Check your web browser's internet proxy settings and turn proxies off (use1338 <i>Edit preferences</i> on Netscape or <i>Internet options</i> on1339 Explorer).</li>1340 1341 <li>If Internet Explorer gives a message saying "The page cannot be1342 displayed" and "Cannot find server or DNS error" at the bottom of the1343 page, check in your network settings that your computer's name is set1344 up correctly. For example, if there is a DNS suffix entered in your1345 TCP/IP properties (in the Control Panel), make sure that your host1346 name and suffix are correct for your computer. If the server is running1347 correctly, you should be able to connect by visiting1348 <a href="http://127.0.0.1/">http://127.0.0.1/</a> in a web browser on the1349 same machine that the local library is running on.</li>1350 1351 </ol>1352 }1353 1354 _t229_ {1355 Collections like those at <a href="http://www.nzdl.org">www.nzdl.org</a>1356 will soon be made available for download.1357 }1358 1359 _t230_ {1360 The initial username required here is <i>admin</i>.1361 1362 <p>If you installed Greenstone using the InstallShield installer on Windows1363 or the Install.sh script on Unix you should have been asked to set a1364 password during the installation procedure.</p>1365 1366 <p>If you didn't, don't worry, the password defaults to being1367 <i>admin</i>.</p>1368 1369 <p>So if you don't know what to enter you should try username =1370 <i>admin</i>, password = <i>admin</i>.<p>1371 }1372 1373 _t231_ {1374 This may be caused by the URL becoming too long for your web1375 browser. Because Greenstone currently stores all state information in the1376 URL, if you do a search for a long phrase the URL can become very1377 long. Different browser's on different platforms have different maximum URL1378 lengths but in general it seems that Netscape can handle longer URLs than1379 can Microsoft Internet Explorer.1380 1381 <p>There is very little you can do to avoid this problem with the way1382 Greenstone is currently implemented (aside from not searching for long1383 phrases). Future versions of Greenstone may store some state information on1384 the server rather than in the URL but this has yet to be implemented.</p>1385 }1386 1387 1388 #######################################################################1389 1390 package faqbuild1391 1392 _tfaqbuildglibody_ {1393 The Greenstone Librarian Interface (GLI) is a graphical tool for building new1394 collections, altering or1395 deleting existing collections, and exporting existing collections to1396 stand-alone CD-ROMs. It allows you to import or assign metadata, and1397 has an interactive collection design module. Launch the GLI under Windows1398 by selecting <i>Greenstone Digital Library</i> from the <i>Programs</i>1399 section of the <i>Start</i> menu and choosing <i>Librarian Interface</i>.1400 Under Linux, run <i>gli.sh</i> from the <i>gsdl/gli</i> directory.1401 For details on using the Librarian Interface see the1402 <a href="_httppagex_(docs)">Greenstone User's Guide</a>.1403 }1404 1405 _t233_ {1406 The Collector is a web interface for collection building, altering and1407 exporting. It predates the Librarian Interface and for most1408 practical purposes, the Librarian Interface should be used instead.1409 To begin using the Collector, click the "The1410 Collector" button on your Greenstone home page. For further details on1411 using the Collector see the <a href="_httppagex_(docs)">Greenstone User's1412 Guide</a>.1413 }1414 1415 _t234_ {1416 It's occasionally preferable to build your Greenstone collections from the1417 command line rather than from the Collector. This allows you greater1418 control over how your new collection turns out. See the <a1419 href="_httppagex_(docs)">Greenstone Developer's Guide</a> for detailed step1420 by step instructions on building collections from the command line.1421 }1422 1423 _t235_ {1424 Are you running Norton Anti-Virus? There are some incompatibilities between1425 Norton and the Greenstone collection building process that cause1426 unpredictable things to happen if you build your collection while Norton is1427 running. Try disabling Norton and rebuilding the collection.1428 1429 <p>If you do not have Norton or disabling Norton does not solve the problem1430 please <a href="_httppagex_(support)">contact us</a> for further help.</p>1431 }1432 1433 _t236_ {1434 If you downloaded Greenstone from the web you will not have all the1435 components required to make the "export to CD-ROM" function1436 work. These extra components have been made available in a separate1437 download which you can get from the <a1438 href="_httppagex_(download)#packages">download</a> page.1439 }1440 1441 _t237_ {1442 Are you using a Netscape web browser with the local library? If so, try1443 using Internet Explorer instead. There are some socket connection problems1444 that show up on Windows 2000 when using Netscape.1445 }1446 1447 _t238_ {1448 The Organizer (also called the "Collection Organizer") is a1449 Windows utility used for automatically generating some of the configuration1450 files (metadata.xml, sub.txt etc.) used by complex Greenstone collections.1451 }1452 1453 _t239_ {1454 From the <a href="_httppagex_(download)#utilities">download</a> page.1455 }1456 1457 _t240_ {1458 There are several reasons that the collector might fail to build a1459 collection and the error messages it produces are not always very helpful.1460 1461 <p>If you changed the default configuration during the <i>configure1462 collection</i> stage you'll need to make sure the changes were valid. For1463 example, if you added a new <i>classify</i> or <i>plugin</i> line you'll1464 need to make sure that the classifier and/or plugin names and arguments are1465 all correct. If they're not the collector will fail. A good test is to1466 build your collection without changing the configuration. If it builds ok1467 with the default configuration but fails after you change the configuration1468 you'll need to look closely at the changes you're making.</p>1469 1470 <p>Another good thing to do if having problems with the collector is to1471 build your collection from the command line instead. You'll get much more1472 feedback to help debug problems when building in this way. For details on1473 how to build a collection from the command line see the <a1474 href="_httppagex_(docs)">Greenstone developer's guide</a>.</p>1475 }1476 1477 _t241_ {1478 The collect.cfg files for many of the collections at <a1479 href="http://www.nzdl.org">www.nzdl.org</a> have been made available <a1480 href="_httppagex_(colcfg)">here</a>.1481 }1482 1483 _t242_ {1484 The <a href="_httpdocsdir_/mgpp_user.pdf">MGPP user manual</a> gives some1485 instructions.1486 }1487 1488 _tfaqbuild11body_ {1489 Visit <a href="http://www.cs.waikato.ac.nz/~mdewsnip/greenstone/make-images.html">this page</a> and follow the instructions.1490 }1491 1492 _tfaqbuildexpatbody_ {1493 Our prebuilt Linux and Mac OS X Greenstone distributions are built on machines using Perl 5.6, and these distributions contain a few binary perl modules. These cause problems if you are using a recent version of perl like 5.8 or 5.8.1 (you can type "perl -v" from the command line to see the version).1494 <p>1495 On the Mac, our distribution contains modules for both perl 5.6 and 5.8 and the correct one should (hopefully) be installed.1496 <p>1497 A typical error message during import.pl would be:1498 <p>1499 Uncaught exception from user code: Can't load '/home/httpd/gsdl/perllib/cpan/auto/XML/Parser/Expat/Expat.so' for module XML::Parser::Expat: /home/httpd/gsdl/perllib/cpan/auto/XML/Parser/Expat/Expat.so: undefined symbol: PL_sv_undef at /usr/lib/perl5/5.8.0/i386-linux-thread-multi/DynaLoader.pm line 229. at /home/httpd/gsdl/perllib/cpan/XML/Parser.pm line 141500 <p>1501 To remedy this, you need to remove the "gsdl/perllib/cpan/XML" and "gsdl/perllib/cpan/auto" directories. (For version 2.52, remove gsdl/perllib/cpan/perl-5.8/XML and gsdl/perllib/cpan/perl-5.8/auto.) Then you need to install the perl XML::Parser natively for your system.1502 <p>1503 On redhat or mandrake, install the .rpm named "perl-XML-Parser", on debian, install the "libxml-parser-perl" package. For other Linuxes, use your distribution's package, or you can get it from <a href="http://search.cpan.org/~msergeant/XML-Parser-2.34/">http://search.cpan.org/~msergeant/XML-Parser-2.34/</a>.1504 <p>1505 You may also need to get Expat, available from <a href="http://sourceforge.net/projects/expat/">http://sourceforge.net/projects/expat/</a>.1506 1507 }1508 1509 _tfaqbuildsizelimitbody_ {1510 The largest collections we have built have been 7 Gb of text, and 11 million short documents (about 3 Gb text). These built with no problems. We haven't tried larger amounts of text because we don't have larger amounts of1511 text lying around. It's no good using 7 Gb twice over to make 14 Gb because the vocabulary hasn't grown accordingly, as it would1512 with a real collection.1513 <p>1514 There are three main limitations:1515 <ol>1516 <li>There is a file size limit of 2 Gb on Linux (soon to be increased to1517 infinity, the Linux people say). I don't know about corresponding1518 figures for Windows; we use Linux for development. There are systems1519 that go higher, but we don't have access to them.<br>1520 1521 The compressed text will hit the limit first. MG stores the compressed1522 text in a single file. 7 Gb will compress to just under 2 Gb, so you1523 can't go much higher without splitting the compressed-text file (hacky,1524 but probably easy).1525 </li>1526 <li> Technical. There is a Huffman coding limitation which we would expect1527 to run into at collections of around 16 Gb. However, the solution is1528 very easy, we just haven't bothered to implement it until we have1529 encountered the problem.1530 </li>1531 <li>1532 Build time. For building a single index on an already-imported1533 collection, extrapolations indicate that on a modern machine with 1 Gb1534 of main memory, you should be able to build a 60 Gb collection in about1535 3 days. However, there are often large gaps1536 between theory and practice in this area! The more indexes you have,1537 the longer things take to build.1538 </li>1539 </ol>1540 In practice, the solution for very large amounts of data is not to treat the collection1541 as one huge monolith, but to partition it into subcollections and arrange for1542 the search engine to search them all together behind the scenes. However, while1543 you can amalgamate the results of searching subcollections fairly easily, it's1544 much harder with browsing. Of course, A-Z lists and datelists and the like1545 aren't really much use with very large collections.1546 This is where new techniques of hierarchical phrase browsing come into their1547 own. And the really good news is that you can partition a collection into1548 subcollections, each with individual phrase browsers, and arrange to view them1549 all together in a single hierarchical browsing structure, as one coordinated1550 whole. We haven't actually demonstrated this yet, but it seems quite feasible.1551 1552 <p>1553 A test collection was built by "Archivo Digital", an office1554 that depends on the "Archivo Nacional de la Memoria" (National Memory1555 Archive in English), in Argentina. It contained sequences of page images with1556 associated OCR text.1557 <p/><i>Setup details</i>1558 <ul>1559 <li>Greenstone version: 2.52</li>1560 <li>Server: Pentium IV 1.8 GHz, 512 Mb RAM, Windows XP Prof.</li>1561 <li>Number of indexed documents: 17,655</li>1562 <li>Number of images (tiff format): 980,000</li>1563 <li>Total size of text files: 3.2 Gb</li>1564 <li>Built indexes: section:text document:Title</li>1565 <li>Used Plugin: PagedImgPlug</li>1566 <li>5 classifiers</li>1567 </ul>1568 <p/><i>Statistics</i>1569 1570 <ul>1571 <li>Time to import the collection: Almost a week was spent collecting documents and importing them. No image conversion was done.</li>1572 <li>Time to build the collection (excluding import): almost 24 hours. The archives and the indexes were on separate hard disks, to reduce the overhead that reading and writing from the same disk would cause.</li>1573 <li>Time to open a hierarchy node that contains 908 objects: 23 seconds</li>1574 <li>Average Time to search only one word in text index: 2 to 5 seconds</li>1575 <li>Average Time to search 3 words in text index: 2 to 5 seconds</li>1576 <li>Average Time to search exact phrases (includes 4, 5 and 6 words): 30 seconds</li></ul>1577 1578 }1579 #######################################################################1580 1581 package faqplugins1582 1583 1584 _available_ {1585 1586 See <a href="_gwcgi_?a=p&p=plugins">this page</a>.1587 1588 }1589 1590 # base puts in surrounding <p> and </p>, so skip first and last ones1591 #1592 _metadata_ {1593 1594 "Default" means that the metadata fields will be automatically assigned (or1595 extracted if possible), while the "Available fields" lists other items1596 of metadata that the plugin may be able to assign based on any arguments1597 given to that plugin in the <tt>collect.cfg</tt> file.1598 All plugins are derived from BasPlug, and have following metadata fields:1599 1600 <table border="1">1601 <tr>1602 <th> </th>1603 <th> Default fields </th>1604 <th> Available fields </th>1605 </tr>1606 <tr>1607 <td> BasPlug </td>1608 <td> Language, Encoding, Source </td>1609 <td> FirstNNNN, Keyphrases, Acronym </td>1610 </tr>1611 </table>1612 </p>1613 1614 <p>1615 In addition, many plugins have additional fields available:1616 <table border="1">1617 1618 <tr>1619 <th> Plugin name </th>1620 <th> Default fields </th>1621 <th> Available fields </th>1622 </tr>1623 1624 <tr>1625 <td> BibTexPlug </td>1626 <td> Title, Creator, Abstract, Author, Booktitle, Chapter, Copyright, Date,1627 Edition, Editor, EntryType Journal, Keywords, Month, Note, Number,1628 Pages, Publisher, PublisherAddress, Volume, Year </td>1629 <td> </td>1630 </tr>1631 1632 <tr>1633 <td> DBPlug </td>1634 <td> </td>1635 <td> (arbitrary metadata field names based on Database configuration file)1636 </td>1637 </tr>1638 1639 <tr>1640 <td> EMAILPlug </td>1641 <td> Date, DateText, From, FromAddr, FromName, Headers, Subject,1642 Title (based on subject, from, and date), To1643 </td>1644 <td> </td>1645 </tr>1646 1647 <tr>1648 <td> ExcelPlug </td>1649 <td> </td>1650 <td> (all fields as in HTMLPlug) </td>1651 </tr>1652 1653 <tr>1654 <td> HTMLPlug </td>1655 <td> Title, URL </td>1656 <td> Author, Creator, Email (others as found in the <tt>-metadata_fields</tt> option) </td>1657 </tr>1658 1659 <tr>1660 <td> ImagePlug </td>1661 <td> Image, ImageHeight, ImageSize, ImageType, ImageWidth, ScreenHeight,1662 screenicon, ScreenSize, ScreenType, ScreenWidth, Source, srclink,1663 srcicon, Thumb, ThumbHeight, ThumbType, ThumbWidth </td>1664 <td> </td>1665 </tr>1666 1667 <tr>1668 <td> IndexPlug </td>1669 <td> as in the <tt>index.txt</tt> file </td>1670 <td> (use metadata.xml files instead of using this plugin) </td>1671 </tr>1672 1673 <tr>1674 <td> MARCPlug </td>1675 <td> Creator, Description, MarcIdentifier, MarcSource, URL, Publisher,1676 Relation, Rights, Subject, Title, Type </td>1677 <td> (Metadata fields as in the <tt>marctodc.txt</tt> file) </td>1678 </tr>1679 1680 <tr>1681 <td> OAIPlug </td>1682 <td> URL, (all metadata in <tt>.oai</tt> markup file) </td>1683 <td> </td>1684 </tr>1685 1686 <tr>1687 <td> PagedImgPlug </td>1688 <td> Image, ImageHeight, ImageSize, ImageType, ImageWidth, ScreenHeight,1689 screenicon, ScreenSize, ScreenType, ScreenWidth, Source, srclink,1690 srcicon, Thumb, ThumbHeight, ThumbType, ThumbWidth </td>1691 <td> </td>1692 </tr>1693 <tr>1694 <td> PDFPlug </td>1695 <td> </td>1696 <td> (all fields in HTMLPlug) </td>1697 </tr>1698 1699 <tr>1700 <td> PPTPlug </td>1701 <td> </td>1702 <td> (all fields in HTMLPlug) </td>1703 </tr>1704 1705 <tr>1706 <td> PSPlug </td>1707 <td> Title </td>1708 <td> Date, Pages, (all fields in TextPlug) </td>1709 </tr>1710 1711 <tr>1712 <td> ReferPlug </td>1713 <td> Abstract, BookConfOnly, Booktitle, Copyright, Creator, Date, Editor,1714 Keywords, Journal, JournalsOnly, Number, Pages, Publisher,1715 Publisheraddr, Report, Title, Volume </td>1716 <td> </td>1717 </tr>1718 1719 <tr>1720 <td> RTFPlug </td>1721 <td> </td>1722 <td> (all fields in HTMLPlug) </td>1723 </tr>1724 1725 <tr>1726 <td> SRCPlug </td>1727 <td> Title, filename, includes, class, classdecl </td>1728 <td> </td>1729 </tr>1730 1731 <tr>1732 <td> TEXTPlug </td>1733 <td> Title </td>1734 <td> </td>1735 </tr>1736 1737 <tr>1738 <td> UnknownPlug </td>1739 <td> (as given in the <tt>-assoc_field</tt> plugin argument) </td>1740 <td> </td>1741 </tr>1742 1743 <tr>1744 <td> WordPlug </td>1745 <td> </td>1746 <td> (all fields in HTMLPlug) </td>1747 </tr>1748 1749 </table>1750 </p>1751 1752 <p>See section two of the _docs:developersguide_ for information about1753 options to plugins, or run the <tt>pluginfo.pl</tt> command on the1754 plugin name after setting up your environment for Greenstone.1755 (For example, "<tt>perl -S pluginfo.pl BasPlug</tt>".)1756 </p>1757 1758 <p>1759 In addition, every document can be manually assigned arbitrary metadata1760 fields and values through use of <tt>metadata.xml</tt> files, as discussed1761 in the manual.1762 }1763 1764 # base puts in surrounding <p> and </p>, so skip first and last ones1765 #1766 _pdfproblems_ {1767 PDF is a "page description language". This means that the document contains1768 objects and commands such as "draw this text here" and "draw this1769 image here".1770 </p>1771 1772 <p>1773 Greenstone uses an external program called "<tt>pdftohtml</tt>" to1774 extract text out of PDF files. Sometimes, there is no text that can be1775 extracted. This often depends on how the PDF was created.1776 1777 <ol>1778 <li>Adobe Acrobat Writer can be used to create PDFs from paper1779 documents that are scanned in by a scanner. In this case, the PDF file1780 contains images of text, rather than computer-readable text. Therefore,1781 <tt>pdftohtml</tt> cannot find any text to extract.</li>1782 1783 <li>Some programs (such as older versions of <tt>GNU ghostscript</tt>,1784 which is used by <tt>ps2pdf</tt> on Unix computers) sometimes create1785 "bitmap fonts", which means that every character in the document is1786 really an image rather than a computer readable letter. The1787 <tt>LaTeX</tt> type-setting program sometimes does this when the1788 "Computer Modern Roman" font is used.</li>1789 1790 <li>Certain characters and character combinations may be extracted incorrectly,1791 depending on the program that generated the PDF file. For example, "ligatures"1792 such as "fi", "fl", "ff" and "ffl" are often rendered using a special glyph1793 rather than as individual characters, and this information may be lost in1794 the textual representation. Also, some PDF generating programs may not1795 correctly encode accented characters. For example, to draw a lowercase "u"1796 with an umlaut accent, LaTeX draws a "u" and then draws an umlaut accent over1797 it. This means that <tt>pdftohtml</tt> will extract two separate characters1798 ('š' and 'u') rather than a single accented character (ÃŒ).</li>1799 1800 <li>PDF contains pieces of text, and coordinates for where that text1801 should be displayed. This means that <tt>pdftohtml</tt> may1802 incorrectly guess the order that the text fragments are supposed to1803 occur in. For example, for text that is in two or more columns, the text1804 may be extracted as the first sentence of each column, then the second1805 sentence of each column, and so on. In this case, the extracted text1806 is still usable for indexing purposes, but should not be displayed.1807 1808 In this case, a format statement should be added to the <tt>collect.cfg</tt>1809 file to provide a link to the original PDF file but not to the extracted1810 text, such as:1811 <center>1812 <small><tt>format SearchVList "<td valign=top>[srclink][srcicon][/srclink]</td> <td>[srclink][Title][/srclink]</td>"</tt></small>1813 </center>1814 </li>1815 1816 <li>Because of the way that images are embedded in PDF files,1817 <tt>pdftohtml</tt> occasionally extracts an image upside-down, or mirrored.1818 This appears to be a bug in the program.</li>1819 1820 </ol>1821 }1822 1823 _unknownplug_ {UnknownPlug is a simple plugin for importing files in formats1824 that Greenstone doesn't know anything about. A dummy document will be1825 created for every such file, and the file itself will be passed to Greenstone1826 as the \"associated file\" of the document.1827 <p>1828 Here's an example where it is useful: A collection has pictures and includes1829 a couple of quicktime movie files with names like DCP_0163.MOV.1830 Rather than write a new plugin for quicktime movies, add this line to the1831 collection configuration file:1832 <center>1833 <small><tt>plugin UnknownPlug -process_exp "*.MOV" -assoc_field "movie"</tt></small></center>1834 <p>1835 A document is created for each movie, with the associated movie1836 file's name in the "movie" metadata field. In the collection's1837 format strings, use the \{If\} macro to output different text for1838 each type of file, like this:1839 1840 <center>1841 <small><tt> \{If\}\{[movie],<HTML for displaying movie>\}<br>1842 \{If\}\{[Image],<HTML for displaying image>\}</tt></small></center>1843 <p>1844 You can also add extra metadata, such as the Title, Subject, and1845 Duration, using the Librarian Interface (or with metadata.xml files and RecPlug).1846 <p>1847 The <tt>-process_exp</tt> option is a regular expression that matches filenames which should be processed by UnknownPlug. You can have several UnknownPlugs specified1848 for a collection, each processing a different kind of file.1849 <p>1850 The <tt>-assoc_field</tt> option is the name of the metadata field that will hold the1851 associated file's name. This can be used to test for these files. You can also specify the mime type of the files to1852 be processed using the <tt>-mime_type</tt> option. To display the original file, use <tt>[srclink][/srclink]</tt> metadata.1853 }1854 1855 1856 1857 #######################################################################1858 1859 package faqcustomize1860 1861 _tfaqcustomizefrontpagelogo_ {1862 You can change the logo that appears at the top of the front page of your library by editing the <tt>home.dm</tt> file in your Greenstone "macros" folder and replacing all instances of "gsdlhead.gif" with the name of your logo image file.1863 }1864 1865 _tfaqcustomizemoreinfo_ {1866 Try <a href="_httppagex_(docs)#user_supplied">this document</a>.1867 }1868 1869 _tfaqcustomizeformat_ {1870 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.1871 <p>1872 <i><u>Site-wide formatting options</u></i><br>1873 These should be placed in gsdl/etc/main.cfg. <br>1874 Syntax: <b>SiteFormat <option-name> <option-value></b>1875 <p>1876 <table class="faq-table"><tr><th width=180>Item</th><th>Description</th></tr>1877 <tr><td>HomePageCols int</td><td>Set the number of columns used to display collections on the home page.<br>Default: 3</td></tr>1878 <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>1879 </table>1880 <p>1881 <i><u>Collection-specific formatting options</u></i><br>1882 These should be placed in gsdl/collect/<collname>/etc/collect.cfg. <br>1883 Syntax: <b>format <option-name> <option-value></b>1884 <p>1885 <table class="faq-table">1886 <tr><th width=220>Item</th><th>Description</th></tr>1887 <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>1888 <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>1889 <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\} <br>[Title] </td></tr>1890 <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>1891 <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>1892 <tr><td>DocumentText formatstring</td><td>Format of the text to be displayed on a document page<br>Default: <center> <table width=537> <tr><td>[Text]</td></tr> </table> </center></td></tr>1893 <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>1894 <tr><td>DocumentArrowsBottom true/false</td><td>Display next/previous section arrows at bottom of document page<br>Default: true</td></tr>1895 <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>1896 <!--<tr><td>RelatedDocuments string</td><td>Don't know that this gets used<br>Default: ""</td></tr>-->1897 <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>1898 <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>1899 </table>1900 1901 <p>1902 <i><u>Formatting Lists</u></i><br>1903 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.1904 <p>1905 <table class="faq-table"><tr><th align=left>Item</th><th align=left>Description</th></tr>1906 <tr><td>VList</td><td>Applies to all vertical lists, unless overridden by a more specific format item. These include search results, classifier lists, and table of contents</td></tr>1907 <tr><td>HList</td><td>Applies to all horizontal lists. Horizontal lists are often used in classifiers, particularly AZ[Compact][Section]Lists</td></tr>1908 <tr><td>DateList</td><td>Applies to all date lists - these are the vertical lists generated by a DateList classifier.</td></tr>1909 <tr><td>SearchVList</td><td>The vertical list of search results</td></tr>1910 <tr><td>CL1VList</td><td>Applies only to the vertical list of classifier 1</td></tr>1911 <tr><td>CL1HList</td><td>Applies only to the horizontal list of classifier 1</td></tr>1912 <tr><td>CL1DateList</td><td>Applies only to the DateList in classifier 1</td></tr>1913 </table>1914 <p>1915 <i><u>Formatstring items</u></i><br>1916 <p>1917 <table class="faq-table"><tr><th align=left>Item</th><th align=left>Description</th></tr>1918 <tr><td>[link][/link]</td><td>Link to the document (Greenstone version)</td></tr>1919 <tr><td>[srclink][/srclink]</td><td>Link to the original document (only if the original was converted to another form)</td></tr>1920 <tr><td>[icon]</td><td>An appropriate icon for a classifier/document node. E.g. bookshelf, book, chapter, page</td></tr>1921 <tr><td>[srcicon]</td><td>An appropriate icon for the original source document. E.g. Word, PDF, PS icon.</td></tr>1922 <!--<tr><td>[href]</td><td>not sure what this does and it caused a segmentation fault when I tried to use it</td></tr>-->1923 <tr><td>[num]</td><td>The document number (position in the search results - useful for debugging)</td></tr>1924 <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>1925 <tr><td>[Text]</td><td>The text of the current section</td></tr>1926 <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>1927 <tr><td>[highlight][/highlight]</td><td>These are used for 'highlighting' (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 <b></b>, <u></u> and <i></i></td></tr>1928 <tr><td>[Summary]</td><td>Displays Summary metadata if available, otherwise displays a short summary created on the fly.</td></tr>1929 <tr><td>[DocOID]</td><td>The internal identifier of the document</td></tr>1930 <tr><td>[DocRank]</td><td>The rank of the current document - used in search results</td></tr>1931 <tr><td>[metadata-name]</td><td>The value of this metadata element for the document</td></tr>1932 </table>1933 <p>1934 <i><u>Extended metadata names</u></i><br>1935 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.1936 <p>1937 <table class="faq-table">1938 <tr><td>[parent:Title]</td><td>The Title of the immediate parent section</td></tr>1939 <tr><td>[parent(Top):Title]</td><td>The Title of the topmost parent section</td></tr>1940 <tr><td>[parent(All):Title]</td><td>All Titles of the parent sections, separated by ", "</td></tr>1941 <tr><td>[parent(All': '):Title]</td><td>All Titles of the parent sections, separated by ": " (or whatever appears inside the ' ')</td></tr>1942 <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>1943 <tr><td>[sibling(All:'<br>'):Subject]</td><td>All Subjects of the current section, separated by <br>. </td></tr>1944 <tr><td>[cgisafe:parent(Top):Title]</td><td>The Title of the topmost parent section, made safe for URLs.</td></tr>1945 <tr><td>[cgisafe:sibling(All:'<br>'):Subject]</td><td>All Subjects of the current section, separated by <br>, made safe for URLs.</td></tr>1946 </table>1947 1948 <p>1949 <i><u>Extended Formatstring items</u></i><br>1950 These items are only available if AllowExtendedOptions is true.1951 <p>1952 <table class="faq-table"><tr><th align=left>Item</th><th align=left>Description</th></tr>1953 <tr><td>[DocumentButtonDetach]</td><td>The Detach button</td></tr>1954 <tr><td>[DocumentButtonHighlight]</td><td>The Highlight button</td></tr>1955 <tr><td>[DocumentButtonExpandText]</td><td>The Expand Text button</td></tr>1956 <tr><td>[DocumentButtonExpandContents]</td><td>The Expand Contents button</td></tr>1957 <tr><td>[DocImage]</td><td>The cover image of the document</td></tr>1958 <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>1959 </table>1960 1961 <p>1962 <i><u>Conditional expressions in formatstrings</u></i><br>1963 <table class="faq-table">1964 <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>1965 <tr><td>\{If\}\{"[metadata]" eq "value", action-if-equal, action-if-not-equal\}</td><td>Can do tests on metadata values: equals</td></tr>1966 <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>1967 <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>1968 </table>1969 }1970 1971 _tfaqcustomizemetadatalinking_ {1972 <i>[contributed by Axel Schild]</i><br/>1973 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 <a> tag around the metadata item, for example:1974 <br><small><tt><a href="url to link to">[dc.Subject]</a></tt></small><br>1975 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.1976 <p>1977 Use the format string below in the collect.cfg file (in this case, as part of the "format DocumentText" statement)1978 <br><small><tt><pre>1979 \{If\}\{[dc.Creator],1980 <tr>1981 <td align=right valign=top><b>Authors:</b></td>1982 <td align=left valign=bottom><label name=AuthorField id=AuthorField>1983 \_httpquery\_;[cgisafe:sibling(All:\\' ; \\'):dc.Creator];[sibling(All:\\'\_\\'):dc.Creator]1984 </label></td>1985 </tr>\} 1986 </pre></tt></small>1987 This statement includes a label definition with the name "AuthorField". "\_httpquery\_" is a macro which resolves into the http-address of the query page of the collection. "[cgisafe:sibling(All:\\' ; \\'):dc.Creator]" displays all Creators, separated by ; and with any special characters escaped for use within a web address. [sibling(All:\\'\_\\'):dc.Creator] produces a similar string without escaping the special characters. Notice the different separation symbols, these are needed later on.1988 <p>1989 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 this case the document package). The change is that \_htmlhead\_ has to be parametrized with1990 1991 <small><tt>\_htmlhead\_(onload="ExtractAuthors();")</tt></small>, where ExtractAuthors(); is a Javascript function that 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 (in gsdl/collect/<collname>/macros) and override the chosen macro with a collection specific macro. In this example this is done by the code sequence1992 1993 <br><small><tt><pre>1994 package document1995 1996 ###document display1997 1998 ###HTML-Page Header1999 \_textheader\_ [c=exacol] \{\_cgihead\_2000 \_htmlhead\_(onload="ExtractSubjects();ExtractAuthors();")2001 <center>2002 <table width=_pagewidth_><tr><td align=right>2003 \_icontab\_\_javalinks\_</td></tr></table>2004 </center>2005 \}2006 </pre></tt></small>2007 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 necessary modification which is in this case2008 <br><small><tt><pre>2009 ### Self-made Javascript functions2010 \_pagescriptextra\_\{2011 function ExtractAuthors() \\\{2012 var res;2013 a = AuthorField.outerText.split(";");2014 resolver = a[0]+"&q=";2015 b = a[1].split("+%3b+");2016 c = a[2].split("\_");2017 res = "";2018 for (i = 0; i < b.length ;i++)2019 \\{2020 res = res + "<a href=" + resolver + b[i]+ "&h=dd0&t=0>" + c[i] + "</a><br/>";2021 \\}2022 AuthorField.outerHTML = res;2023 \\}2024 \}2025 </pre></tt></small>2026 This Javascript function evaluates the string of the defined label, splits it into several strings and composes a string out of those values, which is then set to the "outerHTML" element of the label. "&h=dd0" indicates which index to search in; dd0 should be replaced with the name of the appropriate index. The file gsdl/collect/<collname>/index/build.cfg gives the names of the various indexes.2027 }2028 830 2029 831 #######################################################################
Note:
See TracChangeset
for help on using the changeset viewer.