Changeset 33696
- Timestamp:
- 2019-11-15T22:09:56+13:00 (4 years ago)
- Location:
- main/trunk/model-sites-dev/waikato-edu/collect
- Files:
-
- 2 moved
Legend:
- Unmodified
- Added
- Removed
-
main/trunk/model-sites-dev/waikato-edu/collect/README-maths-activities.txt
r33695 r33696 16 16 17 17 You would choose to recreate the import folder's contents of the maths-activities from scratch if: 18 - themaths-activities/import subfolder is empty19 - you have moved about some files and folders of the Math Resource Activities folder that serves as source (input) to creating the maths-activities's importsubfolder.18 - your Greenstone 3 installation's web/sites/waikato-edu/collect/maths-activities/import subfolder is empty 19 - you have reorganised files and folders in the Math Resources Activities folder that serves as source (input) to creating the "maths-activities" collection's "import" subfolder. 20 20 21 To prepare the maths-activities/import folder's contents from scratch, 21 To prepare the maths-activities/import folder's contents from scratch, first request access to the Math Resources Activities (digitised materials) from the University's Education Deparment. 22 Then follow the instructions below. 22 23 23 24 0. Inspect the image "screenshot-input-mathfolder-organisation.png" which is a screengrab of how the contents of the Math Resource Activities folder could be organised. In the screenshot: … … 25 26 - A further subfolder is also expanded on the left: "Hooked on Algebra". Not shown is that this subfolder, expanded as an example, contains the files "Fishy Algebra.jpg" and "Hooked on Algebra.pdf". 26 27 27 Liang Li organised the contents of the Math Resource Activities folder as seen in the screenshot. Others may decide on a different organisation of its contents. 28 In that case, you want to make sure that your Math Resources Activities folder is hierarchically organised in a similarly sensible fashion. You're free to move across folders and subfolders as you please, and add new ones, just be aware that the folder and subfolder hierarchical structure you create within Math Resources Activities will be reflected in the final Greenstone collection. 28 Kathy Li (Li Liang) organised the contents of the Math Resource Activities folder as seen in the screenshot. Others may decide on a different organisation of its contents. In that case, you want to make sure that your Math Resources Activities folder is hierarchically organised in a similarly sensible fashion. You're free to move across folders and subfolders as you please, and add new ones, just be aware that the folder and subfolder hierarchical structure you create within Math Resources Activities will be reflected in the final Greenstone collection. 29 29 30 IMPORTANT: Also be aware that while the code can cope with spaces, you want to avoid "&" and other tricky characters (e.g. proper quote marks) in names of files and folders. Naming things correctly at this stage will save a lot of grief later. Use "and" in place of "&" for instance in file/folder names, drop quotation marks and colons. If in doubt about any character, replace with a simpler one. Hyphens and underscores are fine. Replace forward slashes, "/", in file/folder names, because "/" has a special meaning in Greenstone. 30 31 31 1. Once you've finished reorganising the Math Resources Activities folder, copy the file "procMath.bat" (a custom made Windows specific script)into the top level of the Math Resources Activities folder.32 1. Once you've finished reorganising the Math Resources Activities folder, copy the custom made Windows specific script file "procMath.bat", located at "web/sites/waikato-edu/collect/maths-activities/DATA-PREPARATION/procMath.bat", into the top level of the Math Resources Activities folder. 32 33 33 2. Double-click theprocMath.bat file and it should run against the structured contents within your Math Resources Activities folder. You can see it's doing something because a black window should pop up wherein lots of text is displayed.34 2. Move into your Math Resources Activities folder where the copy of the procMath.bat file resides. Double-click that procMath.bat file and it should run against the structured contents within your Math Resources Activities folder. You can see it's doing something because a black window should pop up wherein lots of text is displayed. 34 35 35 NOTE: If you have heard of something called the "Windows DOS prompt" and know how to use it, you can use the DOS prompt to run the procMath.bat file too, instead of double clicking it as described above. This is useful for finding any issues (a process known as "debugging") in the event that something goes wrong in processing your Math Resources Activities folder. For example if you used unacceptable characters in file and folder names.36 NOTE: If you have heard of something called the "Windows DOS prompt" and know how to use it, you can use the DOS prompt to run the procMath.bat file too, instead of double clicking it as described above. This is useful for finding any issues (a process known as "debugging") in the event that something goes wrong in processing your Math Resources Activities folder. For example, if you used unacceptable characters in file and folder names. 36 37 37 38 3. After a little while the black window that popped up should disappear again, meaning the procMath.bat script has finished processing your Math Resources Activities folder. … … 39 40 As a result of running procMath.bat successfully, you'll now have a folder called "import" residing at the same level as your Math Resources Activities folder. 40 41 41 4. Move all the contents of this import folder, except its toplevel "metadata.xml" file into your "maths-activities/import" subfolder. Then you may delete the "import" folder produced in steps 2 and 3 above. 42 4. Move all the contents of this import folder, except its toplevel "metadata.xml" file into your Greenstone 3 installation's web/sites/waikato-edu/collect/maths-activities/import folder. 43 Then you may choose to delete the "import" folder produced in steps 2 and 3 above. 42 44 43 45 5. Proceed with the "B. INSTRUCTIONS ON REBUILDING THE maths-activities GREENSTONE COLLECTION, IF THE COLLECTION'S import FOLDER IS NON-EMPTY" below. … … 50 52 To build the maths-activities Greenstone collection (the Math Activities collection), assuming you already have the contents of the collection "import" folder (if not, see instructions under section A above): 51 53 52 0. Follow any instructions in the EducationDept/README.txt file first.54 1. Run the GLI (Greenstone Librarian Interface) application. 53 55 54 1. Move the maths-activities into a Greenstone 3.09 installation's web/sites/waikato-edu/collect/ folder. 56 2. Open the maths-activities collection in GLI. 55 57 56 2. Run the GLI (Greenstone Librarian Interface) application. 57 58 3. Open the maths-activities collection in GLI. 59 60 4. Go into the Create panel and press the Build collection button. 58 3. Go into the Create panel and press the Build collection button. 61 59 Some minutes later, the Preview Collection button will become active, meaning your collection has been built and is ready to preview. (If the Preview button does not become active despite the build process indicating that it finished "successfully", quit GLI, reopen the collection and repeat steps 2-4. You can always email us on the mailing list at [email protected].) 62 60 63 61 64 62 65 C. HOW TO CREATE A NOTHER EDUCATION DEPT'S ACTIVITY COLLECTION66 ------------------------------------------------------------- 63 C. HOW TO CREATE A NEW ACTIVITY COLLECTION SIMILAR TO maths-activities 64 ----------------------------------------------------------------------- 67 65 You can create a different, new Greenstone collection similar to the Math collection by following the steps below. 68 Note that step 2 below requires a Windows machine, but the remain ding steps can be done on other operating systems such as Linux and Mac.66 Note that step 2 below requires a Windows machine, but the remaining steps can be done on other operating systems such as Linux and Mac where you have a Greenstone 3 installed and have got the same "waikato-edu" Greenstone site set up within it. 69 67 70 68 1. Organise your content in a sensible hierarchical folder structure. As mentioned earlier in this README, check your file and folder names don't have "&", "/", quotes and any other characters that you think might be problematic (replace them with other characters or indicative words, e.g. replace "&" with "and"). 71 69 72 70 2. THE SCRIPT IN THIS STEP REQUIRES A Windows MACHINE. 73 Put the script file "procMath.bat" into the toplevel folder of the material you organised in step 1.71 Copy the script file "web/sites/waikato-edu/collect/maths-activities/DATA-PREPARATION/procMath.bat" into the toplevel folder of the material you organised in step 1. 74 72 75 73 3. Double click on the procMath.bat script. A black window will pop up. It will disappear once the script has finished processing your folder's contents. 76 74 At the end of this process, you'll have ended up with a folder called "import" at the same level as the toplevel folder of the material you organised in step 1. 77 75 78 4. Ensure that your Greenstone 3 installation's web/sites/waikato-edu/collect subfolder contains the maths-activities folder. If it doesn't already exist there, copy it into there. 79 80 5. Run the Greenstone Librarian Interface, GLI. You'll now create a new collection based on the maths-activities: 76 4. Run the Greenstone Librarian Interface, GLI. You'll now create a new collection based on the maths-activities: 81 77 Go to GLI's File > New... menu. Give the new collection a name, optionally add a description. Then in the drop-down box for "Base This Collection On", choose the Maths Activities collection (maths-activities). Press OK. 82 78 Your new collection will now have inherited the custom metadata set and overall collection design of the Math Activities collection. So you don't need to put in any effort to get the same behaviour from your new collection. … … 86 82 You can now quit GLI. 87 83 88 6. Move all the contents of the "import" folder produced at the end of step 3 above, excluding its toplevel "metadata.xml" file, into your Greenstone 3 installation's web/sites/waikato-edu/collect/<new collection's name>/import folder. (Where "new collection's name" is the simplified name that got assigned to the new collection you created in step 5.)84 5. Move all the contents of the "import" folder produced at the end of step 3 above, excluding its toplevel "metadata.xml" file, into your Greenstone 3 installation's web/sites/waikato-edu/collect/<new collection's name>/import folder. (Where "new collection's name" is the simplified name that got assigned to the new collection you created in step 4.) 89 85 You can now delete the "import" folder you created in step 3. 90 86 91 7. Run GLI again and use File > Open... to open the collection you created in step 5.87 6. Run GLI again and use File > Open... to open the collection you created in step 4. 92 88 93 8. OPTIONAL STEP: If you want to add additional "tags" to documents or folders, to allow browsing or searching by them, then go to GLI's Enrich pane. On the left, select all files/folders for which a particular tag value is applicable and, on the right, assign this to the field labelled "er.Tag". You can create multiple er.Tags for any file/folder (or selection thereof) by hitting Enter after assigning a value for an er.Tag. This will allow you to enter a second Tag value, and so on.89 7. OPTIONAL STEP: If you want to add additional "tags" to documents or folders, to allow browsing or searching by them, then go to GLI's Enrich pane. On the left, select all files/folders for which a particular tag value is applicable and, on the right, assign this to the field labelled "er.Tag". You can create multiple er.Tags for any file/folder (or selection thereof) by hitting Enter after assigning a value for an er.Tag. This will allow you to enter a second Tag value, and so on. 94 90 Then select other files and folders for which other tag(s) apply, and assign them similarly, until you've assigned all the tag metadata you want to the various files and folders. 95 91 96 BEWARE: if you ever recreate your collection's "import" folder contents as in steps 3 and 6, you will lose any er.Tag values you assigned through GLI.92 BEWARE: if you ever recreate your collection's "import" folder contents as in steps 3 and 5, you will lose any er.Tag values you assigned through GLI. 97 93 98 In order to beenable Searching and Browsing by the tags you assigned, go to GLI > Design pane.94 In order to enable Searching and Browsing by the tags you assigned, go to GLI > Design pane. 99 95 - Choose "Search Indexes" on the right, then press the "New Index" button. In the popup dialog, scroll down until you see "er.Tag" and tick its box. Press "Add Index". Now you've prepared your collection to allow searching by tags. 100 96 - Next, choose "Browsing Classifiers" on the left, then at the bottom on the right set "Select classifier to add" to "List" and press "Add Classifier". The dialog that pops up, next to the "metadata" configuration option at the top, choose "er.Tag" from its drop down values. Scroll further down in the dialog until you see the "buttonname" option and type "tags" as its value. Press "OK" to close the dialog. You've now configured your collection to allow users to browse by the tagging metadata that you've assigned. … … 102 98 ("er" stands for the custom EducationResources.mds metadata set created for the education department.) 103 99 104 9. You're finally ready to rebuild your collection. Still within GLI, click on the Create pane near the top and press the "Build Collection" button. Depending on the size of your collection, this can take some time. Wait until your collection has built successfully and then press the Preview collection which should have become active at this point. Your browser should open up and you should be able to start inspecting the collection you created.100 8. You're finally ready to rebuild your collection. Still within GLI, click on the Create pane near the top and press the "Build Collection" button. Depending on the size of your collection, this can take some time. Wait until your collection has built successfully and then press the Preview collection which should have become active at this point. Your browser should open up and you should be able to start inspecting the collection you created. 105 101 106 102 … … 116 112 117 113 c. You can also join the greenstone-users mailing list to ask Greenstone questions, see http://wiki.greenstone.org/doku.php?id=en:support#central_english_mailing_lists 118 Waikato University Education department staff are also welcome to write to us directly, if that's preferred, at [email protected]119 114 120 115 121 116 117 -
main/trunk/model-sites-dev/waikato-edu/collect/README-science-activities.txt
r33693 r33696 2 2 README 3 3 -------------------- 4 A. RECREATING THE science-activities GREENSTONE COLLECTION's import FOLDER'S CONTENTS FROM SCRATCH 5 B. REBUILDING THE science-activities COLLECTION 6 C. VIEWING THE COLLECTION WHEN IT'S ALREADY BEEN BUILT 7 D. INFORMATION AND WARNINGS 4 8 5 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. 9 10 11 A. RECREATING THE science-activities GREENSTONE COLLECTION's import FOLDER'S CONTENTS FROM SCRATCH 12 --------------------------------------------------------------------------------------------------- 13 ONLY if you ever want to REGENERATE the folders for ingesting into GS3 your crate folders, PDF/Word files and metadata, then: 14 15 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. 6 16 But assuming the Education Dept. has given this content you in a zip format, follow the instructions below. 7 17 8 1. Extract the TT4.02_Science Resources_Crates.zip, which will create a folder called TT4.02_Science Resources_Crates.zip 9 For example, extract it on the Desktop and your Windows desktop will now have a new folder TT4.02_Science Resources_Crates. 18 1. Extract the TT4.02_Science Resources_Crates.zip, which will create a folder called TT4.02_Science Resources_Crates. 19 For example, extract it on the Desktop and your Windows desktop will now have a new folder called "TT4.02_Science Resources_Crates". 20 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. 10 21 11 2. Next, move the file s procCrates.bat and all 14 of the .csv files (A-1 to F-2) into the new TT4.02_Science Resources_Crates folder22 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. 12 23 13 3. Move the "sciencea.gs3coll" folder into your Greenstone 3.09rc1 installation's "web\sites\localsite\collect" folder. 24 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 25 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 14 26 15 4. Move the siteConfig.xml file into your Greenstone 3.09rc1 installation's "web\sites\localsite" folder, thereby replacing the existing file there.27 Double-click on the procCrates.bat script. 16 28 17 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.29 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. 18 30 19 -------------------- 20 TO REGENERATE THE MATERIALS FOR YOUR COLLECTION AND TO REBUILD THAT COLLECTION: 21 4. ONLY if you ever want to REGENERATE the folders for ingesting into GS3 your crate folders, PDF/Word files and metadata, then: 31 [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. 22 32 23 In our example, your extracted TT4.02_Science Resources_Crates was on the Desktop, e.g. C:\Liang\Desktop\TT4.02_Science Resources_Crates 24 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 25 26 a. Open a DOS prompt: 33 Open a DOS prompt: 27 34 first hold down the Windows key on the keyboard (located between Alt and Ctrl keys) and press the R key (R for run); 28 35 then a little dialog will pop up. Type "cmd" into its edit field and press enter and a DOS prompt will appear. 29 36 30 37 In the DOS prompt, type: 31 cd C:\ Liang\Desktop\TT4.02_Science Resources_Crates38 cd C:\Users\You\Desktop\TT4.02_Science Resources_Crates 32 39 (i.e. "cd" followed by the full path to the actual location of your extracted folder) 33 40 34 b.type:41 Next type: 35 42 procCrates.bat 36 37 c. Wait until it finishes. It should have created a folder called "import" in C:\Liang\Desktop\TT4.02_Science Resources_Crates.38 43 39 d. ONLY if you now want to reingest and rebuild your collection with these new folders, use a file browser to do the following: 40 - Delete all but the top-level metadata.xml file in your Greenstone 3.09 (rc1) installation's "web\sites\localsite\collect\sciencea\import" folder. 41 - Go into the "C:\Liang\Desktop\TT4.02_Science Resources_Crates\import" folder. You should see subfolders A-1 to F-2. 42 - 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. 44 Wait for the script to finish. 45 ] 43 46 44 e. Run the GLI/Greenstone Librarian Interface application of your installed Greenstone. 45 In GLI, select File > Open. Choose your "Science Activities (sciencea)" collection.46 When this finishes opening, click on the Create tab in GLI.47 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.47 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: 48 - Delete all except the top-level metadata.xml file in your Greenstone 3 installation's "web/sites/waikato-edu/collect/science-activities/import" folder. 49 - Go into the "C:\Users\You\Desktop\TT4.02_Science Resources_Crates\import" folder. You should see subfolders A-1 to F-2. 50 - 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. 48 51 49 -------------------- 50 INFORMATION: 51 - 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). 52 To rebuild the science-activities collection, follow the instructions under "REBUILDING THE SCIENCE ACTIVITIES COLLECTION" below. 53 54 55 56 B. REBUILDING THE science-activities COLLECTION 57 ------------------------------------------------ 58 1. Run the GLI/Greenstone Librarian Interface application of your installed Greenstone. 59 2. In GLI, select File > Open. Choose your "science-activities" collection. 60 3. When this finishes opening, click on the Create tab in GLI. 61 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. 62 63 64 65 C. VIEWING THE COLLECTION WHEN IT'S ALREADY BEEN BUILT BEFORE 66 -------------------------------------------------------------- 67 You only have to rebuild a collection when you make changes to it or if it's never been built before. 68 Otherwise, if a collection has already been built at some point and hasn't been modified since, you can preview it directly as follows. 69 70 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. 71 72 73 74 D. INFORMATION AND WARNINGS 75 ---------------------------- 76 - 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). 52 77 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). 53 78 … … 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. 57 82 58 - I've modified the Education Resources metadata set to have an extra field called CrateHierarchy, which makes it easier to produce the book nodes. 59 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. 60 - 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: 83 - The collections in the "waikato-edu" Greenstone site make use of the custom Greenstone metadata set file "educationresources.mds". 84 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). 85 * You can copy the educationresources.mds file into gli/metadata to re-use it for other collections you create from scratch. 86 * Alternatively, any collection created based on the science-activities collection will automatically inherit a copy of hte educationresources.mds Greenstone metadata set file. 87 88 - 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: 61 89 <replace macro="_icondocx_" scope="metadata" text="<img src='interfaces/default/images/imsword.gif' border='0'/>" resolve="false"/> 62 90 … … 72 100 So all the hard work here went into procCrates.bat and into setting up the collection's configuration, which produced collectionConfig.xml. 73 101 74 -------------------- 75 BEWARE: 102 103 WARNINGS 76 104 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. 77 105
Note:
See TracChangeset
for help on using the changeset viewer.