NAME

koha-cloud - Creates HTML keywords clouds from Koha Zebra Indexes

VERSION

version 0.051

USAGE

koha-cloud [--verbose|--help] --conf=cloud.conf

Creates multiple HTML files containing kewords cloud with top terms sorted by their logarithmic weight. cloud.conf is a YAML configuration file driving cloud generation process.

PARAMETERS

--conf=configuration file

Specify configuration file name

--verbose|-v

Enable script verbose mode.

--help|-h

Print this help page.

CONFIGURATION

Configuration file looks like that:

--- 
 # Koha configuration file for a specific installation
 # If not present, defaults to KOHA_CONF
 KohaConf: /home/koha/mylibray/etc/koha-conf.xml
 # Zebra index to scan
 ZebraIndex: Author
 # Koha index used to link found kewords with an opac search URL
 KohaIndex: au
 # Number of top keyword to use for the cloud
 Count: 50
 # Include CSS style directives with the cloud
 # This could be used as a model and then CSS directives are
 # put in the appropriate CSS file directly.
 Withcss: Yes
 # HTML file where to output the cloud
 Output: /home/koha/mylibrary/koharoot/koha-tmpl/cloud-author.html
--- 
 KohaConf: /home/koha/yourlibray/etc/koha-conf.xml
 ZebraIndex: Subject
 KohaIndex: su
 Count: 200
 Withcss: no
 Output: /home/koha/yourlibrary/koharoot/koha-tmpl/cloud-subject.html

IMPROVEMENTS

Generated top terms have more informations than those outputted from the time beeing. Some parameters could be easily added to improve this script:

WithCount

In order to output terms with the number of occurences they have been found in Koha Catalogue by Zebra.

CloudLevels

Number of levels in the cloud. Now 24 levels are hardcoded.

Weithing

Weighting method used to distribute terms in the cloud. We could have two values: Logarithmic and Linear. Now it's Logarithmic by default.

Order

Now terms are outputted in the lexical order. They could be sorted by their weight.

AUTHOR

Frédéric Demians <f.demians@tamil.fr>

COPYRIGHT AND LICENSE

This software is Copyright (c) 2017 by Fréderic Démians.

This is free software, licensed under:

The GNU General Public License, Version 3, June 2007