User Tools

Site Tools


en:release:2.87_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:2.87_release_notes [2017/09/27 08:01] – [Notes on using GLI] anupamaen:release:2.87_release_notes [2023/03/13 01:46] (current) – external edit 127.0.0.1
Line 1: Line 1:
 +
 +
 +
 ====== Greenstone 2.87 Release Notes ====== ====== Greenstone 2.87 Release Notes ======
  
 **Release Name:** 2.87 **Release Name:** 2.87
  
-**Release Date:** Not yet released.+**Release Date:** 01 October 2017
  
 ** Released: ** ** Released: **
 +  * Greenstone v2.87: The official Greenstone 2.87. 01 Oct 2017 \\ Binaries for Windows, GNU/Linux 32 and 64 bit, Mac Mountain Lion and Mac El Capitan. Mac Mountain Lion and 32 bit linux binaries were only spot tested. The other 3 binaries were tested more extensively. The sole Windows binary is, as usual, for both 32 and 64 bit machines and was largely tested on **Windows 10** this time.\\ [[http://svn.greenstone.org/main/tags/2.87/|svn tag page]] [[http://trac.greenstone.org/browser/main/tags/2.87|trac tag page]].  Code revision up to 32016/32017. Tag revision: 32020.
  
 ** Release Candidate History ** ** Release Candidate History **
Line 67: Line 71:
 When the client-GLI starts up, a small dialog appears asking you to enter the URL of the remote Greenstone server's gliserver.pl file. This URL generally has the form: %%http://<host>:<port>/greenstone/cgi-bin/gliserver.pl%%, where you have to fill in the host and port values for the remote Greenstone server. After clicking OK, the client-GLI application window will appear. Client-GLI looks and works just like the GLI, except that most of the document processing takes place on the remote machine where the Greenstone server is running. When the client-GLI starts up, a small dialog appears asking you to enter the URL of the remote Greenstone server's gliserver.pl file. This URL generally has the form: %%http://<host>:<port>/greenstone/cgi-bin/gliserver.pl%%, where you have to fill in the host and port values for the remote Greenstone server. After clicking OK, the client-GLI application window will appear. Client-GLI looks and works just like the GLI, except that most of the document processing takes place on the remote machine where the Greenstone server is running.
  
-  * If you wish to work with password protected collections, here's [[http://wiki.greenstone.org/doku.php?id=en:release:2.86_release_notes&#problemauthenticated_collections_require_constant_authentication|a workaround]] to the bug of constantly requiring to authenticate yourself. +  * To get your Greenstone installation set up as a remote server so that other GLI clients can connect to it, refer to the section [[2.87_Release_Notes#Working_with_Remote_Greenstone_and_the_GLI-Client | Working with Remote Greenstone and the GLI-Client]].
-  * To get your Greenstone installation set up as a remote server so that other GLI clients can connect to it, refer to the section [[2.86_Release_Notes#Working_with_Remote_Greenstone_and_the_GLI-Client | Working with Remote Greenstone and the GLI-Client]].+
  
  
 ==== Installing in text-only mode ==== ==== Installing in text-only mode ====
 * Refer to [[http://wiki.greenstone.org/doku.php?id=en:user_advanced:installation#running_the_installer_in_text-only_mode|Running the installer in text-only mode]]. * Refer to [[http://wiki.greenstone.org/doku.php?id=en:user_advanced:installation#running_the_installer_in_text-only_mode|Running the installer in text-only mode]].
 +
 +
 +==== Adding source code to a binary release ==== 
 +Make sure to select the "Greenstone 2" tab of:
 +  * [[http://wiki.greenstone.org/doku.php?id=en:user_advanced:installation#source_component|Windows: Source Component instructions]]
 +  * [[http://wiki.greenstone.org/doku.php?id=en:user_advanced:installation#source_component1|Linux/Mac: Source Component instructions]]
 +
 +
 +==== Installing a source release ==== 
 +
 +Make sure to select the "Greenstone 2" tab of:
 +
 +  * [[http://wiki.greenstone.org/doku.php?id=en:user_advanced:installation#source_distribution|Windows: Source Distribution instructions]]
 +  * [[http://wiki.greenstone.org/doku.php?id=en:user_advanced:installation#source_distribution1|Linux/Mac: Source Distribution instructions]]
  
  
Line 107: Line 124:
  
  
 +===== Learning to use Greenstone =====
 +If your Greenstone is up and running and you're ready to start learning about how to use Greenstone, refer to the [[en:Tutorials | Greenstone 2 Tutorial Exercises]].
 +
 +
 +===== Troubleshooting and other Questions =====
 +  * Have a look at the [[http://wiki.greenstone.org/doku.php?id=en:release:2.86_release_notes#known_issues_and_patches | older 2.86 release's Known Issues and Patches]] section, to see if your question is already covered there and has a solution.
 +
 +  * If not, then please consult the Greenstone FAQ at http://wiki.greenstone.org/wiki/index.php/Greenstone_FAQ\\ to see if any of your questions are answered and for further workarounds of known issues. If any issues persist, write to us on [[http://wiki.greenstone.org/doku.php?id=en:support | the Greenstone Mailing List]].
 +
 +  * If you're running Greenstone 2.87 on a machine where the version of Perl is later than 5.18 (e.g. perl 5.22), as may happen when you upgrade your Ubuntu to 16.04 or later, and if your GLI does not start up properly, then first stop and restart GLI in debug mode to get better error reporting: ''./gli/gli.sh -debug''. \\ Upon running GLI in debug mode, if you see some error messages such as the following when GLI fails to start:
 +<code>
 +Unescaped left brace in regex is deprecated here (and will be fatal in Perl 5.30), passed through in regex; marked by <-- HERE in m/^(\s*)body(\s*){ <-- HERE (\s*)$/ at /home/karl/Greenstone/perllib/plugins/MediaWikiPlugin.pm line 280.
 +Unescaped left brace in regex is deprecated here (and will be fatal in Perl 5.30), passed through in regex; marked by <-- HERE in m/_content_(\s*){ <-- HERE / at /home/karl/Greenstone/perllib/plugins/MediaWikiPlugin.pm line 506.
 +Unescaped left brace in regex is deprecated here (and will be fatal in Perl 5.30), passed through in regex; marked by <-- HERE in m/(\s*|\n)_content_(\s*){ <-- HERE / at /home/karl/Greenstone/perllib/plugins/MediaWikiPlugin.pm line 529.
 +Unescaped left brace in regex is deprecated here (and will be fatal in Perl 5.30), passed through in regex; marked by <-- HERE in m/(\s*|\n)_content_(\s*){ <-- HERE (.|\n)*?}/ at /home/karl/Greenstone/perllib/plugins/MediaWikiPlugin.pm line 534.
 +Unescaped left brace in regex is deprecated here (and will be fatal in Perl 5.30), passed through in regex; marked by <-- HERE in m/(/.*){ <-- HERE ,41}/ at /home/karl/Greenstone/perllib/plugins/DirectoryPlugin.pm line 199.
 +AutoLoadConverters: PDFBox Extension to Greenstone detected for PDFPlugin
 +Unescaped left brace in regex is deprecated here (and will be fatal in Perl 5.30), passed through in regex; marked by <-- HERE in m/^[a-z]{ <-- HERE 2..}/ at /home/karl/Greenstone/perllib/plugins/LaTeXPlugin.pm line 220.
 +Unescaped left brace in regex is deprecated here (and will be fatal in Perl 5.30), passed through in regex; marked by <-- HERE in m/\\(?:addcontentsline){ <-- HERE .*?}\{.*?}\{.*}/ at /home/karl/Greenstone/perllib/plugins/LaTeXPlugin.pm line 371.
 +Unescaped left brace in regex is deprecated here (and will be fatal in Perl 5.30), passed through in regex; marked by <-- HERE in m/\\(?:label|begin|end){ <-- HERE .*?}\s*\n?/ at /home/karl/Greenstone/perllib/plugins/LaTeXPlugin.pm line 380.
 +Unescaped left brace in regex is deprecated here (and will be fatal in Perl 5.30), passed through in regex; marked by <-- HERE in m/(\\[`'="^~\.]){ <-- HERE (\w)}/ at /home/karl/Greenstone/perllib/plugins/LaTeXPlugin.pm line 691.
 +Unescaped left brace in regex is deprecated here (and will be fatal in Perl 5.30), passed through in regex; marked by <-- HERE in m/(\\[uvcH]){ <-- HERE (\w)}/ at /home/karl/Greenstone/perllib/plugins/LaTeXPlugin.pm line 699.
 +Unescaped left brace in regex is deprecated here (and will be fatal in Perl 5.30), passed through in regex; marked by <-- HERE in m/^[a-z]{ <-- HERE 2..}/ at /home/karl/Greenstone/perllib/plugins/BibTexPlugin.pm line 315.
 +Unescaped left brace in regex is deprecated here (and will be fatal in Perl 5.30), passed through in regex; marked by <-- HERE in m/(\\[`'="^~\.]){ <-- HERE (\w)}/ at /home/karl/Greenstone/perllib/plugins/BibTexPlugin.pm line 706.
 +Unescaped left brace in regex is deprecated here (and will be fatal in Perl 5.30), passed through in regex; marked by <-- HERE in m/(\\[uvcH]){ <-- HERE (\w)}/ at /home/karl/Greenstone/perllib/plugins/BibTexPlugin.pm line 713.
 +Getting Download Info: [perl, -S, /home/karl/Greenstone/bin/script/downloadinfo.pl, -describeall, -xml, -language, en]
 +WGet thread is waiting for DownloadJobs.
 +Failed when trying to parse downloadinfo.pl -describeall
 +java.lang.Exception: *** Error running Download Info process, process exited with: 255
 +        at org.greenstone.gatherer.gui.DownloadPane.loadDownloadersInfo(DownloadPane.java:277)
 +        at org.greenstone.gatherer.gui.DownloadPane.<init>(DownloadPane.java:115)
 +        at org.greenstone.gatherer.gui.GUIManager.display(GUIManager.java:394)
 +        at org.greenstone.gatherer.Gatherer.openGUI(Gatherer.java:712)
 +        at org.greenstone.gatherer.GathererProg.main(GathererProg.java:81)
 +java.lang.NullPointerException
 +        at org.greenstone.gatherer.gui.DownloadPane.<init>(DownloadPane.java:116)
 +        at org.greenstone.gatherer.gui.GUIManager.display(GUIManager.java:394)
 +        at org.greenstone.gatherer.Gatherer.openGUI(Gatherer.java:712)
 +        at org.greenstone.gatherer.GathererProg.main(GathererProg.java:81)
 +java.lang.NullPointerException
 +        at org.greenstone.gatherer.gui.DownloadPane.<init>(DownloadPane.java:116)
 +        at org.greenstone.gatherer.gui.GUIManager.display(GUIManager.java:394)
 +        at org.greenstone.gatherer.Gatherer.openGUI(Gatherer.java:712)
 +        at org.greenstone.gatherer.GathererProg.main(GathererProg.java:81)
 +ShutDownHook called...
 +Attempting to forcibly terminate the GS server...
 +Issuing stop command to GS2 Local Library Server. Waiting for GS2 server to stop...
 +Successfully stopped GS2 server.
 +Done.
 +</code>\\ Upon seeing such error messages:
 +
 +0. Exit GLI in the proper manner if it's running.
 +
 +1. Optional: Back up your  GS2.87's ''gs2build/perllib/plugins'' and ''gs2build/perllib/cpan/'' folders (to restore if the patches below don't work).
 +
 +2. Download the ''GS287PluginsForNewerPerlUbuntu.tar.gz'' tarball, which contains the patched up files, from [[http://trac.greenstone.org/browser/patches|the patches page]] and extract the tarball's contents.\\ If you're on a Windows machine, you may want to download the ''GS287PluginsForNewerPerlUbuntu.zip'' ZIP file instead and extract that.
 +
 +3. Five files should have been extracted:
 +  * Put the 3 Plugin.pm files into your GS2.87's ''gs2build/perllib/plugins'' folder.
 +  * put Escape.pm into the ''gs2build/perllib/cpan/URI'' folder.
 +  * put PP.pm into into the ''gs2build/perllib/cpan/JSON'' folder.
 +
 +4. Use a //new terminal// to launch GLI or any commands that previously failed with errors. Hopefully GLI will launch successfully now.
 +
 +===== Useful information =====
 +  * When you've built a collection of documents, you may discover that there appears to be a copy of all these documents in the collection's //import//, //archives// and //index// subfolders and wonder whether Greenstone could really be so  inefficient with space as to keep 3 copies of everything. As it happens though, Greenstone uses **hard-links** both on Linux and **Windows**, in order to keep just one set of your documents. Then it simply hardlinks to these, instead of making copies.
 +By default, Windows doesn't show you when files on your filesystem are hard-linked. If you choose to install the Windows extension program [[http://schinagl.priv.at/nt/hardlinkshellext/hardlinkshellext.html|Link Shell Extension (LSE)]], it will put red arrows on files that are hard linked.
  
 =====To turn on RSS support:===== =====To turn on RSS support:=====
Line 231: Line 315:
   * Then type "http://localhost:8282/greenstone/cgi-bin/library.cgi". It should show the Greenstone home page.   * Then type "http://localhost:8282/greenstone/cgi-bin/library.cgi". It should show the Greenstone home page.
   * To stop the webserver at any point, from your command window run "./gsicontrol.sh web-stop" on linux/mac and "gsicontrol.bat web-stop" on windows.   * To stop the webserver at any point, from your command window run "./gsicontrol.sh web-stop" on linux/mac and "gsicontrol.bat web-stop" on windows.
-  * If you move your Greenstone 2.86 installation folder to another location at any point, then (with the server still stopped), you would need to run "./gsicontrol.sh reset-gsdlhome" on Linux and "gsicontrol.bat reset-gsdlhome" on Windows.+  * If you move your Greenstone 2.87 installation folder to another location at any point, then (with the server still stopped), you may first need to run "./gsicontrol.sh reset-gsdlhome" on Linux and "gsicontrol.bat reset-gsdlhome" on Windows before proceeding.
   * If you forgot the admin password (as is required to access the Administration Pages and to use Remote GLI), this can be reset by running "./gsicontrol.sh configure-admin" on Linux and "gsicontrol.bat configure-admin" on Windows. The password has to be between 3 and 8 characters long.   * If you forgot the admin password (as is required to access the Administration Pages and to use Remote GLI), this can be reset by running "./gsicontrol.sh configure-admin" on Linux and "gsicontrol.bat configure-admin" on Windows. The password has to be between 3 and 8 characters long.
  
 ==== Notes on using GLI ==== ==== Notes on using GLI ====
 In GLI's File > File Associations, you can set which applications are to be called to open files with different file extensions.  In GLI's File > File Associations, you can set which applications are to be called to open files with different file extensions. 
-  * On Mac, you can type ''open %1'' for all of these, which then lets the default application on the Mac open the file extension associated with each file. You may need to find the right command for you version of *Nix.   +  * On Mac, you can type **''open %1''** for all of these, which then lets the default application on the Mac open the file extension associated with each file. You may need to find the right command for you version of *Nix.   
-  * To do the same on Windows, type ''cmd.exe /c start "" "%1"''.+  * To do the same on Windows, type **''cmd.exe /c start "" "%1"''**.
   * To attempt the same on Linux, try typing ''xdg-open %1'' (or if you are specifically on a gnome system, then try ''gnome-open %1'', while on a kde system you'd use ''kde-open %1''). Beware that not all Unix systems support a signal command to open applications, so you may need to use custom commands like ''firefox %1'' to launch in a browser, or ''gedit %1'' to open with a text editor, etc.   * To attempt the same on Linux, try typing ''xdg-open %1'' (or if you are specifically on a gnome system, then try ''gnome-open %1'', while on a kde system you'd use ''kde-open %1''). Beware that not all Unix systems support a signal command to open applications, so you may need to use custom commands like ''firefox %1'' to launch in a browser, or ''gedit %1'' to open with a text editor, etc.
 ==== Working with Remote Greenstone and the GLI-Client ==== ==== Working with Remote Greenstone and the GLI-Client ====
Line 243: Line 327:
 **Instructions** **Instructions**
  
-These instructions are more Greenstone 2.86-specific than the [[http://wiki.greenstone.org/wiki/index.php/Remote_Greenstone|general instructions]] for setting up Greenstone 2 as a remote server. +These instructions are more specific to current and recent Greenstone 2  releases than the [[http://wiki.greenstone.org/wiki/index.php/Remote_Greenstone|general instructions]] for setting up Greenstone 2 as a remote server. 
  
 The following are steps to follow if you're on **Windows**. On **Unix based systems**, you can skip steps 1 and 2, otherwise things are similar. For instance, on Unix systems, you'll want to launch *.bash or *.sh script equivalents to the batch files listed. Also, you'll want to use forward slashes (/) instead of the Windows' backward slash (\) when specifying file paths. The following are steps to follow if you're on **Windows**. On **Unix based systems**, you can skip steps 1 and 2, otherwise things are similar. For instance, on Unix systems, you'll want to launch *.bash or *.sh script equivalents to the batch files listed. Also, you'll want to use forward slashes (/) instead of the Windows' backward slash (\) when specifying file paths.
Line 286: Line 370:
 <code>cacls "C:\Program Files\Greenstone2\collect" /P Everyone:F</code> <code>cacls "C:\Program Files\Greenstone2\collect" /P Everyone:F</code>
 On Linux you would do: On Linux you would do:
-<code>chmod -R a+rw /my/path/to/my/Greenstone2.86/collect</code>+<code>chmod -R a+rw /my/path/to/my/Greenstone2.87/collect</code>
 (If on Vista or Windows 7, you installed Greenstone in an Admin area, such as in Program Files, then you would need change the security settings of the collect directory: Right-click > Properties, then set the folder to "Everyone".) (If on Vista or Windows 7, you installed Greenstone in an Admin area, such as in Program Files, then you would need change the security settings of the collect directory: Right-click > Properties, then set the folder to "Everyone".)
  
Line 432: Line 516:
     * you're on Windows and have OpenOffice/LibreOffice installed in a location other than "C:\Program Files\OpenOffice.org 3". In that case, also ensure that your PATH environment variable contains the path to the "program" folder located in your SOFFICE_HOME path (the OpenOffice installation folder).      * you're on Windows and have OpenOffice/LibreOffice installed in a location other than "C:\Program Files\OpenOffice.org 3". In that case, also ensure that your PATH environment variable contains the path to the "program" folder located in your SOFFICE_HOME path (the OpenOffice installation folder). 
     * you're on Linux and have OpenOffice or LibreOffice installed in a location different from "/opt/openoffice.org3" or "/usr/lib/openoffice" (or "/usr/lib/libreoffice").      * you're on Linux and have OpenOffice or LibreOffice installed in a location different from "/opt/openoffice.org3" or "/usr/lib/openoffice" (or "/usr/lib/libreoffice"). 
-   * Once you have Open Office set up, download the Greenstone extension for it [[http://trac.greenstone.org/browser/main/tags/2.86/gs2-extensions/open-office/trunk|from here]], which is available in tar.gz and zip formats, and unzip into Greenstone's **ext** folder. (If you have any issues try the latest version [[http://trac.greenstone.org/browser/gs2-extensions/open-office/trunk|located here]]. Note that if you get the latest version of the open office extension, you cannot already have an instance of OpenOffice running when using GLI, you will need to terminate any previously running instance. It is also unlikely that you can get a separate instance of OpenOffice running after quitting GLI. If you wish to do so, you will need to use Task Manager to terminate the open office process launched by the extension upon running GLI.)+   * Once you have Open Office set up, download the Greenstone extension for it [[http://trac.greenstone.org/browser/main/tags/2.87rc1/gs2-extensions/open-office/trunk|from here]], which is available in tar.gz and zip formats, and unzip into Greenstone's **ext** folder. (If you have any issues try the latest version [[http://trac.greenstone.org/browser/gs2-extensions/open-office/trunk|located here]]. Note that if you get the latest version of the open office extension, you cannot already have an instance of OpenOffice running when using GLI, you will need to terminate any previously running instance. It is also unlikely that you can get a separate instance of OpenOffice running after quitting GLI. If you wish to do so, you will need to use Task Manager to terminate the open office process launched by the extension upon running GLI.)
    * Before you can use this (or any other Greenstone extension), you will need to quit GLI and GS2-server if either are open and then you will need to relaunch GLI (or run Greenstone scripts) from a fresh command terminal, in order for the extension to become available in the Greenstone environment.    * Before you can use this (or any other Greenstone extension), you will need to quit GLI and GS2-server if either are open and then you will need to relaunch GLI (or run Greenstone scripts) from a fresh command terminal, in order for the extension to become available in the Greenstone environment.
    * With OpenOffice and the extension installed and the Greenstone environment set up for this, Greenstone's Word, PowerPoint and Excel Plugins will have a new option, "-openoffice_conversion", allowing conversion with Open Office instead of the existing converter. Switching on this new option means that more recent Office formats like docx can be included in Greenstone collections and processed by Greenstone.    * With OpenOffice and the extension installed and the Greenstone environment set up for this, Greenstone's Word, PowerPoint and Excel Plugins will have a new option, "-openoffice_conversion", allowing conversion with Open Office instead of the existing converter. Switching on this new option means that more recent Office formats like docx can be included in Greenstone collections and processed by Greenstone.
 ====PDFBox==== ====PDFBox====
   * The PDF Box extension provides support for conversion of PDF documents to text. It supports the latest PDF versions (unlike Greenstone's standard pdftohtml program), so it's useful for collections with new PDF documents.    * The PDF Box extension provides support for conversion of PDF documents to text. It supports the latest PDF versions (unlike Greenstone's standard pdftohtml program), so it's useful for collections with new PDF documents. 
-   * Download the extension [[http://trac.greenstone.org/browser/main/tags/2.86/gs2-extensions/pdf-box/trunk|from here]], which is available in tar.gz and zip formats, and unzip into Greenstone's **ext** folder. The PDF Box extension does not require additional software to be installed. +   * Download the extension [[http://trac.greenstone.org/browser/main/tags/2.87rc1/gs2-extensions/pdf-box/trunk|from here]], which is available in tar.gz and zip formats, and unzip into Greenstone's **ext** folder. The PDF Box extension does not require additional software to be installed. 
    * Before you can use the extension, you will need to quit GLI and GS2-server if either are open and then you will need to relaunch GLI (or run Greenstone scripts) from a fresh command terminal, in order for the extension to become available in the Greenstone environment.    * Before you can use the extension, you will need to quit GLI and GS2-server if either are open and then you will need to relaunch GLI (or run Greenstone scripts) from a fresh command terminal, in order for the extension to become available in the Greenstone environment.
    * PDFBox generates HTML documents from the PDF that may contain more whitespace between lines and paragraphs than you'd wish. In such a case, you can fix this on a per-collection basis using GLI. Open your collection in GLI, go to the Format panel, select Format Features to the left and DocumentText to the right. In the text-area for HTML Format String below, create an HTML style element to set the top and margin bottoms on a paragraph element to 0. You need to escape curly braces with a back slash. In the end your format statement for DocumentText will look like: <br/>    * PDFBox generates HTML documents from the PDF that may contain more whitespace between lines and paragraphs than you'd wish. In such a case, you can fix this on a per-collection basis using GLI. Open your collection in GLI, go to the Format panel, select Format Features to the left and DocumentText to the right. In the text-area for HTML Format String below, create an HTML style element to set the top and margin bottoms on a paragraph element to 0. You need to escape curly braces with a back slash. In the end your format statement for DocumentText will look like: <br/>
Line 462: Line 546:
  
 3. Run the web server and usage.txt should become populated with information. 3. Run the web server and usage.txt should become populated with information.
 +
 +
 ===== Known Issues===== ===== Known Issues=====
  
en/release/2.87_release_notes.1506499284.txt.gz · Last modified: 2017/09/27 08:01 (external edit)