TaxonHub Client. What is Taxon? TaxonHub Client. The Open Source project. suggest-term. admin. Strategy for version numbers

Transcription

1 Table of Contents TaxonHub Client... 2 What is Taxon?... 2 TaxonHub Client... 2 suggest-term... 2 admin... 2 The Open Source project...2 Strategy for version numbers...2 Installing the TaxonHub Client...4 Setting up the TaxonHub Client...4 $api_key... 4 $taxonomy_file... 4 $taxonomy_name... 4 $taxonhub_url... 4 $language... 4 $texts... 5 Test the TaxonHub Client...5 Result of test... 5

2 TaxonHub Client TaxonHub is a repository for taxonomies. You can read more about TaxonHub on What is Taxon? Taxon is an Open Source project to automatically classify a text according to a given taxonomy. The resulting metadata can be used as tags on a web page, as metadata in a record management system, as keys in a mail distribution system and many other places. TaxonHub Client TaxonHub Client enables you to communicate between Taxon on your local system and your TaxonHub account. TaxonHub Client consists of scripts that handle the communication with TaxonHub. As of this version the following scripts are included: suggest-term.php admin.php suggest-term As of version 2.0 Taxon supports the use of an alternative taxonomy. Taxon does not know or care how the alternative taxonomy is created and maintained as long as it is placed correctly. The suggest-term.php displays a web page to the user and captures the suggested term and the corresponding class. The term and class are added to the alternative taxonomy for instant use by Taxon and if you have a TaxonHub account the term and class is sent to your TaxonHub account for later approval. admin Admin.php enables you to download a taxonomy from TaxonHub and install it on your local system with one click. When the taxonomy is downloaded the TaxonHub Client automatically makes a backup. The backups can be restored from the admin page. In order to use the admin page you must have a TaxonHub account and know the TaxonHub API key. The Open Source project Taxon is an Open Source project. It is licensed under GPL 3. Strategy for version numbers The version number of the TaxonHub Client follows the version number of the Taxon system. Major version number 1.x The general idea is to let the major version number reflect the version of the API, so that all versions within 1.x have the same API and should be able to communicate as well as using the taxonomies.

3 Subversion number x.0 The subversion number reflects minor updates, bugs fixes, speed improvement etc. of Taxon. Current version As of 14/ the version is 2.2.

4 Installing the TaxonHub Client Copy the file taxonhub-client-x.y.tar.gz (X.y is the version) to the same directory as Taxon- X.y.tar.gz, usually taxon/. Unpack the file with tar -zxvf taxon-taxonhub-client-x.y.tar.gz Now there is a directory called taxonhub-client/. Either setup your web server to point to the taxonhub-client/ directory or copy the files to another directory (e.g. the Taxon Web Service directory) and point your web server to that directory. Setting up the TaxonHub Client Open the settings/settings.php file in an editor. $api_key If your have an account on TaxonHub you can have TaxonHub Client send the suggestions to your account. Enter the API Key from your TaxonHub Account. $taxonomy_file As of Taxon 2.0 you can place your taxonomy anywhere you want. This setting is the path and filename of you taxonomy. Default is "/usr/share/taxon"; $taxonomy_name The name of the taxonomy without the.json. Default is "test". $taxonhub_url This is the URL for TaxonHub. The only time this should be changed is if you upgrade the version of your TaxonHub account, but then you would proberly be better of downloading the new TaxonHub Client. Default is " $language The language of the user interface. Default is "da" for Danish.

5 $texts $texts is the list of language-dependent texts for the user interface. You can make your own translated text set and set $language to use it. Test the TaxonHub Client Open a browser and enter the URL: You should see a web page with a drop-down list of the classes in your taxonomy. Select a class and enter a term. Click on the send button. Result of test Several things happen when a suggestion is submitted to TaxonHub Client. The user gets a green message saying the suggestion is received. The alternative taxonomy is updated. If not, check the path and file name as well as writing permissions for the alternative taxonomy file. The suggested term and class are sent to the TaxonHub account and is available in the interface. If not, check your API Key and TaxonHub account. That's it! Enjoy Taxon.