Styling Pawtucket - using themes

From CollectiveAccess Documentation
Jump to: navigation, search

The majority of the HTML code, and all of the stylesheets and graphics used to generate pages in Pawtucket are contained in the themes directory. The themes directory contains one or more sub-directories which are individual themes. The title of each theme folder, is the title of the theme. To assign the theme you want to use, set the "$_CA_THEMES_BY_DEVICE" variable in setup.php. Within each theme are 4 directories, conf, css, graphics, and views. Pawtucket comes with two themes: "default" and "iphone". The "iphone" theme is used when Pawtucket is loaded on a mobile device and the "default" theme is used all other times.

To make basic changes to the look of Pawtucket, for example changing colors and fonts, you can modify the stylesheets in themes/default/css/. There are 3 stylesheets in this folder.

global.css contains the majority of the styles used in Pawtucket.
sets.css is used to format the sets interface.
iestyles.css is an Internet Explore specific stylesheet where you can override styles to fix formatting in IE.

As mentioned in Customizing Pawtucket, you can also make some basic changes to the site by setting the formatting variables in app/conf/app.conf or themes/<yourTheme>/conf/app.conf. The settings in your theme's conf files override those in app/conf. This is a convenient way of having theme specific settings.

All site graphics are stored in the graphics folder.

To edit site text and make more significant changes to the overall design of the site, you will need to modify the files in the views directory. If you plan on making significant changes you may want to make your own theme by copying the default theme folder, giving it a new name and adding your theme's name to the "$_CA_THEMES_BY_DEVICE" array in setup.php.

Note there are also HTML views in the plugins folder in app/plugins. To see descriptions of these views please visit Customizing Pawtucket - Plugins.

The following is a brief description of each view in the views folder. A * after a file name indicates you will most likely need to modify this file:

