Greenstone Wiki - en:developer

buildcol

Anonymous (anonymous@undisclosed.example.com) — 2023-03-13T01:46:31+00:00

Buildcol.pl and classifiers buildcol.pl * process the building args (archivedir, maxdocs etc) and read collect.cfg * create a builder object according to the build type (mg, mgpp or lucene) * call the following methods of a builder according to the mode:

compiling_apache

Anonymous (anonymous@undisclosed.example.com) — 2023-03-13T01:46:31+00:00

Apache HTTPD 2.4.9 seemed to be needed to compile apache httpd natively on 64 bit Windows 7. The following are notes on compiling up the dependencies for Apache httpd 2.4.9, but haven't got Apache Httpd 2.4.9 itself compiling on it yet. But the existing GS2 apache httpd 2.2.x does compile still on 64 bit, for which it needs the Visual Studio environment to be set to 32 bit.

compiling_greenstone2

Anonymous (anonymous@undisclosed.example.com) — 2023-03-19T21:12:34+00:00

Compiling Greenstone2 For the Greenstone 3 version of this page, click Compiling Greenstone3. Unix The "standard" commands of $ ./configure $ make $ make install should (hopefully) be all that is required. If you get complaints about not finding gdbm, use the --

compiling_greenstone3

Anonymous (anonymous@undisclosed.example.com) — 2023-03-19T20:53:53+00:00

Compiling Greenstone3 For the Greenstone2 version, see Compiling Greenstone2. Unix Ubuntu Note: You need java from the sun website, not from the sun-java6-jdk package. Download a jdk binary installer from the sun website to a location like ~/jdk-6u5-linux-i586.bin. Then install java:

creating_a_page

Anonymous (anonymous@undisclosed.example.com) — 2023-03-13T01:46:31+00:00

Creating a Page Extra Metadata When a page is being created, we need to know what metadata to get from the server. This is done by looking through the format statments and xsl files. TransformingReceptionist:configure() calls TransformingReceptionist:getRequiredMetadataNamesFromXSLFiles() - this looks through all the xsl files it can find in the interfaces folder, the site folder (for the current site) and the collect folder (for the current site). It scans these files looking for gsf:metada…

deploying_new_extensions

Anonymous (anonymous@undisclosed.example.com) — 2023-03-13T21:08:03+00:00

Deploying New Extensions for Greenstone3 Overview Deploying extensions is now a relatively simple task in Greenstone, thanks to recent updates to the extension manager system in GAI (The Greenstone Administrator Interface). In order to make your extension available to the world of Greenstone users, you must first edit the

document_basket

Anonymous (anonymous@undisclosed.example.com) — 2023-03-13T01:46:31+00:00

Document Basket Greenstone 3 feature. Only partially developed. To enable this, (from 22 Feb 2022): * set servlet param:

documentbasket

true

eclipse_shortcuts

Anonymous (anonymous@undisclosed.example.com) — 2023-03-13T01:46:31+00:00

Eclipse Shortcuts * Ctrl + leftclick to go to definition, while Alt + left-arrow takes you back to where you were (back button, as in a web browser) * Hightlight something + Ctrl + Alt + h shows all the places in the entire Eclipse workspace where the highlighted construct is used

eclipse

Anonymous (anonymous@undisclosed.example.com) — 2023-03-13T01:46:31+00:00

Eclipse and Greenstone 3 Greenstone 3 can be run as a project inside the [www.eclipse.org Eclipse IDE]. Note: not available for Greenstone 2. In this document, $GS3SRCHOME is the full path to the top-level folder of your Greenstone 3. Wherever you see $GS3SRCHOME on this wiki page, it means you need to replace it with the full path to your top-level Greenstone 3 folder.

incremental_building

Anonymous (anonymous@undisclosed.example.com) — 2023-03-13T01:46:31+00:00

Code Notes about Incremental Building. archiveinf-src.gdb - is a reverse lookup between import file and OID that it gets used for. One file may end up with several oids, eg if its a database file of many records. archiveinf-doc.gdb stores a list of OID's. For each one, it stores the following

index

Anonymous (anonymous@undisclosed.example.com) — 2023-03-19T21:13:28+00:00

Developer Guide This section of the wiki is aimed at 'developers': people that want to modify the code themselves to fix bugs or add new features. It also includes information about compiling Greenstone from source, which may be helpful for users on a non-standard operating system where the binaries don't work.

indexers

Anonymous (anonymous@undisclosed.example.com) — 2023-03-13T01:46:31+00:00

Indexers Three indexing tools are used to index collections in Greenstone. They are MG, MGPP and Lucene. The index is physically located under folder: collect/collect-name/index. MG MG is the original indexer used by Greenstone which is described in the book "Managing Gigabytes". It does section level indexing and compression of the source documents. MG is implemented in C.

install_fedora_gsearch

Anonymous (anonymous@undisclosed.example.com) — 2023-03-13T01:46:31+00:00

Fedora Generic Search Installation Fedora Generic Search (Fedora GSearch) provides full-text indexing and searching for Fedora. This functionality is not offered by Fedora out-of-the-box, which is why it's a good idea to install Fedora GSearch alongside it.

install_svn

Anonymous (anonymous@undisclosed.example.com) — 2023-03-13T01:46:31+00:00

