Pawtucket Application Configuration

From CollectiveAccess Documentation
Jump to: navigation, search

This page is currently under development

The app.conf configuration file

This configuration file is specific to the Pawtucket public web front-end application. It contains settings to configure Pawtucket to function on your web server and to customize the display of information. For information on the syntax of CA configuration files see Configuration File Syntax, the section titled Substituting values is especially useful to review as this technique is widely employed when defining file paths in app.conf.

Please note 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.


Directives

session_lifetime ?
session_domain ?
search_engine_plugin ?
character_set Character set to use (usually utf-8)
auth_login_path File path to login page of CollectiveAccess administrative interface
password_reset_url Absolute URL to reset password form
controllers_directory File path to page controllers. Controllers generate variables to pass to views for output.
always_use_default_theme if always_use_default_theme is set to 1 then the theme specified as default above is always used no matter the user's preference
themes_directory Complete server file path to themes directory
themes_url The root relative path to the themes directory
views_directory Complete server file path to views directory
auth_login_url The root relative path to the CollectiveAccess administrative interface login page
auth_logout_url The root relative path to the CollectiveAccess administrative interface logout page
error_display_url The root relative path to error display page; user will be directed here upon unrecoverable error (eg. bad controller or action)
default_action Url to redirect user to when nothing is specified (eg. they go to /index.php) ONLY PUT THE CONTROLLER/ACTION PATH HERE - leave out the 'index.php' for example: Splash/Index



Task queue set up (deferred processing of uploaded media)

taskqueue_handlers ?
taskqueue_handler_plugins ? Path to directory containing media processing plugins
taskqueue_tmp_directory ? Path to directory used by plugins for storage of temprary files



Paths to other config files

data_model Complete server file path to datamodel.conf
user_pref_defs Complete server file path to user_pref_defs.conf
field_label_defs Complete server file path to field_labels.conf
external_applications Complete server file path to external_applications.conf
media_volumes Complete server file path to media_volumes.conf
media_plugins Complete server file path to media_plugins.conf
file_volumes Complete server file path to file_volumes.conf
fileformat_plugins ? Complete server file path to file format Plugins directory
workspace_tmp_directory ? Complete server file path to temporary workspace directory
default_media_icons Complete server file path to default_media_icons.conf
search_config Complete server file path to search.conf
browse_config Complete server file path to browse.conf
media_processing_settings Complete server file path to media_processing.conf
bischen_label_processor_url Complete server file path to ?
annotation_type_config Complete server file path to annotation_types.conf
attribute_type_config Complete server file path to attribute_types.conf
javascript_config Complete server file path to javascript.conf
find_navigation Complete server file path to find_navigation.conf
object_print_forms Complete server file path to object_label_layouts.conf



Formatting Variables

html_page_title The HTML title of the page, appears at top of browser window
header_img File name of title image to use in page header. This will replace the CollectiveAccess logo.
page_footer_text Text used in page footer. This will replace the CollectiveAccess copyright notice.
dont_allow_registration_and_login If set to one, disables registered user features, commenting, tagging, ranking, sets.



User contributed content

dont_allow_registration_and_login If set to one, disables registered user features, commenting, tagging, ranking, sets.
dont_moderate_comments If set to one, new comments and tags are immediately publicly accessible.
dont_email_notification_for_new_comments If set to one, email notification of new comments and tags is not sent to site administrator.
enable_bookmarks If set to one, site wide bookmarking tool is enabled for users. Users can bookmark objects, entities, places, occurrences and collections.
disable_my_collections If set to one, disables My Collections feature.



Set Variables

featured_set_name Set code of set of featured images to use on home and favorites pages
user_set_type Set id of user generated sets
user_set_description Attribute of set description. If not defined here will default to 'set_description'
show_sets_access_form Set to true to display form allowing users with edit access for a set to control user access to set in frontend Lightbox
features_set_type Set id of sets displayed in "features" section



Search Options