About/about_landing_html.php* About page content, it is static html and comes with place holder Lorem ipsum text that should be replaced.
ajaxFooter/ajaxFooter.php An alternate footer only used with Ajax calls. This file does not contain HTML code.
Browse/ajax_browse_facet_html.php Formats the browse panel overlays that present the options for each facet.
Browse/browse_controls_html.php Formats the browse landing page and the browse interface. Note that results views are in the Results directory and are shared by the Search and Browse.
Browse/browse_intro_text_html.php* Browse landing page introductory text, it is static html and comes with place holder Lorem ipsum text that should be replaced. If you do not want introductory text on the landing page of the browse section, remove the text from this file.
bundles/ca_object_representations_display_with_annotations.php
Detail/ajax_ca_objects_media_overlay_html.php Displays the media viewer. This is loaded by an ajax call in an overlay from the object detail page (ca_objects_detail_html.php).
Detail/ca_collections_detail_html.php The collection detail page. Displays collection attributes specified in app/conf/app.conf. See Detail Views in the discussion of application configuration in Basic application configuration. Includes Detail/related_objects_grid.php which presents a grid of thumbnails of each object related to the collection.
Detail/ca_entities_detail_html.php The entity detail page. Displays entity attributes specified in app/conf/app.conf. See Detail Views in the discussion of application configuration in Basic application configuration. Includes Detail/related_objects_grid.php which presents a grid of thumbnails of each object related to the entity.
Detail/ca_objects_detail_html.php The object detail page. Displays object attributes specified in app/conf/app.conf. See Detail Views in the discussion of application configuration in Basic application configuration. Displays media representations for the object. Contains code to format user generated content features (ranking, tagging, and commenting form and link to add object to set). These features are only displayed if login and registration is enabled in app/conf/app.conf. See User generated content in the discussion of application configuration in Basic application configuration.
Detail/ca_occurrences_detail_html.php The occurrence detail page. Displays occurrence attributes specified in app/conf/app.conf. See Detail Views in the discussion of application configuration in Basic application configuration. Includes Detail/related_objects_grid.php which presents a grid of thumbnails of each object related to the occurrence.
Detail/ca_places_detail_html.php The place detail page. Displays place attributes specified in app/conf/app.conf. See Detail Views in the discussion of application configuration in Basic application configuration. Includes Detail/related_objects_grid.php which presents a grid of thumbnails of each object related to the place.
Detail/object_representation_download_binary.php Code to download object representation files
Detail/paging_controls_html.php Page bar for image grid on collection, entity, occurrence, and place detail pages. Included by related_obejcts_grid.php
Detail/related_objects_grid.php Presents a grid of thumbnails of each object related to an authority record. Includes code to format a page bar from Detail/paging_controls_html.php. Is included by collection, entity, occurrence, and place detail pages.
Favorites/favorites_intro_text_html.php* Introductory text that appears at top of Favorites page. It is static HTML and comes with place holder Lorem ipsum text that should be replaced.
Favorites/landing_html.php Presents scrolling columns of thumbnail images in 4 categories, Featured Content, User Favorites/Random Selection, Most Viewed and Recently Added. Includes Favorites/favorites_intro_text_html.php.
Feed/feed_recently_Added_xml.php Generates the RSS feed of recently added objects linked to from the home page of Pawtucket.
LoginReg/loginreg_html.php Login, registration and forgot your password forms.
LoginReg/resetpw_html.php Form to reset site password. Users are sent a link to this form after initiating the reset process through a form in LoginReg/loginreg_html.php.
mailTemplates/instructions.tpl Email template used to instruct users how to reset their password.
mailTemplates/notification.tpl Email template used to notify users their site password has been reset.
mailTemplates/reg_conf.tpl Registration confirmation email template
pageFormat/notifications.php Formats messages that appear beneath header and before page content. Used to display error messages and confirmations that actions have been successfully performed (for example when a comment or tag has been added)
pageFormat/pageHeader.php The header of the page, including the HEAD and opening HTML and BODY tags, and the site navigation. Displays Login/register, Logout, and/or My sets links if user registration and login has been enabled. See User generated content in the discussion of application configuration in Basic application configuration. Displays language drop down if site is configured to be available in more than one language.
pageFormat/pageFooter.php The footer of the page, including closing BODY and HTML tags. The footer text can be changed by editing the "page_footer_text" variable in app/conf/app.conf
Results/ca_collections_results_full_html.php
Results/ca_entities_results_full_html.php
Results/ca_occurences_results_full_html.php
Results/ca_places_results_full_html.php
Formats results for collection, entity, occurrence or place searches and browses. Basic installations of Pawtucket do not search upon authorities.
Results/ca_collections_search_no_results_html.php
Results/ca_entities_search_no_results_html.php
Results/ca_occurences_search_no_results_html.php
Results/ca_places_search_no_results_html.php
Displays message when no search results are found. Note: Basic installations of Pawtucket do not search upon authorities.
Results/ca_object_results_full_html.php Formats object list results view. Displays medium image and text for each result.
Results/ca_object_results_map_balloon_html.php Formats the Google map balloon that opens when a marker is clicked on when the search is displaying mapped results.
Results/ca_object_results_map_html.php Formats object map results view. Plots retrieved objects on a Google map. The attribute containing the coordinate used for mapping the results is assigned in the "ca_objects_map_attribute" variable in app.conf.
Results/ca_object_results_thumbnail_html.php Formats object thumbnail results view. Displays grid of small images with captions and tooltips that display a larger image version and full caption information. Includes Results/ca_object_result_caption_html.php to format captions and Results/ca_object_result_tooltip_html.php to format tooltips.
Results/ca_object_result_caption_html.php Formats caption under thumbnail results. Included by Results/ca_object_results_thumbnail_html.php.
Results/ca_object_result_tooltip_html.php Formats tooltip displayed when thumbnail results are rolled over. Included by Results/ca_object_results_thumbnail_html.php.
Results/ca_object_search_no_results_html.php Displays message when no search results are found.
Results/paging_controls.php Paging bar for search and browse results. Displays teh number of results found, a jump to page form and next and previous navigation.
Results/search_secondary_results/ca_collections_html.php
Results/search_secondary_results/ca_entities_html.php
Results/search_secondary_results/ca_occurrences_html.php
Results/search_secondary_results/ca_places_html.php
Formats secondary search results displayed beneath object search results. Only used if "do_secondary_searches" is enabled and "do_secondary_searches_for_<tablename>" variables are configured in app/conf/app.conf.
Search/ajax_refine_facet_html.php Formats the browse panel overlays used to refine search results.
Search/ajax_search_lookup_json.php JSON-formatted data for quick search suggestion drop-down display in top nav bar. Only used if configured in app/conf/App.conf
Search/ca_objects_search_basic_html.php Assembles object search result pages. Includes Results/paging_controls_html.php, Search/search_controls_html.php, Search/search_refine_html.php and result view or no results views from Results folder. Also includes secondary search results if enabled.
Search/ca_objects_search_advanced_html.php Assembles advanced object search result pages. Includes Search/search_advanced_controls_html.php, Results/paging_controls_html.php, Search/search_controls_html.php, Search/search_refine_html.php and result view or no results views from Results folder.
Search/ca_collections_search_basic_html.php
Search/ca_entities_search_basic_html.php
Search/ca_occurrences_search_basic_html.php
Search/ca_places_search_basic_html.php
Assembles authority search result pages. Includes Search/search_controls_html.php, Search/search_refine_html.php and result view or no results views from Results folder. Note: Basic installations of Pawtucket do not search upon authorities.
Search/search_advanced_controls_html.php Displays the advanced search form or forms configured in advanced_search_forms.conf. Included by Search/ca_objects_search_advanced_html.php.
Search/search_controls_html.php Displays search options in a show/hide div under the page bar. Presents options to change the result view, order of results, the number of results per page and shows the search history.
Search/search_refine_html.php Displays search refine controls in a show/hide div under the page bar. Allows users to refine search results by using the faceted browse.
Sets/ajax_add_item_json.php Displays errors resulting from addition of image to set.
Sets/ajax_delete_item_json.php Displays errors resulting from deletion of set image.
Sets/ajax_reorder_items_json.php Displays errors resulting from reordering of set images.
Sets/sets_html.php Displays user's image sets. Has controls for editing sets, making new sets, and reordering images in sets. This page is only accessible to registered users. The sets 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.
Sets/slideshow_html.php Outputs flash slideshow viewer that allows users to view their image sets as full screen slideshows. Includes slideshow viewer from /viewers/apps/Slideshow.swf.
Sets/xml_set_items.php Generates xml for set items used to make slideshow of set images.
Splash/splash_html.php Formats the splash page. Displays 1 large featured image, 3 smaller featured objects (User Favorite/Random Selection, Most Viewed and Recently Added) and a quick browse. Includes text from Splash/splash_intro_text_html.php.
Splash/splash_intro_text_html.php* Splash page text, by default this has place holder Lorem ipsum text that should be replaced.
System/error_html.php
System/logged_out_html.php
System/login_html.php
System/welcome_html.php
Namespaces

Variants
Actions
Navigation
Tools
User
Personal tools