From d2a7e22e589048b290e275b81881ffb2a138dd47 Mon Sep 17 00:00:00 2001
From: iGor milhit <igor@milhit.ch>
Date: Mon, 14 Nov 2022 18:21:38 +0100
Subject: [PATCH] i18n: extract, translate strings to be translated

- Extracts stings to be translated.
- Translates these strings in English and French.
- Improves some comments in the templates.
- Fixes #18.

Co-Authored-by: iGor milhit <igor@milhit.ch>
---
 i18n/en.toml                   | 14 ++++++++++++++
 i18n/fr.toml                   | 28 ++++++++++++++--------------
 layouts/_default/list.html     |  6 ++++--
 layouts/_default/section.html  |  8 +++++++-
 layouts/_default/single.html   |  2 +-
 layouts/_default/terms.html    |  9 +++++++--
 layouts/partials/metadata.html |  2 +-
 layouts/partials/perso.html    | 28 ++++++++++++++++++----------
 layouts/partials/pro.html      | 24 ++++++++++++++++--------
 9 files changed, 82 insertions(+), 39 deletions(-)
 create mode 100644 i18n/en.toml

diff --git a/i18n/en.toml b/i18n/en.toml
new file mode 100644
index 0000000..5dd703a
--- /dev/null
+++ b/i18n/en.toml
@@ -0,0 +1,14 @@
+address = "Address"
+contactsPriv = "Personal contacts"
+contactsPro = "Professional contacts"
+cv = "cv"
+defaultImageAlt = "Grayish sheep portrait"
+e-mail = "e-mail"
+fingerprint = "Fingerprint"
+lastCommit = "Last commit modifying this page"
+mobile = "Mobile"
+permalink = "Permalink"
+post-infos = "Post information"
+pubkey = "Public key"
+tel = "Phone"
+xmpp = "xmpp"
diff --git a/i18n/fr.toml b/i18n/fr.toml
index d2500d4..52b9fe9 100644
--- a/i18n/fr.toml
+++ b/i18n/fr.toml
@@ -1,14 +1,14 @@
-[lastCommit]
-other = "Dernier commit modifiant cette page"
-
-[post-infos]
-other = "Informations sur le billet"
-
-[permalink]
-other = "Permalien"
-
-[contactsPriv]
-other = "Contacts personnels"
-
-[contactsPro]
-other = "Contacts professionnels"
+address = "Adresse"
+contactsPriv = "Contacts personnels"
+contactsPro = "Contacts professionnels"
+cv = "cv"
+defaultImageAlt = "Portrait de mouton en nuances de gris"
+e-mail = "e-mail"
+fingerprint = "Empreinte"
+lastCommit = "Dernier commit modifiant cette page"
+mobile = "Téléphone mobile"
+permalink = "Permalien"
+post-infos = "Informations sur le billet"
+pubkey = "Clé publique"
+tel = "Téléphone"
+xmpp = "xmpp"
diff --git a/layouts/_default/list.html b/layouts/_default/list.html
index f27475e..775ad82 100644
--- a/layouts/_default/list.html
+++ b/layouts/_default/list.html
@@ -3,10 +3,12 @@
     <header>
         <h2>{{.Title}}</h2>
     </header>
-    <!-- "{{.Content}}" pulls from the markdown content of the corresponding _index.md -->
+    <!-- "{{.Content}}" pulls from the markdown content of the corresponding
+         _index.md -->
     {{.Content}}
     <article class="posts-list">
