Skip to Main Content

Libguide Libguide: Style guide

General

We aim for consistent a 'look and feel' in our LibGuides, particularly within guides of the same type. Using templates, mapped boxes, and assets will help achieve this. For more information about selecting the right guide type or the quality assurance process, see LibGuide creation and publication procedures.

There are many resources to assist with preparing content

Friendly URLs

Friendly URL’s are easy for users to remember, are more meaningful than randomised URLs and provide additional clues for site navigation.

  • Use hyphens instead of spaces
  • Match the terms in the URL to the title of the page
  • In RSGs, make sure the subject code is in the main URL
  • Write the subject code in upper case, but all other words/letters without capitalisation
  • You can breadcrumb the URLs for different pages, matching the terms in the URL to the title of the page
    e.g. If the title of the page is Finish, use that term in the friendly-URL: /ABC100/finish

Spelling and grammar

Across our guides we follow the Macquarie dictionary for spelling and grammar. 

Tone of voice

Charles Sturt is placing increasing emphasis on maintaining an appropriate "tone of voice" in communications with stakeholders.

  • Watch the Tone of Voice video presentation by Sandra Sharpham from the Division of Marketing (13 min)
  • Review the Charles Sturt University Brand Guidelines, specifically Section 2 on Tone of voice (pp. 12 - 31)
  • Consult the cheat sheet and "Before and After" examples provided in the Brand Guidelines

Text formatting

You shouldn't need to change the font or size of the text in your LibGuides. To add structure, interest, and variety, you can use headings, bold, italics, bullet-points and tables.

See Accessibility Basics for information on font colours, headings, and formatting of hypertext links.

  • Use sentence case
  • Use default text size and color
  • Use bold, italics, and headings tags
  • Do not use underlining or color font
  • Heading 1 and 2 are used for the page title and box title only
  • Use Heading 3 for headings in boxes, or customise with Heading 4 and Heading 5 as needed
  • Use clear link text that describes the destination page
  • Avoid using generic link text like "Click here" or "More info"
  • Avoid having two links with the same link-text but different URLs
  • Avoid having two links with the same URL but different link-text
  • Format lists correctly using the appropriate tags
  • Avoid using ampersands, instead use the word and
  • Avoid using shouting caps (excluding acronyms) or capitalisation of each word for headings of boxes. Use sentence case for consistency.

Images and tables

If you use tables or images to convey information, you must follow accessibility guidelines. See the page in this guide on Images, and the page on Alt-text

Tables

  • Use tables for layout or for data
  • Make tables as simple as possible for screen readers
  • Default tables in LibGuides must read from left to right
  • Data tables are used to convey information that cannot be conveyed in any other way

Images

  • Provide clear and meaningful alt text for images; be concise with alt-text and avoid including unnecessary phrases. Don’t include “picture of” or “image of” or “screenshot of”. Assistive technologies will read out “image” and then your alt text.
  • Provide alt-text for functional images that conveys the same information as the image
  • A filename is not acceptable alt-text
  • Not all images need alt text. Leave the alt-text box blank for decorative images in the Image editor in LibGuides
  • Image captions can replace alt-text if they provide the same meaningful information
  • Exception: If information is provided in the content, alt-text duplication is not necessary
  • Alt-text for images of charts can refer to the content that describes the chart
  • Alt-text for images of words should include the exact words in the image

Assets

For links

  • Hyperlink target windows set to open in the same window if it's a Charles Sturt University webpage
  • Hyperlink target windows set the link to open in a new window if it's an external wepbage
  • Select the display below option for displaying link descriptions

For ebook records 

  • Include the title in title case
  • Include the author/editor details in Surname, Initial. format. If more than two authors list first two et al.
  • Remove the ISBN if displaying
  • For the publication date, display only the year
  • For the URL, use the book's permalink as described in the Creating links to resources instructions. Do not use the Primo record link except for VitalSource ebook
     

For physical book records 

  • Include the title in title case
  • Include the author/editor details in Surname, Initial. format. If more than two authors list first two et al.
  • Remove the ISBN if displaying
  • For the publication date, display only the year
  • For the URL, use the Primo record permalink
  • For eReserve items, direct students to the Leganto list in the subject Interact 2 site

For embedded videos 

  • Assign a title element to the embed code that reflects the video content,do this in the embed code after iframe add Title="Name of video”
  • Only one video should be visible at a time
  • When using hyperlinks, it should be set to new window target
  • Ensure the ordering of content makes sense, and consider if chapter titles are required and meet student needs
  • The title of the video should be descriptive of the content
  • Watch the video below for instructions on adding the title and adjusting the video widget size in your LibGuide

Research Skills Guides

Research Skills Guides aim for a consistent feel, look and tone. AA RSG 1 Page Template is for Research Skills Guides. Customisations can be made to the template, including the addition of boxes, assets, text and/or extra sections. The template also contains optional boxes that can be selectively added or removed, and these are currently hidden or in draft mode.

Follow our RSG 1 pager instructions to understand each step from guide creation, the QA process, and library guide publication. 

  • Publication status: unpublished or private during draft, published for student access.
  • Title is inclusive of the subject code.
  • Box titles are appropriate and accurate.
  • Spelling and grammar is consistent and in sentence case, CSU's are written as "Charles Sturt University".
  • Text/content within boxes all follows appropriate/sensible flow.
  • Link targets set appropriately: All Charles Sturt University sites and Libguides open in the same window. If navigating away from our Charles Sturt University pages, it opens in a new target window.
  • For embedded videos, only one should be visible at a time. If presented as a hyperlink, it should be set to new target window.
    Embed codes include the appropriate "title" elements, and content order makes sense, e.g. chapter titles within the video.
  • Mapped boxes should not require any editing such as contact us, feedback or reading writing and referencing.

Library Resource Guides

Library Resource Guides compile recommended library and web resources, tailored to specific subjects and disciplines. AA LRG 1p Template is used for Library Resource Guides. It features designated boxes where you can easily add content and assets. You can also customise the guide by adding additional boxes, e.g. Grey literature resources. 

  • Publication status: unpublished or private during draft, published for student access.
  • Title reflects the subject/discipline.
  • Friendly URL reflects the title.
  • Spelling and grammar is consistent and in sentence case, CSU's are written as "Charles Sturt University".
  • Text/content within boxes all follows appropriate/sensible flow.
  • Link targets set appropriately: All Charles Sturt University sites open in the same window. If navigating away from our Charles Sturt University pages, it opens in a new target window.
  • Use the Creating links to resources instructions to create permalinks to resources. 
  • Mapped boxes should not require any editing such as contact us and quicklinks. 

General Library Guides

General Library guides are used to provide more detailed content and information that does not fit into the other library guide types or our website. In general they have a left-hand navigation bar and follow the same style rules mentioned above. 

If you intend on creating a General library guide, please consult with the relevant Service Manager and the LibGuides Advisory Working Group.
Learn more about Libguide creation and publication procedures.

Charles Sturt University acknowledges the traditional custodians of the lands on which its campuses are located, paying respect to Elders, both past and present, and extend that respect to all First Nations Peoples.Acknowledgement of Country

Charles Sturt University is an Australian University, TEQSA Provider Identification: PRV12018. CRICOS Provider: 00005F.