Editing Repository configuration (section)

==ArchiveConfig.pm==
This module imports the other 5 perl modules. It allows lots of little tweaks to the system, which are all commented in the file.

It includes options to hide various features you may not want and to customise the browse, search and subscription functions.

Also you can customise what each type of user can and can't do, and how they authenticate their passwords.

This configuaration file contains perl methods which are called when a session starts and ends, to log things, to generate the entities for the entities file and security on non public files.

===Browse Views===
The browse views are generated by the script "generate_views" and what that script does is configured by the "browse_views" item in the config.

It is a reference to a perl array [], each item of which is a hash {}.

The hash has 3 required properties and a number of optional ones.

; id (required) : The ID of this view - the view will be placed in a subdirectory of /views/ of this name. The ID is also used to identify the full name of this view in the phrase file. <tt> id=>"foo" </tt> would find it's title in the phrase "viewname_eprint_foo"
; fields (required) : The list of the names of the fields to browse, seperated by a slash "/". This should normally be a single field unless you want to merge the values of two fields. The id part of a field may be specified by appending ".id" to the fieldname.
; order (required) : A list of fields to sort by in order of priority, sepearted by slashes "/". A minus sign prefixing the fieldname "-" indicates reverse sorting on that field.
; allow_null : Should we make a page for the "unset" condition? A page for items which do not have a year set may be useful. But for other fields this may be meaningless. Set it to 1 for true.
; include : Generate a file for every value, ending in ".include" which contains the XHTML of the citations of records and the number of records, but without wrapping the site standard template around it.
; nohtml : Normally the system generates a page like that described for "include" with a .html suffix and the site template. If nohtml is set to 1 then it won't.
; citation : Normally the citation used is that for the "type" of eprint. If this is set then that citation (from the citations file) will be used for all items. This allows for some clever stuff if you want to make page which can get sucked into another website.
Normally the system puts a paragraph tag around each citation, but if you use a custom citation this will not happen.
; nocount : Do not include the count of how many items at the top of the page.
; nolink : The system generates an <tt>index.html</tt> in <tt>/view/</tt> with a list of all the browse views available. Setting nolink to 1 will hide this item.
; noindex : Do not generate an <tt>index.html</tt> file in <tt>/view/''foo''/</tt> listing all the values of the view and linking to their respective pages.
; notimestamp (since v2.2) : Do not add the timestamp at the bottom of the view page.
; hideempty (since v2.2) : Only applicable to subjects. This option will supress subjects which do not have any records in. This is useful on "young" archives which look very empty if you have a large subject tree and only a few records, and those clustered in 3 or 4 subjects.

The most common view is to browse by subject:


<code>
 { id=>"subject", allow_null=>0, fields=>"subjects", 
    order=>"title/authors", hideempty=>1 }
</code>
A more complex view generates a view on author & editor ID's which are not advertised but may be captured by some other software to build staff CV pages.


<code>
 { id=>"person", allow_null=>0, fields=>"authors.id/editors.id", 
    nohtml=>1, nolink=>1, noindex=>1, include=>1, 
    order=>"-year/title" }
</code>
For my example person id "wh" this will generate a webpage called /view/person/wh.include (and one for each other value of authors or editors ID's) which can be captured by an external automated system.

===User Privs===
The user permission configuration allows you to set what types of user can and can't do. The user home page will only show a user options which they can do.

New types of user, and which data about themselves they can edit is set in metadata-fields.xml.

Permissions are set by "type" of user. By default there are 3 kinds of user: "user", "editor" and "admin".

Admin can, by default, do everything.

; subscription (since EPrints v2.1) : If included then this kind of user can create subscriptions.
; set-password : Reset their password via the web registration system.
; deposit : Submit items into the archive.
; view-status : View the archive status page.
; editor : User can edit then approve submitted items into the main archive, or delete them, or return them to sender. Also can remove items from the archive back into the edit buffer for corrections, and move records into the deleted table (delete them).
; staff-view : User can perform a "staff search" of user or eprint records and view ALL the metadata.
; edit-subject : User can edit the subject tree via the online interface.
; edit-user : User can edit other users records.
; change-email : User can change their email address via the web interface. This is safer than allowing them to edit it directly as it ensures they cannot set it to an address which they recieve (it mails them a confirmation pin number)
; change-user : This allows the sinister feature which lets you log in as someone else. It still requires a password. This is useful if you want to perform admin tasks as a super user, then log-in as a normal user to deposit items.
; no_edit_own_record (since v2.2) : This supresses the "edit my user record" option. This may be useful if you disable web-registration and import the user records from some other database.