GC-ministers: small documentation edits

wet-boew · Mar 27, 2024 · fd7935a · fd7935a
1 parent 8165098
commit fd7935a
Show file tree

Hide file tree

Showing 10 changed files with 93 additions and 58 deletions.
diff --git a/_data/components.json b/_data/components.json
@@ -827,34 +827,46 @@
 			"instructions": {
 				"en": [
 					"The following coded example is the default layout. When you are implementing your instance, you can omit any of the following:<ul><li>image</li><li>mandate letter link</li><li>briefing book link</li></ul>",
-					"The <code>&lt;div class=\"col-md-6\"></code> can be repeated as many times as there are ministers or institutional heads."
+					"The <code>&lt;div class=\"col-md-6\"></code> can be repeated as many times as there are ministers or institutional heads.",
+					"Refer to the official guidance for the appropriate section heading."
 				],
 				"fr": [
 					"L'exemple codé suivant est la présentation par défaut. Lorsque vous mettez en œuvre votre instance, vous pouvez omettre les éléments suivants&nbsp;:<ul><li>Image</li><li>Lettre de mandat</li><li>Dossier d’information</li></ul>",
-					"Le <code>&lt;div class=\"col-md-6\"></code> peut être répété autant de fois qu'il y a de ministres ou de chefs d'institution."
+					"Le <code>&lt;div class=\"col-md-6\"></code> peut être répété autant de fois qu'il y a de ministres ou de chefs d'institution.",
+					"Reportez-vous aux directives officielles pour connaître le titre de section approprié."
 				]
 			},
 			"notes": {
 				"en": [
-					"Please refer to the working example for the HTML markup when there is no image."
+					"The recommended image size is 200px by 250px."
 				],
 				"fr": [
-					"Veuillez vous référer à l'exemple pratique pour le balisage HTML lorsqu'il n'y a pas d'image."
+					"La taille d'image recommandée est de 200px par 250px."
 				]
 			},
 			"sample": {
 				"en": [
 					{
 						"@type": "source-code",
-						"description": "Code sample:",
-						"code": "<section class=\"gc-minister\">\n\t<h2>Minister(s)</h2>\n\t<div class=\"row wb-eqht-grd\">\n\t\t<div class=\"col-md-6\">\n\t\t\t<div class=\"row\">\n\t\t\t\t<div class=\"pull-right col-md-7 col-xs-12\">\n\t\t\t\t\t<h3><a href=\"#\">The Honourable [Minister name]</a></h3>\n\t\t\t\t</div>\n\t\t\t\t<div class=\"col-md-5 col-xs-12\">\n\t\t\t\t\t<img src=\"./img/minister-200x250.jpg\" alt=\"The Honourable [Minister name]\">\n\t\t\t\t</div>\n\t\t\t\t<div class=\"col-md-7 col-xs-12\">\n\t\t\t\t\t<p>[Official title]</p>\n\t\t\t\t\t<ul>\n\t\t\t\t\t\t<li><a href=\"\">Mandate letter</a></li>\n\t\t\t\t\t\t<li><a href=\"\">Briefing book</a></li>\n\t\t\t\t\t</ul>\n\t\t\t\t</div>\n\t\t\t</div>\n\t\t</div>\n\t</div>\n</section>"
+						"description": "Code sample with image:",
+						"code": "<section class=\"gc-minister\">\n\t<h2>Minister</h2>\n\t<div class=\"row wb-eqht-grd\">\n\t\t<div class=\"col-md-6\">\n\t\t\t<div class=\"row\">\n\t\t\t\t<div class=\"pull-right col-md-7 col-xs-12\">\n\t\t\t\t\t<h3><a href=\"#\">The Honourable [Minister name]</a></h3>\n\t\t\t\t</div>\n\t\t\t\t<div class=\"col-md-5 col-xs-12\">\n\t\t\t\t\t<img src=\"[image url]\" alt=\"The Honourable [Minister name]\">\n\t\t\t\t</div>\n\t\t\t\t<div class=\"col-md-7 col-xs-12\">\n\t\t\t\t\t<p>[Official title]</p>\n\t\t\t\t\t<ul>\n\t\t\t\t\t\t<li><a href=\"\">Mandate letter</a></li>\n\t\t\t\t\t\t<li><a href=\"\">Briefing book</a></li>\n\t\t\t\t\t</ul>\n\t\t\t\t</div>\n\t\t\t</div>\n\t\t</div>\n\t</div>\n</section>"
+					},
+					{
+						"@type": "source-code",
+						"description": "Code sample without image:",
+						"code": "<section class=\"gc-minister\">\n\t<h2>Minister</h2>\n\t<div class=\"row wb-eqht-grd\">\n\t\t<div class=\"col-md-6\">\n\t\t\t<h3><a href=\"#\">The Honourable [Minister 3 name]</a></h3>\n\t\t\t<p>[Official title]</p>\n\t\t\t<ul>\n\t\t\t\t<li><a href=\"\">Mandate letter</a></li>\n\t\t\t\t<li><a href=\"\">Briefing book</a></li>\n\t\t\t</ul>\n\t\t</div>\n\t</div>\n</section>"
 					}
 				],
 				"fr": [
 					{
 						"@type": "source-code",
-						"description": "Exemple de code :",
-						"code": "<section class=\"gc-minister\">\n\t<h2>Ministre(s)</h2>\n\t<div class=\"row wb-eqht-grd\">\n\t\t<div class=\"col-md-6\">\n\t\t\t<div class=\"row\">\n\t\t\t\t<div class=\"pull-right col-md-7 col-xs-12\">\n\t\t\t\t\t<h3><a href=\"#\">L'honorable [prénom et nom de famille]</a></h3>\n\t\t\t\t</div>\n\t\t\t\t<div class=\"col-md-5 col-xs-12\">\n\t\t\t\t\t<img src=\"./img/minister-200x250.jpg\" alt=\"L'honorable [prénom et nom de famille]\">\n\t\t\t\t</div>\n\t\t\t\t<div class=\"col-md-7 col-xs-12\">\n\t\t\t\t\t<p>[Titre officiel du ministre]</p>\n\t\t\t\t\t<ul>\n\t\t\t\t\t\t<li><a href=\"\">Lettre de mandat</a></li>\n\t\t\t\t\t\t<li><a href=\"\">Dossier d'information</a></li>\n\t\t\t\t\t</ul>\n\t\t\t\t</div>\n\t\t\t</div>\n\t\t</div>\n\t</div>\n</section>"
+						"description": "Exemple de code avec image :",
+						"code": "<section class=\"gc-minister\">\n\t<h2>Ministre</h2>\n\t<div class=\"row wb-eqht-grd\">\n\t\t<div class=\"col-md-6\">\n\t\t\t<div class=\"row\">\n\t\t\t\t<div class=\"pull-right col-md-7 col-xs-12\">\n\t\t\t\t\t<h3><a href=\"#\">L'honorable [prénom et nom de famille]</a></h3>\n\t\t\t\t</div>\n\t\t\t\t<div class=\"col-md-5 col-xs-12\">\n\t\t\t\t\t<img src=\"[url de l'image]\" alt=\"L'honorable [prénom et nom de famille]\">\n\t\t\t\t</div>\n\t\t\t\t<div class=\"col-md-7 col-xs-12\">\n\t\t\t\t\t<p>[Titre officiel du ministre]</p>\n\t\t\t\t\t<ul>\n\t\t\t\t\t\t<li><a href=\"\">Lettre de mandat</a></li>\n\t\t\t\t\t\t<li><a href=\"\">Dossier d'information</a></li>\n\t\t\t\t\t</ul>\n\t\t\t\t</div>\n\t\t\t</div>\n\t\t</div>\n\t</div>\n</section>"
+					},
+					{
+						"@type": "source-code",
+						"description": "Exemple de code sans image :",
+						"code": "<section class=\"gc-minister\">\n\t<h2>Ministre</h2>\n\t<div class=\"row wb-eqht-grd\">\n\t\t<div class=\"col-md-6\">\n\t\t\t<h3><a href=\"#\">The Honourable [Minister 3 name]</a></h3>\n\t\t\t<p>[Titre officiel du ministre]</p>\n\t\t\t<ul>\n\t\t\t\t<li><a href=\"\">Lettre de mandat</a></li>\n\t\t\t\t<li><a href=\"\">Dossier d'information</a></li>\n\t\t\t</ul>\n\t\t</div>\n\t</div>\n</section>"
 					}
 				]
 			}
