Getting Started

When developing a website or web application you need to include the style guide artefacts into your project. The artefcts include all the CSS, JavaScript, images and fonts which are required in order to use any of the components found within the University of Adelaide style guide.

There are two options available to include these artefacts into your project. You can either download and embed the artefacts directly into your project, or reference the artefacts from the University of Adelaide web server.

To download the artefacts directory, visit the style guide theme repository.

To reference the artefacts on the University of Adelaide web server, use the following artefacts path: //global.adelaide.edu.au/ua_theme/v_x.x/

University of Adelaide web server artefacts path explained:

The end of the path is a version directory /v_x.x/ which directly relates to the release tags of the style guide artefacts. To determine which version of style guide you require you can visit the style guide theme repository release tags. It is recommended that you reference the most recent release tag.

You will notice that the version folder does not include the patch version number. This is because the University of Adelaide web server version directories are sym linking to the most recent patch folder. For example, v_1.2 is sym linked to v_1.2.1. It is recommended that you do not include the patch tag number in your version directory path to ensure that you get any future bug fixes that are released to that minor release version. For example, you would use /v_1.2/css instead of /v_1.2.1/css.

For more information about version release tag numbers you can visit http://semver.org/.

Within this artefacts path on the web server the exact same folder structure exists as seen in the style guide theme repository. This is because it is cloned from this repository into the University of Adelaide web server, into its respective version folder, ie, /v_1.2/css/, /v_1.2/js/, etc.

Features within each release tag:

To determine which style guide features have been implemented within each release tag, you can review the style guide changelog.

Updating to a later version of style guide:

When updating from a release tag to a later version in order to include new features into your project, you will need to review any breaking changes that may have occurred between releases by reviewing the style guide markup changelog.

What to include:

When referencing the artefacts from the University of Adelaide web server, the minimum required CSS and JavaScript references are seen in the demo below. The footer-global.js is required in order to dynamically load the footer, as seen in the simple global footer section of the style guide.

If you require the production JavaScript from the style guide artefacts but you do not need jQuery, we have built a version of the production JavaScript which does not have jQuery included: /js/production/production-nojquery.min.js