Administrator

How do I build a Resource Library?

Follow
Ryan Richins
  • Agilix team member
  • Updated:
    info_outline
    Created:

Resource libraries are collections of categorized content pages that are built at the domain level and can be searched, bookmarked, shared, and rated by users in all subdomains.

Admins with domain edit rights can create and manage multiple libraries and the pages found in them. For example, they might create one Resource library for teachers and admins called School Community Resources and another focused on science teachers called K-12 Science Resources.

Create Resource Library

Only Admins can create Resource Libraries.

To do so:

  1. Open the vertical menu in the toolbar of Domain Details.  
  2. Select Domain Settings.
  1. Select the Show text editor icon next to Save in the toolbar.
  1. In the Application Settings window, set up your library like this:
 <communitypages-list>
    <communitypages id="[ENTER UNIQUE ID]" domainid="[ENTER CURRENT DOMAIN ID]"  
    title="[ENTER VISIBLE LIBRARY TITLE]" icon="[ENTER ICON TITLE]" order="[ENTER NUMBER]">
      <category-list>
        <category id="[ENTER CATEGORY GUID]" title="[ENTER VISIBLE CATEGORY TITLE]" />
        <category id="[ENTER CATEGORY GUID]" title="[ENTER VISIBLE CATEGORY TITLE]" />
        <category id="[ENTER CATEGORY GUID]" title="[ENTER VISIBLE CATEGORY TITLE]" />
        <category id="[ENTER CATEGORY GUID]" title="[ENTER VISIBLE CATEGORY TITLE]" />
      </category-list>
      <pagetype-list>
        <pagetype name="[ENTER VISIBLE PAGE TYPE]" icon="[ENTER ICON TITLE]"   
        iconcolor="[ENTER FONT COLOR CODE”/>
        <pagetype name="[ENTER VISIBLE PAGE TYPE]" icon="[ENTER ICON TITLE]"   
        iconcolor="[ENTER FONT COLOR CODE”/>
        <pagetype name="[ENTER VISIBLE PAGE TYPE]" icon="[ENTER ICON TITLE]"   
        iconcolor="[ENTER FONT COLOR CODE”/>
        <pagetype name="[ENTER VISIBLE PAGE TYPE]" icon="[ENTER ICON TITLE]"   
        iconcolor="[ENTER FONT COLOR CODE”/>
        <pagetype name="[ENTER VISIBLE PAGE TYPE]" icon="[ENTER ICON TITLE]"   
        iconcolor="[ENTER FONT COLOR CODE”/>
      </pagetype-list>
    </communitypages>
  </communitypages-list>
  • <communitypages-list>: This element defines the Resource Libraries for your domain.
    • <communitypages>: Include this element for each library you want included in your domain's App Menu.
  • communitypages id: The library's unique ID. It must be unique from the other communitypages entries, and must be a valid XML element name without spaces or underscore (_) characters. Once you have created pages for this ID, don't change it. If you do change it, any pages associated with the old ID are orphaned and won't be associated with the new one.
  • domain id: The domain ID of the domain that you are adding this communitypages entry to. You can copy/paste this ID from the Edit Settings modal dialog header where you are editing the XML settings.
  • title: The library title that users see as a tab on the Main Menu.
  • icon: The Font Awesome Pro icon name to use for the menu item. Prefix Font Awesome icon names with `fa-` and one of the following styles (if omitted, the default icon is the Material library_books icon):
  • order: The order in which the menu entry should appear. The default order of the menu entry is 12.5.
  • <category-list><category>: Defines a list of category entries that display on the home page of this Resource Library. Each category entry defines a category of resource library pages and has these attributes:
    • category id: Each category's unique ID. It must be unique among the other category entries in this list, and must be a valid XML element name without spaces. Do not change a category ID after creating documents in that category. If you do change it, any pages associated with the old ID are not associated with the new one. To ensure uniqueness, we recommend using GUIDs without hyphens or other special characters.
    • title: Each category's title that users see listed on the Resource Library.
  • <pagetype-list><pagetype>: Defines a list of page-type entries that the author can choose from when authoring a page. These types also display as filters on the search page.
    • name: The page type's unique name. Each type should be a single word (no spaces), such as Document, Link, or Image. We recommend that each entry be capitalized to appear consistent in the filter list with other filters.
    • icon: If you want to specify a page icon from the Font Awesome Pro library, enter the icon name. Prefix Font Awesome icon names with `fa-` and one of the following styles:
    • iconcolor: If you want to specify a specific color for the icon, enter the hex code.
  1. Save.

Note

Be sure to use straight quotation marks (not curly or smart quotation marks) in the Text editor:

Straight quotation mark: "

Curly or smart quotation mark:

Example

This is how the custom icons and colors appear with pages.

Add pages to the Resource Library

Only admins with domain editing permissions can add, edit, and delete content pages in a Resource Library.

To add pages:

  1. Open the Resource Library you want to add to from your App Menu. This Resource Library is titled School Community Resources.
  1. Click the Create Page button in the toolbar. If you don't see this option and should, contact your system admin about your permissions.
  1. Provide the following information:
    • Page Title as you want it displayed to users.
    • Category(s) that you want the page to be included in. These are the categories you created when you built your library.
    • Type of content you want the page marked as. Users can filter by this value.
    • Whether you want the page Featured, meaning it appears at the top of the category with a star.
    • Description of the page that appears for users as they browse pages. You can create keywords within the Description field's text with hashtags—written with a # symbol. If you want users to be able to search for a phrase, like Science Project, remove the space between the words: #scienceproject.
    • Add Attachments that you want included with the page.
    • Page Content is the main content intended for users.
  2. Click Save.

Browse, filter, and search the Resource Library

To find pages:

  1. Open the Resource Library you want to add to from your App Menu. This Resource Library is titled School Community Resources.
  1. At any point, click your library title in the upper lefthand corner to return to this page.
  2. From here, you can:
    • Use the Search field to search the entire library and then Filter the search results.
    • Review and select Featured, New, Bookmarked, and Edited pages.
    • Browse a category you're interested in.
  1. When you select a category, you can:
  1. When you select a page, you can:
    • Review the page content.
    • Edit Page content (if you have domain edit permissions).
    • Delete Page (if you have domain edit permissions).
    • Click the Share icon to get a reference number which will automatically pull up this page when entered in the Search field.

Use hashtags to create easily discoverable resources

When creating a Resource Library page, you can create keywords within the Description field's text with hashtags—written with a # symbol. If you want users to be able to search for a phrase, like Science Project, remove the space between the words: #scienceproject.

These keywords are indexed in the Resource Library, allowing users to search for them using the hashtag symbol.

Example

Notice that the page Description below uses the following keywords:

  • #rationalnumber
  • #integers
  • #grade7
  • #grade8
  • #grade9
Example

Once that page is created, users can search using any of those keywords, and find this article.

Comments (2)

Sort by
Jason Albertson

It looks like only teachers and admins can access resource libraries in our domain. Is that how these are intended to function--for teacher/admin use only, not students?

0 Comment actions Permalink
Brian Williams
  • Agilix team member

Hello Jason:

Yes you are correct that the resources page is not intended for student's to use. 

0 Comment actions Permalink
Please sign in to leave a comment.