Year
Learning Area
LibGuide Conventions
Guide Details

Guide Details

Guide Title

Guide titles should be be reflective of the content in the guide. Additional descriptors (year level, subject, etc...) should not be within the title as they will all be used elsewhere.

Guide Description

Guide description should contain one or two sentences relating to the content of the guide. This description should contain year group, specific subject and assignment name. (i.e. Research guide for Year 9 History 'A Land Divided' assignment. Students will…).

Description are not displayed on published guides but are used and displayed for search results and links on social media.

Guide Type

Assign guide type as required.

Guide Group

Guide groups are mainly used to categorise guides into learning areas. This will give them specific colours and templates and once published will ensure they are accessible from the Research Guides page. Each guide can only be assigned one group.

While other groups exist, choosing to associate your guide with a non-learning area group will mean it may not display correctly without also assigning a template and it will not automatically be added to the Research Guides page.

New groups should not be created without consultation.

Guide Subjects

Guide subjects should reference the course the guide is being used for. Multiple subjects can be assigned to a guide.

The guide subject is displayed in the header of each guide.

Subject name changes and new subjects have to be added through the admin interface.

Guide Tags

Guide tags are mostly hidden metadata that can be added for search purposes. There is no need to add keywords that are already used in the title or description as these areas are searched first.

Guide URL

Guide URL should be added to all guides in the following format:

library.scotch.wa.edu.au/learning-area/subject/year-level/name-of-guide

All spaces should be replaced with a dash.

eg. https://library.scotch.wa.edu.au/sciences/human-biology/year-11/altitude-training

Page URL

Individual pages should all have a friendly URL added. These will be added to the end of the guide url and should contain the page name.

All spaces should be replaced with a dash.

eg. library.scotch.wa.edu.au/sciences/human-biology/year-11/altitude-training/studies

Guide Metadata

Custom metadata is added to all guides for details that do not have an inbuilt area.

To add metadata click the menu, then Guide Metadata, then Custom Metadata.

All metadata requires a Name and a Value and the public checkbox must be selected for it to work.

The Name should always be lowercase with all spaces replaced by a dash.

Year Level

To add a year level add the following custom metadata:

Name: year

Value: year-level (eg. "11")

Banner Image

To add a banner image to your guide add the following custom metadata:

Name: banner

Value: image-source (eg. "https://libapps.s3.amazonaws.com/accounts/4781/images/littlepipers-colour.png")

Banner Attribution

To add attribution for your banner image to your guide add the following custom metadata:

Name: "attribution-by"

Value: Name of person or site (eg. "Vincent van Gogh")

You can also add some additional metadata to link the name you provided above to a source.

Name: "attribution-url"

Value: url-source (eg. "www.google.com")

You can have the attribution without a link but can not have the reverse (link but not title).

Look & Feel

Guide Templates

The way your guide looks is dependent on the type of guide you are creating. All standard research guides that are attached to a learning area will automatically get the "Top-Nav" template.

If the guide you are creating is for a different purpose you can select from a couple of different templates:

  1. "Guide - Top-Nav"
  2. "Guide - Side Nav"

All other templates should not be used are they are purpose built templates and may not have all the functionality of the standard themes.

Pages

You should aim to have no more than 3-4 pages. Stats drop off considerably the more pages you have so you may need to find the most efficient way to structure your content.

Pages should be based on a different concept per page, not on a resource type. Stats suggest that pages on a resource type (eg. "Books") are very rarely visited.

Columns

Column structure is entirely the authors choice, but the way guides are set out plays a bit part in the readability and hierarchy of the information on the guide.

The most efficient layout is a 2 column 75/25 split. This gives you one column for all you main content and a smaller side column for additional content.

You should never have an empty column.

Guide Home Page

All guides created must have an introduction to the content and guide.

Definitions and thesaurus of terms.

Links to Content

All links are required to be leveled, have an icon and description/abstract.

Pasting from External Source

There is no longer a paste button in LibGuides so pasting has to done using keyboard shortcuts or your browser menus.

If you are pasting from Word or any external source you may need to remove existing formatting. You can do this by clicking the remove format button. You can check if any existing styling has been copied across by clicking the Source button.

Guide Assets

Guide Folder Shared Library

All assets will now be placed into a folder on the shared drive instead of into the Shared Folder within libguides. When you upload you will now place it into your personal folder in the libguide system as the original file will be in the folder on staff share.

  • If working from home then you will need to transfer these file in once you get back to school. I suggest you create a folder on your desktop first then transfer it back across when the guide is completed.
  • The folder location is staffshare/library/2016/libguides/TermX
  • In each term place your images in a folder NAMED the same as your guide you created. Also place the task sheet and any other assets into this folder.

Image File Name

lg_image-name

EXAMPLE: lg_africa-map.jpg

Image File Size

Banner images should be sized at 1920px x 400px to ensure visibility in all areas.

The points of interest should be in the middle 50% and they should not contain and words that may lose meaning if cut off.

You should aim for file size to be <200kb.

Image File Type

.jpg or .png

Document File Name

document-title.pdf

Linking

Embedding Content

Video Content - Widescreen (16:9)

<div class="embed-responsive embed-responsive-16by9">

    <iframe width="1280" height="720" src="https://www.youtube.com/embed/w81g199L8YA" frameborder="0" allowfullscreen></iframe>

</div>

Video Content - (4:3)

<div class="embed-responsive embed-responsive-4by3">

    <iframe width="1280" height="720" src="https://www.youtube.com/embed/w81g199L8YA" frameborder="0" allowfullscreen></iframe>

</div>

ClickView Videos

Browser Issues

Oliver Slider