Adding a new Ref collection

Contents


1. Creating the necessary directories
    1.1 Creating main directories on UNIX
    1.2 Creating main directories on WINDOWS
2. Populating the directories with the required/desired files
    2.1 The Collection configuration file
    2.2 Access control to checkin on UNIX
    2.3 Access control to checkin on WINDOWS
3. Making the new collection visible in the index pages
    3.1 Update collections.xml
    3.2 Update collections.ssi
4. Customising the New Collection


1. Creating the necessary directories

The following sections describe, separately for a UNIX and WINDOWS ref-collection, the required direcrories that have to be created when adding a new collection.


1.1 Creating main directories on UNIX

Create the base directory for the collection, which will hold all the files/documents and sub-directories:

/afs/cern.ch/project/support/ref/CollectionName
/afs/cern.ch/project/support/ref/CollectionName/cfg

Where Collection name is the name of the collection (can have several levels, e.g. CERN/IT/GLM )

Modify the AFS ACLs to grant write permission to the acount of the webserver that is handling the ref-website, i.e 'wcncron' presently:

fs sa . wcncron write

Create the necessary sub/directory in the bin directory which will hold the protected link to the checkin program

/afs/cern.ch/project/support/ref/bin/CollectionName

Inside this directory make a relative link to checkin file in the directory /afs/cern.ch/project/support/ref/bin/ below (or above depending on you mental model of the filesystem)

ln -s ../../../checkin

1.2 Creating main directories on WINDOWS

Create the base folder for the collection, which will hold all the files/documents and sub-folders:

Access via the file system:

NB: The following procedure you might want to do in any case since the security settings can only be influenced to an satisfactory granularity using the File-System and not FrontPage

Right click on "My Computer" on the desktop and select Map Network Drive...". Select a free drive letter, e.g. N then select "Microsoft Windows Network". Double click CERN, look for WEB3 in the list, double click on it and double click on the directory ref1.

Accessing with Frontpage 98:

Start->1-Applications->FrontPage_Explorer, then File->Open_Front_Page_Web and click on More_Webs. Make sure that "Open an existing Frontpage Web" is selected and type in the corresponding field: ref1.web.cern.ch.web. You will be asked for Name/Password where you type your normal NICE/NOVELL login/password. "Map Network Drive...". Select a free drive letter, e.g. N then select "Microsoft Windows Network". Double click CERN, look for WEB3 in the list, double click on it and double click on the directory ref1.

Create the collection folder:

\\WEB3\ref1\CERN\CollectionName
\\WEB3\ref1\CERN\CollectionName\cfg

Where Collection name is the name of the collection (can have several levels, e.g. CERN\IT\GLM )

Modify the permissions of this newly created folder such as that those people meant to handle the collection have write access to this directory. Use the access via the file-system described above

Create the necessary sub-folder in the bin directory

\\WEB3\ref1\bin\CERN\CollectionName
Most likely you would like to restrict access to the checkin mechanism. Do it now ! Have a look at 2.3 Access control to checkin on WINDOWS, before copying the checkin program into the directory !

Inside this folder create a copy of the checkin file from the directory /afs/cern.ch/project/support/ref/bin/ below (or above depending on you mental model of the filesystem). You can do this by right clicking on the master checkin file and drag&drop, you will be asked if you want to copy or move the file, select copy !


2. Populating the directories with the required/desired files

The following will give you some instructions on the files required for the checkin mechanism to work properly with the new collection


2.1 The Collection configuration file

There is one file required to checkin/modify documents of new collection, the configuration file of the collection:

/afs/cern.ch/project/support/ref/bin/CollectionName/cfg/CollectionNameHyphen.cfg
e.g.
/afs/cern.ch/project/support/ref/bin/CERN/IT/US/cfg/CERN-IT-US.cfg

Most likely you will want to customise the collections appearance, like the docuemnt descriptors, the templates for the various automatically created HTML files, the notification messages etc. For the description of these paramters/files please refer to the document "Configuration Parameters for Document Collections"

.

2.2 Access control to checkin on UNIX

To restrict access to the checkin mechanism on UNIX, the recommended way is to create a htaccess and a htpasswd files named e.g. "CERN-IT-GLM.htaccess.admin" and "CERN-IT-GLM.htpasswd.admin" in the directory /afs/cern.ch/project/support/ref/CollectionName/cfg. Then create a symbolic link inside the bin directory of the collection, e.g. /afs/cern.ch/project/support/ref/bin/CollectionName to the file "CERN-IT-GLM.htaccess.admin".


2.3 Access control to checkin on WINDOWS

The restrict access to the checkin Script, use the Windows File-Explorer and select the directory \\WEB3\ref1\bin\CERN\CollectionName with the right mouse button and select Properties. In the properties panel select the Security tab and click on the Permissions button. You will get a list of the permissions presently applicable, please modify it as wanted.


3. Making the new collection visible in the index pages

To make the collections accessible via normal browsing and also for using the document de-referencer to enable abbreviated versions of document references such as http://cern.ch/it-us-2000, the following files have to been updated.


3.1 Update collections.xml

To make the scripts register and the document de-referencer aware of a new collection the follwing file has to be updated:

/afs/cern.ch/project/support/ref/cfg/collections.xml

This XML-file has to contain a block similar to the one below for each docuemnt collection, using the following syntax:

  <collection>     
  <name>CERN/Tutorial</name>
  <extension>topic</extension>
  <title>Informatics Tutorial by Topic</title>
  <pattern>(cern)(-|/)(tutorial)</pattern>
  <url></url>
</collection>
name
the name of the collection, e.g. CERN/IT/US

extension
the name-extension of the collection for shared collections, a configuration file with the name CollectionName-extension.cfg has to be in the configuration directory. The bin directory has to contain a sub-directory CollectionName/extension/ containing a link to 'checkin'

title
One line description of the collection. Used in the collection selection list for registration

pattern
Regular expression pattern for the document De-Referencer (short spelling of documents). Used to match the document references, for a normal collection with YYYY-NNN structure this would be e.g.

    (cern)(-|/)(it)(-|/)(us)(-|/)(\d{4})(-|/)(\d{3})

This has only to be specified if the actual document contains files with dashes in their name, e.g. to make http://cern.ch/ref/cnl-2000-001/alice-data work properly.

url
to be specified if the collection is not residing on ref, e.g. for collections located at http://cern.ch/ref1 use http://cern.ch/ref1

3.2 Update collections.ssi

You also have to add an entry for the new collection in the collection list insert of the main page ( and if appropriate also the hirachy down ) namely:

The List of collections visible on Ref:

UNIX: /afs/cern.ch/project/support/ref/ssi/collections.ssi
WIN: \\WEB3\ref1\ssi\collections.ssi

This file is included by the index.html file below:

UNIX: /afs/cern.ch/project/support/ref/CERN/index.shtml
WIN: \\WEB3\ref1\ssi\collections.ssi

4. Customising the new collection

For Administrators of a collection there are various paramters template.files via which they can customise the behaviour and appearance of the collection. The instructions how to do this can be found elsewhere, e.g:

"Configuration Parameters for Document Collections"
"Automatic creation of Indexes for document sets"