\n"
+ }
+ ]
+ }
+ },
+ {
+ "@id": "_:implement_contributors_gcweb",
+ "iteration": "_:iteration_contributors_3",
+ "name": {
+ "en": "GCWeb Jekyll",
+ "fr": "GCWeb Jekyll"
+ },
+ "introduction": {
+ "en": "This implementation is meant for developers trying to implement this component within a GCWeb Jekyll site.",
+ "fr": "Cette implémentation est destinée aux développeurs essayant d'implémenter ce composant dans un site GCWeb Jekyll."
+ },
+ "instructions": {
+ "en": [
+ "To show the page's contributors, in the page's front-matter, set the property contributors to an array of objects containing the following properties: name and url."
+ ],
+ "fr": [
+ "Pour afficher les contributeurs de la page, dans l'en-tête de la page, définissez la propriété contributors à un tableau d'objets contenant les propriétés suivantes : name et url."
+ ]
+ },
+ "sample": {
+ "en": [
+ {
+ "@type": "source-code",
+ "description": "Code sample:",
+ "code": "\"contributors\": [\n\t{ \"name\": \"[Department or agency 1]\", \"url\": \"https://www.canada.ca/en\" },\n\t{ \"name\": \"[Department or agency 2]\", \"url\": \"https://www.canada.ca/en\" }\n]"
+ }
+ ],
+ "fr": [
+ {
+ "@type": "source-code",
+ "description": "Exemple de code:",
+ "code": "\"contributors\": [\n\t{ \"name\": \"[Ministère ou agence 1]\", \"url\": \"https://www.canada.ca/fr\" },\n\t{ \"name\": \"[Ministère ou agence 2]\", \"url\": \"https://www.canada.ca/fr\" }\n]"
+ }
+ ]
+ }
+ },
+ {
+ "@id": "_:implement_contributors_migrate_1_to_1.1",
+ "iteration": "_:iteration_contributors_3",
+ "name": {
+ "en": "Migrate from version 1 to 1.1",
+ "fr": "Migration de la version 1 à 1.1"
+ },
+ "introduction": {
+ "en": "This implementation is meant for developers or publishers trying to migrate their page from using the contributors version 1.0 to 1.1.",
+ "fr": "Cette implémentation est destinée aux développeurs ou aux éditeurs qui tentent de migrer leur composante contributeurs de la version 1.0 vers la version 1.1."
+ },
+ "instructions": {
+ "en": [
+ "Move the contributors component directly after the <h2 class=\"wb-inv\">Page details</h2> located inside the <section class=\"pagedetails\"> section.",
+ "Change the <h2>From:</h2> to an <h3>From:</h3>."
+ ],
+ "fr": [
+ "Déplacez la composante contributeurs directement après le <h2 class=\"wb-inv\">Détails de la page</h2> situé à l'intérieur de la section <section class=\"pagedetails\">.",
+ "Changez le <h2>De :</h2> à un <h3>De :</h3>."
+ ]
+ },
+ "notes": {
+ "en": [
+ "This version of the component must now be located inside the Page details component version 3.3."
+ ],
+ "fr": [
+ "Cette version de la composante doit être incluse dans la composante Détails de la page version 3.3."
+ ]
+ }
+ }
+ ],
+ "iteration": [
+ {
+ "@id": "_:iteration_contributors_3",
+ "name": "Contributors - Iteration 3",
+ "date": "2024-12",
+ "detectableBy": ".pagedetails .gc-contributors",
+ "breaking": [
+ "Changed context of use in the page. The component must be located in the page details section above the date modified component.",
+ "
\n"
+ }
+ ],
+ "successor": "_:iteration_contributors_2"
+ }
+ ],
+ "changesets": [
+ {
+ "@id": "_:cs_contributors",
+ "name": "Contributors - Version 1.1",
+ "status": "stable",
+ "baseOnIteration": "_:iteration_contributors_3",
+ "detectableBy": ".pagedetails .gc-contributors",
+ "layout": "Title and list are displayed inline on medium screens and up. They are displayed vertically on smaller screens.",
+ "semantic": "section>h3+ul>li*n>a",
+ "style": "The
font size is smaller. The links are bolded.",
+ "context": "Located in the page details section of the page above the date modified component.",
+ "static": [
+ "From:",
+ "De :"
+ ],
+ "schema": [
+ "Array of contributors objects",
+ "contributors object: contributor name, contributor link"
+ ]
+ },
+ {
+ "@id": "_:cs_contributors",
+ "name": "Contributors - Version 1",
+ "status": "demoted",
+ "baseOnIteration": "_:iteration_contributors_2",
+ "detectableBy": ".gc-contributors",
+ "layout": "Title and list are displayed inline on medium screens and up. They are displayed vertically on smaller screens.",
+ "semantic": "section>h2+ul>li*n>a",
+ "style": "The
font size is smaller. The links are bolded.",
+ "context": "Located within the main section of the page",
+ "static": [
+ "From:",
+ "De :"
+ ],
+ "schema": [
+ "Array of contributors objects",
+ "contributors object: contributor name, contributor link"
+ ],
+ "test": [
+ "Contributors version 1",
+ "Contributeurs version 1"
+ ]
+ }
+ ]
+}
,{
"@context": {
"@version": 2.0,
@@ -2640,8 +2936,8 @@
"en": "Documentation on how to use the page details section.",
"fr": "Documentation sur l'utilisation de la section des détails de la page."
},
- "version": "3.2",
- "modified": "2024-07-24",
+ "version": "3.3",
+ "modified": "2024-12-20",
"componentName": "page-details",
"componentType": "container",
"status": "stable",
@@ -2706,11 +3002,13 @@
"dependencies": {
"en": [
{ "title": "Feedback area", "url": "https://wet-boew.github.io/GCWeb/sites/feedback/feedback-docs-en.html", "component": "feedback" },
- { "title": "Date modified", "url": "https://wet-boew.github.io/GCWeb/sites/date-modified/date-modified-en.html", "component": "date-modified" }
+ { "title": "Date modified", "url": "https://wet-boew.github.io/GCWeb/sites/date-modified/date-modified-en.html", "component": "date-modified" },
+ { "title": "Contributors", "url": "https://wet-boew.github.io/GCWeb/sites/contributors/contributors-en.html", "component": "contributors" }
],
"fr": [
{ "title": "Zone de rétroaction", "url": "https://wet-boew.github.io/GCWeb/sites/feedback/feedback-docs-fr.html", "component": "feedback" },
- { "title": "Date de modification", "url": "https://wet-boew.github.io/GCWeb/sites/date-modified/date-modified-fr.html", "component": "date-modified" }
+ { "title": "Date de modification", "url": "https://wet-boew.github.io/GCWeb/sites/date-modified/date-modified-fr.html", "component": "date-modified" },
+ { "title": "Contributeurs", "url": "https://wet-boew.github.io/GCWeb/sites/contributors/contributors-fr.html", "component": "contributors" }
]
},
"a11yGuidance": "no accessibility guidance",
@@ -2736,20 +3034,33 @@
"fr": { "href": "page-details-pft-fr.html", "text": "Détails de la page avec Outil de rétroaction sur la page" }
},
{
- "en": { "href": "deprecated/page-details-v3-en.html", "text": "Deprecated as of GCWeb v16.0.0 - Page details version 3.0" },
- "fr": { "href": "deprecated/page-details-v3-fr.html", "text": "Obsolète à partir de GCWeb v16.0.0 - Détails de la page version 3.0" }
+ "en": { "href": "page-details-contributors-en.html", "text": "Page details with Contributors" },
+ "fr": { "href": "page-details-contributors-fr.html", "text": "Détails de la page avec Contributeurs" }
+ },
+ {
+ "en": { "href": "demoted/page-details-v3.2-en.html", "text": "Demoted as of GCWeb v16.2.0 - Page details version 3.2" },
+ "fr": { "href": "demoted/page-details-v3.2-fr.html", "text": "Rétrogradée à partir de GCWeb v16.2.0 - Détails de la page version 3.2" }
},
{
"en": { "href": "deprecated/page-details-v3.1-en.html", "text": "Deprecated as of GCWeb v16.0.0 - Page details version 3.1" },
"fr": { "href": "deprecated/page-details-v3.1-fr.html", "text": "Obsolète à partir de GCWeb v16.0.0 - Détails de la page version 3.1" }
+ },
+ {
+ "en": { "href": "deprecated/page-details-v3-en.html", "text": "Deprecated as of GCWeb v16.0.0 - Page details version 3.0" },
+ "fr": { "href": "deprecated/page-details-v3-fr.html", "text": "Obsolète à partir de GCWeb v16.0.0 - Détails de la page version 3.0" }
}
],
"implementation": [
"_:implement_pd",
"_:implement_pd_gcweb",
- "_:implement_pd_3to5"
+ "_:implement_pd_3to5",
+ "_:implement_pd_5to6"
],
"history": [
+ {
+ "en": "December 2024 - Added Contributors component.",
+ "fr": "Juillet 2024 - Ajout de la composante Contributeurs."
+ },
{
"en": "July 2024 - Removed \"col-lg-9\" class.",
"fr": "Juillet 2024 - Retrait de la classe « col-lg-9 »."
@@ -2776,7 +3087,7 @@
"implementation": [
{
"@id": "_:implement_pd",
- "iteration": "_:iteration_pd_5",
+ "iteration": "_:iteration_pd_6",
"name": {
"en": "Standard",
"fr": "Standard"
@@ -2787,12 +3098,14 @@
},
"instructions": {
"en": [
- "The Page details component must include the Date modified component. It can also contain the Page feedback component. See below the code sample for each scenario.",
- "For more information about Page feedback tool component, please visit Page feedback area page."
+ "The Page details component must include the Date modified component. It can also contain the Page feedback component and Contributors component. See below the code sample for each scenario.",
+ "For more information about Page feedback tool component, please visit Page feedback area page.",
+ "For more information about Contributors component, please visit Contributors page."
],
"fr": [
- "Le composant Détails de la page doit inclure le composant Date de modification. Il peut également contenir le composant Outil de rétroaction sur la page. Voir ci-dessous l'exemple de code pour chaque scénario.",
- "Pour plus d'informations sur le composant de l'Outil de rétroaction sur la page, veuillez visiter la page Zone de rétroaction sur la page."
+ "Le composant Détails de la page doit inclure la composante Date de modification. Il peut également contenir la composante Outil de rétroaction sur la page et la composante Contributeurs. Voir ci-dessous l'exemple de code pour chaque scénario.",
+ "Pour plus d'informations sur la composante Outil de rétroaction sur la page, veuillez visiter la page Zone de rétroaction sur la page.",
+ "Pour plus d'informations sur la composante de Contributeurs, veuillez visiter la page Contributeurs."
]
},
"sample": {
@@ -2802,7 +3115,7 @@
"description": "Default Page details:",
"code": {
"@type": [ "@id", "rdf:HTML" ],
- "@value": "samples/page-details-3.2-en.html#default"
+ "@value": "samples/page-details-3.3-en.html#default"
}
},
{
@@ -2810,7 +3123,15 @@
"description": "Page details with Page feedback tool:",
"code": {
"@type": [ "@id", "rdf:HTML" ],
- "@value": "samples/page-details-3.2-en.html#pft"
+ "@value": "samples/page-details-3.3-en.html#pft"
+ }
+ },
+ {
+ "@type": "source-code",
+ "description": "Page details with Contributors:",
+ "code": {
+ "@type": [ "@id", "rdf:HTML" ],
+ "@value": "samples/page-details-3.3-en.html#contributors"
}
}
],
@@ -2820,7 +3141,7 @@
"description": "Détails de la page par défaut :",
"code": {
"@type": [ "@id", "rdf:HTML" ],
- "@value": "samples/page-details-3.2-fr.html#default"
+ "@value": "samples/page-details-3.3-fr.html#default"
}
},
{
@@ -2828,7 +3149,15 @@
"description": "Détails de la page avec Outil de rétroaction sur la page :",
"code": {
"@type": [ "@id", "rdf:HTML" ],
- "@value": "samples/page-details-3.2-fr.html#pft"
+ "@value": "samples/page-details-3.3-fr.html#pft"
+ }
+ },
+ {
+ "@type": "source-code",
+ "description": "Détails de la page avec Contributeurs :",
+ "code": {
+ "@type": [ "@id", "rdf:HTML" ],
+ "@value": "samples/page-details-3.3-fr.html#contributors"
}
}
]
@@ -2836,7 +3165,7 @@
},
{
"@id": "_:implement_pd_gcweb",
- "iteration": "_:iteration_pd_5",
+ "iteration": "_:iteration_pd_6",
"name": {
"en": "GCWeb Jekyll",
"fr": "GCWeb Jekyll"
@@ -2847,10 +3176,12 @@
},
"instructions": {
"en": [
- "To show the \"Page feedback tool\", in the page's front-matter, set the property feedback to true."
+ "To show the \"Page feedback tool\", in the page's front-matter, set the property feedback to true.",
+ "To show the page's contributors, in the page's front-matter, set the property contributors to an array of objects containing the following properties: name and url."
],
"fr": [
- "Pour afficher l'\"Outil de rétroaction sur la page\", dans l'en-tête de la page, définissez la propriété feedback à true."
+ "Pour afficher l'\"Outil de rétroaction sur la page\", dans l'en-tête de la page, définissez la propriété feedback à true.",
+ "Pour afficher les contributeurs de la page, dans l'en-tête de la page, définissez la propriété contributors à un tableau d'objets contenant les propriétés suivantes : name et url."
]
},
"sample": {
@@ -2858,14 +3189,14 @@
{
"@type": "source-code",
"description": "Code sample:",
- "code": "\"feedback\": true"
+ "code": "\"feedback\": true,\n\"contributors\": [\n\t{ \"name\": \"[Department or agency 1]\", \"url\": \"https://www.canada.ca/en\" },\n\t{ \"name\": \"[Department or agency 2]\", \"url\": \"https://www.canada.ca/en\" }\n]"
}
],
"fr": [
{
"@type": "source-code",
"description": "Exemple de code:",
- "code": "\"feedback\": true"
+ "code": "\"feedback\": true,\n\"contributors\": [\n\t{ \"name\": \"[Ministère ou agence 1]\", \"url\": \"https://www.canada.ca/fr\" },\n\t{ \"name\": \"[Ministère ou agence 2]\", \"url\": \"https://www.canada.ca/fr\" }\n]"
}
]
}
@@ -2893,15 +3224,104 @@
"Déplacez le composant de date de modification hors de la grille et insérez-le juste avant la balise de fermeture <section>. Supprimez le <div class=\"col-xs-12\"> dans lequel il se trouvait."
]
}
+ },
+ {
+ "@id": "_:implement_pd_5to6",
+ "iteration": "_:iteration_pd_6",
+ "name": {
+ "en": "Migration from version 3.2 to 3.3",
+ "fr": "Migration de la version 3.2 vers 3.3"
+ },
+ "introduction": {
+ "en": "This implementation is meant for developers or publishers trying to migrate their page from using the page details version 3.2 to 3.3 (move to page details).",
+ "fr": "Cette implémentation est destinée aux développeurs ou aux éditeurs qui tentent de migrer leur page de la version 3.0 vers la version 3.2 (déplacement vers les détails de la page)."
+ },
+ "instructions": {
+ "en": [
+ "If there is a \"Contributors\" component present on the page, move it directly after the <h2 class=\"wb-inv\">Page details</h2>.",
+ "Change the <h2>From:</h2> to an <h3>From:</h3>."
+ ],
+ "fr": [
+ "S'il y a une composante « Contributeurs » présente dans la page, déplacez la composante directement après le <h2 class=\"wb-inv\">Détails de la page</h2>.",
+ "Changez le <h2>De :</h2> à un <h3>De :</h3>."
+ ]
+ }
}
],
"iteration": [
+ {
+ "@id": "_:iteration_pd_6",
+ "name": "Page details - Iteration 6",
+ "date": "2024-12",
+ "detectableBy": "section.pagedetails",
+ "predecessor": "_:iteration_pd_5",
+ "additions": [
+ "Adding contributors component."
+ ],
+ "assets": [
+ {
+ "@type": "source-code",
+ "@language": "en",
+ "description": "Default Page details",
+ "code": {
+ "@type": [ "rdf:HTML", "@id" ],
+ "@value": "samples/page-details-3.3-en.html#default"
+ }
+ },
+ {
+ "@type": "source-code",
+ "@language": "fr",
+ "description": "Détails de la page par défaut",
+ "code": {
+ "@type": [ "rdf:HTML", "@id" ],
+ "@value": "samples/page-details-3.3-fr.html#default"
+ }
+ },
+ {
+ "@type": "source-code",
+ "@language": "en",
+ "description": "Page details with Page feedback tool",
+ "code": {
+ "@type": [ "rdf:HTML", "@id" ],
+ "@value": "samples/page-details-3.3-en.html#pft"
+ }
+ },
+ {
+ "@type": "source-code",
+ "@language": "fr",
+ "description": "Détails de la page avec Outil de rétroaction sur la page",
+ "code": {
+ "@type": [ "rdf:HTML", "@id" ],
+ "@value": "samples/page-details-3.3-fr.html#pft"
+ }
+ },
+ {
+ "@type": "source-code",
+ "@language": "en",
+ "description": "Page details with contributors",
+ "code": {
+ "@type": [ "rdf:HTML", "@id" ],
+ "@value": "samples/page-details-3.3-en.html#contributors"
+ }
+ },
+ {
+ "@type": "source-code",
+ "@language": "fr",
+ "description": "Détails de la page avec contributeurs",
+ "code": {
+ "@type": [ "rdf:HTML", "@id" ],
+ "@value": "samples/page-details-3.3-fr.html#contributors"
+ }
+ }
+ ]
+ },
{
"@id": "_:iteration_pd_5",
"name": "Page details - Iteration 5",
"date": "2024-07",
"detectableBy": "section.pagedetails",
"predecessor": "_:iteration_pd_4",
+ "successor": "_:iteration_pd_6",
"fixes": [
"Removed \"col-lg-9\" class since \"col-md-9\" already fulfils the same purpose."
],
@@ -3143,10 +3563,49 @@
}
],
"changesets": [
+ {
+ "@id": "_:cs_pd_6",
+ "name": "Page details - version 3.3",
+ "status": "stable",
+ "baseOnIteration": "_:iteration_pd_6",
+ "detectableBy": "section.pagedetails",
+ "layout": [
+ "Contributors (if included) on the top row",
+ "Page feedback tool (if included) on the top left",
+ "Date modified on bottom left"
+ ],
+ "style": "Not applicable",
+ "semantic": {
+ "@type": "source-code",
+ "description": "Source code",
+ "code": "\n\t
[i18nText-pageDetails]
\n\t\n\t\n\t\n"
+ },
+ "include": {
+ "@type": "source-code",
+ "collapsed": true,
+ "description": "Include with logic in Liquid.",
+ "code": {
+ "@type": [ "@id", "rdf:HTML" ],
+ "@value": "includes/footer.html"
+ }
+ },
+ "logic": "Not applicable",
+ "guidance": "Not applicable",
+ "context": "The last item of the element.",
+ "configuration": [
+ "Input the date when the page was last modified inside the