Merge pull request #473 from gethinode/develop

Add abbr shortcode

.github/workflows/npm-publish.yml

@@ -31,8 +31,9 @@ jobs:
           cache: 'npm'
           cache-dependency-path: '**/package-lock.json'
   
-      - name: Perform clean install of npm
-        run: npm ci
+      # [27/AUG/23] Adjusted from npm ci to prevent EBADPLATFORM error due to fsevents
+      - name: Install npm
+        run: npm i
 
       - name: Publish package to npm
         run: npm publish

config/_default/hugo.toml

@@ -97,6 +97,9 @@ home = ["HTML", "RSS", "REDIR"]
   [[module.mounts]]
     source = "content"
     target = "content"
+  [[module.mounts]]
+    source = "data"
+    target = "data"
   [[module.mounts]]
     source = "i18n"
     target = "i18n"

data/abbr.yml

@@ -0,0 +1,8 @@
+- id: css
+  long: "Cascading Style Sheets"
+
+- id: html
+  long: "HyperText Markup Language"
+
+- id: svg
+  long: "Scalable Vector Graphics"

exampleSite/content/en/blog/bootstrap-elements.md

@@ -14,6 +14,16 @@ thumbnail:
 
 Hinode provides several shortcodes that wrap common Bootstrap components. Refer to the [official documentation]({{< param "links.hinode_docs" >}}) for more details.
 
+## Abbr
+
+As an example, the following shortcode displays the full text of an abbreviation on hover.
+
+<!-- markdownlint-disable MD037 -->
+{{< example lang="hugo" >}}
+{{</* abbr html */>}}
+{{< /example >}}
+<!-- markdownlint-enable MD037 -->
+
 ## Accordion
 
 As an example, the following shortcode displays an accordion with three elements, of which the first element is expanded.
@@ -347,11 +357,11 @@ Loading...
 
 ## Timeline
 
-As an example, the following shortcode displays a timeline with the file `data/timeline-en.yml` as data.
+As an example, the following shortcode displays a timeline with the file `data/timeline.en.yml` as data.
 
 <!-- markdownlint-disable MD037 -->
 {{< example lang="hugo" >}}
-{{</* timeline data="timeline-en" background="dark" */>}}
+{{</* timeline data="timeline" background="dark" */>}}
 {{< /example >}}
 <!-- markdownlint-enable MD037 -->
 

exampleSite/hugo_stats.json

