This page and the related files are hosted by
|
URLibService User's Guide
Version 2.1
Chapter 3
Customizing the Bibliographic Mirror
by Gerald J. F. Banon
This page and the related files are hosted by
|
|
by Gerald J. F. Banon
Preamble
Customizing the banner space content
Customizing the mirror home page
Customizing the submission forms
Customizing the review process
Implementing links and forms
With URLibService on (see Chapter 1), you can customize any installed Bibliographic Mirrors in an Archive (Digital Repository) of the URLib platform.
A Bibliographic Mirror is a Web interface to a given part of the URLib collection. In a URLibService installation, a default Bibliographic Mirror is created, mirroring the Local Collection. Other Bibliographic Mirrors can also be created mirroring some different parts of the URLib collection.
Each Bibliographic Mirror has its own mirror home page. You can customize the one you are in charge with.
In this chapter, we explain how to customize the mirror home page and the banner space content.
Before to implement any customizing tasks, you should known how to open the URLibService window using the command start (see Chapter 1).
OBSERVATION: When you point to the site URL (ex: http://hostname.domain.name:1905), you will be redirected to the default Bibliographic Mirror (created at installation) through the file </DocumentRoot/mirror/index.html>. If you want to be redirected to another Bibliographic Mirror you may create the file </DocumentRoot/mirror/index2.html> containing another redirection. This file has priority over the default one </DocumentRoot/mirror/index.html>.
The banner space is the area where the URLib banners are displayed.
There are two types of banners. First, the banners which are in the URLib Librarian charge, these banners are usually displayed on the left part of the banner space. Second, the banners which are in the local collection administrator charge. These banners are usually displayed on the right part of the banner space.
As a local collection administrator, you may control part of the banner space. You may post new banners, unpost old ones and define the banner display sequence.
Each banner must be deposited in a URLib repository which Content Type is defined as Banner.
In order to be displayed in the banner space, a banner must be referenced in the so-called banner sequence.
The banner sequence defines which banners must be displayed and in which order. This sequence is defined in a file called <@bannerSequence.tcl> and deposited in a repository which Content Type is defined as Banner Sequence.
To customize the banner space, follow the steps described below.
i. Deposit the document entitled URLib banner sequence contained in the repository <dpi.inpe.br/banon/2000/02.05.09.57> in a new repository by using the URLibService tool Depositing a Document (DD).
ii. Click the Edit Button and update the metadata for this new repository by changing the document title to something like "My banner sequence".
iii. Click the Content Type link in the Check window for this repository and select the Banner Sequence option.
iv. Edit the file <@bannerSequence.tcl> in this repository in order to define the new the banner sequence.
Each Bibliographic Mirror has its own mirror home page. Each of both is subject of a repository. Let <M> be the name of the Bibliographic Mirror repository.
OBSERVATION: If this repository doesn't yet exist, it can be created using the option Add in the Update menu, at the bottom of the Document Update form from an existing Bibliographic Mirror.
To customize the mirror home page, follow the steps described below.
i. Deposit the document entitled Default mirror home page contained in the repository <dpi.inpe.br/banon/2000/01.23.20.24> in a new repository by using the URLibService tool Depositing a Document (DD) with the file <mirrorHomePage.html> selected. To learn how to use this tool, see the FAQ called "Como acrescentar um novo item de informação a partir de um já existente usando a janela do URLibService" pointing to ibi:8JMKD3MGP5W34M/3FU99GE.
Let <A> be the name of the new repository.
ii. Click the Edit Button and update the metadata for the <A> repository by changing the document title to something like "My home page" or "Copy of the default mirror home page".
OBSERVATION: The customization of the Bibliographic Mirror might not include the customization of the default file <mirrorHomePage.html>. One can distinguish three cases:
a/ The customization consists of creating a completely new mirror home page (as an example, point to ibi:83LX3pFwXQZ4dqvktTY/L2Qpi). In this case, execute just Item iii. below;
b/ The customization is limited to the submission forms. In this case, execute first Item iii. below, then OBSERVATION of Item vii, and finally the items of Customizing the submission forms;
c/ The customization doesn't concern the file <mirrorHomePage.html> itself. In this case, execute Item iii. below and then the following ones.
In all the above cases the file <mirrorHomePage.html> must be removed after beeing included in the <A> repository. Hence, in the absence of this file in <A>, the default file <mirrorHomePage.html> in the repository
<dpi.inpe.br/banon/2000/01.23.20.24> is automatically used in its place. In this way, any update of the default file <mirrorHomePage.html> reflects in the customized bibiographic mirror.
The default mirror home page consists of the file <mirrorHomePage.html> with four frames called Form, SimpleForm, Button and About. Once duplicated, these frames may be customized (as an example, point to ibi:83LX3pFwXQZ5Jpy/CxGU3).
iii. Select the Local Bibliographic Mirror Repository
in the URLibService window (its appears in the
S button menu with the identification
key UL::LoBiMi)
and click the Parent Repository
link in the Check window. The Parent Repository
window for this repository will open, then change the line:
<../../../../../../col/dpi.inpe.br/banon/2000/01.23.20.24> (or any other line)
to:
<../../../../../../col/A>
and press the OK Button in this window.
OBSERVATION: The TCL variables set in <doc/displayControl.tcl> are overwitten by the TCL variables set in <auxdoc/displayControl.tcl>. This is a simple way to customize the submission forms: the default part lying in <doc> and the customized part in <auxdoc>.
iv. Deposit the document entitled English version of the default mirror pages contained in the repository <dpi.inpe.br/banon/1999/05.03.22.11> in a new repository by using the URLibService tool Depositing a Document (DD) with the files <enIndex.html>, <mirrorStandard.css>, and the files you are planning to modify (except all the files which are in the <mirror> directory) selected.
Let <B> be the name of the new repository.
OBSERVATION: English is considered the first language for the default mirror pages. If you plan not to use English and want a different first language (for example, Portuguese) then deposit instead the corresponding version of the default mirror pages (for Portuguese, deposit instead the document entitled Portuguese/Brazil version of the default mirror pages contained in the repository <dpi.inpe.br/banon/1999/06.19.22.43>), following the same recommendations as in the English case.
v. Click the Edit Button and update the metadata for the <B> repository by changing the document title to something like "English version of my home page". The Target File must remaind <enIndex.html>.
IMPORTANT: The document folder <B/doc> must NOT contain a file called <mirror/enAbout.tcl>.
OBSERVATION: To customize the background image used in the file <enButton.html>, just deposit the corresponding file <buttonBg.jpg> in the document folder <A/doc>.
vi. Select the <A> repository
in the URLibService window and click the Parent Repository
link in the Check window. The Parent Repository
window for this repository will open, then enter the line:
<../../../../../../col/B>
and press the OK Button in this window.
At this point, we have the following hierarchy (parent being placed upward):
(enAbout.html) <B>
|
(mirrorHomePage.html) <A>
|
(Bibliographic Mirror) <M>
vii. Select the <B> repository
in the URLibService window and click the Parent Repository
link in the Check window. The Parent Repository
window for this repository will open, then enter the line:
<../../../../../../col/dpi.inpe.br/banon/1999/05.03.22.11>
and press the OK Button in this window.
At this point, we have the following hierarchy (parent being placed upward):
(<dpi.inpe.br/banon/1999/05.03.22.11>) <22.11>
|
(enAbout.html) <B>
|
(mirrorHomePage.html) <A>
|
(Bibliographic Mirror) <M>
OBSERVATION: If customizing the mirror home page doesn't imply any change in the English version of the default mirror pages, then repository <B> does not need to be created, but, in this case, the repository <dpi.inpe.br/banon/1999/05.03.22.11> should be defined as a Parent Repository of repository <A>. This leads to a simplified hierarchy (parent being placed upward):
(<dpi.inpe.br/banon/1999/05.03.22.11>) <22.11>
|
(mirrorHomePage.html) <A>
|
(Bibliographic Mirror) <M>
HINT: If you need to access a file, called for example <myFile>, located in <B/doc>, from one of the dynamic files <enAbout.html>, <enButton.html> <enForm.html> and <enSimpleForm.html>, you should use the URL: <http://\$env(SERVER_NAME):\$env(SERVER_PORT)/col/\$languageRep1/doc/myFile>. Or, alternatively, <../../../../../../../col/B/doc/myFile>.
HINT: If you need to access the dynamic file <enAbout.html>, located in <B/doc> from one file located in <B/doc> you should use the URL: <../../../../../../../col/A/doc/mirror.cgi/About?languagebutton=en>.
At this point, by entering your URLib site address in your Web browser, you will see again the default mirror home page. Nevertheless, what you will see is indeed the page to be customized.
If the default mirror home page cannot be not displayed, you should check the target file name of the local bibliographic mirror repository (or of the Bibliographic Mirror repository which is the child of repository <A>) by clicking the Edit Button and scrolling down until the Target File field appears. It must be <mirror.cgi>.
viii. Edit the files in the document folders <A/doc> and <B/doc> to customize the mirror home page. This mirror home page must be in English.
If the mirror home page must appear in more than one language, follow the next steps for each language.
ix. Deposit the document contained in the repository <B> in a new repository by using the URLibService tool Depositing a Document (DD) with all the files selected.
Let <C> be the name of the new repository and let <cc> be the language code (for example, <cc> = <fr> for french) for that repository.
IMPORTANT: The document folder <C/doc> must NOT contain a file called <mirror/ccAbout.tcl>.
x. Click the Edit Button and update the metadata for the <C> repository by changing the document title according to the new language.
xi. Rename the files in the document folder <C/doc> changing the language code prefix <en> into <cc>. Edit these files translating them into the new language.
xii. In the File List of the Check window for the <C> repository, click the file name <ccIndex.html> by using the mouse right button. This file name turns into red indicating that the file <ccIndex.html> is the target file for the <C> repository.
xiii. Click the Parent Repository
link in the Check window for the
<C> repository. The Parent Repository
window for this repository will open, then enter the lines:
<../../../../../../col/B>
<../../../../../../col/D>
and press the OK Button in this window.
Where <D> is the repository name of the default mirror page in the same language as the one planned for the mirror home page in <C>. For example, <D> = <dpi.inpe.br/banon/1999/06.19.22.43> for Portuguese/Brazil (pt-BR). If the desired language doesn't exist, choose the most meaningful among the existing ones in the current version of URLibService.
At this point, we may have the following hierarchy (parent being placed upward):
(<dpi.inpe.br/banon/1999/05.03.22.11>) <22.11>
|
(enAbout.html) <B> <D> (<dpi.inpe.br/banon/1999/06.19.22.43>)
/ \\ /
(mirrorHomePage.html) <A> <C> (pt-BRAbout.html)
|
(Bibliographic Mirror) <M>
OBSERVATION: Optionaly, you may enter a <+> as shown below:
<../../../../../../col/B +>
then you can execute the following optionaly steps.
xiv. (optional) Click the Language link in the Check window for the <C> repository. The Language window for this repository will open, then select the <cc> language and press the OK Button in this window.
xv. (optional) Select the <B> repository in the URLibService window and click the Language link in the Check window. The Language window for this repository will open, then select the <en> language and press the OK Button in this window.
HINT: If you need to access a file, called for example <myFile>, located in <C/doc>, from one of the dynamic files <ccAbout.html>, <ccButton.html>, <ccForm.html> and <ccSimpleForm.html>, you should use the URL: <http://\$env(SERVER_NAME):\$env(SERVER_PORT)/col/\$languageRep1/doc/myFile>. Or, alternatively, <../../../../../../../col/C/doc/myFile>.
HINT: If you need to access the dynamic file <ccAbout.html>, located in <C/doc> from one file located in <C/doc> you should use the URL: <../../../../../../../col/A/doc/mirror.cgi/About?languagebutton=cc>.
Customizing the submission forms may be independent of customizing the mirror home page. It is assumed that the steps i. to iii. of the previous section have been made (the steps iv to xv are optional).
To customize the submission forms, follow the steps described below.
i. Deposit (again) the document entitled Default mirror home page contained in the repository <dpi.inpe.br/banon/2000/01.23.20.24> in a new repository by using the URLibService tool Depositing a Document (DD) with the file <displayControl.tcl> (or <start.html>, in the case of implementing a meta form) selected.
Let <E> be the name of the new repository.
ii. Click the Edit Button and update the metadata for the <E> repository by changing the document title to something like "My submission forms".
iii. Click the Content Type link in the Check window. The Content Type window for this repository will open, then select the option Submission Form and press the OK Button in this window.
iv. Select the <A> repository
in the URLibService window and click the Parent Repository
link in the Check window. The Parent Repository
window for this repository will open, then add the line
<../../../../../../col/E>
and press the OK Button in this window.
At this point, we may have the following hierarchy (parent being placed upward):
<22.11> (<dpi.inpe.br/banon/1999/05.03.22.11>)
|
(displayControl.tcl) <E> <B> <D> (<dpi.inpe.br/banon/1999/06.19.22.43>)
\\ / \\ /
(mirrorHomePage.html) <A> <C> (pt-BRAbout.html)
|
(Bibliographic Mirror) <M>
OBSERVATION: If <displayControl.tcl> exists in the <A> repository, then it is ignored. It is now the <displayControl.tcl> in <E> that is mandatory and can be used for customizing the submission forms.
OBSERVATION: The variables in <doc/displayControl.tcl> are overwitten by the variables in <auxdoc/displayControl.tcl>. This is another and simple way to customize the submission forms: the default part lying in <doc> and the customized part in <auxdoc>.
OBSERVATION: Sometimes it may be usefull to replicate existing submission forms in a new Archive. In this case it is sufficient to import the existing repositories <E>, <F> and <G> in the new Archive. In such situation, the repository hierarchy reduced as shown below (parent being placed upward):
(enFillingInstructions.tcl) <F>
/ \\
(pt-BRFillingInstructions.tcl) <G> <E> <1> (<dpi.inpe.br/banon/1999/05.03.22.11>)
\\ /
(mirrorHomePage.html) <A>
|
(Bibliographic Mirror) <M>
OBSERVATION: If you want to use the meta form to customize dynamically the submission/update form for Conference Proceedings, you need to select the <E> repository in the URLibService window and click the Parent Repository link in the Check window. The Parent Repository window for this repository will open, then enter the line:
<../../../../../../col/iconet.com.br/banon/2006/07.02.02.18>
and press the OK Button in this window. In this way, the Administrator page for customizing the conference submission forms becomes a parent repository for <E> and, the file <displayControl.tcl> (if any) becomes optional in the case you just need to customize the conference submission form. By just entering the above line, an English submission/update form will be produced. In the case of customizing a Bibliographic Mirror to just create a meta form for conference proceedings (as an example, point to urlib:4CR88AP:8JMKD3MGP8W/35J68U8), the repository hierarchy is reduced as shown below (parent being placed upward):
(<iconet.com.br/banon/2006/07.02.02.18>) <02.18> (Administrator page for customizing the conference submission forms)
|
(start.html) <E>
|
(mirror home page) <A>
|
(Bibliographic Mirror) <M>
If you need to customize the language of the submission/update form and its filling instructions, you must proceed implementing the following steps.
v. Deposit (again) the document entitled
English version of the default mirror pages
contained in the repository
<dpi.inpe.br/banon/1999/05.03.22.11>
in a new repository by using the URLibService tool Depositing a Document
(DD) with the files
<mirrorStandard.css> and
<enFillingInstructions.tcl>,
and all the files in the folder
<instructions> that you are planning to modify,
selected.
Optionaly, you may select the files
<enSubmit.html>,
<enSubmitAcknowledgement.html>,
<enUpdateAcknowledgement.html>,
<enUpdateSubmission.html>,
<enRegister.html>,
<enEnterPassword.html>,
<enReview.html>,
<enUserPage.html> and/or
<enAdvancedUserPage.html>
as well.
Let <F> be the name of the new repository.
If you need to access a file, called for example <myFile>, located in <F/doc>, from one of the above files, you can use the URL: <http://\$env(SERVER_NAME):\$env(SERVER_PORT)/col/\$submissionFormLanguageRep/doc/myFile>.
OBSERVATION: You should choose as first language for the submission forms the same first language you have chosen fo the default mirror pages (see previous section).
vi. Click the Edit Button and update the metadata for the <F> repository by changing the document title to something like "English version of my submission forms". The Target File must be <enFillingInstructions.tcl>.
vii Select the <E> repository
in the URLibService window and click the Parent Repository
link in the Check window. The Parent Repository
window for this repository will open, then enter the line:
<../../../../../../col/F>
and press the OK Button in this window.
At this point, we may have the following hierarchy (parent being placed upward):
(enFillingInstructions.tcl) <F> <22.11> (<dpi.inpe.br/banon/1999/05.03.22.11>)
\\ |
(displayControl.tcl) <E> <B> <D> (<dpi.inpe.br/banon/1999/06.19.22.43>)
\\ / \\ /
(mirrorHomePage.html) <A> <C> (pt-BRAbout.html)
|
(Bibliographic Mirror) <M>
At this point, by clicking any submission links in your Web browser, you will see again the submission forms. Nevertheless, what you will see are indeed the forms to be customized.
viii. Edit the files in the document folders <E/doc> and <F/doc> to customize the submission forms. These submission forms must be in English.
If the submission forms must appear in more than one language, follow the next steps for each language.
ix. Deposit the document contained in the repository <F> in a new repository by using the URLibService tool Depositing a Document (DD) with all the files selected (or no file selected).
Let <G> be the name of the new repository and let <cc> be the language code (for example, <cc> = <fr> for french) for that repository.
If you need to access a file, called for example <myFile>, located in <G/doc>, from one of the files in <G> , you can use the URL: <http://\$env(SERVER_NAME):\$env(SERVER_PORT)/col/\$submissionFormLanguageRep/doc/myFile>.
x. Click the Edit Button and update the metadata for the <G> repository by changing the document title according to the new language.
xi. Rename the files in the document folder <G/doc> changing the language code prefix <en> into <cc>. Edit these files translating them into the new language.
xii. In the File List of the Check window for the <G> repository, click the file name <ccSubmit.html> by using the mouse right button. This file name turns into red indicating that the file <ccFillingInstructions.tcl> is the target file for the <G> repository.
xiii. Click the Parent Repository
link in the Check window for the
<G> repository. The Parent Repository
window for this repository will open, then enter the line:
<../../../../../../col/F>
and press the OK Button in this window.
At this point, we may have the following hierarchy (parent being placed upward):
(enFillingInstructions.tcl) <F> <22.11> (<dpi.inpe.br/banon/1999/05.03.22.11>)
/ \\ |
(pt-BRFillingInstructions.tcl) <G> <E> <B> <D> (<dpi.inpe.br/banon/1999/06.19.22.43>)
\\ / \\ /
(mirrorHomePage.html) <A> <C> (pt-BRAbout.html)
|
(Bibliographic Mirror) <M>
The documents of the type 'Conference Proceedings' can be reviewed. To customize the review process, follow the steps described below.
i. Deposit the Empty Document in a new repository by using the URLibService tool Depositing a Document (DD).
Let <H> be the name of the new repository.
ii. Save in the document folder <H/doc> a file called:
<subjectList.html>.
The content of this file must be the following line:
\[\[Load ../../../../../../\$languageRep2/doc/\${language}SubjectList.html fileContent; set fileContent\]\]
iii. Click the Content Type link in the Check window for repository <H> and select the Tcl Page option.
iv. Click the Parent Repository
link in the Check window.
The Parent Repository
window will open, then enter the line:
<../../../../../../col/E>
(where <E> is the submission form
repository that contains the appropriate controlArray.tcl file)
and press the OK Button in this window.
v. Click the User With Write Permission link in the Check window and select the word: <administrator>.
vi. (Optional step) Click the User With Read Permission link in the Check window and select the word: <administrator>.
vii. In the File List of the Check window click the file name <subjectList.html> by using the mouse right button. This file name turns into red indicating that the file <subjectList.html> is the target file.
viii. Customize the conference forms opening the Administrator page for customizing the conference forms within the <E> repository.
ix. Click the Edit Button and update the metadata for the <H> repository by incluing in document title the conference acronym as defined in the Administrator page for customizing the conference forms.
x. Place the lines bellow in the <displayControl.tcl> file within
<E/doc>.
set userNameList(Misc) {\[ReplicateTwice \$userGroup\] \[list {Other Reviewer} {Other Reviewer} {Closed Review} {Closed Review} {Declined Review} {}\]}
set readUserNameList(Misc) {}
if \[info exists userGroup\] {
array set optionTable2 \[list Misc,%@documentstage \[concat \[ReplicateTwice2 \$userGroup\] {{{Send Review} {Closed Review}} {{Other Reviewer => } {Other Reviewer}} {{Decline Review} {Declined Review}}}\]\]
}
Within any Web pages, you can implement links and forms. Some examples are given below. In these examples the server address is <$localSite> and the Bibliographic Mirror repository is <$loBiMiRep>.
Example 1 - Programmed search with result in a new window without a Return Button
Source code
<A HREF=http://$localSite/col/$loBiMiRep/doc/mirrorsearch.cgi?query=ti+urlibservice&continue=yes&targetframe=Customizing+the+Bibliographic+Mirror TARGET="Customizing the Bibliographic Mirror">URLibService References</A>
Resulting line
URLibService References
Example 4 - Search help in a new window without a Return Button
Source code
<A HREF=http://$localSite/col/$loBiMiRep/doc/mirror.cgi/Help TARGET=_blank>Help by Examples</A>
Resulting line
Help by Examples
Example 5 - Search help in this window with a Return Button to this page (at <$localSite>)
Source code
<A HREF=http://$localSite/col/$loBiMiRep/doc/mirror.cgi/Help?returnbutton=yes&returnaddress=http://$localSite/col/iconet.com.br/banon/2001/04.28.19.50/doc/target.html#3>Help by Examples</A>
Resulting line
Help by Examples