@@ -870,8 +882,13 @@
 				{
 					"@type": "source-code",
 					"@language": "en",
-					"description": "Code sample",
-					"code": "<section class=\"gc-minister\">\n\t<h2>Minister(s)</h2>\n\t<div class=\"row wb-eqht-grd\">\n\t\t<div class=\"col-md-6\">\n\t\t\t<div class=\"row\">\n\t\t\t\t<div class=\"pull-right col-md-7 col-xs-12\">\n\t\t\t\t\t<h3><a href=\"#\">The Honourable [Minister name]</a></h3>\n\t\t\t\t</div>\n\t\t\t\t<div class=\"col-md-5 col-xs-12\">\n\t\t\t\t\t<img src=\"./img/minister-200x250.jpg\" alt=\"The Honourable [Minister name]\">\n\t\t\t\t</div>\n\t\t\t\t<div class=\"col-md-7 col-xs-12\">\n\t\t\t\t\t<p>[Official title]</p>\n\t\t\t\t\t<ul>\n\t\t\t\t\t\t<li><a href=\"\">Mandate letter</a></li>\n\t\t\t\t\t\t<li><a href=\"\">Briefing book</a></li>\n\t\t\t\t\t</ul>\n\t\t\t\t</div>\n\t\t\t</div>\n\t\t</div>\n\t</div>\n</section>"
+					"description": "Code sample with image",
+					"code": "<section class=\"gc-minister\">\n\t<h2>Minister</h2>\n\t<div class=\"row wb-eqht-grd\">\n\t\t<div class=\"col-md-6\">\n\t\t\t<div class=\"row\">\n\t\t\t\t<div class=\"pull-right col-md-7 col-xs-12\">\n\t\t\t\t\t<h3><a href=\"#\">The Honourable [Minister name]</a></h3>\n\t\t\t\t</div>\n\t\t\t\t<div class=\"col-md-5 col-xs-12\">\n\t\t\t\t\t<img src=\"[image url]\" alt=\"The Honourable [Minister name]\">\n\t\t\t\t</div>\n\t\t\t\t<div class=\"col-md-7 col-xs-12\">\n\t\t\t\t\t<p>[Official title]</p>\n\t\t\t\t\t<ul>\n\t\t\t\t\t\t<li><a href=\"\">Mandate letter</a></li>\n\t\t\t\t\t\t<li><a href=\"\">Briefing book</a></li>\n\t\t\t\t\t</ul>\n\t\t\t\t</div>\n\t\t\t</div>\n\t\t</div>\n\t</div>\n</section>"
+				},
+				{
+					"@type": "source-code",
+					"description": "Code sample without image",
+					"code": "<section class=\"gc-minister\">\n\t<h2>Minister</h2>\n\t<div class=\"row wb-eqht-grd\">\n\t\t<div class=\"col-md-6\">\n\t\t\t<h3><a href=\"#\">The Honourable [Minister 3 name]</a></h3>\n\t\t\t<p>[Official title]</p>\n\t\t\t<ul>\n\t\t\t\t<li><a href=\"\">Mandate letter</a></li>\n\t\t\t\t<li><a href=\"\">Briefing book</a></li>\n\t\t\t</ul>\n\t\t</div>\n\t</div>\n</section>"
 				}
 			]
 		}
