From b03408a5d1031f25c196562c08be0b96235ec666 Mon Sep 17 00:00:00 2001
From: Gregor Gawol <gawol@ub.uni-leipzig.de>
Date: Thu, 19 Mar 2020 11:33:36 +0100
Subject: [PATCH] refs #16538 * complete documentation
---
Readme.md | 47 ++++++++++++++++++++++++++++++++++++++++++++++-
1 file changed, 46 insertions(+), 1 deletion(-)
diff --git a/Readme.md b/Readme.md
index cbbf852..88152bf 100644
--- a/Readme.md
+++ b/Readme.md
@@ -2,22 +2,67 @@
Introduction
------------
+
This module is an Open Source Software of the University Library Leipzig.
The module retrieve the data of [BSZ One Stop Search (BOSS)](https://wiki.bsz-bw.de/doku.php?id=projekte:boss:start).
Installation
------------
+
+**Composer**
+
Packagist Repo [Module for BOSS Webservice](https://packagist.org/packages/finc/boss-module)
To Install use Composer
php composer require finc\boss-module
+**VuFind**
+
+*theme.config.php*
+
+Write to the configuration a *mixins*-statement.
+
+```
+return [
+ [...],
+ 'mixins' => [
+ 'boss'
+ ],
+ [...]
+];
+```
+
+*templates/**file**.phtml*
+
+To display the data when write the following JS-Script in to a PHTML-File
+
+```
+<? $script = <<<JS
+$(document).ready(function() {
+ var recordId = $('.hiddenId').val();
+ var recordSource = $('.hiddenSource').val();
+ $.ajax({
+ dataType: 'json',
+ url: VuFind.path + '/AJAX/JSON?method=getBoss',
+ method: 'GET',
+ data: {id: recordId, source: recordSource}
+ }).done(function(response) {
+ $('.boss-data-false').html(response.data.html);
+ });
+});
+JS;
+?>
+<?=$this->inlineScript(\Zend\View\Helper\HeadScript::SCRIPT, $script, 'SET');?>
+<div class="boss-data"></div>
+```
+
Configuration
-------------
+
You must to create a configuration file in config folder.
- Filename: boss.ini
+**boss.ini**
; Which networks do you want to retrieve data?
[General]
--
GitLab