American Indian College Fund

Transcription

1 American Indian College Fund Resource Repository Development Plan May 2017

2 The following is a detailed description of the functional requirements for the new Resource Repository and the development approach that will be used to achieve those requirements. The overall goals are to match the designs as closely as possible and create an easy-to-use admin process to create and edit resources. SINGLE RESOURCE PAGE TEMPLATE The single resource template will be used to display an individual resource. Firefly will create a new WordPress page template for this style of page. When this template is selected, custom fields will appear to help easily manage the content for the various sections of the page without needing to work with HTML code. MARQUEE The background image and title will be defined through custom fields. If these fields are not specified, the settings for the resource list are applied on the front end. The background image will resize as the screen size changes. TITLE The built-in WordPress page title field will be used to provide the Resource Title. AUTHORS A repeatable text field allows multiple authors to be associated with a resource. While the resource list page will show at most two authors, all authors will be displayed on the single resource page. Each author field will contain a single author and will feature drag-and-drop functionality to control the display order. Author names will be displayed in APA format, i.e., last name, first name initial, middle initial (if provided). PUBLICATION DATE A date picker allows a publication date to be selected for the resource. This date is for display only and does not allow date-based control of the visibility of the resource on the site. (For instance, setting the publication date at a point in the future will NOT render the resource invisible prior to that date. Resources that are not ready to appear on the site can be saved as WordPress drafts in order to make edits without making them publicly available.) The publication date will be displayed near the resource s title on the single resource page and in the resource s tile on the resource list page. EXCERPT A custom WYSIWYG content field will be used to provide a short excerpt or description of the resource s content. This text will be displayed in the resource s tile on the Resource List page and will not be shown on the single resource page. American Indian College Fund: Resource Repository Development Plan Page 2 of 5

3 ABSTRACT OR OTHER TEXT This module consists of two fields: Text a WYSIWYG content field to provide longer-form text associated with the resource Type: A drop-down menu of text types (Abstract, Description, Excerpt, More Information, etc.). The selection will be used as a header shown above the text entered in the Text field The header and text entered here will be shown on the single resource page. IMAGE The built-in WordPress featured image field will be used to associate an image with the resource. This image will be shown as the top portion of the resource s tile on the resource list page and will also appear on the single resource page near the resource s title and metadata. CATEGORY A combo box field will allow the resource to be associated with the appropriate category, such as Research, Early Childhood, Native Place-Based Leadership, Faculty Development, Native Language and Culture, Capacity Building Programs, etc. Combo boxes allow users to select existing categories from a drop-down list or type a new category into a text field. The category will be shown as a link in the resource s tile on the resource list page and near the resource s title on the single resource page. Clicking the link will take the user to a resource list page showing only the resources in that category. RESOURCE(S) This module allows one or more files to be associated with a resource via a repeater field. Each file is identified by a pair of fields: Resource type a drop-down list containing predefined resource types (e.g. Publication, Video, Fact Sheet, Literature Review, etc.) File a chooser that allows the resource file to be uploaded or selected from files that already exist on the site s server, or a text field for a YouTube URL if the resource type is set to Video The resource type determines how the file will be accessed on the single resource page. If the resource type is set to Publication, a link to download or open the file will be displayed along with a Download icon. The behavior for Fact Sheet and Literature Review is identical to that of Publication, displaying appropriate text labels and icons for those types. If the resource type is Video, the file field expects a YouTube URL, and the YouTube player will be displayed on the single resource page. American Indian College Fund: Resource Repository Development Plan Page 3 of 5

4 SHARING FUNCTIONALITY Buttons to allow users to easily share each resource will appear close to the resource s metadata on the single resource page. This functionality will be provided via the AddThis sharing plugin, which allows site administrators to easily select and configure the social networks and other mediums to be included in the sharing options. These settings are made at the global level and will not be included in the fields present when editing a single resource. RESOURCE LIST TEMPLATE The resource list template automatically displays a collection of tiles representing individual resources. Firefly will create a new WordPress page template for this purpose. When this template is selected, a number of custom fields will appear to help easily manage the content for the various sections of the page without needing to work with HTML code. MARQUEE The top area consists of a background image and title. Each of these pieces will be defined through custom fields. The background image will resize as the screen changes. INTRO TEXT Introductory text will be entered in the main WYSIWYG editor for the page. On all screen sizes, this content will be presented in one column. RESOURCE LIST The resource list will be automatically generated by WordPress. The same template will be used for listing all resources as well as handling filtered listings (showing all resources in a category or resource type, for example). Each resource will be displayed as a tile in a grid layout. Each tile will display the following information (as available): Title Category Type Author(s) o If a resource has one or two authors, their names will be displayed (e.g. By Davis, M. or By Armstrong, L. & Davis, M. ) o If a resource has more than two authors, the primary author s name will be listed, followed by et al. (e.g. By Ellington, D. et al. ) Excerpt/Summary Publication Date Image American Indian College Fund: Resource Repository Development Plan Page 4 of 5

5 On desktop screen sizes, the grid layout will display three tiles per row, adjusting to two per row on smaller screens and one per row on mobile devices. American Indian College Fund: Resource Repository Development Plan Page 5 of 5