@@ -888,15 +905,18 @@
 			"style": "The image has a thin grey border.",
 			"context": "To be used in the institutional landing page template.",
 			"schema": [
-				"Minister name",
-				"Minister title",
-				"Minister page URL",
-				"Minister image URL",
-				"Mandate letter text",
-				"Mandate letter URL",
-				"Briefing book text",
-				"Briefing book URL"
-			]
+				"Section title (type: STRING) - for example: Minister, President, Parliamentary secretary, Associate minister, Ombudsman, Management",
+				"Ministers (type: ARRAY)",
+				"Ministers > Name (type: STRING)",
+				"Ministers > Title (type: STRING)",
+				"Ministers > Page URL (type: STRING)",
+				"Ministers > Image URL (type: STRING)",
+				"Ministers > Mandate letter text (type: STRING)",
+				"Ministers > Mandate letter URL (type: STRING)",
+				"Ministers > Briefing book text (type: STRING)",
+				"Ministers > Briefing book URL (type: STRING)"
+			],
+			"mediaConsiderations": "Recommended image size: 200x250px."
 		}
 	]
 }

diff --git a/_includes/components/gc-minister/gc-minister-special-cases.html b/_includes/components/gc-minister/gc-minister-special-cases.html
@@ -1,13 +1,13 @@
 <section class="gc-minister">
