Changeset 33696 for main/trunk/model-sites-dev/waikato-edu/collect/README-science-activities.txt

Timestamp:

2019-11-15T22:09:56+13:00 (4 years ago)

Author:

ak19

Message:

Moved the individual READMEs into the top level too along with modifications. Corrected references to them in the top README file.

File:

• main/trunk/model-sites-dev/waikato-edu/collect/README-science-activities.txt (moved) (moved from main/trunk/model-sites-dev/waikato-edu/collect/science-activities/DATA-PREPARATION/README-science.txt ) (3 diffs)

main/trunk/model-sites-dev/waikato-edu/collect/README-science-activities.txt

@@ -2 +2 @@
   README
 --------------------
+A. RECREATING THE science-activities GREENSTONE COLLECTION's import FOLDER'S CONTENTS FROM SCRATCH
+B. REBUILDING THE science-activities COLLECTION
+C. VIEWING THE COLLECTION WHEN IT'S ALREADY BEEN BUILT
+D. INFORMATION AND WARNINGS
 
-Obtain the TT4.02 Science Resources Crates content from the Uni of Waikato Education Department. We do not have the permission to distribute it or make it public.
+
+
+A. RECREATING THE science-activities GREENSTONE COLLECTION's import FOLDER'S CONTENTS FROM SCRATCH
+---------------------------------------------------------------------------------------------------
+ONLY if you ever want to REGENERATE the folders for ingesting into GS3 your crate folders, PDF/Word files and metadata, then:
+
+0. Obtain the TT4.02 Science Resources Crates content from the Uni of Waikato Education Department. We do not have the permission to distribute it or make it public.
 But assuming the Education Dept. has given this content you in a zip format, follow the instructions below.
 
-1. Extract the TT4.02_Science Resources_Crates.zip, which will create a folder called TT4.02_Science Resources_Crates.zip
-For example, extract it on the Desktop and your Windows desktop will now have a new folder TT4.02_Science Resources_Crates.
+1. Extract the TT4.02_Science Resources_Crates.zip, which will create a folder called TT4.02_Science Resources_Crates.
+For example, extract it on the Desktop and your Windows desktop will now have a new folder called "TT4.02_Science Resources_Crates".
+If not already present, obtain the 14 .csv files labelled between A-1 to F-2 from the Education department and put them into the new TT4.02_Science Resources_Crates folder.
 
-2. Next, move the files procCrates.bat and all 14 of the .csv files (A-1 to F-2) into the new TT4.02_Science Resources_Crates folder
+2. Next, move the file web/sites/waikato-edu/collect/science-activities/DATA-PREPARATION/procCrates.bat into the new TT4.02_Science Resources_Crates folder as well.
 
-3. Move the "sciencea.gs3coll" folder into your Greenstone 3.09rc1 installation's "web\sites\localsite\collect" folder.
+In our example, your extracted TT4.02_Science Resources_Crates was on the Desktop, e.g. at C:\Users\You\Desktop\TT4.02_Science Resources_Crates
+Whatever the actual location, remember it and use it in the following. I will stick with the example of C:\Users\You\Desktop\TT4.02_Science Resources_Crates
 
-4. Move the siteConfig.xml file  into your Greenstone 3.09rc1 installation's "web\sites\localsite" folder, thereby replacing the existing file there.
+Double-click on the procCrates.bat script.
 
-5. Start your Greenstone's installation's "Greenstone Server" application. Pressing this application's "Enter Library" button should open your default browser on your Greenstone DL home page. Visit your new Science Activities collection, as it's prebuilt.
+Wait until the procCrates.bat script has finished processing the TT4.02_Science Resources_Crates folder contents. It should have created a folder called "import" in C:\Users\You\Desktop\TT4.02_Science Resources_Crates.
 
---------------------
-TO REGENERATE THE MATERIALS FOR YOUR COLLECTION AND TO REBUILD THAT COLLECTION:
-4. ONLY if you ever want to REGENERATE the folders for ingesting into GS3 your crate folders, PDF/Word files and metadata, then:
+[ONLY IF things didn't work out correctly in step a, then you can delete any folder called "import" that it produced and run the procCrates.bat script manually, to look for any issues.
 
-In our example, your extracted TT4.02_Science Resources_Crates was on the Desktop, e.g. C:\Liang\Desktop\TT4.02_Science Resources_Crates
-Whatever the actual location, remember it and use it in the following. I will stick with the example of C:\Liang\Desktop\TT4.02_Science Resources_Crates
-
-a. Open a DOS prompt:
+Open a DOS prompt:
     first hold down the Windows key on the keyboard (located between Alt and Ctrl keys) and press the R key (R for run);
     then a little dialog will pop up. Type "cmd" into its edit field and press enter and a DOS prompt will appear.
 
 In the DOS prompt, type:
-    cd C:\Liang\Desktop\TT4.02_Science Resources_Crates
+    cd C:\Users\You\Desktop\TT4.02_Science Resources_Crates
 (i.e. "cd" followed by the full path to the actual location of your extracted folder)
 
-b. type:
+Next type:
     procCrates.bat
-    
-c. Wait until it finishes. It should have created a folder called "import" in C:\Liang\Desktop\TT4.02_Science Resources_Crates.
 
-d. ONLY if you now want to reingest and rebuild your collection with these new folders, use a file browser to do the following:
-- Delete all but the top-level metadata.xml file in your Greenstone 3.09 (rc1) installation's "web\sites\localsite\collect\sciencea\import" folder.
-- Go into the "C:\Liang\Desktop\TT4.02_Science Resources_Crates\import" folder. You should see subfolders A-1 to F-2.
-- MOVE all these into your Greenstone 3.09 (rc1) installation's "web\sites\localsite\collect\sciencea\import" folder, where you should already have the old solitary metadata.xml file at this level.
+Wait for the script to finish.
+]
 
