Archiving content - nschonni/wet-boew GitHub Wiki

français

Table of Contents

Overview

Project lead: Stephane Berube (@berubs)

The Standard on Web Usability requires an archived content notice to clearly inform users that the Web page has been archived on the Web.

Description

The archiving approach helps users identify Web pages that have been archived online.

Working example of an archived Web page

Benefits

  • This approach has been usability tested with users.
  • Complies to Section 6.1.5 of the Standard on Web Usability.
  • Helps users identify identify that content is archived when coming to the site from a search engine by including the the word "ARCHIVED" in the page title (the h1 and <title> elements);
  • Broader use of this pattern across the Government of Canada will allow users to learn to identify archived content on any Government of Canada site.
  • Provides a link to the content that replaces this content, if there is any.
  • Helps users identify identify that content is archived when they arrive at an anchored link and not at the top of the page by including a progressive enhancement that indicates that the Web page is archived when the user scrolls the page.

Use When

This approach is mandatory for Government of Canada Web pages that have been archived online.

A Web page can be archived online if it is:

    • maintained for reference, research or recordkeeping purposes;
    • will not be altered or updated after the date of archiving; and
    • stored in a digital repository.
Examples include; a new policy that has replaced an old policy, older versions of reports, events that have happened in the past (such as conferences).

Do Not Use When

  • The Web page includes current content.
  • In place of removing redundant, outdated and trivial content (ROT).
  • As an excuse not to make Web pages compliant to the new Standard on Web Accessibility (WCAG 2.0).

Implementation

HTML pages

  1. Prepend "ARCHIVED - " / "ARCHIVÉE -" to the page title and the content area h1 element.
  2. Add the following code right after the content area h1 element (correcting the image path and grids classes as needed and replacing the opening message with text that is more relevant to the archived page):
English pages: 
<p><img src="../../build/js/images/archived/warning.gif" alt="Warning" title="Warning" class="margin-bottom-none" />The <a href="http://www.tbs-sct.gc.ca/pol/doc-eng.aspx?id=24227">Standard on Web Usability</a> replaces this content. This content is archived because Common Look and Feel 2.0 Standards have been rescinded.</p>
<div id="archived" class="wet-boew-archived span-8"><section>
<h2>Archived Content</h2>
<p>Information identified as archived is provided for reference, research or recordkeeping purposes. It is not subject to the Government of Canada Web Standards and has not been altered or updated since it was archived. Please contact us to request a format other than those available.</p>
</section></div>

French pages: 

<p><img src="../../build/js/images/archived/warning.gif" alt="Avertissement" title="Avertissement" class="margin-bottom-none" />La <a href="http://www.tbs-sct.gc.ca/pol/doc-fra.aspx?id=24227">Norme sur la facilité d'emploi des sites Web</a> remplace ce contenu. Cette page Web a été archivée parce que les Normes sur la normalisation des sites Internet 2.0 ont étés annulées.</p>
<div id="archived" class="wet-boew-archived span-8"><section>
<h2>Contenu archivé</h2>
<p>L’information dont il est indiqué qu’elle est archivée est fournie à des fins de référence, de recherche ou de tenue de documents. Elle n’est pas assujettie aux normes Web du gouvernement du Canada et elle n’a pas été modifiée ou mise à jour depuis son archivage. Pour obtenir cette information dans un autre format, veuillez communiquer avec nous.</p>
</section></div>

Non-HTML pages

For archived non-HTML pages, (e.g. PDFs), include the following:

  • An HTML-based interstitial page that uses this component (as described in the HTML pages section) and indicates the document that you are about to view has been archived.
  • If you can modify the non-HTML document, also include the following:
    • Archived notification box;
    • "ARCHIVED" in the title; and,
    • ARCHIVED in the link.

Examples

Development

The code for archiving content is located in several places within the source folder of WET:

Known Issues

Version History

Related documentation

⚠️ **GitHub.com Fallback** ⚠️