[OPEN-ILS-DOCUMENTATION] Czech added content Perl module - documentation

[Linda Jansova]

Hi,

We have prepared a piece of documentation describing how added content 
provided by Obalkyknih.cz (Czech added content provider) can be enabled 
in Evergreen from version 2.12 onwards (provided that our Perl module 
and proposed changes to templates submitted to Git - 
http://git.evergreen-ils.org/?p=working/Evergreen.git;a=shortlog;h=refs/heads/user/jkotrla/lp1624366-added_content_obalkyknih 
- are accepted).

The text is included in the attached file - I have tried my best to make 
it as much AsciiDoc as possible (not sure whether it is entirely 
correct, though).

It should be added to documentation describing how external content can 
be included in Evergreen OPAC. At this moment, the latest version of 
this documentation is available at 
http://docs.evergreen-ils.org/2.11/_including_external_content_in_your_public_interface.html; 
however, as we hope that our module and changes to template files will 
be included in 2.12, the URL will then probably look more like 
http://docs.evergreen-ils.org/2.12/_including_external_content_in_your_public_interface.html.

It would make sense to us if our text was included somewhere after 
Content Cafe or NoveList paragraphs.

Thank you in advance for making our piece a part of the Evergreen 
documentation!

Linda

PS: Of course, should there be some additional questions regarding our 
text, I will be more than happy to answer them.


-------------- next part --------------
Obalkyknih.cz
^^^^^^^
Setting up Obalkyknih.cz account
+++++++
If your library wishes to use added content provided by Obalkyknih.cz, a service based in the Czech Republic, you have to http://obalkyknih.cz/signup[create an Obalkyknih.cz account]. Please note that the interface is only available in Czech. After logging in your Obalkyknih.cz account, you have to add your IP address and Evergreen server address to your account settings. (In case each library uses an address of its own, all of these addresses have to be added.) 
Enabling Obalkyknih.cz in Evergreen
+++++++
Set obalkyknih_cz.enabled to true in '/openils/var/templates/opac/parts/config.tt2':
[source,perl]
obalkyknih_cz.enabled = 'true';
Enable added content from Obalkyknih.cz in '/openils/conf/opensrf.xml' configuration file (and – at the same time – disable added content from Open Library, i.e., Evergreen's default added content provider):
[source,xml]
<!-- <module>OpenILS::WWW::AddedContent::OpenLibrary</module> -->
[source,xml]
<module>OpenILS::WWW::AddedContent::ObalkyKnih</module>
Using default settings for Obalkyknih.cz means all types of added content from Obalkyknih.cz are visible in your online catalog. If the module is enabled, book covers are always displayed. Other types of added content (summaries, ratings or tables of contents) can be: 
* switched off using _false_ option,
* switched on again using _true_ option.
The following types of added content are used: 
* summary (or annotation)
* tocPDF (table of contents available as image)
* tocText (table of contents available as text)
* review (user reviews)
An example of how to switch off summaries: 
[source,xml]
<summary>false</summary>