@@ -2,6 +2,7 @@
   "htmlElements": {
     "tags": [
       "a",
+      "abbr",
       "body",
       "br",
       "button",
@@ -258,7 +259,7 @@
       "mt-3",
       "mt-5",
       "mt-auto",
-      "multi-docs-collapse-14",
+      "multi-docs-collapse-15",
       "multi-file-collapse-1",
       "mx-auto",
       "mx-md-2",
@@ -403,6 +404,7 @@
       "-theme",
       "-theme-collapsed",
       "TableOfContents",
+      "abbr",
       "accordion",
       "accordion-0",
       "accordion-0-heading-0",
@@ -413,7 +415,7 @@
       "accordion-0-item-2",
       "alert",
       "badge",
-      "body-docs-collapse-14",
+      "body-docs-collapse-15",
       "body-file-collapse-1",
       "breadcrumb",
       "btn-webshare",
@@ -429,7 +431,7 @@
       "docs",
       "example",
       "file",
-      "footer-docs-collapse-14",
+      "footer-docs-collapse-15",
       "footer-file-collapse-1",
       "formula-katex",
       "icon",

layouts/shortcodes/abbr.html

@@ -0,0 +1,64 @@
+<!-- 
+    Creates an HTML element that shows the long form of an abbrevitation. The abbreviation data is centrally stored in a
+    data file. By default, the shortcode uses "abbr.yaml" with translation support.
+    
+    The data file is expected to store key-value pairs, where "id" is the lower-case abbrevation and "long" its long
+    form. The following example illustrates this using YML:
+
+    - id: css
+      long: "Cascading Style Sheets"
+
+    The shortcode supports the following arguments:
+    "key"           Required case-insensitive key of the abbreviation. In shorthand notation, this is the first (and
+                    only) matched argument.
+    "data"          Optional filename of the abbrevation input. It defaults to "abbr.yaml" with translation support.
+                    You can omit the file extension. The file should reside in the "data" folder. The data supports
+                    language extensions. For example, "abbr.en.yaml" refers to the English translation of the
+                    abbrevation data. The filename "abbr.yaml" is used when no suitable translation is found.
+-->
+
+{{ $error := false }}
+
+{{ $key := "" }}
+{{- if .IsNamedParams }}{{ $key = .Get "key" }}{{ else }}{{ $key = .Get 0 }}{{ end }}
+
+{{ if not $key -}}
+    {{ errorf "Missing param 'key': %s" .Position -}}
+    {{ $error = true }}
+{{ end -}}
+
+{{- $data := .Get "data" | default "abbr" -}}
+{{ if not $data -}}
+    {{ errorf "Missing param 'data': %s" .Position -}}
+    {{ $error = true }}
+{{ end -}}
+
+{{ if not $error }}
+    {{/* Try language-specific file first */}}
+    {{ $path := path.Join (path.Dir $data) (printf "%s.%s" (path.BaseName $data) .Page.Language.Lang) (path.Ext $data) }}
+    {{ $entries := index site.Data $path }}
+    {{/* Use exact provided path as backup */}}
+    {{ if not $entries -}}
+        {{ $entries = index site.Data $data }}
+    {{ end }}
+    {{ if not $entries -}}
+        {{ errorf "Invalid abbrevation data '%s': %s" $data .Position -}}
+        {{ $error = true }}
+    {{ end -}}
+
+    {{ $title := "" }}
+    {{ if not $error }}
+        {{ $elements := (where $entries "id" (lower $key)) }}
+        {{ if gt (len $elements) 0 }}
+            {{ $title = index (index $elements 0) "long" }}
+        {{ end -}}
+        {{ if not $title -}}
+            {{ errorf "Cannot find value for '%s': %s" $key .Position -}}
+            {{ $error = true }}
+        {{ end -}}
+    {{ end }}
+
+    {{ if not $error }}
+        <abbr title="{{ $title }}">{{ $key }}</abbr>
+    {{ end }}
+{{ end }}

layouts/shortcodes/timeline.html

@@ -3,7 +3,9 @@
     
     Show items ordered on a vertical timelime. The shortcode supports the following arguments:
     "data"          Required filename of the timeline input. You can omit the file extension. The file should reside in
-                    the "data" folder.
+                    the "data" folder. The data supports language extensions. For example, "timeline.en.yaml" refers to
+                    the English translation of the timeline data. The filename "timeline.yaml" is used when no suitable
+                    translation is found.
     "background"    Optional border color of the connector dots, defaults to the body background color. If set, uses a
                     subtle background color that is adaptive to the current color mode.
     "class"         Optional class attribute of the timeline's container.
@@ -17,7 +19,13 @@
     {{ $error = true }}
 {{ end -}}
 
-{{ $entries := index site.Data $data }}
+{{/* Try language-specific file first */}}
+{{ $path := path.Join (path.Dir $data) (printf "%s.%s" (path.BaseName $data) .Page.Language.Lang) (path.Ext $data) }}
+{{ $entries := index site.Data $path }}
+{{/* Use exact provided path as backup */}}
+{{ if not $entries -}}
+    {{ $entries = index site.Data $data }}
+{{ end }}
 {{ if not $entries -}}
     {{ errorf "Invalid timeline data '%s': %s" $data .Position -}}
     {{ $error = true }}

package-lock.json

@@ -1,12 +1,12 @@
 {
   "name": "@gethinode/hinode",
-  "version": "0.19.0-alpha",
+  "version": "0.19.0-alpha2",
   "lockfileVersion": 2,
   "requires": true,
   "packages": {
     "": {
       "name": "@gethinode/hinode",
-      "version": "0.19.0-alpha",
+      "version": "0.19.0-alpha2",
       "license": "MIT",
       "devDependencies": {
         "@fullhuman/postcss-purgecss": "^5.0.0",

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gethinode/hinode",
-  "version": "0.19.0-alpha",
+  "version": "0.19.0-alpha2",
   "description": "Hinode is a clean documentation and blog theme for Hugo, an open-source static site generator",
   "keywords": [
     "hugo",