-e. Run the GLI/Greenstone Librarian Interface application of your installed Greenstone.
-In GLI, select File > Open. Choose your "Science Activities (sciencea)" collection.
-When this finishes opening, click on the Create tab in GLI.
-Find the Build Collection button at the bottom and press it. This can take a long time, maybe 15 mins or more. Eventually it will finish building and you can press the Preview button also at the bottom of the Create pane to have it open a browser for you and show you the finished collection.
+3. ONLY if you now want to reingest and rebuild your collection with the contents of the new import folder, use a file browser to do the following:
+- Delete all except the top-level metadata.xml file in your Greenstone 3 installation's "web/sites/waikato-edu/collect/science-activities/import" folder.
+- Go into the "C:\Users\You\Desktop\TT4.02_Science Resources_Crates\import" folder. You should see subfolders A-1 to F-2.
+- MOVE all these into your Greenstone 3 installation's "web/sites/waikato-edu/collect/science-activities/import" folder, where you should already have the old solitary metadata.xml file at this level.
 
---------------------
-INFORMATION:
-- I exported each crate's .csv file individually from Excel (by default it exports in ASCII encoding format, so I left it as such and let procCrates.bat below deal with this).
+To rebuild the science-activities collection, follow the instructions under "REBUILDING THE SCIENCE ACTIVITIES COLLECTION" below.
+
+
+
+B. REBUILDING THE science-activities COLLECTION
+------------------------------------------------
+1. Run the GLI/Greenstone Librarian Interface application of your installed Greenstone.
+2. In GLI, select File > Open. Choose your "science-activities" collection.
+3. When this finishes opening, click on the Create tab in GLI.
+4. Find the Build Collection button at the bottom and press it. This can take a long time, maybe 15 mins or more. Eventually it will finish building and you can press the Preview button also at the bottom of the Create pane to have it open a browser for you and show you the finished collection.
+
+
+
+C. VIEWING THE COLLECTION WHEN IT'S ALREADY BEEN BUILT BEFORE
+--------------------------------------------------------------
+You only have to rebuild a collection when you make changes to it or if it's never been built before.
+Otherwise, if a collection has already been built at some point and hasn't been modified since, you can preview it directly as follows.
+
+Start your Greenstone's installation's "Greenstone Server" application. Pressing this application's "Enter Library" button should open your default browser on your Greenstone DL home page. Visit your new science-activities collection, as it's prebuilt.
+
+
+
+D. INFORMATION AND WARNINGS
+----------------------------
+- I exported each crate's .csv file individually from Excel (by default it exports in ASCII encoding format, so I left it as such and let the procCrates.bat script deal with this).
 I did this by opening the "Crates (TT4.02).xlsx" file that was in the TT4.02_Science Resources_Crates.zip downloaded from your Google drive. Then I clicked on each sheet and did Save As > *.csv (the most basic CSV option).
 
@@ -56 +81 @@
 NOTE: I have had to change / (forward slash) to ; (semi-colon) as the / is used as a hierarchy separator by the browsing classifier code.
 
-- I've modified the Education Resources metadata set to have an extra field called CrateHierarchy, which makes it easier to produce the book nodes.
-The educationresources.mds (metadata set file) lives inside your web\sites\localsite\collect\sciencea\metadata folder. You can copy it into gli\metadata to re-use it for other collections.
-- I've modified web\sites\localsite\siteConfig.xml with a single additional line to have a word icon for docx files too (not just for the old .doc files). The additional line is:
+- The collections in the "waikato-edu" Greenstone site make use of the custom Greenstone metadata set file "educationresources.mds".
+It can be found at waikato-edu/collect/science-activities/metadata/educationresources.mds (if you've already moved the waikato-edu site into your Greenstone 3 installation, it can be found within your Greenstone 3 installation directory at web/sites/waikato-edu/collect/science-activities/metadata/educationresources.mds).
+    * You can copy the educationresources.mds file into gli/metadata to re-use it for other collections you create from scratch.
+    * Alternatively, any collection created based on the science-activities collection will automatically inherit a copy of hte educationresources.mds Greenstone metadata set file.
+    
+- I've modified web/sites/waikato-edu/siteConfig.xml with a single additional line to have a word icon for docx files too (not just for the old .doc files). The additional line is:
     <replace macro="_icondocx_" scope="metadata" text="&lt;img src='interfaces/default/images/imsword.gif' border='0'/&gt;" resolve="false"/>
 
@@ -72 +100 @@
 So all the hard work here went into procCrates.bat and into setting up the collection's configuration, which produced collectionConfig.xml.
 
---------------------
-BEWARE:
+
+WARNINGS
 Beware not to change the encoding of procCrates.bat from ASCII to UTF-8 or other encodings. If you wish to edit this file, open it in Notepad++ and leave it's encoding in ASCII.