Greenstone Wiki

User Tools

Site Tools

You are here: index » en » release » 3.12_release_notes
en:release:3.12_release_notes

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
en:release:3.12_release_notes [2025/07/25 01:20] – [RSS issue] kjdonen:release:3.12_release_notes [2025/09/26 01:35] (current) – [Important Changes and Bug Fixes for 3.12] kjdon
Line 110: Line 110:
  
   * **GLI Changes: **   * **GLI Changes: **
-    * **Webswing GLI** - a lot of tidying up and stability fixes. Introduced in 3.11, Webswing GLI allows running the GLI in a browser. (But regular, desktop GLI is not going away, and still available as before.) WebSwing GLI replaces the client-GLI with Remote GS3 server combination and GLI applet/GLI Webstart application. Refer to [[https://files.greenstone.org/tutorial/gs3-current/en/all_tutorials.html#webswing_gli|Using WebSwing GLI (Web GLI)]] for instructions on how to start using WebSwing GLI. It's mostly the same as Desktop GLI, so the linked tutorial runs you through just the differences. See also [[en:user_advanced:webswing_gli|Webswing GLI page]] for additional info on getting it working.  +    * **Webswing GLI** - a lot of tidying up and stability fixes. Introduced in 3.11, Webswing GLI allows running the GLI in a browser. (But regular, desktop GLI is not going away, and still available as before.) WebSwing GLI replaces the client-GLI with Remote GS3 server combination and GLI applet/GLI Webstart application. Refer to the [[https://files.greenstone.org/tutorial/gs3-current/en/all_tutorials.html#webswing_gli|Using WebSwing GLI (Web GLI)]] tutorial for instructions on how to start using WebSwing GLI. It's mostly the same as Desktop GLI, so the linked tutorial runs you through just the differences. See also [[en:user_advanced:webswing_gli|Webswing GLI page]] for additional info on getting it working.  
-    * **the Files tab.** Added mainly to support Webswing GLI users, the Files tab gives a view of the entire collection - unlike the Gather tab, which just shows the import folder. Using the Files tab, a user can add resources, xsl files, javascript etc to their collection. Previously this would have required logging in to the server and uploading files.+    * **the Files tab.** Added mainly to support Webswing GLI users, the Files tab gives a view of the entire collection - unlike the Gather tab, which just shows the import folder. Using the Files tab, a user can add resources, xsl files, javascript etc to their collection. Previously this would have required logging in to the server and uploading files. This tab is only active in Expert mode - to change modes, go to File->Preferences->Mode.
     * **custom fields** Allows adding custom metadata names for indexes, sort fields, facet fields - in case you need to use extracted metadata that doesn't end up in the metadata lists in GLI.     * **custom fields** Allows adding custom metadata names for indexes, sort fields, facet fields - in case you need to use extracted metadata that doesn't end up in the metadata lists in GLI.
     * ** shared-collections-editor** New authentication group in webswing GLI - allows the user to edit shared collections, but not personal collections. Gli now also provides the option when creating a new collection for it to be personal or shared (depending on the user's authentication groups).     * ** shared-collections-editor** New authentication group in webswing GLI - allows the user to edit shared collections, but not personal collections. Gli now also provides the option when creating a new collection for it to be personal or shared (depending on the user's authentication groups).
Line 118: Line 118:
   * **Collage and Phind applets now webswing applications:** support for applets was discontinued by the popular web browsers. The useful applets //Phind// and //Collage// are now back and available for use again, having being ported as webswing applications.    * **Collage and Phind applets now webswing applications:** support for applets was discontinued by the popular web browsers. The useful applets //Phind// and //Collage// are now back and available for use again, having being ported as webswing applications. 
        
-  * **perl-with-cpan bundled:** perl 5.32.1 (5.32.1.1 on windows, 32 bit) is now bundled with Greenstone 3.12 and includes specific cpan libraries that Greenstone makes use of. Greenstone's bundled perl-with-cpan can be found in your GS3.12 installation's ''bin/darwin/perl'' for Mac, ''bin/linux/perl'' for Linux and in ''bin/windows/strawberry-perl/perl'' for windows. If you are compiling adn running Greenstone from a source release or SVN, you will need to get this Greenstone compatible perl by running e//xt-cli/get-selfcontained-perl-with-span.sh/bat//.+  * **perl-with-cpan bundled:** perl 5.32.1 (5.32.1.1 on windows, 32 bit) is now bundled with Greenstone 3.12 and includes specific cpan libraries that Greenstone makes use of. Greenstone's bundled perl-with-cpan can be found in your GS3.12 installation's ''bin/darwin/perl'' for Mac, ''bin/linux/perl'' for Linux and in ''bin/windows/strawberry-perl/perl'' for windows. If you are compiling and running Greenstone from a source release or SVN, you will need to get this Greenstone compatible perl by running //ext-cli/get-selfcontained-perl-with-span.sh/bat//.
  
   * **-metadata_mapping_file option for plugins:** - using a set of rules specified in a csv file, a plugin can generate new metadata values through manipulation of existing metadata. See //greenstone3/gs2build/etc/metadata_mapping_rules.csv// for a sample file and description of the syntax. This is available for all plugins - set the -metadata_mapping_file option to the name of a CSV file of rules. This file can be located in greenstone3/gs2build/etc (available for all collections) or in a collection's etc folder (just for that collection).   * **-metadata_mapping_file option for plugins:** - using a set of rules specified in a csv file, a plugin can generate new metadata values through manipulation of existing metadata. See //greenstone3/gs2build/etc/metadata_mapping_rules.csv// for a sample file and description of the syntax. This is available for all plugins - set the -metadata_mapping_file option to the name of a CSV file of rules. This file can be located in greenstone3/gs2build/etc (available for all collections) or in a collection's etc folder (just for that collection).
  
   * **File Level Document History**   * **File Level Document History**
 +
   * ** PreProcessPlugin** - a new plugin which can run an arbitrary script, either once at the start of import, or on matching documents. For example, it could be used to run a command line conversion script on files before importing them.   * ** PreProcessPlugin** - a new plugin which can run an arbitrary script, either once at the start of import, or on matching documents. For example, it could be used to run a command line conversion script on files before importing them.
 +
   * ** OIDtype: filename_regex** - used to automatically make document OIDs from filenames   * ** OIDtype: filename_regex** - used to automatically make document OIDs from filenames
-  * ** new sort mode**  - based on ArbiLex TODO+ 
 +  * ** new sort modes for List classifier**  - based on [[https://metacpan.org/pod/Sort::ArbBiLex | ArbiLex]], allows custom structured sorting. See //gs2build/perllib/structured_sort_definition.pm//. The classifier option values are **structured** and **structured_grouped**. The default sort order definition takes letters and their accented versions as a group, but with an order within that group.  
   * ** WordPlugin -generate_pdf_as_associated_file** - a new option for WordPlugin, which is available if you have the open Office Extension installed. This saves the Word document as a PDF, which gets associated with the Greenstone document.  TODO - how do you then link to it?   * ** WordPlugin -generate_pdf_as_associated_file** - a new option for WordPlugin, which is available if you have the open Office Extension installed. This saves the Word document as a PDF, which gets associated with the Greenstone document.  TODO - how do you then link to it?
 +
   * **user comments now editable** - in the online document editor.   * **user comments now editable** - in the online document editor.
 +
   * **ext-cli** - a new mechanism for Greenstone 3. the ext-cli folder contains scripts to download and install locally versions of perl, Java Development Kit, ant, gcloud, mavin, nodejs, python3, rclone. These are very helpful for people wanting to compile up Greenstone themselves, and for running various Greenstone extensions.   * **ext-cli** - a new mechanism for Greenstone 3. the ext-cli folder contains scripts to download and install locally versions of perl, Java Development Kit, ant, gcloud, mavin, nodejs, python3, rclone. These are very helpful for people wanting to compile up Greenstone themselves, and for running various Greenstone extensions.
 +
   * ** new modelsite** - if you want to create a new site, you can make a copy of the modelsite. modelsite contains modelcol, which is used as the base when creating a new collection. If your new site contains specific configuration file settings which will pertain to all collections, you can edit the //web/sits/<newsite>/collect/modelcol/etc/collectionConfig.xml// file  - all newly created collections in that site will copy this.    * ** new modelsite** - if you want to create a new site, you can make a copy of the modelsite. modelsite contains modelcol, which is used as the base when creating a new collection. If your new site contains specific configuration file settings which will pertain to all collections, you can edit the //web/sits/<newsite>/collect/modelcol/etc/collectionConfig.xml// file  - all newly created collections in that site will copy this. 
-  * **OAIServer support for Europeana EDM format** - see //resources/oai/OAIConfig.xml.in//+ 
 +  * ** updated modelcol** - the modelcol now contains placeholder files for some auxiliary files that are commonly customised. Eg custom javascript, XSL etc. This allows easier customisation of the collection through the new GLI Files tab. 
 + 
 +  * **OAIServer support for Europeana EDM format** - see //resources/oai/OAIConfig.xml.in// Thanks to Diego Spano. 
   * **new associated file urls** - the old way of linking to a document's associated files (eg the original PDF) looked like: //library/sites/<sitename>/collect/<collname>/assoc/<assocfilepath>/doc.pdf//. assocfilepath is based on the identifier of the document, and has the potential to change each time a collection is rebuilt, meaning these links to files are not stable between builds. The new format looks like //library/collection/<collname>/document/<docid>/assoc/doc.pdf// - assocfilepath no longer needed.   * **new associated file urls** - the old way of linking to a document's associated files (eg the original PDF) looked like: //library/sites/<sitename>/collect/<collname>/assoc/<assocfilepath>/doc.pdf//. assocfilepath is based on the identifier of the document, and has the potential to change each time a collection is rebuilt, meaning these links to files are not stable between builds. The new format looks like //library/collection/<collname>/document/<docid>/assoc/doc.pdf// - assocfilepath no longer needed.
  
 +===== Greenstone Extensions =====
 +
 +Greenstone has many extensions - projects that add functionality to it. Some are Greenstone3 extensions, which live in the //greenstone3/ext// folder, and can be viewed at [[https://trac.greenstone.org/browser/gs3-extensions]]. Others are Greenstone2 versions - if they relate to collection building then they are suitable for Greenstone 3 also, and would live in //greenstone3/gs2build/ext//. They can be viewed at [[https://trac.greenstone.org/browser/gs2-extensions]].
 +
 +==== Extensions included by default in 3.12:====
 +
 +** Greenstone3 extensions**
 +  * **solr** - adds collection indexing using SOLR
 +  * **webswing** - adds the ability to run Java programs (GLI, phind, collage) in the browser.
 +
 +To deactivate these, you can run the DEACTIVATE.sh script in greenstone3/ext
 +
 +** Greenstone 2 extensions**
 +  * **pdf-box** - adds better PDF handling
 +  * **tika** - adds support for docx files using UnknownConverterPlugin
 +
 +==== Other useful extensions ====
 +  * **OpenOffice** - If you have LibreOffice or OpenOffice installed, you can use the OpenOffice extension to process some newer versions of Microsoft Word, Excel and Powerpoint documents. Refer to the [[en:user_advanced:greenstone_extensions|openoffice greenstone extension]] instructions.
 +  * **Tesseract** - allows extraction of text from image files using OCR. Refer to the [[en:user_advanced:greenstone_extensions#tesseract|tesseract extension]] instructions. 
 ===== Known Issues ===== ===== Known Issues =====
-=== RSS issue ===+=== RSS issues ===
  
-The RSS button (see [[en:user:rss| the RSS page]] for more information) gives a transformation error. - To fix this please edit web/interfaces/default/transform/gslib.xsl - copy the collNameChecked variable definition from web/interfaces/default/transform/layouts/header-vars.xsl into this file.+  * The RSS button (see [[en:user:rss| the RSS page]] for more information) gives a transformation error. - To fix this please edit web/interfaces/default/transform/gslib.xsl - copy the collNameChecked variable definition from web/interfaces/default/transform/layouts/header-vars.xsl into this file. 
 +  * If you edit the collectionConfig file to add a plugout line, it gets removed by GLI. Solution: use the import options -saveas and -saveas_options on the Create Pane instead. 
 +  * Incremental build doesn't update the RSS information with any deletions. Solution: do a full rebuild to remove all the deleted items from the RSS info.
  
 === GLI issue === === GLI issue ===
en/release/3.12_release_notes.1753406455.txt.gz · Last modified: 2025/07/25 01:20 by kjdon