search_results_partition_by_type If set to true, search results are partitioned by type. Requires that your views take this into account (default views *do not*)
do_secondary_searches Perform secondary searches when search objects? (Secondary searches are searches performed when searching for objects [the "primary" search] on authorities)
do_secondary_search_for_ca_entities Show search results for entities along with objects
do_secondary_search_for_ca_places Show search results for places along with objects
do_secondary_search_for_ca_occurrences Show search results for occurrences along with objects
do_secondary_search_for_ca_collections Show search results for collections along with objects
items_per_page_options_for_ca_objects_search List of number of results per page. Displayed in search options form.(example: [21, 28, 35])
items_per_secondary_search_page Number of results per page for secondary search results.
use_advanced_search Set to true to enable the advanced search form feature (forms are configured in advanced_search_forms.conf)
result_views_for_ca_objects, result_views_for_ca_entities, result_views_for_ca_places, result_views_for_ca_occurrences, result_views_for_ca_collections Lists of search result views for searches and browses. If not defined, the default views are used. Must be an associative array where the key is the code for the view and the value is the name of the view as it should be displayed in the drop down in the search options form. (example: {thumbnail = _(Thumbnails), full = _(List)}) When creating your own results views, the view files need to named <tablename>_results_<view code>_html.php (example: ca_objects_results_full_html.php) and should be saved in the "Results" folder of your theme.
result_views_options_for_ca_objects, result_views_options_for_ca_entities, result_views_options_for_ca_places, result_views_options_for_ca_occurrences, result_views_options_for_ca_collections Lists of options, description and icon graphic file name, for each result view. The description and icon are used in formatting the options panel in searches and browses. If not defined, the default settings are used. Must be an associative array where the key is the code for the views defined in result_views_for<tablename> and the value is an array of options containing 2 keys, "description" and "icon". The icon value should be the path relative to your theme's graphics folder and file name.


Example:
result_views_options_for_ca_objects = {
thumbnail = {description = _(View thumbnails with brief captions), icon = icon_thumbnail.gif}
}

result_sort_options_for_ca_objects, result_sort_options_for_ca_entities, result_sort_options_for_ca_places, result_sort_options_for_ca_occurrences, result_sort_options_for_ca_collections Lists of attributes to order searches and browses by. If not defined, the default options are used. Must be an associative array where the key is the attribute code and the value is the name of the sort option as it should be displayed in the drop down in the search options form. (example: {ca_object_labels.name => _(Title), ca_objects.idno_sort => _(Idno)})
show_map_object_search_results Include map as option for search results layout. ca_objects_map_attribute must also be defined, it is the attribute of the coordinates to map on the search results.
<table_name>_search_refine_facet_group Name of facet group to restrict facets by, for the specified table (eg. ca_objects, ca_entities, ca_places, etc.). Facet groups are defined in the browse.conf file.
<table_name>_restrict_to_types List of record types to restrict search and browse to, for the specified table (eg. ca_objects, ca_entities, ca_places, etc.).
<table_name>_restrict_to_types_dont_include_subtypes Works in combination with <table_name>_restrict_to_types. Prevents subtypes from being included in search and browse results when set to true.



Quick Search Options ("live" search in search box in header)

quicksearch_return_ca_objects Set to true to return objects in quicksearch
quicksearch_return_ca_entities Set to true to return entities in quicksearch
quicksearch_return_ca_places Set to true to return places in quicksearch
quicksearch_return_ca_occurrences Set to true to return occurrences in quicksearch
quicksearch_return_ca_collections Set to true to return collections in quicksearch



Browse Options

browse_targets List of table names to allow browsing on(example: [ca_objects, ca_entities])
items_per_page_options_for_ca_objects_browse List of number of results per page. Displayed in browse options form.(example: [21, 28, 35])
<table_name>_browse_facet_group Name of facet group to restrict facets by, for the specified table (eg. ca_objects, ca_entities, ca_places, etc.). Facet groups are defined in the browse.conf file.



Content Caching

do_content_caching Set to 1 if you want to cache content, as configured in the content_caching.conf config file Caching can greatly increase performance and high-traffic sites
content_cache_dir Directory to store content cache data in



Item Viewability (access enforcement)

dont_enforce_access_settings If set to true, no access checks are performed
public_access_settings List of values for 'access' field in objects, entities, places, etc. that allow public (unrestricted) viewing
privileged_access_settings List of values for 'access' field in objects, entities, places, etc. that allow privileged viewing (ie. user in on a privileged network as defined below)
privileged_networks List of IP address to consider "privileged" (can see items where access = value in privileged_access_settings above) It is ok to use wildcards ("*") for portions of the address to create class C or B addresses Eg. 192.168.1.5, 192.168.1.* and 192.168.*.* are all valid and increasingly broad



Detail Views

