Changeset 36364 for documentation/trunk

Timestamp:

2022-08-09T13:34:47+12:00 (21 months ago)

Author:

anupama

Message:

In DEC GS2 collection manifest-demo-e, when a delete manifest file specifies the OIDs of files to delete, one does not need to manually delete the matching documents from import. I've just tested this out with GS3 (Incremental Building tutorial) on Linux, and the same is true: when a manifest that specifies the OIDs to delete is provided, the matching documents do not need to be deleted from the import folder for the incremental rebuilding to get rid of the specified documents from archives and index. The OIDtype for the collection can furthermore also remain at dirname (instead of changing it to full_filname) for the incremental delete with manifests to work just fine. So this commit updates the incremental building tutorial to not instruct the user to do unnecessary steps.

File:

• documentation/trunk/tutorials/xml-source/tutorial_en.xml (modified) (5 diffs)

documentation/trunk/tutorials/xml-source/tutorial_en.xml

@@ -5500 +5500 @@
 <Text id="ic-03">Do not build the collection in GLI. We'll be building and rebuilding manually, from the command-line terminal. So close GLI once the files and folders have finished copying into your collection. You can choose to run the Greenstone server at any stage, however.</Text>
 </NumberedItem>
+<!--
 <NumberedItem>
 <Text id="ic-04">In a text editor, open your <Format>incremen</Format> collection's <Format><MajorVersion number="2">collect.cfg</MajorVersion><MajorVersion number="3">collectionConfig.xml</MajorVersion></Format> file located in <Format><MajorVersion number="3">web\sites\localsite\</MajorVersion>collect\incremen\etc</Format>.</Text>
@@ -5514 +5515 @@
 </MajorVersion>
 </NumberedItem>
+-->
 <NumberedItem>
 <Text id="ic-05">Since this is the first time we're building our collection, we're going to do a complete build. And we'll use the command line to do so. Open a terminal. To open a terminal in Windows, press Ctrl+r and type <Format>cmd</Format> in the <b>Run</b> dialog that displays. To open a terminal on a Mac machine, click on menu <Path>Go &rarr; Utilities &rarr; Terminal</Path>. Use the terminal to <Format>cd</Format> into your Greenstone installation folder. For instance, if you have your Greenstone installed on Windows as "<i>Greenstone</i>" within your account folder at <Format>C:\Users\me</Format>, then type the following in your terminal and hit Enter:</Text>
@@ -5593 +5595 @@
 &lt;Manifest&gt;<br />
   <Tab n="1"/>&lt;Delete&gt;<br />
-    <Tab n="2"/>&lt;OID&gt;b18ase-b18ase_htm&lt;/OID&gt;<br />
+    <!--<Tab n="2"/>&lt;OID&gt;b18ase-b18ase_htm&lt;/OID&gt;<br />
     <Tab n="2"/>&lt;OID&gt;fb33fe-fb33fe_htm&lt;/OID&gt;<br />
+    -->
+    <Tab n="2"/>&lt;OID&gt;b18ase&lt;/OID&gt;<br />
+    <Tab n="2"/>&lt;OID&gt;fb33fe&lt;/OID&gt;<br />
   <Tab n="1"/>&lt;/Delete&gt;<br />
 &lt;/Manifest&gt;
@@ -5600 +5605 @@
 <Text id="ic-10b">As per the above manifest file, the operation to be performed by an incremental build is a &lt;Delete&gt; operation on two documents. For the delete operation, the documents are not indicated by the &lt;Filename&gt; XML element, but by the &lt;OID&gt; element which specifies the object identifier. We need to use the OID here because we're telling Greenstone precisely what the identifiers of the documents are that we wish to have removed from our collection. The identifiers of every built document in a Greenstone collection are specified in the Identifier field of the document's <i>doc.xml</i> file located in the collection's <Format>archives</Format> folder. The <i>doc.xml</i> file is the Greenstone-specific XML format in which Greenstone stores documents already imported.</Text>
 <Text id="ic-10c">For instance, to find the identifier of the <i>b18ase.htm</i> document in your built collection, open up <Format><MajorVersion number="3">web\sites\localsite\</MajorVersion>collect\incremen\archives\b18ase-b.dir\doc.xml</Format> in a text editor. Then scroll down, looking for a piece of Greenstone extracted metadata labelled <i>Identifier</i>, which is the OID for this document:</Text>
-<Format>&lt;Metadata name=&quot;Identifier&quot;&gt;b18ase-b18ase_htm&lt;/Metadata&gt;</Format>
+<!--<Format>&lt;Metadata name=&quot;Identifier&quot;&gt;b18ase-b18ase_htm&lt;/Metadata&gt;</Format>-->
+<Format>&lt;Metadata name=&quot;Identifier&quot;&gt;b18ase&lt;/Metadata&gt;</Format>
 <Text id="ic-10d">The above value for the document identifier is what's used in the <i>delete-some-files.xml</i> manifest file to refer to this document. This document is one of two that are to be deleted as per the manifest file. Make sure to close the <i>doc.xml</i> file if you have it open.</Text>
 </NumberedItem>
+<!--
 <NumberedItem>
 <Text id="ic-11">So then, let's first physically remove these two documents from our collection, so that the contents of the <Format>import</Format> folder match what the manifest specifies: use a file browser to remove the folders <i>b18ase</i> and <i>fb33fe</i> from the collection's <Format>import</Format> folder.</Text>
 </NumberedItem>
+-->
 <NumberedItem>
 <Text id="ic-12">Finally, let's incrementally rebuild the collection, specifying the manifest file that Greenstone should use this time to carry out the incremental build operation. As before, there are two steps.</Text>
@@ -5668 +5676 @@
 </Comment>
 <NumberedItem>
-  <Text id="ic-21">Now repeat all the above exercises in the same sequence once again, but with a new collection called <i>autoincr</i> also based on the <i>Demo</i> collection. Remember to once again set <Format>&lt;importOption name="OIDtype" value="full_filename"/&gt;</Format> in the collectionConfig.xml file and to make <Format>document</Format> level for searching the <Format>default</Format>. And build the collection the first time around with <Format>perl -S full-rebuild.pl -site localsite autoincr</Format>, also largely as before. However, this time <i>don't</i> pass in any manifest file as an argument to the subsequent rebuild commands which use the <Format>incremental-import.pl</Format> script. So you'd be running these commands after each change:</Text>
+  <Text id="ic-21">Now repeat all the above exercises in the same sequence once again, but with a new collection called <i>autoincr</i> also based on the <i>Demo</i> collection. Remember <!--to once again set <Format>&lt;importOption name="OIDtype" value="full_filename"/&gt;</Format> in the collectionConfig.xml file and--> to make <Format>document</Format> level for searching the <Format>default</Format>. And build the collection the first time around with <Format>perl -S full-rebuild.pl -site localsite autoincr</Format>, also largely as before. However, this time <i>don't</i> pass in any manifest file as an argument to the subsequent rebuild commands which use the <Format>incremental-import.pl</Format> script. So you'd be running these commands after each change:</Text>
   <Format>
     perl -S incremental-import.pl -incremental -site localsite autoincr<br />