From 73b72d2524d4e19515aa613f394c05491c513181 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marc-Andr=C3=A9=20Garneau?= Date: Thu, 2 Nov 2023 13:49:46 -0400 Subject: [PATCH] Date modified: Adding date modified site functionality documentation --- _data/design-patterns.json | 1 + _data/sites.json | 96 +++++++++++++------ _data/wet-boew.json | 2 +- sites/date-modified/date-modified-en.html | 53 ++++++++++ sites/date-modified/date-modified-fr.html | 55 +++++++++++ .../date-modified/includes/date-modified.html | 4 + sites/date-modified/index.json-ld | 34 +++++++ sites/page-details/_base.scss | 23 ----- sites/page-details/includes/footer.html | 5 +- 9 files changed, 214 insertions(+), 59 deletions(-) create mode 100644 _data/design-patterns.json create mode 100644 sites/date-modified/date-modified-en.html create mode 100644 sites/date-modified/date-modified-fr.html create mode 100644 sites/date-modified/includes/date-modified.html create mode 100644 sites/date-modified/index.json-ld diff --git a/_data/design-patterns.json b/_data/design-patterns.json new file mode 100644 index 0000000000..fe51488c70 --- /dev/null +++ b/_data/design-patterns.json @@ -0,0 +1 @@ +[] diff --git a/_data/sites.json b/_data/sites.json index 90efd68f63..1368a926c9 100644 --- a/_data/sites.json +++ b/_data/sites.json @@ -172,6 +172,40 @@ ] } } +,{ + "@context": { + "@version": 1.1, + "dct": "http://purl.org/dc/terms/", + "title": { "@id": "dct:title", "@container": "@language" }, + "description": { "@id": "dct:description", "@container": "@language" }, + "modified": "dct:modified" + }, + "title": { + "en": "Date modified", + "fr": "Date de modification" + }, + "description": { + "en": "Indicates the date on which the current page was last modified.", + "fr": "Indique la date à laquelle la page courante a été modifiée pour la dernière fois." + }, + "modified": "2023-11-02", + "componentName": "date-modified", + "status": "stable", + "pages": { + "docs": [ + { + "title": "Date modified", + "language": "en", + "path": "date-modified-en.html" + }, + { + "title": "Date de modification", + "language": "fr", + "path": "date-modified-fr.html" + } + ] + } +} ,{ "@context": { "@version": 2.0, @@ -508,20 +542,20 @@ "fr": "Standard (wet-boew)" }, "introduction": { - "en": "This implementation is meant for developers/publishers adding the component manually with using the latest GCWeb version along with at least the implementation of the page details version 2.x.", - "fr": "Cette implémentation est destinée aux développeurs/éditeurs qui ajoutent le composant manuellement en utilisant une version récente de GCWeb avec l'implémentation de la version 2.x du détails de la page." + "en": "This implementation is meant for developers/publishers adding the component manually while using the latest version of GCWeb along with the implementation of the page details version 2.0 and above.", + "fr": "Cette implémentation est destinée aux développeurs/éditeurs qui ajoutent le composant manuellement en utilisant la dernière version de GCWeb avec l'implémentation de la version 2.0 ou plus du détails de la page." }, "instructions": { "en": [ - "Ensure the version of GCWeb v13.9.0 or earlier is implemented", - "Ensure the latest version of page details is implemented", - "To show the page feedback form, create a <div class=\"wb-disable-allow\"> with the following data attributes:", + "Ensure the version of GCWeb v13.9.0 or earlier is implemented.", + "Ensure the latest version of the page details is implemented.", + "To show the page feedback form, create a <div class=\"wb-disable-allow\"> with the following data attributes:", "Additionally, your page needs to have the following metadata: <meta name=\"dcterms.creator\" content=\"[Department name]\">" ], "fr": [ - "Vérifier qu'une version récente de GCWeb (v13.9.0 ou plus récent) est implémenté", - "Vérifier que la version 2.1, ou plus récente, du détails de la page est implémenté", - "Pour afficher le formulaire de rétroaction sur la page, créez un <div class=\"wb-disable-allow\"> avec les attributs suivants :", + "Vérifier que la version v13.9.0 ou plus récente de GCWeb est implémentée.", + "Vérifier que la version 2.1, ou plus récente, du détails de la page est implémentée.", + "Pour afficher le formulaire de rétroaction sur la page, créez un <div class=\"wb-disable-allow\"> avec les attributs suivants :", "De plus, vous pouvez définir les métadonnées suivantes : <meta name=\"dcterms.creator\" content=\"[Department name]\">" ] }, @@ -540,7 +574,7 @@ { "@type": "source-code", "description": "Code sample:", - "code": "<div class=\"wb-disable-allow\" \ndata-ajax-replace=\"assets/page-feedback-en.html\" \ndata-feedback-section=\"[Text defining the section where your page resides]\" \ndata-feedback-theme=\"[Text defining the theme of your page]\"></div>" + "code": "<div class=\"wb-disable-allow\" \ndata-ajax-replace=\"https://www.canada.ca/etc/designs/canada/wet-boew/assets/feedback/page-feedback-en.html\" \ndata-feedback-section=\"[Text defining the section where your page resides]\" \ndata-feedback-theme=\"[Text defining the theme of your page]\"></div>" }, { "@type": "source-code", @@ -556,7 +590,7 @@ { "@type": "source-code", "description": "Exemple de code :", - "code": "<div class=\"wb-disable-allow\" \ndata-ajax-replace=\"assets/page-feedback-fr.html\" \ndata-feedback-section=\"[Texte définissant la section où réside votre page]\" \ndata-feedback-theme=\"[Texte définissant le thème de votre page]\"></div>" + "code": "<div class=\"wb-disable-allow\" \ndata-ajax-replace=\"https://www.canada.ca/etc/designs/canada/wet-boew/assets/feedback/page-feedback-fr.html\" \ndata-feedback-section=\"[Texte définissant la section où réside votre page]\" \ndata-feedback-theme=\"[Texte définissant le thème de votre page]\"></div>" }, { "@type": "source-code", @@ -638,21 +672,21 @@ "fr": "Utilisateur SWG" }, "introduction": { - "en": "For users that are authoring web page on Canada.ca Managed Web Services.", - "fr": "Pour les utilisateurs qui font de l'édition de page web sur Canada.ca via le Service web géré." + "en": "For users that are authoring Web pages on Canada.ca Managed Web Services.", + "fr": "Pour les utilisateurs qui font de l'édition de pages Web sur Canada.ca via le Service Web géré." }, "instructions": { "en": [ - "Read the design system guidance before to adding the page feedback tool on your pages.", + "Read the design system guidance before adding the Page feedback tool on your pages.", "If you are configuring the section, please follow the additional design system guidance.", - "You can configure the page feedback tool via the page properties by specifying the optional configuration (contact info and section). The value for the theme configuration are automatically set by the MWS.", - "For additional guidance on how to implements, you can consult the guide on GCPedia along with the other documentation for the managed web service." + "You can configure the Page feedback tool via the page properties by adjusting the optional configurations (contact info and section). The value for the theme configuration is automatically set by MWS.", + "For additional guidance on how to implement the Page feedback tool, you can consult the guide on GCPedia along with the other documentation for MWS." ], "fr": [ - "Veuillez lire les consignes du système de conception avant d'ajouter l'outil de rétroaction sur la page à vos pages.", + "Veuillez lire les consignes du système de conception avant d'ajouter l'Outil de rétroaction sur la page à vos pages.", "Si vous configurez la section, veuillez suivre les consignes supplémentaires du système de conception.", - "Vous pouvez configurer l'outil de rétroaction sur la page via les propriétés de la page en spécifiant la configuration facultative (informations de contact et section). Les valeurs de la configuration du thème sont automatiquement définies par le SWG.", - "Pour des conseils supplémentaires sur la mise en œuvre, vous pouvez consulter le guide sur GCPedia avec les autres documents du service web géré." + "Vous pouvez configurer l'Outil de rétroaction sur la page via les propriétés de la page en ajustant les configurations facultative (informations de contact et section). Les valeurs de la configuration du thème sont automatiquement définies par le SWG.", + "Pour des conseils supplémentaires sur la mise en œuvre de l'Outil de rétroaction sur la page, vous pouvez consulter le guide sur GCPedia avec les autres documents du SWG." ] } }, @@ -660,24 +694,24 @@ "@id": "_:implement_pft_contact", "iteration": "_:iteration_pft_1", "name": { - "en": "Standard (wet-boew)", - "fr": "Standard (wet-boew)" + "en": "Standard (WET-BOEW)", + "fr": "Standard (WET-BOEW)" }, "introduction": { - "en": "This implementation is meant for developers/publishers adding the component manually with using the latest GCWeb version along with at least the implementation of the page details version 2.x.", - "fr": "Cette implémentation est destinée aux développeurs/éditeurs qui ajoutent le composant manuellement en utilisant une version récente de GCWeb avec l'implémentation de la version 2.x du détails de la page." - }, + "en": "This implementation is meant for developers/publishers adding the component manually while using the latest version of GCWeb along with the implementation of the page details version 2.0 and above.", + "fr": "Cette implémentation est destinée aux développeurs/éditeurs qui ajoutent le composant manuellement en utilisant la dernière version de GCWeb avec l'implémentation de la version 2.0 ou plus du détails de la page." + }, "instructions": { "en": [ "Ensure the version of GCWeb v13.9.0 or earlier is implemented", "Ensure the latest version of page details is implemented", - "To show the page feedback form, create a <div class=\"wb-disable-allow\"> with the following data attributes:", + "To show the page feedback form, create a <div class=\"wb-disable-allow\"> with the following data attributes:", "Additionally, your page needs to have the following metadata: <meta name=\"dcterms.creator\" content=\"[Department name]\">" ], "fr": [ - "Vérifier qu'une version récente de GCWeb (v13.9.0 ou plus récent) est implémenté", - "Vérifier que la version 2.1, ou plus récente, du détails de la page est implémenté", - "Pour afficher le formulaire de rétroaction sur la page, créez un <div class=\"wb-disable-allow\"> avec les attributs suivants :", + "Vérifier que la version v13.9.0 ou plus récente de GCWeb est implémentée.", + "Vérifier que la version 2.1, ou plus récente, du détails de la page est implémentée.", + "Pour afficher le formulaire de rétroaction sur la page, créez un <div class=\"wb-disable-allow\"> avec les attributs suivants :", "De plus, vous pouvez définir les métadonnées suivantes : <meta name=\"dcterms.creator\" content=\"[Department name]\">" ] }, @@ -696,7 +730,7 @@ { "@type": "source-code", "description": "Code sample:", - "code": "<div class=\"wb-disable-allow\" \ndata-ajax-replace=\"assets/page-feedback-en.html\" \ndata-feedback-section=\"[Text defining the section where your page resides]\" \ndata-feedback-theme=\"[Text defining the theme of your page]\" \ndata-feedback-link=\"[Contact link text]\" \ndata-feedback-url=\"[Contact link URL]\"></div>" + "code": "<div class=\"wb-disable-allow\" \ndata-ajax-replace=\"https://www.canada.ca/etc/designs/canada/wet-boew/assets/feedback/page-feedback-en.html\" \ndata-feedback-section=\"[Text defining the section where your page resides]\" \ndata-feedback-theme=\"[Text defining the theme of your page]\" \ndata-feedback-link=\"[Contact link text]\" \ndata-feedback-url=\"[Contact link URL]\"></div>" }, { "@type": "source-code", @@ -712,7 +746,7 @@ { "@type": "source-code", "description": "Exemple de code :", - "code": "<div class=\"wb-disable-allow\" \ndata-ajax-replace=\"assets/page-feedback-fr.html\" \ndata-feedback-section=\"[Texte définissant la section où réside votre page]\" \ndata-feedback-theme=\"[Texte définissant le thème de votre page]\" \ndata-feedback-link=\"[Texte du lien de contact]\" \ndata-feedback-url=\"[URL du lien de contact]\"></div>" + "code": "<div class=\"wb-disable-allow\" \ndata-ajax-replace=\"https://www.canada.ca/etc/designs/canada/wet-boew/assets/feedback/page-feedback-fr.html\" \ndata-feedback-section=\"[Texte définissant la section où réside votre page]\" \ndata-feedback-theme=\"[Texte définissant le thème de votre page]\" \ndata-feedback-link=\"[Texte du lien de contact]\" \ndata-feedback-url=\"[URL du lien de contact]\"></div>" }, { "@type": "source-code", @@ -1004,7 +1038,7 @@ "name": "Page feedback tool with AJAX", "status": "stable", "baseOnIteration": "_:iteration_pft_1", - "detectableBy": "
", + "detectableBy": ".pagedetails .wb-disable-allow[data-ajax-replace*=feedback]", "layout": [ "At the top-left column in the page details component", "When user selects \"No\", a form with a textarea appears" @@ -2139,7 +2173,7 @@ "include": { "@type": "source-code", "collapsed": true, - "description": "Include with logic in Handlebars.", + "description": "Include with logic in Liquid.", "code": { "@type": [ "@id", "rdf:HTML" ], "@value": "includes/footer.html" diff --git a/_data/wet-boew.json b/_data/wet-boew.json index f481b5a74d..e7084716b3 100644 --- a/_data/wet-boew.json +++ b/_data/wet-boew.json @@ -92,4 +92,4 @@ ] } } -] \ No newline at end of file +] diff --git a/sites/date-modified/date-modified-en.html b/sites/date-modified/date-modified-en.html new file mode 100644 index 0000000000..ed05d7d888 --- /dev/null +++ b/sites/date-modified/date-modified-en.html @@ -0,0 +1,53 @@ +--- +{ + "altLangPage": "date-modified-fr.html", + "breadcrumbs": [ + { "title": "GCWeb home", "link": "https://wet-boew.github.io/GCWeb/index-en.html" } + ], + "dateModified": "2023-11-02", + "description": "Documentation on how to use the date modified.", + "language": "en", + "title": "Date modified" +} +--- +
+ +
+
Status
+
Stable
+
Version
+
1.0.0
+
Type
+
Canada.ca site functionality
+
+ +