allow_detail_for_ca_entities, allow_detail_for_ca_places, allow_detail_for_ca_occurrences, allow_detail_for_ca_collections Set to true to allow detail pages for entities, places, occurrences and collections
ca_objects_detail_display_attributes, ca_entities_detail_display_attributes, ca_places_detail_display_attributes, ca_occurrences_detail_display_attributes, ca_collection_detail_display_attributes Array of attribute codes to be displayed on object, entity, place, occurrence and collection detail pages
ca_objects_description_attribute, ca_entities_description_attribute, ca_places_description_attribute, ca_occurrences_description_attribute, ca_collection_description_attribute Attribute code of description to be displayed on object, entity, place, occurrence and collection detail pages
redirect_to_ca_objects_detail_if_is_first_facet, redirect_to_ca_entities_detail_if_is_first_facet, redirect_to_ca_places_detail_if_is_first_facet, redirect_to_ca_occurrences_detail_if_is_first_facet, redirect_to_ca_collections_detail_if_is_first_facet Set to true to redirect to detail page on first browse
show_add_this Set to true to display Add This social media sharing button on object detail page
show_facebook_share Set to true to display a link to share on Facebook in the toolbar beneath the media on the object detail page
ca_objects_map_attribute Attribute of coordinates to map on object detail page and search results (table.attributeCode). If not set, no map is displayed.
allow_browse_within_detail_for_ca_entities, allow_browse_within_detail_for_ca_places, allow_browse_within_detail_for_ca_occurrences, allow_browse_within_detail_for_ca_collections, allow_browse_within_detail_for_ca_objects Set to the tablename of the type of browse to perform on the detail page, or 0 to disable.
sort_browse_within_detail_for_ca_entities, sort_browse_within_detail_for_ca_places, sort_browse_within_detail_for_ca_occurrences, sort_browse_within_detail_for_ca_collections Set the sort order of the browse on the detail pages using any field or metadata element in the browsed table; you can sort on titles by using the label table name + label field (eg. ca_object_labels.name)
<table_name>_refine_facet_group Name of facet group to restrict facets by in the refine browse, for the specified table (eg. ca_objects, ca_entities, ca_places, etc.). Facet groups are defined in the browse.conf file.



Set-based slideshow

ca_objects_set_slideshow_display_attributes Array of attribute codes to be displayed in information panel in user-created-set ("My Collections") slideshow viewer. The information referred to be each code is displayed on its own line.




Media versions

ca_objects_representation_display_versions List of versions of object representation media to pass to the ca_objects detail view
ca_objects_representation_default_image_display_version Default version to use for display of images
ca_objects_representation_default_video_display_version Default version to use for display of video
ca_objects_representation_default_audio_display_version Default version to use for display of audio



Media processing tweaks

dont_use_imagick If set to 1 the PECL Imagick API for ImageMagick will not be used even if it is installed and available on your system. If you are experiencing crashes while processing media you might want to try setting this to one; Imagick is preferred because of its good performance but it can have stability problems on some systems.



UI Locales/Languages

ui_locales List of locales/languages that you want the Pawtucket UI to support. Each locale *MUST* have a messages.po/mo translation file in app/locales



Splash page features

The default implementation of the Pawtucket "splash" (front) page includes several displays of objects by specific criteria, including objects most recently added, most recently viewed and most highly rated by users. Generation of these lists becomes computationally expensive for larger datasets, so to optimize splash page performance generation of all unused lists should be disabled. The following criteria allow you to disable generation of specific lists as well as customize the media versions returned for display.

splash_disable_highest_rated_objects If set to a non-zero value generation of objects with highest user ratings for the splash page is disabled
splash_highest_rated_display_versions List of media versions to provide information for to the splash page view for highest rated objects. If omitted defaults to: ['thumbnail', 'small', 'medium', 'mediumlarge', 'preview', 'widepreview']
splash_disable_recently_added_objects If set to a non-zero value generation of recently added object list for the splash page is disabled
splash_recently_added_display_versions List of media versions to provide information for to the splash page view for recently added objects. If omitted defaults to: ['thumbnail', 'small', 'medium', 'mediumlarge', 'preview', 'widepreview']
splash_disable_random_objects If set to a non-zero value generation of list of random objects for the splash page is disabled
splash_random_display_versions List of media versions to provide information for to the splash page view for list of randomly selected objects. If omitted defaults to: ['thumbnail', 'small', 'medium', 'mediumlarge', 'preview', 'widepreview']
splash_disable_most_viewed_objects If set to a non-zero value generation of list of most viewed objects is disabled
splash_most_viewed_display_versions List of media versions to provide information for to the splash page view for most viewed objects. If omitted defaults to: ['thumbnail', 'small', 'medium', 'mediumlarge', 'preview', 'widepreview']
splash_disable_recently_viewed_objects If set to a non-zero value generation of recently viewed objects is disabled
splash_recently_viewed_display_versions List of media versions to provide information for to the splash page view for recently viewed objects. If omitted defaults to: ['thumbnail', 'small', 'medium', 'mediumlarge', 'preview', 'widepreview']
Namespaces

Variants
Actions
Navigation
Tools
User
Personal tools