Customizing Pawtucket - Section by section

From CollectiveAccess Documentation
Jump to: navigation, search

The following is an overview of the site sections of Pawtucket. A description of each section's views is available in Styling Pawtucket - Using Themes.

Home Page

The home page is composed of a large featured item, introductory text, 3 smaller featured items and a quick browse.

Featured item - You can control which item appears as the featured item on the home page by creating a set of items whose set code corresponds to the name defined in the featured_set_name variable in app.conf. A random object from this set will be displayed on the home page each time the page is loaded. Sets are created in CollectiveAccess under Manage > My Sets. If you do not define a set of images for use, a random object from the collection will be presented here instead. A caption containing the primary label for the object appears underneath the home page text to the right of the image.

Home page text - Enter the text you would like to appear on your home page in the following HTML template within your theme directory: views/Splash/splash_intro_text_html.php. This template supports HTML markup, and at a minimum you should wrap paragraphs of text in div tags to ensure proper spacing.

Additional featured content - Additional items are featured on the home page within 3 categories. Clicking the "More" link beneath these items will take you to the Favorites page containing more items from each of these categories.

User favorites / Random selection - If you have enabled ranking and users have ranked objects in your collection, the highest ranked object will appear under the heading "User favorites". If ranking information is not available, a random item will be displayed under the heading "Random selection".:
Most viewed - Pawtucket keeps track of how many hits each record has, "Most viewed" presents the most visited item from the collection.:
Recently Added - Displays the newest item added to the database.:

Quick browse - Allows users to initiate a browse without having to navigate to the Browse section of the site.

Favorites Page

The Favorites page is linked to through the "More" link beneath the 3 smaller featured items on the Home page. The introductory text on this page can be changed by editing the following HTML template within your theme directory: views/Favorites/favorites_intro_text_html.php. This template supports HTML markup and at a minimum you should wrap paragraphs of text in div tags to ensure proper spacing.

The Favorites page contains additional items from the categories displayed on the home page:

Featured content - Put items in this category by creating a set of objects whose set code corresponds to the name defined in the featured_set_name variable in app.conf. Sets are created in CollectiveAccess under Manage > My Sets. If you do not define a set of images for use, random objects from the collection will be presented here instead.
User favorites / Random selection - If you have enabled ranking and users have ranked objects in your collection, the highest ranked objects will appear under the heading "User favorites". If ranking information is not available, random items will be displayed under the heading "Random selection".
Most viewed - Pawtucket keeps track of how many hits each record has, "Most viewed" presents the most visited items from the collection.
Recently Added - Displays the newest items added to the database.



Browse

Pawtucket contains a faceted browse that can be configured to return any type of item in the database. Although objects are most commonly browsed for, you can have the browse retrieve other items by defining the browse_targets array in app.conf to a list of the database table names you would like to allow browsing upon. If more than one table is configured, a drop down will appear in the browse interface for users to choose what they are browsing for.

It is important to carefully configure the browse facets in your Pawtucket installation to reflect the cataloging in your database. See Browse Configuration for a detailed discussion on how to customize the browse. Make sure to include a description in each facet since this text is used on the landing page of the browse section in Pawtucket.

The Browse section's landing page also displays a block of introductory text that you will need to set or remove if you do not require introductory text. It is in /themes/default/views/Browse/browse_intro_text_html.php.

Result views are shared between the search and browse. See "Search" below to learn how to configure Pawtucket to use custom result views and sort options.

Search

Quick Search "Live" Searching - Pawtucket can be configured to suggest search results to users as they type text into the search box in the nav bar. When "live" searching is enabled, a layer is drawn below the search box containing links directly to the detail pages of the retrieved items. Enable live searching for objects and authority items by setting quicksearch_return_ca_objects, quicksearch_return_ca_entities, quicksearch_return_ca_places, quicksearch_return_ca_occurrences and/or quicksearch_return_ca_occurrences to 1 in app.conf You will also need to enable detail views for the items you are allowing live searching on so users can click through the results to obtain more information about the item. To do this, set allow_detail_for_ca_entities, allow_detail_for_ca_places, allow_detail_for_ca_occurrences and/or allow_detail_for_ca_collections to 1 in app.conf.

Secondary Searches - Pawtucket's search is configured to be object centric, however you can configure it to include secondary search results for authority items (Places, Entities, Occurrences, Collections) beneath the object results. To enable secondary searching set do_secondary_searches to 1 in app.conf. You can set how many results per page you would like to appear for secondary searches by defining items_per_secondary_search_page in app.conf. Additionally, you must indicate which secondary results to display by setting do_secondary_search_for_ca_entities, do_secondary_search_for_ca_places, do_secondary_search_for_ca_occurrences and/or do_secondary_search_for_ca_collections to 1. You will also need to enable detail views for the items you are allowing secondary searching on so users can click through the results to obtain more information about the item. To do this, set allow_detail_for_ca_entities, allow_detail_for_ca_places, allow_detail_for_ca_occurrences and/or allow_detail_for_ca_collections to 1 in app.conf.