SVN Installation Windows Linux and Mac This covers installing subversion from a source tarball, for client-type uses. This document is based on an install of Subversion-1.4.3.tar.gz, but the install procedure should be similar for other versions as well. This does NOT cover installing Subversion as a server - some other steps are required for that. And it does not cover the procedure for compiling the 'bleeding-edges' version of subversion, which is a little different and more complicated (st…

koha_greenstone_integration

Anonymous (anonymous@undisclosed.example.com) — 2023-03-13T01:46:31+00:00

Koha Greenstone Integration Here are some notes about integrating Greenstone 2.83 with Koha. This enables Koha to link to the Greenstone version of a document if available. And enables Greenstone to download metadata from Koha using OAI for the documents in its collection.

linux_source_install_gs2

Anonymous (anonymous@undisclosed.example.com) — 2023-03-19T21:08:05+00:00

Source Installation on Linux - Greenstone2 NB: These instructions will apply from 7th June 2007 * Step By Step Installing Greenstone 2.82 on Ubuntu 8.10 (Quickstart) Getting Greenstone2 running under linux, using SVN and Apache My sample user is xxx - substitute your username for xxx in the following instructions.

linux_source_install_gs3

Anonymous (anonymous@undisclosed.example.com) — 2023-03-19T21:08:59+00:00

Source Installation on Linux - Greenstone3 This walkthrough is for Linux. But it may have the side-effect of helping Windows users too. Useful links and further information * Install SVN * SVN * Compiling Greenstone3 * Greenstone3-Home Preliminaries: Downloading the necessary utilities (apr, apr-util, SVN, Ant)

mac_source_install

Anonymous (anonymous@undisclosed.example.com) — 2023-03-13T01:46:31+00:00

Source Installation for Mac sp:~/greenstone3 spdegabrielle$ sudo emacs /etc/profile #For Tomcat export JAVA_HOME=/System/Library/Frameworks/JavaVM.framework/Versions/1.5.0/Home export CATALINA_HOME=/usr/local/tomcat export JAVA_OPTS="-Xmx512M -Xms64M -Dfile.encoding=UTF-8"

mssql

Anonymous (anonymous@undisclosed.example.com) — 2023-03-13T01:46:31+00:00

Using MS-SQL as collection database Tested Environment: Windows XP and Windows 2003 Server Tested MS-SQL installation: Microsoft SQL server 2005 Express Tested C++ Compiler: Microsoft Visual C++ 2008 Express Edition Build time setup * Modified files

pharos

Anonymous (anonymous@undisclosed.example.com) — 2023-03-13T01:46:31+00:00

PHAROS Image/Video indexing Instructions for installing PHAROS Image/Video indexing with Greenstone3. Based on GCC 4.4.3 and Ubuntu Linux 10.4 (Lucid Lynx). Initial instructions by Katherine Don, with modifications thanks to Evan Brown and Suzanne Little, Knowledge Media Institute

plugins

Anonymous (anonymous@undisclosed.example.com) — 2023-03-13T01:46:31+00:00

Explaining plugins Plugins are written in the Perl language. They all derive from a basic plugin called BasePlugin, which performs universally-required operations like creating a new Greenstone archive document to work with, assigning an object identifier (OID), and handling the sections in a document. Plugins are kept in the

release_kits

Anonymous (anonymous@undisclosed.example.com) — 2023-03-13T01:46:31+00:00

Release Kits The Greenstone release kits automate the task of creating a releases of Greenstone2, Greenstone3 or the documented example collections. They are basically a collection of ant scripts which encode the process for creating a release, but they also contain the ant-installer software for creating jar installers, wrapper code to turn jar installers into native executables, some custom ant tasks, and some canned resources which go into realeases. They do things like download source code …

seaweed

Anonymous (anonymous@undisclosed.example.com) — 2023-03-13T01:46:31+00:00

Seaweed in Greenstone 3 The Pei Jones project was undertaken over the summer of 2010-2011. While the main goal of this project was to present the digital collection of Images and OCR'd text in Greenstone, a secondary goal was to provide functionality that was not standard in a Greenstone Digital Library; such functionality as live editing of metadata and full text.

svn

Anonymous (anonymous@undisclosed.example.com) — 2023-03-19T21:10:32+00:00

Greenstone Subversion (SVN) Repository The Greenstone source code is kept under version-control in a subversion repository. For information about using SVN see this page, or the subversion book. * Repository Root: * Repository Browser: Repository Structure The basic structure of the repository is

unix_source_install

Anonymous (anonymous@undisclosed.example.com) — 2023-03-13T01:46:31+00:00

Source Installation on Linux (and Mac?) Current instructions You need: * A command-line SVN installed. * JDK: Minimum Java JDK 6.x (may still be used for compiling the nightly linux GS3 binaries) or later. For compiling on 64 bit machines, need the 64 bit version of JDK.

useful_commandline_commands

Anonymous (anonymous@undisclosed.example.com) — 2023-03-19T21:21:57+00:00

Useful Windows Batch Commands Delete all .svn subdirectories (from stackoverflow) " FOR /d /r . %d IN (.svn) DO @IF EXIST "%d" rd /s /q "%d""

using_svn

Anonymous (anonymous@undisclosed.example.com) — 2023-03-13T01:46:31+00:00

Using SVN For notes on installing SVN, read install SVN. Checking out projects You need to know the urls of the components you want to checkout. Then you would do either of the following: svn checkout url svn co url The above will check it all out into a default folder name. For instance:

web_services

Anonymous (anonymous@undisclosed.example.com) — 2023-03-13T01:46:31+00:00

Greenstone 3 Web services and servlets Servlets The standard method of running Greenstone3 is as a Java servlet. There are several different classes of servlets in GS3 -- and you can also create your own -- but the most important is the class for libraries. In Greenstone3, a

windows_source_install

Anonymous (anonymous@undisclosed.example.com) — 2023-03-19T21:17:39+00:00

Source Installation on Windows Current instructions You need: * An SVN client installed, which can be downloaded from . The instructions below assume a command-line SVN client. * Java JDK 6.x or later. For compiling on Windows 64 bit, need the 64 bit version of JDK. For compiling Greenstone 3.06 and onwards, need JDK 7.x or later.