Customizing Pawtucket - Basic application configuration

From CollectiveAccess Documentation
Jump to: navigation, search

Modifying Pawtucket to meet your needs begins with setting up the application configuration file in app/conf/app.conf. Keep in mind there is a conf directory within each theme whose files override those in app/conf. The app.conf file in your theme's conf directory does not have to be a complete file, it can contain only the setting you would like to override. For a detailed explanation of the variables in app.conf click here. For more information on customizing Pawtucket click here. The following is a list of variables you should consider changing to establish the basic functionality of your site:

Formatting

theme By default, Pawtucket uses the theme "default". If you decide to create your own theme, copy the "default" folder in the themes directory and enter the name of your new theme here.
html_page_title Enter the HTML title of the page, which appears at the top of the browser window.
header_img To replace the CollectiveAccess logo in the header of the site, upload the replacement graphic to the graphics folder in your theme directory and enter the name of the file here. If your graphics folder contains sub-directories you must include the file path relative to the graphics folder.
page_footer_text Enter the text you would like to appear at the bottom of the page. This is a good place to include a copyright notice.

User generated content

dont_allow_registration_and_login Pawtucket has a set of features only available to registered site users. If enabled, registered users can rank, tag and comment upon objects. They can also make named sets of images that can be publicly shared as slideshows. Set to 1 to disable registration and login.

Detail Views

Are you only using Pawtucket to catalogue objects? Or do you have in depth authority records you would like to share with your users? You can chose what records have detail pages and what attributes are displayed on those pages by setting the following variables. Note that objects always have detail pages.:

allow_detail_for_ca_entities, allow_detail_for_ca_places, allow_detail_for_ca_occurrences, allow_detail_for_ca_collections You can choose what records have detail pages by setting these variables to 1.
ca_objects_detail_display_attributes, ca_entities_detail_display_attributes, ca_places_detail_display_attributes, ca_occurrences_detail_display_attributes, ca_collections_detail_display_attributes Place attributes on your detail pages by defining arrays of attribute codes in the variables that correspond to each detail page.
ca_objects_description_attributes, ca_entities_description_attributes, ca_places_description_attributes, ca_occurrences_description_attributes, ca_collections_description_attributes Include descriptive text on your detail pages by entering the attribute code of your description information in the variable that corresponds to each detail page.

Social Media Sharing

show_add_this Set to true to display Add This social media sharing button on the object detail page

Type-based content restriction

You can restrict what material Pawtucket displays for a given sort of item (e.g. objects, entities, occurrences) by type using the following directive. For instance, if your system defines object types video, audio, film and print, and you only wish to display objects of type film or video with Pawtucket you can add this to your app.conf file:

ca_objects_restrict_to_types = [film, video]

The above assumes that the identifiers for the types are "film" and "video" respectively.

<tablename>_restrict_to_types A list of types to restrict content to for the item specified by <tablename>. Valid <tablename> values are ca_objects, ca_entities, ca_places, ca_occurrences, ca_collections, ca_storage_locations, ca_loans and ca_movements. The list can be the identifiers for the desired types, as defined in the relevant type list, or numeric type_ids. Identifiers are recommended as they are generally more readable and less prone to change across installations.
<tablename>_restrict_to_types_dont_include_subtypes By default the type restriction set by <tablename>_restrict_to_types includes all sub-types of the specified types. If this directive set to a non-zero value then the type restriction is limited to enumerated types only.

sphinx

Namespaces

Variants
Actions
Navigation
Tools
User
Personal tools