Introduction

+ +

Purpose

+

Use the date modified component to provide a person with the date that the content was last updated.

+ +

Evaluation and report

+

There is no evaluation and report available for this component.

+ +

Guidance

+ + +

Variants

+

This component supports only 1 variant:

+ + +

Date modified (default)

+ +

Iteration 1

+

Code:

+
<dl id="wb-dtmd">
+	<dt>Date modified:</dt>
+	<dd><time property="dateModified">YYYY-MM-DD</time></dd>
+</dl>
+ +

Working example(s)

+

Refer to the date modified at the bottom of this page.

diff --git a/sites/date-modified/date-modified-fr.html b/sites/date-modified/date-modified-fr.html new file mode 100644 index 0000000000..403d6798a2 --- /dev/null +++ b/sites/date-modified/date-modified-fr.html @@ -0,0 +1,55 @@ +--- +{ + "altLangPage": "date-modified-en.html", + "breadcrumbs": [ + { "title": "GCWeb accueil", "link": "https://wet-boew.github.io/GCWeb/index-fr.html" }, + { "title": "Méli-mélo", "link": "https://wet-boew.github.io/GCWeb/méli-mélo/méli-mélo-fr.html" } + + ], + "dateModified": "2023-11-02", + "description": "Documentation sur l'utilisation de la date de modification.", + "language": "fr", + "title": "Date de modification" +} +--- +
+ +
+
Statut
+
Stable
+
Version
+
1.0.0
+
Type
+
Fonctionnalité globale de site de Canada.ca
+
+ +