-        <!-- Ranges through content/posts/*.md -->
+        <!-- Ranges through content/posts/*.md in reverse order, then displays
+             the post title, the date and categories (list-footer template) -->
         {{ range .Pages.ByPublishDate.Reverse }}
         <article>
             <a href="{{.Permalink}}">{{.Title}}</a>
diff --git a/layouts/_default/section.html b/layouts/_default/section.html
index 7b99c18..e1bc813 100644
--- a/layouts/_default/section.html
+++ b/layouts/_default/section.html
@@ -2,12 +2,18 @@
 <header>
     <h2>{{.Title}}</h2>
 </header>
-<!-- "{{.Content}}" pulls from the markdown content of the corresponding _index.md -->
+<!-- "{{.Content}}" pulls from the markdown content of the corresponding
+     _index.md -->
 <article>
     <header>
         {{.Content }}
     </header>
     <article class="posts-list">
+        <!--
+            Ranges pages by the publish date, in reverse order, to display the
+            post titles of the section from most recent to older. It adds to
+            the title the date and categories (from lists-footer.html)
+        -->
         {{ range .Pages.ByPublishDate.Reverse }}
             <article>
                 <a href="{{ .Permalink }}">
diff --git a/layouts/_default/single.html b/layouts/_default/single.html
index 3483a52..0b53320 100644
--- a/layouts/_default/single.html
+++ b/layouts/_default/single.html
@@ -2,7 +2,7 @@
   <header class="post-header">
     <h1 id="title">{{ .Title }}</h1>
     <!--
-      If it's a static page, then the post information are useless and
+      If it's a static page, then the post information is useless and
       therefore not displayed. The test checks if the page IS NOT a static
       page.
     -->
diff --git a/layouts/_default/terms.html b/layouts/_default/terms.html
index b817b74..eb55187 100644
--- a/layouts/_default/terms.html
+++ b/layouts/_default/terms.html
@@ -2,12 +2,17 @@
   <header>
     <h2>{{.Title}}</h2>
   </header>
-  <!-- "{{.Content}}" pulls from the markdown content of the corresponding _index.md -->
+  <!-- "{{.Content}}" pulls from the markdown content of the corresponding
+       _index.md -->
   {{.Content}}
   <article class="terms">
+    <!-- Ranges throught categories, alphabetically, then displays the posts
+         title with the number of item in the category -->
     {{ range .Data.Terms.Alphabetical }}
     <article class="term">
-      <p><a href="{{ .Page.Permalink }}">{{ .Page.Title }}</a> ({{ .Count }})</p>
+      <p>
+        <a href="{{ .Page.Permalink }}">{{ .Page.Title }}</a> ({{ .Count }})
+      </p>
     </article>
     {{ end }}
   </article>
diff --git a/layouts/partials/metadata.html b/layouts/partials/metadata.html
index 5990b3a..5d5ca53 100644
--- a/layouts/partials/metadata.html
+++ b/layouts/partials/metadata.html
@@ -14,7 +14,7 @@
   {{- else if .Site.Params.ImageDescription -}}
   <meta property="og:image:alt" content="{{ .Site.Params.ImageDescription }}">
   {{- else -}}
-  <meta property="og:image:alt" content="Grayish sheep portrait">
+  <meta property="og:image:alt" content="{{ i18n "defaultImageAlt" }}">
   {{ end }}
   <meta property="og:locale" content="{{ .Language.Lang }}">
   {{- if .IsNode }}
diff --git a/layouts/partials/perso.html b/layouts/partials/perso.html
index 10c8765..f4d227f 100644
--- a/layouts/partials/perso.html
+++ b/layouts/partials/perso.html
@@ -1,35 +1,43 @@
 <h2 id="contactsPriv">{{ i18n "contactsPriv" }}</h2>
 <dl class="home-lists">
   {{ with .Site.Params.contactsPriv.email }}
-    <dt>e-mail</dt>
+    <dt>{{ i18n "e-mail" }}</dt>
     <dd><a href="mailto:{{ . }}" itemprop="email">{{ . }}</a></dd>
   {{ end }}
   {{ with .Site.Params.contactsPriv.address }}
-    <dt>Adresse</dt>
+  <dt>{{ i18n "address" }}</dt>
     <dd><span itemprop="address">{{ . }}</span></dd>
   {{ end }}
   {{ with .Site.Params.contactsPriv.phone }}
-    <dt>Tél.</dt>
-    <dd><a href="tel:{{ replace . " " ""}}"><span itemprop="telephone">{{ . }}</span></a></dd>
+  <dt>{{ i18n "tel" }}</dt>
+    <dd>
+      <a href="tel:{{ replace . " " ""}}">
+        <span itemprop="telephone">{{ . }}</span>
+      </a>
+    </dd>
   {{end}}
   {{ with .Site.Params.contactsPriv.mobile }}
-    <dt>Tél. mobile</dt>
-    <dd><a href="tel:{{ replace . " " ""}}"><span itemprop="telephone">{{ . }}</span></a></dd>
+  <dt>{{ i18n "mobile" }}</dt>
+    <dd>
+      <a href="tel:{{ replace . " " ""}}">
+        <span itemprop="telephone">{{ . }}</span>
+      </a>
+    </dd>
   {{end}}
   {{ with .Site.Params.contactsPriv.publickey }}
-    <dt>Clé publique</dt>
+  <dt>{{ i18n "pubkey" }}</dt>
     <dd><a href="/{{ . }}">{{ . }}</a></dd>
   {{ end }}
   {{ with .Site.Params.contactsPriv.fingerprint }}
-    <dt>Empreinte</dt>
+  <dt>{{ i18n "fingerprint" }}</dt>
     <dd><code>{{ . }}</code></dd>
   {{ end }}
   {{ with .Site.Params.contactsPriv.xmpp }}
-    <dt>XMPP/jabber</dt>
+  <dt class="smallcaps">{{ i18n "xmpp" }}</dt>
     <dd>{{ . }}</dd>
   {{ end }}
   {{ with .Site.Params.contactsPriv.cv}}
-    <dt>CV</dt>
+  <dt class="smallcaps">{{ i18n "cv" }}</dt>
     <dd><a href="/{{ . }}">{{ . }}</a></dd>
   {{end}}
 </dl>
diff --git a/layouts/partials/pro.html b/layouts/partials/pro.html
index b54142d..014ffc9 100644
--- a/layouts/partials/pro.html
+++ b/layouts/partials/pro.html
@@ -1,27 +1,35 @@
 <h2 id="contactsPro">{{ i18n "contactsPro" }}</h2>
 <dl class="home-lists">
   {{ with .Site.Params.contactsPro.email }}
-    <dt>e-mail</dt>
+  <dt>{{ i18n "e-mail" }}</dt>
     <dd><a href="mailto:{{ . }}" itemprop="email">{{ . }}</a></dt>
   {{end}}
   {{ with .Site.Params.contactsPro.address }}
-    <dt>Adresse</dt>
+  <dt>{{ i18n "address" }}</dt>
     <dd><span itemprop="address">{{ . }}</span></dd>
   {{end}}
   {{ with .Site.Params.contactsPro.mobile}}
-    <dt>Mobile</dt>
-    <dd><a href="tel:{{ replace . " " ""}}"><span itemprop="telephone">{{ . }}</span></a></dd>
+  <dt>{{ i18n "mobile" }}</dt>
+    <dd>
+      <a href="tel:{{ replace . " " ""}}">
+        <span itemprop="telephone">{{ . }}</span>
+      </a>
+    </dd>
   {{end}}
   {{ with .Site.Params.contactsPro.phone}}
-    <dt>Tél.</dt>
-    <dd><a href="tel:{{ replace . " " ""}}"><span itemprop="telephone">{{ . }}</span></a></dd>
+  <dt>{{ i18n "tel" }}</dt>
+    <dd>
+      <a href="tel:{{ replace . " " ""}}">
+        <span itemprop="telephone">{{ . }}</span>
+      </a>
+    </dd>
   {{end}}
   {{ with .Site.Params.contactsPro.publickey }}
-    <dt>Clé publique</dt>
+  <dt>{{ i18n "pubkey" }}</dt>
     <dd><a href="/{{ . }}">{{ . }}</a></dd>
   {{end}}
   {{ with .Site.Params.contactsPro.fingerprint}}
-    <dt>Empreinte</dt>
+  <dt>{{ i18n "fingerprint" }}</dt>
     <dd><code>{{ . }}</code></dd>
   {{end}}
 </dl>