-	<h2>{% if page.language == "en" %}Minister(s){% else %}Ministre(s){% endif %}</h2>
+	<h2>{% if page.language == "en" %}Ministers{% else %}Ministres{% endif %}</h2>
 	<div class="row wb-eqht-grd">
 		<div class="col-md-6">
 			<div class="row">
 				<div class="pull-right col-md-7 col-xs-12">
 					<h3><a href="#">{% if page.language == "en" %}The Honourable [Minister name]{% else %}L'honorable [prénom et nom de famille]{% endif %}</a></h3>
 				</div>
 				<div class="col-md-5 col-xs-12">
-					<img src="./img/minister-200x250.jpg" alt="{% if page.language == 'en' %}The Honourable [Minister name]{% else %}L'honorable [prénom et nom de famille]{% endif %}">
+					<img src="https://via.placeholder.com/200x250/000000/FFFFFF.png" alt="{% if page.language == 'en' %}The Honourable [Minister name]{% else %}L'honorable [prénom et nom de famille]{% endif %}">
 				</div>
 				<div class="col-md-7 col-xs-12">
 					<p>{% if page.language == "en" %}[Official title]{% else %}[Titre officiel du ministre]{% endif %}</p>
@@ -20,7 +20,7 @@ <h3><a href="#">{% if page.language == "en" %}The Honourable [Minister name]{% e
 					<h3><a href="#">The Honourable [Minister 2 name with a very long name]</a></h3>
 				</div>
 				<div class="col-md-5 col-xs-12">
-					<img src="./img/minister-200x250.jpg" alt="The Honourable [Minister 2 name with a very long name]">
+					<img src="https://via.placeholder.com/200x250/000000/FFFFFF.png" alt="The Honourable [Minister 2 name with a very long name]">
 				</div>
 				<div class="col-md-7 col-xs-12">
 					<p>{% if page.language == "en" %}[Official title]{% else %}[Titre officiel du ministre]{% endif %}</p>

diff --git a/_includes/components/gc-minister/gc-minister-two-ministers.html b/_includes/components/gc-minister/gc-minister-two-ministers.html
@@ -1,13 +1,13 @@
 <section class="gc-minister">
-	<h2>{% if page.language == "en" %}Minister(s){% else %}Ministre(s){% endif %}</h2>
+	<h2>{% if page.language == "en" %}Ministers{% else %}Ministres{% endif %}</h2>
 	<div class="row wb-eqht-grd">
 		<div class="col-md-6">
 			<div class="row">
 				<div class="pull-right col-md-7 col-xs-12">
 					<h3><a href="#">{% if page.language == "en" %}The Honourable [Minister name]{% else %}L'honorable [prénom et nom de famille]{% endif %}</a></h3>
 				</div>
 				<div class="col-md-5 col-xs-12">
-					<img src="./img/minister-200x250.jpg" alt="{% if page.language == 'en' %}The Honourable [Minister name]{% else %}L'honorable [prénom et nom de famille]{% endif %}">
+					<img src="https://via.placeholder.com/200x250/000000/FFFFFF.png" alt="{% if page.language == 'en' %}The Honourable [Minister name]{% else %}L'honorable [prénom et nom de famille]{% endif %}">
 				</div>
 				<div class="col-md-7 col-xs-12">
 					<p>{% if page.language == "en" %}[Official title]{% else %}[Titre officiel du ministre]{% endif %}</p>
@@ -24,7 +24,7 @@ <h3><a href="#">{% if page.language == "en" %}The Honourable [Minister name]{% e
 					<h3><a href="#">{% if page.language == "en" %}The Honourable [Minister name]{% else %}L'honorable [prénom et nom de famille]{% endif %}</a></h3>
 				</div>
 				<div class="col-md-5 col-xs-12">
-					<img src="./img/minister-200x250.jpg" alt="{% if page.language == 'en' %}The Honourable [Minister name]{% else %}L'honorable [prénom et nom de famille]{% endif %}">
+					<img src="https://via.placeholder.com/200x250/000000/FFFFFF.png" alt="{% if page.language == 'en' %}The Honourable [Minister name]{% else %}L'honorable [prénom et nom de famille]{% endif %}">
 				</div>
 				<div class="col-md-7 col-xs-12">
 					<p>{% if page.language == "en" %}[Official title]{% else %}[Titre officiel du ministre]{% endif %}</p>

diff --git a/_includes/components/gc-minister/gc-minister.html b/_includes/components/gc-minister/gc-minister.html
@@ -1,13 +1,13 @@
 <section class="gc-minister">
-	<h2>{% if page.language == "en" %}Minister(s){% else %}Ministre(s){% endif %}</h2>
+	<h2>{% if page.language == "en" %}Minister{% else %}Ministre{% endif %}</h2>
 	<div class="row wb-eqht-grd">
 		<div class="col-md-6">
 			<div class="row">
 				<div class="pull-right col-md-7 col-xs-12">
 					<h3><a href="#">{% if page.language == "en" %}The Honourable [Minister name]{% else %}L'honorable [prénom et nom de famille]{% endif %}</a></h3>
 				</div>
 				<div class="col-md-5 col-xs-12">
-					<img src="./img/minister-200x250.jpg" alt="{% if page.language == 'en' %}The Honourable [Minister name]{% else %}L'honorable [prénom et nom de famille]{% endif %}">
+					<img src="https://via.placeholder.com/200x250/000000/FFFFFF.png" alt="{% if page.language == 'en' %}The Honourable [Minister name]{% else %}L'honorable [prénom et nom de famille]{% endif %}">
 				</div>
 				<div class="col-md-7 col-xs-12">
 					<p>{% if page.language == "en" %}[Official title]{% else %}[Titre officiel du ministre]{% endif %}</p>

diff --git a/components/gc-minister/_base.scss b/components/gc-minister/_base.scss
@@ -7,7 +7,6 @@
 
 	h3 {
 		font-size: 20px;
-		font-weight: $normal-weight;
 		margin-bottom: 15px;
 		margin-top: 15px;
 	}

diff --git a/components/gc-minister/img/minister-200x250.jpg b/components/gc-minister/img/minister-200x250.jpg