Introduction

+ +

Objectif

+

Utilisez la composante « Date de modification » pour fournir à aux gens la date où le contenu a été mis à jour en dernier.

+ +

Évaluation et rapport

+

Il n'y a pas d'évaluation ni de rapport disponible pour cette composante.

+ +

Orientation

+ + +

Variantes

+

Ce composant prend en charge 1 variante:

+ + +

Date de modification (par défaut)

+ +

Itération 1

+

Code:

+
<dl id="wb-dtmd">
+	<dt>Date de modification :</dt>
+	<dd><time property="dateModified">AAAA-MM-JJ</time></dd>
+</dl>
+ +

Exemple(s) pratique(s)

+

Veuillez vous référer à la date de modification au bas de cette page.

diff --git a/sites/date-modified/includes/date-modified.html b/sites/date-modified/includes/date-modified.html new file mode 100644 index 0000000000..3b5a0837bc --- /dev/null +++ b/sites/date-modified/includes/date-modified.html @@ -0,0 +1,4 @@ +
+
{{ i18nText-dateModified }}
+
+
diff --git a/sites/date-modified/index.json-ld b/sites/date-modified/index.json-ld new file mode 100644 index 0000000000..fa36436f92 --- /dev/null +++ b/sites/date-modified/index.json-ld @@ -0,0 +1,34 @@ +{ + "@context": { + "@version": 1.1, + "dct": "http://purl.org/dc/terms/", + "title": { "@id": "dct:title", "@container": "@language" }, + "description": { "@id": "dct:description", "@container": "@language" }, + "modified": "dct:modified" + }, + "title": { + "en": "Date modified", + "fr": "Date de modification" + }, + "description": { + "en": "Indicates the date on which the current page was last modified.", + "fr": "Indique la date à laquelle la page courante a été modifiée pour la dernière fois." + }, + "modified": "2023-11-02", + "componentName": "date-modified", + "status": "stable", + "pages": { + "docs": [ + { + "title": "Date modified", + "language": "en", + "path": "date-modified-en.html" + }, + { + "title": "Date de modification", + "language": "fr", + "path": "date-modified-fr.html" + } + ] + } +} diff --git a/sites/page-details/_base.scss b/sites/page-details/_base.scss index f1029d6985..6f76f8826b 100644 --- a/sites/page-details/_base.scss +++ b/sites/page-details/_base.scss @@ -38,17 +38,6 @@ main { padding-bottom: 2em; padding-top: 2em; - // Needed for backwards compatibility with GCWeb 4.0.26 and below's HTML markup. Remove in GCWeb 4.1+. - &.row { - details { - margin: { - bottom: .25em; - left: 1.1em; - right: 1.1em; - } - } - } - // Add a top margin to the report a problem link/summary. .row { div { @@ -64,18 +53,6 @@ main { } } - // Needed for backwards compatibility with GCWeb 4.0.26 and below's HTML markup. Remove in GCWeb 4.1+. - .datemod { - padding: { - bottom: 7px; - top: 7px; - } - - #wb-dtmd { - margin-top: 0; - } - } - details { margin-bottom: 0; diff --git a/sites/page-details/includes/footer.html b/sites/page-details/includes/footer.html index 8306efd3c1..7da8e14115 100644 --- a/sites/page-details/includes/footer.html +++ b/sites/page-details/includes/footer.html @@ -24,10 +24,7 @@

{{ i18nText-pageDetails }}

{%- endif -%}
-
-
{{ i18nText-dateModified }}
-
-
+ {%- include date-modified/date-modified.html -%}