Custom search result views - You can configure Pawtucket to use your own custom search/browse result views by setting the result_views_for_<tablename> in app.conf. When creating your own results views, the view files need to named <tablename>_results_<view code>_html.php (Note the view code is defined in app.conf.) and should be saved in the "Results" folder of your theme.

Custom search result sort options - You can configure Pawtucket to sort search/browse results by the attributes of your choice by setting the result_sort_options_for_<tablename> in app.conf.

Advanced Search

Pawtucket2's advanced search feature integrates custom search forms into your website. The advanced search site section is enabled by setting use_advanced_search to true in app.conf. The advanced search form or forms is configured in advanced_search_forms.conf All result code is shared with the basic search.

Detail Pages

Pawtucket is designed to be object centric, so it is programmed for objects to have detail pages. It can be configured to display detail views for entities, places, occurrences, and/or collections by setting allow_detail_for_ca_entities, allow_detail_for_ca_places, allow_detail_for_ca_occurrences and/or allow_detail_for_ca_collections to 1 in app.conf. All detail pages will display the title of the item at the top of the page and is formatted to provide for a left column that can be configured to contain metadata elements and links to related content. In the object detail, the right side of the page displays the object's representations and a user generated content submission form when user generated content has been enabled. (See User generated content in the discussion of application configuration in Basic application configuration.) Details for entities, places, occurrences and collections contain a paged grid of thumbnails of objects related to the item being detailed in the right column of the page.

To place metadata elements in the left column of a detail page, set ca_objects_detail_display_attributes, ca_entities_detail_display_attributes, ca_places_detail_display_attributes, ca_occurrences_detail_display_attributes and/or ca_collections_detail_display_attributes in app.conf to a list of the element codes you would like to appear. You can also have descriptive text display in this column by setting ca_objects_description_attribute, ca_entities_description_attribute, ca_places_description_attribute, ca_occurrences_description_attribute, and/or ca_collections_description_attribute in app.conf to the element code of your descriptive text.

Lists of the entities, places, collections, occurrences and objects related to the item being detailed will appear as links to the related item's detail page if detail pages have been enabled for the item type.

Gallery

The Gallery section is a plugin that can be enabled or disabled. For instruction on how to enable the Gallery section and a breakdown of the views used to generate this section, please visit Customizing Pawtucket - Plugins

The Gallery section provides you with the utility to publish curated sets of images with accompanying descriptive information without any custom programming or formatting. It is an easy way to present slideshows or simple online exhibitions and create narratives with the objects from your collection.

Gallery presents sets of images created in CollectiveAccess's Manage > My Sets interface. Sets are selected to appear in this section based on their type and access settings. You can configure which type set is used in the Gallery section by defining the variable "simpleGallery_set_type" in app.conf. All sets with this type whose access is set to public will appear in the Gallery section. The landing page of the section contains a list of all accessible sets. The introductory text on this page can be changed by editing the HTML template within the plugin's view directory, for example: app/plugins/simpleGallery/views/default/intro_text_html.php. The detail page for each set contains the descriptive text entered for the set and a grid of thumbnail images of each object in the set. When clicked on, these thumbnails open a panel with a larger image, the label and descriptive text entered for the image and a link to see the object's full detail page. This panel also provides next and previous navigation between objects in the set. The set detail page also contains links to other gallery sets in the right hand column of the page.

About

In the default theme, the About section has one page containing placeholder Lorem ipsum text that you can replace with your own text. If your site design requires additional static pages, simply create additional views in your theme's About folder and add links to your pages from within your site. Your new views need to be .php files. The url to your new pages ends with the name of the view file: <domain name>/index.php/About/<view_name>. For example, a link to index.php/About/contact would load the following view: /About/contact.php.

My Collection

The collections feature is only available if user registration and login has been enabled. See User generated content in the discussion of application configuration in Basic application configuration. Registered users can create collections of objects by clicking the "Add to collection" link beneath images on the object detail page. They can then edit their collection, create new collections and organize the images in their collections by clicking the My Collections link at the top right of the page (this link only appears when users are logged in). Users can share links to slideshows of their collection images if their collection's Display option is set to public.

sphinx

Namespaces

Variants
Actions
Navigation
Tools
User
Personal tools