Date: Thu, 28 Mar 2024 19:07:43 +0100 (CET) Message-ID: <1193215508.5592.1711649263374@gazella.mgmt.psnc> Subject: Exported From Confluence MIME-Version: 1.0 Content-Type: multipart/related; boundary="----=_Part_5591_1872751699.1711649263373" ------=_Part_5591_1872751699.1711649263373 Content-Type: text/html; charset=UTF-8 Content-Transfer-Encoding: quoted-printable Content-Location: file:///C:/exported.html
In this chapter, there are instructions on the c= onfiguration of some mechanisms related to the reader application.
The dLibra system makes it possible to use a cen= tral login system created with the use of the CAS server and the LDAP servi= ce. CAS is available as another identity provider in file dlibra-we= bapp/WEB-INF/conf/user-providers.xml. The following fragment shoul= d be uncommented:
<pl.= psnc.dlibra.web.comp.user.CasUserInformationProvider> <loginPage>http://dlibra.psnc.pl/cas/login?service=3D${prevpage}&= lt;/loginPage> <logoutPage>${homepage}main?action=3DLogoutAction</logoutPage&= gt; <loginPagePosition>2</loginPagePosition> <methodNameResourceKey>uip.cas.name</methodNameResourceKey> <ldapConfiguration>WEB-INF/conf/ldap.properties</ldapConfigura= tion> <userAttributesDefaults> <property name=3D"givenName" value=3D"dLibra"/> <property name=3D"cn" value=3D""/> <property name=3D"mail" value=3D""/> </userAttributesDefaults> <emailAttributeName>mail</emailAttributeName> </pl.psnc.dlibra.web.comp.user.CasUserInformationProvider>
Next, the user should:
Next, the content of file dlibra-webapp/WEB-INF/conf/ldap.proper= ties should be completed. The file contains parameters which make = it possible to use the LDAP service.
The reader application makes it possible to publ= ish various types of messages on the home page. Those news can be added wit= h the use of the administration panel of the reader application or by means= of the mechanism of RSS news import. A sample import process is discussed = below.
In order to import news from an RSS available on= line, the user should uncomment the =E2=80=9Cperiodic-task=E2=80=9D tag con= taining the configuration of the NewsImportTask in the periodic.xml file
<peri= odic-task logicClass=3D"pl.psnc.dlibra.web.comp.periodic.NewsImportTask" =09 executeOnStart=3D"yes"> <description>Checks feed url given in configuration, and imports new= s from that feed.</description> .... </periodic-task>
The configuration of that task consists of the f= ollowing parameters:
by default, that task is carried out once a day;= whenever the reader application detects that a new news item has appeared = in the RSS channel, it will import it within the framework of the nearest p= erformance of that task.
In the reader application of the dLibra system, = bookplates are represented as images with a link to the selected page (libr= ary, institution, etc.) which appear on the page with the description of a = publication (publication, docmetadata). Bookplates are added on th= e basis of the values of particular attributes in metadata. For example, a = bookplate may be displayed depending on the value of the =E2=80=9CPermissio= ns=E2=80=9D attribute =E2=80=93 for the =E2=80=9CLibrary Institution X=E2= =80=9D value, an image which identifies that institution will be displayed,= together with a link to the home page of that institution, =E2=80=9Cww= w.instytucjabibliotecznax.com=E2=80=9D.
A bookplate is added in the following manner:
File webapp/WEB-INF/conf/exNbris.xml contains the f= ollowing entries:
<exli= brises> <attribute rdfname=3D"Rights"> <attribute-value value=3D"Biblioteka Uniwersytecka w Poznaniu"> <exlibris> <img>bu-poznan.png</img> <link>http://lib.amu.edu.pl/</link> </exlibris> </attribute-value> </attribute> </exlibrises>
In the end, the =E2=80=9Cexlibris=E2=80=9D elements are det= ermined in the =E2=80=9Cattribute-value=E2=80=9D element. An =E2= =80=9Cexlibris=E2=80=9D element has to subordinate elements, =E2= =80=9Cimg=E2=80=9D and =E2=80=9Clink=E2=80=9D; the first one is the name of= a graphics file (added in the first step to the /exlibris folder), and the= second one indicates the link to the page to which the user will be redire= cted when the bookplate image has been clicked.
The =E2=80=9Cattribute, =E2=80=9Cattribute-value=E2=80= =9D, and =E2=80=9Cexlibris=E2=80=9D elements can be defined many t= imes, so many bookplates can be added for every determined value of a metad= ata attribute,
For example:
<exli= brises> <attribute rdfname=3D"Rights"> <attribute-value value=3D"Biblioteka Uniwersytecka w Poznaniu"> <exlibris> <img>bu-poznan.png</img> <link>http://lib.amu.edu.pl/</link> </exlibris> </attribute-value> <attribute-value value=3D"BUP"> <exlibris> <img>bu-poznan.png</img> <link>http://lib.amu.edu.pl/</link> </exlibris> </attribute-value> <attribute-value value=3D"Uniwersytet im. A.Mickiewicza i Politechnika= Pozna=C5=84ska"> <exlibris> <img>uam.png</img> <link>http://uam.edu.pl/</link> </exlibris> <exlibris> <img>put.png</img> <link>http://www.put.poznan.pl/</link> </exlibris> </attribute-value> </attribute> </exlibrises>
In that configuration, the =E2=80=9CBiblioteka Uniwersytecka w Poznaniu= =E2=80=9D bookplate will appear for the =E2=80=9CPermissions=E2=80=9D attribute both when it has the =E2=80=9CBiblioteka Uniwersyteck= a w Poznaniu=E2=80=9D value and when it has the =E2=80=9CBUP=E2=80=9D value= . Moreover, if the same =E2=80=9CPermissions=E2=80=9D attr= ibute has the =E2=80=9CUniwersytet A. Mickiewicza i Politechnika Poznanska= =E2=80=9D value, two bookplates (images with links) will be displayed, for = the Adam Mickiewicz University and for the Poznan University of Technology.=
The exlibris.xml configuration will only begin to apply after the servle= t environment of the reader application (Apache Tomcat) has been restarted.= Incorrect settings may cause exceptions and system log errors to appear.= p>
In order to change the default JCR backup creati= on settings in the system, the user should edit the periodic.xml f= ile in the /WEB-INF directory of the reader application. The entry concerni= ng the appropriate periodic task is looks as follows:
<peri= odic-task logicClass=3D"pl.psnc.dlibra.web.comp.periodic.JCRBackupTask" exe= cuteOnStart=3D"yes"> =09=09<expression>0 0 23 * * ?</expression> =09=09<properties> =09=09=09<property> =09=09=09=09<name>jcr.backup.dir</name> =09=09=09=09<value>[backup directory path]</value> =09=09=09=09<description>Path to JCR backup destination directory. Pa= th should end with '/'.</description> =09=09=09</property> =09=09=09<property> =09=09=09=09<name>copies.amount</name> =09=09=09=09<value>[amount of copies]</value> =09=09=09=09<description>Specifies how many different copies of backu= p can be stored at once</description> =09=09=09</property> =09=09</properties> =09=09<description>Task is responsible for backup of JCR stored data&= lt;/description> </periodic-task>
Two parameters can be changed in the task: jcr.b= ackup.dir and copies.amount. By means of the first parameter, the administr= ator indicates the directory in which backups are to be placed. Every singl= e backup copy is an XML file named jcr-backup_[the date of the creation of = the copy].xml, for example, jcr-backup_2010.12.25.08.00.00.xml.
The second parameter determines the maximum number of backup copies. The= periodic task is carried out periodically =E2=80=93 by default, every 24 h= ours. Thus, when the maximum number of copy files has been created, each su= bsequent file overwrites the oldest file from the jcr.backup.dir d= irectory.
The copies.amount can have the following values:=
A change of parameters in periodic tasks require= s a restart of the container (for example, Apache Tomcat), of the reader ap= plication.
Uwaga
When the parameters mentioned above are filled in incorrectly, the task = may function incorrectly, and exceptions can be reported in the logs.
Restoring Data from JCR = Backup Copies
In order to recover data from a backup copy XML = file, it should be placed in an appropriate directory. That directory is co= nfigured in the /WEB-INF/conf/jcr.properties file of the reader ap= plication, at parameter jcr.restore.dir.
A backup copy is automatically restored at a res= tart of the container (for example, Apache Tomcat) of the reader applicatio= n.
Caution! When the data from a backu= p copy file have been recovered, the file is automatically removed.<= /p>
The =E2=80=9Ccontext-param=E2=80=9D parameter from the /WEB-INF/web.xml = file of the reader application is responsible for configuring the thumbnail= s displayed in the reader application. The file looks as follows:
<cont= ext-param> =09=09<description> =09=09=09... =09=09</description> =09=09<param-name>thumbnails.settings</param-name> =09=09<param-value>{ =09=09=09"recommended": {206;232;1.0;false;image/png}, =09=09=09"coll_home_recommended": {206;232;1.0;false;image/png}, =09=09=09"collection_description": {390;400;1.0;false;image/png}, =09=09=09"edition": {242;132;1.0;false;image/png}, =09=09=09"docmetadata": {225;335;1.0;false;image/png}, =09=09=09"result_item": {206;232;1.0;false;image/png}, =09=09=09"example": {200;200;1.0;false;image/png} =09=09}</param-value> </context-param>
The parameter values are entered between the <param-value></param-value> tags. The p=
arameter consists of id_miniatury:zestaw_parametr=C3=B3w=
_miniatury pairs The parameter set consists of four parts w=
hich are separated with the semicolon (;) character, so various thumbnail p=
rofiles can be defined, for example: =E2=80=9Crecomended=E2=80=9D, =E2=80=
=9Ccol_home_recommended=E2=80=9D, or =E2=80=9Ccollection_description=E2=80=
=9D, and we can choose a suitable size of the image. The URL below illustra=
tes the schema of the access to a thumbnail:
https://{domena}/image/{typ_obiektu}/thumbnail:{id_miniatury}/{id}
where:
In the example presented above,= the parameter set for the example thumbnail is: 200, 200,1.0, false, and i= mage/png. The subsequent parts mean:
The first two values determine the dimensions of the output graphics fil= e of the thumbnail for the reader application regardless of the dimensions = of the input graphics file entered in the Editor Application. Thus, if the = graphics file in the Editor Application has been entered in dimensions: wid= th =3D 500 pixels, height =3D 200 pixels, then the image will be appropriat= ely scaled in the reader application, to the dimensions configured in the = =E2=80=9Cthumbnails.settings=E2=80=9D parameter.
That can be useful when the thumbnail files entered by editors are very = detailed, and that degree of detail is not necessary when they are displaye= d in the reader application; moreover,when the dimensions are decreased, th= e memory volume needed for sending them is lowered, which may accelerate th= e speed of the data transfer.
The next parameter is related to the last one, and it is only taken into= account when the thumbnail has the =E2=80=9Cimage/jpeg=E2=80=9D format of = the output graphics file. It makes it possible to further decrease the sent= file, thanks to the lossy compression of the JPEG format. The optimal comp= ression is set with the use of a floating-point number, in the (0,1) range,= for example, 0.1, 0.25, or 0.3.
The next parameter determines the way in which the input image is to be = adjusted to the dimensions of the thumbnail entered in the =E2=80=9Cthu= mbnails.settings=E2=80=9D parameter. When the flag is set to =E2=80=9C= true=E2=80=9D, the original graphics file will be decreased proportionally = and cropped to the area defined by the first two parameters. When the flag = is set to =E2=80=9Cfalse=E2=80=9D, the original graphics file will be adjus= ted to fit in the area defined by the =E2=80=9Cthumbnails.settings<= /strong>=E2=80=9D thumbnail parameters.
The last parameter determines the type of the output graphics file forma= t of the thumbnail. The two most popular formats, JPEG and PNG, are support= ed. When the JPEG format is chosen, the parameter of the degree of compress= ion (described above) is also significant. The formats are identified by MI= ME types. For PNG, it is =E2=80=9Cimagne/png=E2=80=9D and for JPEG =E2=80= =93 =E2=80=9Cimage/jpeg=E2=80=9D.
A change of thumbnail display parameters requires a restart of the conta= iner (for example, Apache Tomcat), of the reader application.
Uwaga!
When incorrect parameters are entered, thumbnail= s may not be displayed, and errors may be reported in the logs.
The basic configuration of the =E2=80=9CRecommended=E2=80=9D component i= s in the /WEB-INF/components.xml file of the reader application.= p>
Here is a sample configuration entry of the component:
<comp= onent name=3D"pl.psnc.dlibra.web.comp.pages.components.RecommendedComponent= "> =09<properties> =09=09<property> =09=09=09<name>RecommendedId</name> =09=09=09<value>&recommendedId;</value> =09=09</property> =09=09<property> =09=09=09<name>RecommendedCount</name> =09=09=09<value>20</value> =09=09</property> =09=09<property> =09=09=09<name>reverseOrder</name> =09=09=09<value>true</value> =09=09</property> =09</properties> </component>
The configuration has two basic parameters:
When it has its default values, the first parameter puts in the value of= the recommendedld entity which is declared at the beginning of the documen= t, in line:
<!ENT= ITY recommendedId "3">
The default value of the entity is =E2=80=9C3=E2= =80=9D, and it points to the ID of the collection which is automatically cr= eated during installation.
From that collection, the publications which are= to be displayed in the component are randomly selected, and only those of = the randomly selected publications are displayed to which a thumbnail is as= signed. When the collection does not contain any publications which fulfill= the abovementioned conditions, the component will not be displayed.
The value of the recommendedld entity is also used in the configuration = of the CollectionsStructureComponent component in the HiddenCollec= tionslds parameter in which the collections which are invisible in the collection tree are defined.
Both the value assigned to the entity and the pa= rameter values can be changed so as to indicate collections chosen by the a= dministrator.
The next parameter, RecommendedCount, is respons= ible for the number of publications to be selected randomly and presented i= n the component. If the component does not find an appropriate number of pu= blications with thumbnails in the collection, it will display those it has = been able to find.
Adding a Component to a = Page
The next step of the configuration of the compon= ent is adding it to a selected page. Pages are defined in the /WEB-INF/page= s.xml configuration file of the reader application. In order to add the com= ponent to the home page, the user should find the declaration of the page (= the <page> tag) named =E2=80=9Cmain=E2=80=9D in the pages.xml documen= t.
The following entry should be made in that decla= ration, between the <components></components> tags (the entry s= hould be already in the file by default):
<comp= onent name=3D"pl.psnc.dlibra.web.comp.pages.components.RecommendedComponent= "> =09<place>main</place> =09<position>4</position> </component>
The configuration and changes in the components.xml and pages.xml files = do not require a restart of the container of the reader application.
This section is about the configuration of the s= elf-archiving mechanism, pubcreator.properties, in the rea= der application.
The first configuration file is /WEB-INF/con= f/pubcreator.properties; it contains the following parameters:
The class.name and main.= files.suggesters parameters are not subject to changes.
The max.file.size parameter allows admi= nistrators to introduce limits of the size of the content files of created = publications. The file size is given in bytes. In this case, value =E2=80= =9C0=E2=80=9D means that the size is not limited.
One important parameter is upload.temp.dir. In that parameter, the administrator determines the path to the tempora= ry file directory. Publication content files are also stored in that direct= ory until they are sent to the server. When the process of creating a publi= cation has finished, the files are automatically removed from the directory= . If a user does not complete the process of creating a publication in his = or her session, the temporary files sent by that user to the reader applica= tion will be removed by the appropriate periodic task. The setting of that parameter is important for th= e correct functioning of the self-archiving mechanism.
The remaining parameters, that is, main.files= .suggesters.use, main.files.suggesters, and default.main.= files.lookup.filter.regexp(x) are for configuring the suggestion optio= ns of the main content file. In the current version of the dLibra system, t= here is a suggestion mechanism based on file names. default.main.files.= lookup.filter.regexp(x), parameters, where x are the subsequent number= s from set N=3D{0,1,...n}, determine the regular expressions which recogniz= e the potential main content files of a publication.
Configuring the Attribute = Form =E2=80=93 pubc-metadata.xml
File /WEB-INF/conf/pubc-metadata.xml is = for configuring the attribute form which appears in the second step of the = publication creator. That file determines, among other things, the number, = type, and order of metadata attributes.
The basic form of the file looks as follows:
<pubc= -metadata> =09<attribute name=3D"title" required=3D"true" pname=3D"true"> =09=09<position>1</position> =09=09<rdf-name>Title</rdf-name> =09</attribute> =09<attribute name=3D"author" required=3D"true"> =09=09<position>2</position> =09=09<rdf-name>Creator</rdf-name> =09</attribute> =09<attribute name=3D"abstract"> =09=09<position>3</position> =09=09<rdf-name>Abstract</rdf-name> =09</attribute> =09<attribute name=3D"subject"> =09=09<position>4</position> =09=09<rdf-name>Subject</rdf-name> =09</attribute> =09<attribute name=3D"date" required=3D"true"> =09=09<position>5</position> =09=09<rdf-name>Date</rdf-name> =09=09<input-type name=3D"DATE"> =09=09</input-type> =09</attribute> =09<attribute name=3D"licence" alias=3D"true"> =09=09<position>6</position> =09=09<rdf-name>Rights</rdf-name> =09</attribute> =09<attribute name=3D"comments" alias=3D"true"> =09=09<position>7</position> =09=09<rdf-name>Description</rdf-name> =09=09<multiple>false</multiple> =09=09<input-type name=3D"TEXTAREA"/> =09</attribute> </pubc-metadata>
The main element of the XML structure is pubc= -metadata which contains attribute elements which represent fields in = the form. Every attribute element has its own set of elements and attribute= s.
The attribute elements are:
The subordinate elements of the attribute element are:
The =E2=80=9Cname=E2=80=9D attribute of the =E2= =80=9Cattribute=E2=80=9D element must be unique for every defined field. Th= e administrator can use that attribute in correlation with the =E2=80=9Cali= as=E2=80=9D attribute set to the =E2=80=9Ctrue=E2=80=9D value because by de= fault the name of a field is taken directly from the name of the dLibra met= adata attribute indicated with the =E2=80=9Crdf-name=E2=80=9D element (see = above); in this case, however, the user can set his or her own name for the= filed in the label files of the =E2=80=9CPub licationUploadComponent=E2=80= =9D file. Such a label begins with the =E2=80=9CPublicationUploadComp= onent=E2=80=9D prefix and ends with the name determined in the attribute, f= or example, =E2=80=9CPublicationUploadComponent.title=E2=80=9D.
For more information about labels, see here.
The =E2=80=9Crequired=E2=80=9D attribute= determines whether the field must be filled in in order for the publicatio= n to be accepted. When the user does not enter any value in that field, an = appropriate message will be displayed in the creator. The =E2=80=9Cpnam= e=E2=80=9D attribute determines whether the data taken from the field = will play the role of the name of the publication; a field marked in this w= ay with the attribute should be a required field. If there is no field with= the =E2=80=9Cpname=E2=80=9D attribute set to the =E2=80=9Ctrue=E2=80=9D va= lue, the name of the created publication will be taken from the first requi= red field.
Uwaga
If no field in the form is defined as the publication name field and no = field in the form is marked as required, every attempt at creating the publ= ication will end with an error in the reader application.
The first important subordinate element of the = =E2=80=9Cattribute=E2=80=9D element is =E2=80=9Crdf-name=E2=80=9D. It combi= nes the indicated field of the form with an attribute in the metadata schem= a of the digital library. All values entered in the field are associated wi= th a specific metadata attribute through the RDF name of the attribute. Sam= ple RDF names are: =E2=80=9CTitle=E2=80=9D, =E2=80=9CCreator=E2=80=9D, =E2= =80=9CAbstract=E2=80=9D.
Uwaga
In order for the form to function correctly, a specific metadata schema = attribute must be assigned to every defined field of the form.
The =E2=80=9Cposition=E2=80=9D subordinate element determines the positi= on of the field on the list of form fields. The two additional subordinate = elements, =E2=80=9Cmultiple=E2=80=9D and =E2=80=9Cinput-type=E2=80=9D, are = not required. The first one determines if many values can be added to the f= ield (the default value of that element is =E2=80=9Ctrue=E2=80=9D), and the= second one determines the type of the field. There are three types to choo= se from: TEXT (standard text field), TEXTAREA (big text field), and DATE (d= ate checkbox); they are entered in the =E2=80=9Cname=E2=80=9D attribute of = the element. By default, the TEXT type is selected for every field.
For example:
<inpu= t-type name=3D"DATE"> </input-type>
If a DATE-type field is defined, the following su= bordinate elements can be placed between the <input-type ...></inp= ut-type> tags:
Here is a sample configuration of the date field:
<inpu= t-type name=3D"DATE"> <startYear>1990</startYear> <endYear>2010</endYear> <separator>:</separator> </input-type>
The last issue worth noting is the management of controlled metadata att= ributes. The fields which refer to controlled attributes in the RDF name ar= e presented as expandable lists from which the user can choose one of the p= roposed items. Attributes are set as controlled in the Administrator Applic= ation. For more information about that subject, see here
Entering any changes in the pubcreator.properties or pubc-m= etadata.xml file requires a restart of the container of the reader app= lication.
Configuring the Rules
Before adding a publication, every user must accept the Rules, the conte= nt of which can be adjusted to the needs of the digital library. The conten= t of the =E2=80=9CRules=E2=80=9D is located on the =E2=80=9Cregulations=E2= =80=9D help page and can be changed in the administration panel of the read= er application.
The Rules can also be completely disabled in the publication creator, by= adding an entry concerning the =E2=80=9CPublicationUploadComponent=E2=80=9D in the =E2=80=9Ccomponents.xml=E2=80=9D file.
<comp= onent name=3D"pl.psnc.dlibra.web.comp.pages.components.PublicationUploadCom= ponent"> =09=09<properties> =09=09=09<property> =09=09=09=09<name>regulationsAcceptRequired</name> =09=09=09=09<value>false</value> =09=09=09</property> =09=09</properties> </component>
A change of the =E2=80=9Ccomponents.xml=E2=80=9D does not require a rest= art of the container of the reader application.
Other Configuration Stages=
In order for the self-archiving functionality to operate correctly, ther= e must be appropriate settings in the dLibra server. The configuration of t= he self-archiving functionality can be checked here.
The basic parameters of the action of adding public tags are configurabl= e. To configure them, the user should open the action configuration file, /= WEB-INF /actions.xml. It contains the following entry:
&= lt;action name=3D"pl.psnc.dlibra.web.comp.pages.actions.AddBookmarkTagActio= n"> =09=09<properties> =09=09=09<property> =09=09=09=09<name>accept.all.tags</name> =09=09=09=09<value>false</value> =09=09=09</property> =09=09=09<property> =09=09=09=09<name>max.tag.length</name> =09=09=09=09<value>100</value> =09=09=09</property> =09=09=09<property> =09=09=09=09<name>min.tag.length</name> =09=09=09=09<value>3</value> =09=09=09</property> =09=09</properties> =09</action>
In the public tag moderation process, they are ke= pt for a period of time in which the moderator can set their status to the = =E2=80=9Caccepted=E2=80=9D or =E2=80=9Cunaccepted=E2=80=9D value. Only acce= pted public tags are added to the =E2=80=9CTag=E2=80=9D attribute of the se= lected publication. The =E2=80=9Caccept.all.tags=E2=80=9D parameter d= etermines whether the sent proposal of a public tag is to be automatically = set as =E2=80=9Caccepted=E2=80=9D, which status can be changed by the moder= ator. By default, the =E2=80=9Caccept.all.tags=E2=80=9D parameter has= the =E2=80=9Cfalse=E2=80=9D value, which means that the added public tags = are =E2=80=9Cunaccepted=E2=80=9D by default.
The two following parameter= s determine the minimum (=E2=80=9Cmin.tag.length=E2=80=9D) and maximum (=E2= =80=9Cmax.tag.length=E2=80=9D) number of characters for a public tag. If a = tag is not within the limit, it is not added to the proposal of key words. = Setting the value of any of those parameters to =E2=80=9C0=E2=80=9D will ca= use the parameter to not be taken into account when checking the number of = tag characters.=20The described configuration allows the user to de= termine the protection in the PDF document displayed by the reader applicat= ion with greater precision. In order to begin modifying the parameters for = protecting PDF files, the user should display the =E2=80=9Csettings.xml=E2= =80=9D file from the /WEB-INF/formats/pdf for edition.
The file should contain the following entries:
<prop= erties> <!-- In case of any problems with securing PDF files you may try to use alterna= tive format writer based on iText. --> <!-- <entry key=3D"secured.format.writer.class">pl.psnc.dlibra.web.comp.f= ormats.writers.ItextSecuredPdfFormatWriter</entry> --> <entry key=3D"secured.format.writer.class">pl.psnc.dlibra.web.comp.fo= rmats.writers.SecuredPdfFormatWriter</entry> <entry key=3D"handler.id">pdf:secured</entry> <entry key=3D"handled.mime.types">application/pdf</entry> <entry key=3D"handles.secured">true</entry> <entry key=3D"handles.normal">false</entry> <entry key=3D"owner.pass"></entry> <entry key=3D"user.pass"></entry> <entry key=3D"print.degraded">true</entry> <entry key=3D"print">false</entry> <entry key=3D"modify.annotations">false</entry> <entry key=3D"fill.in.form">false</entry> <entry key=3D"extract.for.accessibility">false</entry> <entry key=3D"assemble.document">false</entry> <entry key=3D"extract.content">false</entry> </properties>
The basic parameters are =E2=80=9Cowner.pass=E2=80=9D a= nd =E2=80=9Cuser.pass=E2=80=9D. They determine, respective= ly: the password of the owner of the PDF document and the password of the u= ser of the PDF document. The user password allows document browsing, and th= e owner=E2=80=99s password is needed for introducing changes in those docum= ents which allow that.
As regards the remaining parameters, there are (with the omission of the= general parameters of the configuration of the display mechanism):
All the parameters from the list have boolean-type values (=E2=80=9Ctrue= =E2=80=9D or =E2=80=9Cfalse=E2=80=9D)
If the PDF protection does not produce the expected results, an alternat= ive mechanism of generating protected PDFs can be used, by entering value = =E2=80=9Cpl.psnc.dlibra.web.comp.formats.writers.ItextSecuredPdfFormatW= riter=E2=80=9D (in the XML comment) in the =E2=80=9Csecured.fo= rmat.writer.class=E2=80=9D parameter, instead of the default =E2= =80=9Cpl.psnc.dlibra.web.comp.formats.writers.SecuredPdfFormatWriter=E2=80=9D value.
A change of those parameters requires a restart of the container (Apache= Tomcat) of the reader application.
Since version 5.0 of the dLibra system, administrators can indicating an= y collection from the collections in the digital library to be the main col= lection, and they can connect many reader applications to = one dLibra server. In order to configure the main collection for a read= er application, the /WEB-iNF/web.xmi file must be opened for edition. It co= ntains the following entry (by default, in the XML comment):
<cont= ext-param> =09<description> =09=09Configurable main dLibra collection id =09</description> =09<param-name>main.collection.id</param-name> =09<param-value>[id of collection]</param-value> </context-param>
The entry should be =E2=80=9Cuncommented=E2=80=9D, and the =E2=80=9C[id = of collection]=E2=80=9D should be replaced with the numerical ID of the col= lection (the unique ID set in the collection database). In the end, the ser= vlet environment (for example, Tomcat) should be restarted.
In order to change the default contact values in = the form, the user should open the =E2=80=9CWEBAPP_en.xml=E2=80=9D (for Eng= lish) and =E2=80=9CWEBAPP_ pl.xml=E2=80=9D (for Polish) from the =E2=80=9C/= WEB-INF/components/resources=E2=80=9D directory for edition. The files may = contain the following entries:
<entr= y key=3D"ContactComponent.Name">Instytucja partnerska BC</entry> <entry key=3D"ContactComponent.Address">ul. Nieznana 16, 61-895 Pozna= =C5=84, POLSKA</entry> <entry key=3D"ContactComponent.URL">http://institution.com/</entry= > <entry key=3D"ContactComponent.Mail">mail@institution.com</entry&g= t; <entry key=3D"ContactComponent.Phone">telefon: (+48) 61-333-33-32, fa= ks: (+48) 61-333-33-33</entry>
Particular values for the XML elements correspond to the values from the= form. The changes in those files do not require a restart of the servlet c= ontainer.
As regards the contact form, one should also remember about the email ad= dress to which the messages entered by the user are sent. That address can = be configured in the =E2=80=9C/WEB-INF/actions.xml=E2=80=9D file, by changi= ng the value for the declared =E2=80=9CSendMailActiorr=E2=80=9D action.
<acti= on name=3D"pl.psnc.dlibra.web.comp.pages.actions.SendMailAction"> =09<properties> =09=09<property> =09=09=09<name>to.web.mail</name> =09=09 =09<value>[adresy mail, na ktory maja byc wysylane zgloszeni= a]</value> =09=09</property> =09=09 ... =09</properties> </action>
Any number of semicolon- or comma-separated email= addresses can be placed between the =E2=80=9Cvalue=E2=80=9D tags.
Watermarks are displayed for protected JP= G presentations (a special publication tag in the dLibra system, w= hich is created by indicating the directory with JPG files as the main file= ). It is done with the use of a special Java applet.
A watermark is an image which is put over the con= tent of a presentation, with the effect of opacity. We recommend the use of= a graphics file in the PNG format which makes it possible to save an image= with a transparent background. Such an image is also enlarged to take as m= uch space as possible. However, it is centered and not spread to the propor= tions of the main image. One can also obtain the effect of a watermark smal= ler than the main image, by adding a transparent border of selected width i= n the watermark graphic.
Apart from an image, the name of the logged in us= er can also be automatically put in a watermark. Watermark configurat= ion is located in the =E2=80=9CWEB-INF/web.xml file=E2=80= =9D, in the section about the =E2=80=9CwatermarkServlet=E2= =80=9D servlet. The following parameters can be defined there:
image.path
=E2=80=9D =E2=80=93 the path to t=
he image which is to be displayed as the watermark;opacity
=E2=80=9D =E2=80=93the strength of t=
he opacity effect; it must be a number from the (0,1) range; for value 0, t=
he image is invisible, completely transparent, and for value 1, it complete=
ly covers the content;text.userName.position
=E2=80=9D =E2=80=93 the pos=
ition indicates the upper left-hand corner of the rectangle in which the na=
me of the user will be placed; the position is entered as coordinates in th=
e watermark image, where the 0,0 point is the upper left-hand corner of the=
image;text.userName.size
=E2=80=9D =E2=80=93 the size of=
the rectangle in which the name of the user will be entered, also in relat=
ion to the size of the watermark; if the size of the font is not defined, t=
hen the size which will make it possible to fit in the name in the rectangl=
e will be automatically set;text.userName.align
=E2=80=9D =E2=80=93 the positi=
on of the name of the user in the defined rectangle; possible values: left,=
center, and right;"text.userName.wordwrap"
=E2=80=93 makes text wrapping pos=
sibel when the username is long;text.userName.font
=E2=80=9D =E2=80=93 the font of=
the username; the font availability depends on what fonts are installed on=
the user=E2=80=99s computer; usually, however, Arial, Courier New, Monospa=
ced, Verdana, and Tahoma fonts are available;text.userName.font.style
=E2=80=9D =E2=80=93 makes=
it possible to enable bold and italic type in the username;text.userName.font.color
=E2=80=9D - =E2=80=
=93 the color of the username, in the hexadecimal format; andtext.userName.font.size
=E2=80=9D =E2=80=93 the fo=
nt size; if it is not defined, the maximum size which allows the whole name=
to fit in will be chosen.The site map is a protocol which makes it easier for indexing bots to co= llect information about the most important pages in the reader application.= Within the framework of the =E2=80=9CSitemapGeneratingTask=E2=80=9D periodic task, the reader application generates absolute URLs to= those pages and saves them in accordance with the following assumptions:= p>
In order to change the default page map generatio= n settings in the system, the user should edit the =E2=80=9Cperiodic.xml=E2= =80=9D file in the =E2=80=9C/WEB-INF=E2=80=9D directory of the reader appli= cation. The entry concerning the appropriate periodic task is looks as foll= ows:
=09<p= eriodic-task logicClass=3D"pl.psnc.dlibra.web.comp.periodic.SitemapGenerati= ngTask" =09=09 executeOnStart=3D"yes" > =09=09<description>Generates sitemap.</description> =09=09<expression>0 0 0 1/10 * ?</expression> =09=09<properties> =09=09=09<property> =09=09=09=09<name>urlParams</name> =09=09=09=09<value>Title;Creator</value> =09=09=09</property> =09=09=09<property> =09=09=09=09<name>overwriteRobotsFile</name> =09=09=09=09<value>true</value> =09=09=09</property> =09=09</properties> =09</periodic-task>
In the task, you can set the values of the follow= ing parameters:
Linking publications make it possible to enter, i=
n a digital library, the information about an object which is made availabl=
e by another website. In the default configuration, when the user wants to =
see the content of such a publication, the user will first see a notice the=
information about the external content and the target link which has to be=
called. If we want the user to be redirected to the target address without=
having the notice displayed, we should add the configuration presented bel=
ow to the =E2=80=9CWEB-INF/components.xml
=E2=80=9D:
<= ;component name=3D"pl.psnc.dlibra.web.comp.pages.components.ContentBrowserC= omponent"> <properties> <property> <name>linkedPublication</name> <value>redirect</value> </property> </properties> </component>