Cover Page Heading 1
Build Specification
Prepared for Australian Public Service Commission
CONFIDENTIAL – DO NOT DISTRIBUTE
© Squiz Pty Ltd 2011. This document is for use with Australian Public Service Commission only.
Contents Page
1 Version History 4
1.1 Reviewers 4
2 Introduction 5
2.1 Purpose 5
2.2 Scope 5
2.3 Out of Scope 5
2.4 Audience 5
2.5 Approach 5
2.6 Assumptions 5
2.7 Related Documentation 5
2.8 Glossary of terms 6
3 Global Header and Footer Elements 7
3.1 Wireframe 7
3.2 Functionality 7
3.3 Build Specification 8
4 Home page elements 10
4.1 Wireframe 10
4.2 Functionality 10
4.3 Build specification 11
5 Level 1 Landing Page 14
5.1 Wireframe 14
5.2 Functionality 14
5.3 Build specification 15
6 Sub-page L2 – L3 elements 16
6.1 Wireframe 16
6.2 Functionality 17
6.3 Build specification 17
7 Publications search and listing 19
7.1 Wireframe 19
7.2 Functionality 19
7.3 Build specification 20
8 Circulars and advices search and elements 22
8.1 Wireframe 22
8.2 Functionality 22
8.3 Build specification 23
9 Appendix A – Metadata Schemas 25
9.1 AGLS Global Schema 25
9.2 General Metadata Schema 26
9.3 APSC Metadata Schema 26
9.4 APSC Tagging Schema 27
10 Appendix B - Users & Groups 29
10.1 User Group Details 29
10.2 User Groups Asset Map Configuration 29
10.3 WYSIWYG Plugins Preferences 30
11 Permissions 32
11.1 Implementation Strategy 34
12 Appendix B – Accessibility and Browser Requirements 35
APSC-BuildSpecification-v0_4.docxAPSC-BuildSpecification-v0_4CONFIDENTIAL – DO NOT DISTRIBUTE / 24 of 24
1 Version History
Version / Date / Author/Editor / Title / Organisation / Notes /0.1 / 14/12/2011 / Libby Heasman / Technical Business Analyst / Squiz / Initial Version
0.2 / 10/01/2012 / Libby Heasman / Technical Business Analyst / Squiz / Changes made after receiving mockups
0.3 / 30/01/92012 / Libby Heasman / Technical Business Analyst / Squiz / Changes from meeting on 25/01/2012
0.4 / 15/2/2011 / Libby Heasman / Technical Business Analyst / Squiz / Changes from the meeting on the 10/2/2012
1.1 Reviewers
Name / Title / Organisation /Bruce Hargrave / Project Manager / Squiz
Andrew Glenn / Internet Manager / Australian Public Service Commission
2 Introduction
2.1 Purpose
This document outlines the build specification for each functional component to be implemented for the APSC website implementation to Squiz Matrix.
2.2 Scope
The scope of this document is confined to defining the APSC website requirements:
· Functional components to be implemented
· Underlying Squiz Matrix tools and features that will be used to provide the specified functionality
2.3 Out of Scope
The following items are deemed out of scope for this document
·
2.4 Audience
This document has been written for the Australian Public Service Commission and assumes readers are familiar with basic Squiz Matrix concepts and tools.
2.5 Approach
The Build Specification was written following discussions of business requirements, website requirements analysis workshops and the development of a functional specification; these have been the basis for the specification.
2.6 Assumptions
The following assumptions were made by Squiz in preparing this document:
ID / Description /1. / The business requirements have been defined and are correct as of the 12th December 2011
2.7 Related Documentation
The below documents are complementary to this document and/or served as inputs:
ID / Description / Version / Creator1 / APSC Website Redesign Functional Specification / 1 / Libby Heasman
2.8 Glossary of terms
For more information see http://manuals.matrix.squizsuite.net/concepts
Term / Description /Asset / In Squiz Matrix, everything is an asset. Your websites, designs, pages, images and files are assets within the system. There are many different types of assets in Squiz Matrix; some common examples include Folder, Image, MS Excel Document, PDF file, Standard Page, Asset listing
Backend / Generic term used to describe the administration interface
CMS / Content management system (Squiz Matrix)
Design area / Dynamically handled area of the design template, for example: Breadcrumbs, Menu, Re-usable content and layouts, CSS.
Customisation / A Design Customisation allows you to configure the settings for the design areas, without the need to create a separate Design asset. Customisations are essentially variations on a theme
Static HTML / HTML (HyperText Markup Language) content that is not required to be generated dynamically
Ajax / Asynchronous JavaScript and XML – Term given when JavaScript is used to communicate with the server to retrieve information.
Nested content / Asset re-used by including it in the content of another asset.
Squiz / Previous branding name for Squiz Matrix. Some remnants of this naming still remain in the system, particularly when referring to design area tags.
Markup / Short hand way of referring to HTML
CSS / Cascading Style Sheet – The technology used to define the look and feel of the HTML
Body copy / A dependent Matrix asset that holds HTML content
Hyperlink / Reference to a page, or asset that the browser can directly follow
RSS / Really Simple Syndication – a format of XML used to produce a web feed in a standardised format.
Trigger / An asset type in Matrix that can respond to events occurring within the system and perform actions.
CSS / CSS stands for Cascading Style Sheets. CSS is designed primarily to enable the separation of document content from document presentation, including elements such as the layout, colours, and fonts
APSC-BuildSpecification-v0_4.docxAPSC-BuildSpecification-v0_4
CONFIDENTIAL – DO NOT DISTRIBUTE / 24 of 24
3 Global Header and Footer Elements
3.1 Wireframe
3.2 Functionality
ID / Element / Description /G1 / Australian Government Logo / Australian Government Logo positioned as per the Australian Government requirements.
G2 / Graphic and mission / Welcoming graphic representative of the people of the Australian Public Service. A short description of the APSC to summarise their mission.
G3 / RSS / Subscribe using RSS. This RSS button will link to an RSS page to allow users to either subscribe to RSS feeds they are interested in or subscribe to all feeds from the site.
G4 / Talk with us/collaborate / Talk with us link. This link navigates the user to a collaboration landing page. If they are available, this page will contain further links to individual blogs and surveys through an asset listing of child pages. The collaboration landing page will use the L1 inside page design.
G5 / Global header links / Quick links to key pages. These links serve as a quick jump to the Home, Contact Us and About Us page from anywhere in the site.
G6 / Search / This search box will search the entire site by keywords entered.
G7 / Global footer links / Footer links. The footer will contain links to Privacy, Copyright, Freedom of Information and the Information Publication Scheme and the Sitemap
(IDs match those referenced in the wireframe)
3.3 Build Specification
The global header and footer will be made up of the following Squiz Matrix Assets:
Squiz Matrix Asset / Functionality /Nested standard page asset / · To create global links, search form and RSS link, Talk to us link and footer links /
Section images / · A selection of images that will display one randomly on page load /
Search page / · Single keyword search which will be used by the nested standard page asset /
3.3.1 Australian Government logo
Logo will to be included in the design parse file with a link to the site URL.
3.3.2 Graphic and mission
The graphic change will involve changing the banner on page load. The banner will be the width of the page and will include the image of the APSC employee and the banner will be selected at random using JavaScript. The rest of the text will be added through the design parse files except the employee’s role and section text. The role and section text will be an empty span tag that will be populated using some JSON mapping that will load the correct text for the banner that loads.
3.3.3 RSS/Talk with us links
These links will be built as a single nest content area in the design parse file. This will nest a standard page asset that has a presentation and content type of raw HTML.
3.3.4 RSS subscription page
The RSS subscription page will allow interested users to subscribe to page changes for specific areas of the site. The RSS Feed will be made up of the following asset:
· Asset Listing Page – To create a list of all standard pages in the document site. This will created using a structured root node selector for each topic area of the site.
· RSS Feed – To list out the results of the Asset Listing Page.
3.3.5 Global header links
These links will be built as a single nest content area in the design parse file. This will nest a standard page asset that has a presentation and content type of raw HTML.
3.3.6 Search
Search to be included as a nested design area, nesting a standard page asset with a content type and presentation of raw HTML. A search page setup to perform a single keyword search will be referenced by the search form.
3.3.7 Global footer links
These links will be built as a single nest content area in the design parse file. This will nest a standard page asset that has a presentation and content type of raw HTML.
4 Home page elements
4.1 Wireframe
4.2 Functionality
ID / Element / Description /H1 / Navigation menu / This will provide links to the top-level assets under the site asset.
H2 / Latest news list / This box will display the last 5 latest news items released. The first item on the list is the most recent news item and will be displayed in bold text. All remaining news items in the list will be in normal text. All news items will display
· the release date by day and month
· the title of the news item which is a link to the complete news article.
When a new news items is added it will become the first item in the list.
H3 / Current events list / This box will display the last 5 event news items. The first item on the list is the most recent event news item and will be displayed in bold text. All remaining event news items in the list will be in normal text. All event items will display
· the release date
· the title of the event news item
· a short description of the event
· a Read More link to be taken to the event page.
When a new event items is added it will become the first item in the list.
H4 / Current campaignPriorities box / This box will display the current campaignPrioritiess within the APS. The content of this box will be updated as necessary.
H5 / Navigate by topic / This box allows the user to navigate to a topic heading or key Level 1 or 2 pages.
Many of these topic headings will be type 2 links to L1 items such as the Merit protection commission. Type 2 links do not appear in the main menu
H6 / Navigate by audience / This box allows the user to navigate to an area of interest based on their role or objective in the site. Each of the topic headings links to a single Role page that offers predetermined areas of interest for that role. Each of the sub headings will link to Level 1 or Level 2 pages
Many of these topic headings will be type 2 links to L1 items. Type 2 links do not appear in the main menu
(IDs match those referenced in the wireframe)
4.3 Build specification
Squiz Matrix Asset / Functionality /Asset Listings / · To create the nested news, events, current campaignPriorities information /
Asset Listing / · To created the Information about section /
Search page / · To enable the Information for section /
Standard page / · To nest the search page. /
Standard page / · To create the links for each information for area /
4.3.1 Navigation menu
The menu will use the menu normal design area and display the top level only.
4.3.2 Latest news list
This will be built using an Asset Listing that with the following settings:
· Root node – the News section of the site that will store all news items
· Asset to list – news items
· Asset Access to List – effective read
· Assets per page – 3
· Asset sorting – sort by Published date descending.
The results need to display as an unordered list.
Default format bodycopy will contain:
· %asset_published^date_format:d-M% - %asset_name_linked%
CSS will be used to style the bullet image.
4.3.3 Current events list
This will be built using an Asset Listing that with the following settings:
· Root node – the Events section of the site which will be a folder storing all events as standard pages
· Asset to list – news items
· Asset Access to List – effective read
· Assets per page – 3
· Asset sorting – sort by Published date descending.
The results need to display as an unordered list.
Default format bodycopy will contain:
· %asset_published^date_format:d-M% - %asset_name_linked%
CSS will be used to style the bullet image.
4.3.4 Current campaignPriorities box
This will be built as a standard page with 3 items in an unordered list and will be updated as necessary. This will be included as a nested design area in the design parse file.
4.3.5 Navigate by topic
This will be built using an Asset Listing to list out the top-level pages of the site information architecture. The Asset Listing will be setup:
· Root node – site asset
· Asset to list – standard pages
· Asset Access to List – effective read
· Direct children only - yes
· Assets per page – 3
The Default Format Bodycopy will display the %asset_name_linked% keyword replacement.