From 6f14084c1385a6af1d34f0ef44de5c64cde19845 Mon Sep 17 00:00:00 2001 From: Joe Mooring Date: Sun, 2 Feb 2025 11:15:51 -0800 Subject: [PATCH] Move glossary to quick reference section --- content/en/contribute/documentation.md | 16 ++++--------- content/en/getting-started/glossary/cache.md | 5 ---- .../en/getting-started/glossary/element.md | 5 ---- content/en/getting-started/glossary/field.md | 5 ---- .../glossary/global-resource.md | 10 -------- .../glossary/_index.md | 11 +++++---- .../glossary/action.md | 0 .../glossary/archetype.md | 0 .../glossary/argument.md | 0 .../glossary/array.md | 0 .../glossary/asset-pipeline.md | 5 ++++ .../glossary/bool.md | 0 .../glossary/boolean.md | 0 .../glossary/branch-bundle.md | 0 .../glossary/build.md | 0 .../glossary/bundle.md | 0 content/en/quick-reference/glossary/cache.md | 5 ++++ .../glossary/chain.md | 0 .../glossary/cjk.md | 0 .../glossary/cli.md | 0 .../glossary/collection.md | 0 .../glossary/content-adapter.md | 0 .../glossary/content-format.md | 0 .../glossary/content-type.md | 0 .../glossary/content-view.md | 0 .../glossary/context.md | 0 .../glossary/default-sort-order.md | 0 .../en/quick-reference/glossary/duration.md | 5 ++++ .../en/quick-reference/glossary/element.md | 5 ++++ .../glossary/embedded-template.md | 0 .../glossary/environment.md | 0 content/en/quick-reference/glossary/field.md | 5 ++++ .../glossary/flag.md | 0 .../glossary/float.md | 0 .../glossary/floating-point.md | 0 .../glossary/fragment.md | 0 .../glossary/front-matter.md | 0 .../glossary/function.md | 0 content/en/quick-reference/glossary/glob.md | 6 +++++ .../glossary/global-resource.md | 10 ++++++++ .../glossary/headless-bundle.md | 0 .../glossary/identifier.md | 0 .../glossary/int.md | 0 .../glossary/integer.md | 0 .../glossary/internationalization.md | 0 .../glossary/interpreted-string-literal.md | 0 .../glossary/interval.md | 0 .../glossary/kind.md | 0 .../glossary/layout.md | 0 .../glossary/leaf-bundle.md | 0 .../glossary/lexer.md | 0 .../glossary/list-page.md | 0 .../glossary/list-template.md | 0 .../glossary/localization.md | 0 .../glossary/logical-path.md | 0 .../glossary/map.md | 0 .../glossary/markdown-attribute.md | 3 ++- .../glossary/marshal.md | 0 .../glossary/method.md | 0 .../glossary/module.md | 0 .../glossary/node.md | 0 .../glossary/noop.md | 0 .../glossary/object.md | 0 .../glossary/ordered-taxonomy.md | 0 .../glossary/output-format.md | 0 .../glossary/page-bundle.md | 0 .../glossary/page-collection.md | 0 .../glossary/page-kind.md | 0 .../glossary/page-resource.md | 0 .../glossary/pager.md | 0 .../glossary/paginate.md | 0 .../glossary/pagination.md | 0 .../glossary/paginator.md | 0 .../glossary/parameter.md | 0 .../glossary/partial.md | 0 .../glossary/permalink.md | 0 .../glossary/pipe.md | 0 .../glossary/pipeline.md | 0 .../en/quick-reference/glossary/pretty-url.md | 5 ++++ .../glossary/publish.md | 0 .../glossary/raw-string-literal.md | 0 .../glossary/regular-page.md | 0 .../glossary/relative-permalink.md | 0 .../glossary/remote-resource.md | 0 .../glossary/render-hook.md | 0 .../glossary/resource-type.md | 0 .../glossary/resource.md | 0 .../glossary/scalar.md | 0 .../glossary/scope.md | 0 .../glossary/scratch-pad.md | 0 .../glossary/section-page.md | 0 .../glossary/section.md | 0 .../en/quick-reference/glossary/segment.md | 5 ++++ .../glossary/shortcode.md | 0 .../glossary/slice.md | 0 .../glossary/string.md | 0 .../glossary/taxonomic-weight.md | 0 .../glossary/taxonomy-object.md | 0 .../glossary/taxonomy-page.md | 0 .../glossary/taxonomy.md | 0 .../glossary/template-action.md | 0 .../glossary/template.md | 0 .../glossary/term-page.md | 0 .../glossary/term.md | 0 .../glossary/theme.md | 0 .../glossary/token.md | 0 .../glossary/type.md | 0 .../en/quick-reference/glossary/ugly-url.md | 5 ++++ .../glossary/unmarshal.md | 0 .../glossary/variable.md | 0 .../glossary/walk.md | 0 .../glossary/weight.md | 0 .../glossary/weighted-page.md | 0 .../glossary/zero-time.md | 0 content/en/quick-reference/methods.md | 4 ++-- .../en/quick-reference/page-collections.md | 4 ++-- layouts/_default/_markup/render-link.html | 2 +- layouts/shortcodes/glossary-term.html | 6 ++--- layouts/shortcodes/glossary.html | 24 ++++++++++++------- 119 files changed, 93 insertions(+), 58 deletions(-) delete mode 100644 content/en/getting-started/glossary/cache.md delete mode 100644 content/en/getting-started/glossary/element.md delete mode 100644 content/en/getting-started/glossary/field.md delete mode 100644 content/en/getting-started/glossary/global-resource.md rename content/en/{getting-started => quick-reference}/glossary/_index.md (62%) rename content/en/{getting-started => quick-reference}/glossary/action.md (100%) rename content/en/{getting-started => quick-reference}/glossary/archetype.md (100%) rename content/en/{getting-started => quick-reference}/glossary/argument.md (100%) rename content/en/{getting-started => quick-reference}/glossary/array.md (100%) create mode 100644 content/en/quick-reference/glossary/asset-pipeline.md rename content/en/{getting-started => quick-reference}/glossary/bool.md (100%) rename content/en/{getting-started => quick-reference}/glossary/boolean.md (100%) rename content/en/{getting-started => quick-reference}/glossary/branch-bundle.md (100%) rename content/en/{getting-started => quick-reference}/glossary/build.md (100%) rename content/en/{getting-started => quick-reference}/glossary/bundle.md (100%) create mode 100644 content/en/quick-reference/glossary/cache.md rename content/en/{getting-started => quick-reference}/glossary/chain.md (100%) rename content/en/{getting-started => quick-reference}/glossary/cjk.md (100%) rename content/en/{getting-started => quick-reference}/glossary/cli.md (100%) rename content/en/{getting-started => quick-reference}/glossary/collection.md (100%) rename content/en/{getting-started => quick-reference}/glossary/content-adapter.md (100%) rename content/en/{getting-started => quick-reference}/glossary/content-format.md (100%) rename content/en/{getting-started => quick-reference}/glossary/content-type.md (100%) rename content/en/{getting-started => quick-reference}/glossary/content-view.md (100%) rename content/en/{getting-started => quick-reference}/glossary/context.md (100%) rename content/en/{getting-started => quick-reference}/glossary/default-sort-order.md (100%) create mode 100644 content/en/quick-reference/glossary/duration.md create mode 100644 content/en/quick-reference/glossary/element.md rename content/en/{getting-started => quick-reference}/glossary/embedded-template.md (100%) rename content/en/{getting-started => quick-reference}/glossary/environment.md (100%) create mode 100644 content/en/quick-reference/glossary/field.md rename content/en/{getting-started => quick-reference}/glossary/flag.md (100%) rename content/en/{getting-started => quick-reference}/glossary/float.md (100%) rename content/en/{getting-started => quick-reference}/glossary/floating-point.md (100%) rename content/en/{getting-started => quick-reference}/glossary/fragment.md (100%) rename content/en/{getting-started => quick-reference}/glossary/front-matter.md (100%) rename content/en/{getting-started => quick-reference}/glossary/function.md (100%) create mode 100644 content/en/quick-reference/glossary/glob.md create mode 100644 content/en/quick-reference/glossary/global-resource.md rename content/en/{getting-started => quick-reference}/glossary/headless-bundle.md (100%) rename content/en/{getting-started => quick-reference}/glossary/identifier.md (100%) rename content/en/{getting-started => quick-reference}/glossary/int.md (100%) rename content/en/{getting-started => quick-reference}/glossary/integer.md (100%) rename content/en/{getting-started => quick-reference}/glossary/internationalization.md (100%) rename content/en/{getting-started => quick-reference}/glossary/interpreted-string-literal.md (100%) rename content/en/{getting-started => quick-reference}/glossary/interval.md (100%) rename content/en/{getting-started => quick-reference}/glossary/kind.md (100%) rename content/en/{getting-started => quick-reference}/glossary/layout.md (100%) rename content/en/{getting-started => quick-reference}/glossary/leaf-bundle.md (100%) rename content/en/{getting-started => quick-reference}/glossary/lexer.md (100%) rename content/en/{getting-started => quick-reference}/glossary/list-page.md (100%) rename content/en/{getting-started => quick-reference}/glossary/list-template.md (100%) rename content/en/{getting-started => quick-reference}/glossary/localization.md (100%) rename content/en/{getting-started => quick-reference}/glossary/logical-path.md (100%) rename content/en/{getting-started => quick-reference}/glossary/map.md (100%) rename content/en/{getting-started => quick-reference}/glossary/markdown-attribute.md (75%) rename content/en/{getting-started => quick-reference}/glossary/marshal.md (100%) rename content/en/{getting-started => quick-reference}/glossary/method.md (100%) rename content/en/{getting-started => quick-reference}/glossary/module.md (100%) rename content/en/{getting-started => quick-reference}/glossary/node.md (100%) rename content/en/{getting-started => quick-reference}/glossary/noop.md (100%) rename content/en/{getting-started => quick-reference}/glossary/object.md (100%) rename content/en/{getting-started => quick-reference}/glossary/ordered-taxonomy.md (100%) rename content/en/{getting-started => quick-reference}/glossary/output-format.md (100%) rename content/en/{getting-started => quick-reference}/glossary/page-bundle.md (100%) rename content/en/{getting-started => quick-reference}/glossary/page-collection.md (100%) rename content/en/{getting-started => quick-reference}/glossary/page-kind.md (100%) rename content/en/{getting-started => quick-reference}/glossary/page-resource.md (100%) rename content/en/{getting-started => quick-reference}/glossary/pager.md (100%) rename content/en/{getting-started => quick-reference}/glossary/paginate.md (100%) rename content/en/{getting-started => quick-reference}/glossary/pagination.md (100%) rename content/en/{getting-started => quick-reference}/glossary/paginator.md (100%) rename content/en/{getting-started => quick-reference}/glossary/parameter.md (100%) rename content/en/{getting-started => quick-reference}/glossary/partial.md (100%) rename content/en/{getting-started => quick-reference}/glossary/permalink.md (100%) rename content/en/{getting-started => quick-reference}/glossary/pipe.md (100%) rename content/en/{getting-started => quick-reference}/glossary/pipeline.md (100%) create mode 100644 content/en/quick-reference/glossary/pretty-url.md rename content/en/{getting-started => quick-reference}/glossary/publish.md (100%) rename content/en/{getting-started => quick-reference}/glossary/raw-string-literal.md (100%) rename content/en/{getting-started => quick-reference}/glossary/regular-page.md (100%) rename content/en/{getting-started => quick-reference}/glossary/relative-permalink.md (100%) rename content/en/{getting-started => quick-reference}/glossary/remote-resource.md (100%) rename content/en/{getting-started => quick-reference}/glossary/render-hook.md (100%) rename content/en/{getting-started => quick-reference}/glossary/resource-type.md (100%) rename content/en/{getting-started => quick-reference}/glossary/resource.md (100%) rename content/en/{getting-started => quick-reference}/glossary/scalar.md (100%) rename content/en/{getting-started => quick-reference}/glossary/scope.md (100%) rename content/en/{getting-started => quick-reference}/glossary/scratch-pad.md (100%) rename content/en/{getting-started => quick-reference}/glossary/section-page.md (100%) rename content/en/{getting-started => quick-reference}/glossary/section.md (100%) create mode 100644 content/en/quick-reference/glossary/segment.md rename content/en/{getting-started => quick-reference}/glossary/shortcode.md (100%) rename content/en/{getting-started => quick-reference}/glossary/slice.md (100%) rename content/en/{getting-started => quick-reference}/glossary/string.md (100%) rename content/en/{getting-started => quick-reference}/glossary/taxonomic-weight.md (100%) rename content/en/{getting-started => quick-reference}/glossary/taxonomy-object.md (100%) rename content/en/{getting-started => quick-reference}/glossary/taxonomy-page.md (100%) rename content/en/{getting-started => quick-reference}/glossary/taxonomy.md (100%) rename content/en/{getting-started => quick-reference}/glossary/template-action.md (100%) rename content/en/{getting-started => quick-reference}/glossary/template.md (100%) rename content/en/{getting-started => quick-reference}/glossary/term-page.md (100%) rename content/en/{getting-started => quick-reference}/glossary/term.md (100%) rename content/en/{getting-started => quick-reference}/glossary/theme.md (100%) rename content/en/{getting-started => quick-reference}/glossary/token.md (100%) rename content/en/{getting-started => quick-reference}/glossary/type.md (100%) create mode 100644 content/en/quick-reference/glossary/ugly-url.md rename content/en/{getting-started => quick-reference}/glossary/unmarshal.md (100%) rename content/en/{getting-started => quick-reference}/glossary/variable.md (100%) rename content/en/{getting-started => quick-reference}/glossary/walk.md (100%) rename content/en/{getting-started => quick-reference}/glossary/weight.md (100%) rename content/en/{getting-started => quick-reference}/glossary/weighted-page.md (100%) rename content/en/{getting-started => quick-reference}/glossary/zero-time.md (100%) diff --git a/content/en/contribute/documentation.md b/content/en/contribute/documentation.md index 16d06dee1..9316378d2 100644 --- a/content/en/contribute/documentation.md +++ b/content/en/contribute/documentation.md @@ -41,7 +41,7 @@ Please follow these guidelines: - Remove consecutive blank lines (maximum of two) - Remove trailing spaces -### Glossary of terms +### Glossary Glossary terms are maintained on individual pages. While not directly accessible to site visitors, these pages act as a central repository for term definitions. @@ -53,7 +53,7 @@ To link to a term definition on the glossary page, use this custom link syntax: [term](g) ``` -Lookups are case-insensitive, ignore formatting, and support both singular and plural forms. For example, all of these variations will link to the same glossary entry: +Lookups are case-insensitive, ignore formatting, and support both singular and plural forms. For example, all of these variations will link to the same glossary term: ```text [global resource](g) @@ -68,12 +68,9 @@ To insert a term definition, use the [`glossary-term`] shortcode: {{%/* glossary-term "global resource" */%}} ``` -[glossary of terms]: /getting-started/glossary/ -[`glossary-term`]: #glossary-term - ### Terminology -Please link to the [glossary of terms] when necessary, and use the terms consistently throughout the documentation. Of special note: +Please link to the glossary (see above) when necessary, and use the terms consistently throughout the documentation. Of special note: - The term "front matter" is two words unless you are referring to the configuration key - The term "home page" is two words @@ -85,8 +82,6 @@ Please link to the [glossary of terms] when necessary, and use the terms consist - Capitalize the word "Markdown" - Hyphenate the term "open-source" when used an adjective. -Use the [glossary link] (`gl`) shortcode to insert a link to the glossary entry for the given term, and use the [glossary term] (`gt`) shortcode to insert the definition of the given term. - ### Page titles and headings Please follow these guidelines for page titles and headings: @@ -124,8 +119,6 @@ Yes → Hugo is fast. Level 6 headings are styled as `dt` elements. This was implemented to support a [glossary] with linkable terms. -[glossary]: /getting-started/glossary/ - ### Function and method descriptions When adding a page to the [functions] or [methods] section, begin the description with the word "Returns". With functions and methods that return a boolean value, begin the description with the phrase "Reports whether". @@ -472,13 +465,14 @@ Step 9 [ATX]: https://spec.commonmark.org/0.30/#atx-headings [Microsoft Writing Style Guide]: https://learn.microsoft.com/en-us/style-guide/welcome/ +[`glossary-term`]: #glossary-term [basic english]: https://simple.wikipedia.org/wiki/Basic_English [code examples]: #code-examples [code shortcode]: #code [code-toggle shortcode]: #code-toggle [documentation repository]: https://github.com/gohugoio/hugoDocs/ [fenced code blocks]: https://spec.commonmark.org/0.30/#fenced-code-blocks -[glossary of terms]: /getting-started/glossary/ +[glossary]: /quick-reference/glossary/ [indented code blocks]: https://spec.commonmark.org/0.30/#indented-code-blocks [issues]: https://github.com/gohugoio/hugoDocs/issues [list items]: https://spec.commonmark.org/0.30/#list-items diff --git a/content/en/getting-started/glossary/cache.md b/content/en/getting-started/glossary/cache.md deleted file mode 100644 index 139ce9033..000000000 --- a/content/en/getting-started/glossary/cache.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -title: cache ---- - -A software component that stores data so that future requests for the same data are faster. diff --git a/content/en/getting-started/glossary/element.md b/content/en/getting-started/glossary/element.md deleted file mode 100644 index 5c33c55ad..000000000 --- a/content/en/getting-started/glossary/element.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -title: element ---- - -A member of a slice or array. diff --git a/content/en/getting-started/glossary/field.md b/content/en/getting-started/glossary/field.md deleted file mode 100644 index f49e65c79..000000000 --- a/content/en/getting-started/glossary/field.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -title: field ---- - -A predefined key-value pair in front matter such as `date` or `title`. See also [parameter](g). diff --git a/content/en/getting-started/glossary/global-resource.md b/content/en/getting-started/glossary/global-resource.md deleted file mode 100644 index e51e68363..000000000 --- a/content/en/getting-started/glossary/global-resource.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -title: global resource ---- - -A file within the `assets` directory, or within any directory [mounted](/hugo-modules/configuration/#module-configuration-mounts) to the `assets` directory. Capture one or more global resources using the [`resources.Get`], [`resources.GetMatch`], [`resources.Match`], or [`resources.ByType`] functions. - -[`resources.Get`]: /functions/resources/get/ -[`resources.GetMatch`]: /functions/resources/getmatch/ -[`resources.Match`]: /functions/resources/match/ -[`resources.ByType`]: /functions/resources/byType/ diff --git a/content/en/getting-started/glossary/_index.md b/content/en/quick-reference/glossary/_index.md similarity index 62% rename from content/en/getting-started/glossary/_index.md rename to content/en/quick-reference/glossary/_index.md index 001d80fe0..0ed74be8e 100644 --- a/content/en/getting-started/glossary/_index.md +++ b/content/en/quick-reference/glossary/_index.md @@ -1,13 +1,14 @@ --- -title: Glossary of terms +title: Glossary description: Terms commonly used throughout the documentation. -categories: [getting started] +categories: [quick-reference] keywords: [glossary] menu: docs: - parent: getting-started - weight: 80 -weight: 80 + parent: quick-reference + weight: 40 +aliases: [/getting-started/glossary/] +weight: 40 layout: single build: render: always diff --git a/content/en/getting-started/glossary/action.md b/content/en/quick-reference/glossary/action.md similarity index 100% rename from content/en/getting-started/glossary/action.md rename to content/en/quick-reference/glossary/action.md diff --git a/content/en/getting-started/glossary/archetype.md b/content/en/quick-reference/glossary/archetype.md similarity index 100% rename from content/en/getting-started/glossary/archetype.md rename to content/en/quick-reference/glossary/archetype.md diff --git a/content/en/getting-started/glossary/argument.md b/content/en/quick-reference/glossary/argument.md similarity index 100% rename from content/en/getting-started/glossary/argument.md rename to content/en/quick-reference/glossary/argument.md diff --git a/content/en/getting-started/glossary/array.md b/content/en/quick-reference/glossary/array.md similarity index 100% rename from content/en/getting-started/glossary/array.md rename to content/en/quick-reference/glossary/array.md diff --git a/content/en/quick-reference/glossary/asset-pipeline.md b/content/en/quick-reference/glossary/asset-pipeline.md new file mode 100644 index 000000000..5f3264a6e --- /dev/null +++ b/content/en/quick-reference/glossary/asset-pipeline.md @@ -0,0 +1,5 @@ +--- +title: asset pipeline +--- + +An _asset pipeline_ is a system that automates and optimizes the handling of static assets like images, stylesheets, and JavaScript files. diff --git a/content/en/getting-started/glossary/bool.md b/content/en/quick-reference/glossary/bool.md similarity index 100% rename from content/en/getting-started/glossary/bool.md rename to content/en/quick-reference/glossary/bool.md diff --git a/content/en/getting-started/glossary/boolean.md b/content/en/quick-reference/glossary/boolean.md similarity index 100% rename from content/en/getting-started/glossary/boolean.md rename to content/en/quick-reference/glossary/boolean.md diff --git a/content/en/getting-started/glossary/branch-bundle.md b/content/en/quick-reference/glossary/branch-bundle.md similarity index 100% rename from content/en/getting-started/glossary/branch-bundle.md rename to content/en/quick-reference/glossary/branch-bundle.md diff --git a/content/en/getting-started/glossary/build.md b/content/en/quick-reference/glossary/build.md similarity index 100% rename from content/en/getting-started/glossary/build.md rename to content/en/quick-reference/glossary/build.md diff --git a/content/en/getting-started/glossary/bundle.md b/content/en/quick-reference/glossary/bundle.md similarity index 100% rename from content/en/getting-started/glossary/bundle.md rename to content/en/quick-reference/glossary/bundle.md diff --git a/content/en/quick-reference/glossary/cache.md b/content/en/quick-reference/glossary/cache.md new file mode 100644 index 000000000..a86068e4a --- /dev/null +++ b/content/en/quick-reference/glossary/cache.md @@ -0,0 +1,5 @@ +--- +title: cache +--- + +A _cache_ is a software component that stores data so that future requests for the same data are faster. diff --git a/content/en/getting-started/glossary/chain.md b/content/en/quick-reference/glossary/chain.md similarity index 100% rename from content/en/getting-started/glossary/chain.md rename to content/en/quick-reference/glossary/chain.md diff --git a/content/en/getting-started/glossary/cjk.md b/content/en/quick-reference/glossary/cjk.md similarity index 100% rename from content/en/getting-started/glossary/cjk.md rename to content/en/quick-reference/glossary/cjk.md diff --git a/content/en/getting-started/glossary/cli.md b/content/en/quick-reference/glossary/cli.md similarity index 100% rename from content/en/getting-started/glossary/cli.md rename to content/en/quick-reference/glossary/cli.md diff --git a/content/en/getting-started/glossary/collection.md b/content/en/quick-reference/glossary/collection.md similarity index 100% rename from content/en/getting-started/glossary/collection.md rename to content/en/quick-reference/glossary/collection.md diff --git a/content/en/getting-started/glossary/content-adapter.md b/content/en/quick-reference/glossary/content-adapter.md similarity index 100% rename from content/en/getting-started/glossary/content-adapter.md rename to content/en/quick-reference/glossary/content-adapter.md diff --git a/content/en/getting-started/glossary/content-format.md b/content/en/quick-reference/glossary/content-format.md similarity index 100% rename from content/en/getting-started/glossary/content-format.md rename to content/en/quick-reference/glossary/content-format.md diff --git a/content/en/getting-started/glossary/content-type.md b/content/en/quick-reference/glossary/content-type.md similarity index 100% rename from content/en/getting-started/glossary/content-type.md rename to content/en/quick-reference/glossary/content-type.md diff --git a/content/en/getting-started/glossary/content-view.md b/content/en/quick-reference/glossary/content-view.md similarity index 100% rename from content/en/getting-started/glossary/content-view.md rename to content/en/quick-reference/glossary/content-view.md diff --git a/content/en/getting-started/glossary/context.md b/content/en/quick-reference/glossary/context.md similarity index 100% rename from content/en/getting-started/glossary/context.md rename to content/en/quick-reference/glossary/context.md diff --git a/content/en/getting-started/glossary/default-sort-order.md b/content/en/quick-reference/glossary/default-sort-order.md similarity index 100% rename from content/en/getting-started/glossary/default-sort-order.md rename to content/en/quick-reference/glossary/default-sort-order.md diff --git a/content/en/quick-reference/glossary/duration.md b/content/en/quick-reference/glossary/duration.md new file mode 100644 index 000000000..21fd3c832 --- /dev/null +++ b/content/en/quick-reference/glossary/duration.md @@ -0,0 +1,5 @@ +--- +title: duration +--- + +A _duration_ is a data type that represent a length of time, expressed using units such as seconds (represented by `s`), minutes (represented by `m`), and hours (represented by `h`). For example, `42s` means 42 seconds, `6m7s` means 6 minutes and 7 seconds, and `6h7m42s` means 6 hours, 7 minutes, and 42 seconds. diff --git a/content/en/quick-reference/glossary/element.md b/content/en/quick-reference/glossary/element.md new file mode 100644 index 000000000..39f5df656 --- /dev/null +++ b/content/en/quick-reference/glossary/element.md @@ -0,0 +1,5 @@ +--- +title: element +--- + +An _element_ is a member of a [_slice_](g) or [_array_](g). diff --git a/content/en/getting-started/glossary/embedded-template.md b/content/en/quick-reference/glossary/embedded-template.md similarity index 100% rename from content/en/getting-started/glossary/embedded-template.md rename to content/en/quick-reference/glossary/embedded-template.md diff --git a/content/en/getting-started/glossary/environment.md b/content/en/quick-reference/glossary/environment.md similarity index 100% rename from content/en/getting-started/glossary/environment.md rename to content/en/quick-reference/glossary/environment.md diff --git a/content/en/quick-reference/glossary/field.md b/content/en/quick-reference/glossary/field.md new file mode 100644 index 000000000..a32eb3a6b --- /dev/null +++ b/content/en/quick-reference/glossary/field.md @@ -0,0 +1,5 @@ +--- +title: field +--- + +A _field_ is a predefined key-value pair in front matter such as `date` or `title`. diff --git a/content/en/getting-started/glossary/flag.md b/content/en/quick-reference/glossary/flag.md similarity index 100% rename from content/en/getting-started/glossary/flag.md rename to content/en/quick-reference/glossary/flag.md diff --git a/content/en/getting-started/glossary/float.md b/content/en/quick-reference/glossary/float.md similarity index 100% rename from content/en/getting-started/glossary/float.md rename to content/en/quick-reference/glossary/float.md diff --git a/content/en/getting-started/glossary/floating-point.md b/content/en/quick-reference/glossary/floating-point.md similarity index 100% rename from content/en/getting-started/glossary/floating-point.md rename to content/en/quick-reference/glossary/floating-point.md diff --git a/content/en/getting-started/glossary/fragment.md b/content/en/quick-reference/glossary/fragment.md similarity index 100% rename from content/en/getting-started/glossary/fragment.md rename to content/en/quick-reference/glossary/fragment.md diff --git a/content/en/getting-started/glossary/front-matter.md b/content/en/quick-reference/glossary/front-matter.md similarity index 100% rename from content/en/getting-started/glossary/front-matter.md rename to content/en/quick-reference/glossary/front-matter.md diff --git a/content/en/getting-started/glossary/function.md b/content/en/quick-reference/glossary/function.md similarity index 100% rename from content/en/getting-started/glossary/function.md rename to content/en/quick-reference/glossary/function.md diff --git a/content/en/quick-reference/glossary/glob.md b/content/en/quick-reference/glossary/glob.md new file mode 100644 index 000000000..5243d1ef9 --- /dev/null +++ b/content/en/quick-reference/glossary/glob.md @@ -0,0 +1,6 @@ +--- +title: glob +reference: https://github.com/gobwas/glob?tab=readme-ov-file#example +--- + +A _glob_ is a pattern used to match filenames and paths. It's a shorthand for specifying a set of files, making it easier to work with multiple files at once. diff --git a/content/en/quick-reference/glossary/global-resource.md b/content/en/quick-reference/glossary/global-resource.md new file mode 100644 index 000000000..1ca42a6ec --- /dev/null +++ b/content/en/quick-reference/glossary/global-resource.md @@ -0,0 +1,10 @@ +--- +title: global resource +--- + +A file within the `assets` directory, or within any directory mounted to the `assets` directory. Capture one or more global resources using the [`resources.Get`], [`resources.GetMatch`], [`resources.Match`], or [`resources.ByType`] functions. + +[`resources.Get`]: /functions/resources/get/ +[`resources.GetMatch`]: /functions/resources/getmatch/ +[`resources.Match`]: /functions/resources/match/ +[`resources.ByType`]: /functions/resources/byType/ diff --git a/content/en/getting-started/glossary/headless-bundle.md b/content/en/quick-reference/glossary/headless-bundle.md similarity index 100% rename from content/en/getting-started/glossary/headless-bundle.md rename to content/en/quick-reference/glossary/headless-bundle.md diff --git a/content/en/getting-started/glossary/identifier.md b/content/en/quick-reference/glossary/identifier.md similarity index 100% rename from content/en/getting-started/glossary/identifier.md rename to content/en/quick-reference/glossary/identifier.md diff --git a/content/en/getting-started/glossary/int.md b/content/en/quick-reference/glossary/int.md similarity index 100% rename from content/en/getting-started/glossary/int.md rename to content/en/quick-reference/glossary/int.md diff --git a/content/en/getting-started/glossary/integer.md b/content/en/quick-reference/glossary/integer.md similarity index 100% rename from content/en/getting-started/glossary/integer.md rename to content/en/quick-reference/glossary/integer.md diff --git a/content/en/getting-started/glossary/internationalization.md b/content/en/quick-reference/glossary/internationalization.md similarity index 100% rename from content/en/getting-started/glossary/internationalization.md rename to content/en/quick-reference/glossary/internationalization.md diff --git a/content/en/getting-started/glossary/interpreted-string-literal.md b/content/en/quick-reference/glossary/interpreted-string-literal.md similarity index 100% rename from content/en/getting-started/glossary/interpreted-string-literal.md rename to content/en/quick-reference/glossary/interpreted-string-literal.md diff --git a/content/en/getting-started/glossary/interval.md b/content/en/quick-reference/glossary/interval.md similarity index 100% rename from content/en/getting-started/glossary/interval.md rename to content/en/quick-reference/glossary/interval.md diff --git a/content/en/getting-started/glossary/kind.md b/content/en/quick-reference/glossary/kind.md similarity index 100% rename from content/en/getting-started/glossary/kind.md rename to content/en/quick-reference/glossary/kind.md diff --git a/content/en/getting-started/glossary/layout.md b/content/en/quick-reference/glossary/layout.md similarity index 100% rename from content/en/getting-started/glossary/layout.md rename to content/en/quick-reference/glossary/layout.md diff --git a/content/en/getting-started/glossary/leaf-bundle.md b/content/en/quick-reference/glossary/leaf-bundle.md similarity index 100% rename from content/en/getting-started/glossary/leaf-bundle.md rename to content/en/quick-reference/glossary/leaf-bundle.md diff --git a/content/en/getting-started/glossary/lexer.md b/content/en/quick-reference/glossary/lexer.md similarity index 100% rename from content/en/getting-started/glossary/lexer.md rename to content/en/quick-reference/glossary/lexer.md diff --git a/content/en/getting-started/glossary/list-page.md b/content/en/quick-reference/glossary/list-page.md similarity index 100% rename from content/en/getting-started/glossary/list-page.md rename to content/en/quick-reference/glossary/list-page.md diff --git a/content/en/getting-started/glossary/list-template.md b/content/en/quick-reference/glossary/list-template.md similarity index 100% rename from content/en/getting-started/glossary/list-template.md rename to content/en/quick-reference/glossary/list-template.md diff --git a/content/en/getting-started/glossary/localization.md b/content/en/quick-reference/glossary/localization.md similarity index 100% rename from content/en/getting-started/glossary/localization.md rename to content/en/quick-reference/glossary/localization.md diff --git a/content/en/getting-started/glossary/logical-path.md b/content/en/quick-reference/glossary/logical-path.md similarity index 100% rename from content/en/getting-started/glossary/logical-path.md rename to content/en/quick-reference/glossary/logical-path.md diff --git a/content/en/getting-started/glossary/map.md b/content/en/quick-reference/glossary/map.md similarity index 100% rename from content/en/getting-started/glossary/map.md rename to content/en/quick-reference/glossary/map.md diff --git a/content/en/getting-started/glossary/markdown-attribute.md b/content/en/quick-reference/glossary/markdown-attribute.md similarity index 75% rename from content/en/getting-started/glossary/markdown-attribute.md rename to content/en/quick-reference/glossary/markdown-attribute.md index ab9a984f5..2e355999e 100644 --- a/content/en/getting-started/glossary/markdown-attribute.md +++ b/content/en/quick-reference/glossary/markdown-attribute.md @@ -1,5 +1,6 @@ --- title: Markdown attribute +reference: /content-management/markdown-attributes/ --- -A list of attributes, containing one or more key-value pairs, separated by spaces or commas, and wrapped by braces. Apply Markdown attributes to images and block-level elements including blockquotes, fenced code blocks, headings, horizontal rules, lists, paragraphs, and tables. See [details](/getting-started/configuration-markup/#goldmark). +A list of attributes, containing one or more key-value pairs, separated by spaces or commas, and wrapped by braces. Apply Markdown attributes to images and block-level elements including blockquotes, fenced code blocks, headings, horizontal rules, lists, paragraphs, and tables. diff --git a/content/en/getting-started/glossary/marshal.md b/content/en/quick-reference/glossary/marshal.md similarity index 100% rename from content/en/getting-started/glossary/marshal.md rename to content/en/quick-reference/glossary/marshal.md diff --git a/content/en/getting-started/glossary/method.md b/content/en/quick-reference/glossary/method.md similarity index 100% rename from content/en/getting-started/glossary/method.md rename to content/en/quick-reference/glossary/method.md diff --git a/content/en/getting-started/glossary/module.md b/content/en/quick-reference/glossary/module.md similarity index 100% rename from content/en/getting-started/glossary/module.md rename to content/en/quick-reference/glossary/module.md diff --git a/content/en/getting-started/glossary/node.md b/content/en/quick-reference/glossary/node.md similarity index 100% rename from content/en/getting-started/glossary/node.md rename to content/en/quick-reference/glossary/node.md diff --git a/content/en/getting-started/glossary/noop.md b/content/en/quick-reference/glossary/noop.md similarity index 100% rename from content/en/getting-started/glossary/noop.md rename to content/en/quick-reference/glossary/noop.md diff --git a/content/en/getting-started/glossary/object.md b/content/en/quick-reference/glossary/object.md similarity index 100% rename from content/en/getting-started/glossary/object.md rename to content/en/quick-reference/glossary/object.md diff --git a/content/en/getting-started/glossary/ordered-taxonomy.md b/content/en/quick-reference/glossary/ordered-taxonomy.md similarity index 100% rename from content/en/getting-started/glossary/ordered-taxonomy.md rename to content/en/quick-reference/glossary/ordered-taxonomy.md diff --git a/content/en/getting-started/glossary/output-format.md b/content/en/quick-reference/glossary/output-format.md similarity index 100% rename from content/en/getting-started/glossary/output-format.md rename to content/en/quick-reference/glossary/output-format.md diff --git a/content/en/getting-started/glossary/page-bundle.md b/content/en/quick-reference/glossary/page-bundle.md similarity index 100% rename from content/en/getting-started/glossary/page-bundle.md rename to content/en/quick-reference/glossary/page-bundle.md diff --git a/content/en/getting-started/glossary/page-collection.md b/content/en/quick-reference/glossary/page-collection.md similarity index 100% rename from content/en/getting-started/glossary/page-collection.md rename to content/en/quick-reference/glossary/page-collection.md diff --git a/content/en/getting-started/glossary/page-kind.md b/content/en/quick-reference/glossary/page-kind.md similarity index 100% rename from content/en/getting-started/glossary/page-kind.md rename to content/en/quick-reference/glossary/page-kind.md diff --git a/content/en/getting-started/glossary/page-resource.md b/content/en/quick-reference/glossary/page-resource.md similarity index 100% rename from content/en/getting-started/glossary/page-resource.md rename to content/en/quick-reference/glossary/page-resource.md diff --git a/content/en/getting-started/glossary/pager.md b/content/en/quick-reference/glossary/pager.md similarity index 100% rename from content/en/getting-started/glossary/pager.md rename to content/en/quick-reference/glossary/pager.md diff --git a/content/en/getting-started/glossary/paginate.md b/content/en/quick-reference/glossary/paginate.md similarity index 100% rename from content/en/getting-started/glossary/paginate.md rename to content/en/quick-reference/glossary/paginate.md diff --git a/content/en/getting-started/glossary/pagination.md b/content/en/quick-reference/glossary/pagination.md similarity index 100% rename from content/en/getting-started/glossary/pagination.md rename to content/en/quick-reference/glossary/pagination.md diff --git a/content/en/getting-started/glossary/paginator.md b/content/en/quick-reference/glossary/paginator.md similarity index 100% rename from content/en/getting-started/glossary/paginator.md rename to content/en/quick-reference/glossary/paginator.md diff --git a/content/en/getting-started/glossary/parameter.md b/content/en/quick-reference/glossary/parameter.md similarity index 100% rename from content/en/getting-started/glossary/parameter.md rename to content/en/quick-reference/glossary/parameter.md diff --git a/content/en/getting-started/glossary/partial.md b/content/en/quick-reference/glossary/partial.md similarity index 100% rename from content/en/getting-started/glossary/partial.md rename to content/en/quick-reference/glossary/partial.md diff --git a/content/en/getting-started/glossary/permalink.md b/content/en/quick-reference/glossary/permalink.md similarity index 100% rename from content/en/getting-started/glossary/permalink.md rename to content/en/quick-reference/glossary/permalink.md diff --git a/content/en/getting-started/glossary/pipe.md b/content/en/quick-reference/glossary/pipe.md similarity index 100% rename from content/en/getting-started/glossary/pipe.md rename to content/en/quick-reference/glossary/pipe.md diff --git a/content/en/getting-started/glossary/pipeline.md b/content/en/quick-reference/glossary/pipeline.md similarity index 100% rename from content/en/getting-started/glossary/pipeline.md rename to content/en/quick-reference/glossary/pipeline.md diff --git a/content/en/quick-reference/glossary/pretty-url.md b/content/en/quick-reference/glossary/pretty-url.md new file mode 100644 index 000000000..b15ef9f0f --- /dev/null +++ b/content/en/quick-reference/glossary/pretty-url.md @@ -0,0 +1,5 @@ +--- +title: pretty URL +--- + +A _pretty URL_ is a URL that does not include a file extension. diff --git a/content/en/getting-started/glossary/publish.md b/content/en/quick-reference/glossary/publish.md similarity index 100% rename from content/en/getting-started/glossary/publish.md rename to content/en/quick-reference/glossary/publish.md diff --git a/content/en/getting-started/glossary/raw-string-literal.md b/content/en/quick-reference/glossary/raw-string-literal.md similarity index 100% rename from content/en/getting-started/glossary/raw-string-literal.md rename to content/en/quick-reference/glossary/raw-string-literal.md diff --git a/content/en/getting-started/glossary/regular-page.md b/content/en/quick-reference/glossary/regular-page.md similarity index 100% rename from content/en/getting-started/glossary/regular-page.md rename to content/en/quick-reference/glossary/regular-page.md diff --git a/content/en/getting-started/glossary/relative-permalink.md b/content/en/quick-reference/glossary/relative-permalink.md similarity index 100% rename from content/en/getting-started/glossary/relative-permalink.md rename to content/en/quick-reference/glossary/relative-permalink.md diff --git a/content/en/getting-started/glossary/remote-resource.md b/content/en/quick-reference/glossary/remote-resource.md similarity index 100% rename from content/en/getting-started/glossary/remote-resource.md rename to content/en/quick-reference/glossary/remote-resource.md diff --git a/content/en/getting-started/glossary/render-hook.md b/content/en/quick-reference/glossary/render-hook.md similarity index 100% rename from content/en/getting-started/glossary/render-hook.md rename to content/en/quick-reference/glossary/render-hook.md diff --git a/content/en/getting-started/glossary/resource-type.md b/content/en/quick-reference/glossary/resource-type.md similarity index 100% rename from content/en/getting-started/glossary/resource-type.md rename to content/en/quick-reference/glossary/resource-type.md diff --git a/content/en/getting-started/glossary/resource.md b/content/en/quick-reference/glossary/resource.md similarity index 100% rename from content/en/getting-started/glossary/resource.md rename to content/en/quick-reference/glossary/resource.md diff --git a/content/en/getting-started/glossary/scalar.md b/content/en/quick-reference/glossary/scalar.md similarity index 100% rename from content/en/getting-started/glossary/scalar.md rename to content/en/quick-reference/glossary/scalar.md diff --git a/content/en/getting-started/glossary/scope.md b/content/en/quick-reference/glossary/scope.md similarity index 100% rename from content/en/getting-started/glossary/scope.md rename to content/en/quick-reference/glossary/scope.md diff --git a/content/en/getting-started/glossary/scratch-pad.md b/content/en/quick-reference/glossary/scratch-pad.md similarity index 100% rename from content/en/getting-started/glossary/scratch-pad.md rename to content/en/quick-reference/glossary/scratch-pad.md diff --git a/content/en/getting-started/glossary/section-page.md b/content/en/quick-reference/glossary/section-page.md similarity index 100% rename from content/en/getting-started/glossary/section-page.md rename to content/en/quick-reference/glossary/section-page.md diff --git a/content/en/getting-started/glossary/section.md b/content/en/quick-reference/glossary/section.md similarity index 100% rename from content/en/getting-started/glossary/section.md rename to content/en/quick-reference/glossary/section.md diff --git a/content/en/quick-reference/glossary/segment.md b/content/en/quick-reference/glossary/segment.md new file mode 100644 index 000000000..745e196de --- /dev/null +++ b/content/en/quick-reference/glossary/segment.md @@ -0,0 +1,5 @@ +--- +title: segment +--- + +A _segment_ is a subset of a site, filtered by [_logical path_](g), language, [_page kind_](g), and [_output format_](g). diff --git a/content/en/getting-started/glossary/shortcode.md b/content/en/quick-reference/glossary/shortcode.md similarity index 100% rename from content/en/getting-started/glossary/shortcode.md rename to content/en/quick-reference/glossary/shortcode.md diff --git a/content/en/getting-started/glossary/slice.md b/content/en/quick-reference/glossary/slice.md similarity index 100% rename from content/en/getting-started/glossary/slice.md rename to content/en/quick-reference/glossary/slice.md diff --git a/content/en/getting-started/glossary/string.md b/content/en/quick-reference/glossary/string.md similarity index 100% rename from content/en/getting-started/glossary/string.md rename to content/en/quick-reference/glossary/string.md diff --git a/content/en/getting-started/glossary/taxonomic-weight.md b/content/en/quick-reference/glossary/taxonomic-weight.md similarity index 100% rename from content/en/getting-started/glossary/taxonomic-weight.md rename to content/en/quick-reference/glossary/taxonomic-weight.md diff --git a/content/en/getting-started/glossary/taxonomy-object.md b/content/en/quick-reference/glossary/taxonomy-object.md similarity index 100% rename from content/en/getting-started/glossary/taxonomy-object.md rename to content/en/quick-reference/glossary/taxonomy-object.md diff --git a/content/en/getting-started/glossary/taxonomy-page.md b/content/en/quick-reference/glossary/taxonomy-page.md similarity index 100% rename from content/en/getting-started/glossary/taxonomy-page.md rename to content/en/quick-reference/glossary/taxonomy-page.md diff --git a/content/en/getting-started/glossary/taxonomy.md b/content/en/quick-reference/glossary/taxonomy.md similarity index 100% rename from content/en/getting-started/glossary/taxonomy.md rename to content/en/quick-reference/glossary/taxonomy.md diff --git a/content/en/getting-started/glossary/template-action.md b/content/en/quick-reference/glossary/template-action.md similarity index 100% rename from content/en/getting-started/glossary/template-action.md rename to content/en/quick-reference/glossary/template-action.md diff --git a/content/en/getting-started/glossary/template.md b/content/en/quick-reference/glossary/template.md similarity index 100% rename from content/en/getting-started/glossary/template.md rename to content/en/quick-reference/glossary/template.md diff --git a/content/en/getting-started/glossary/term-page.md b/content/en/quick-reference/glossary/term-page.md similarity index 100% rename from content/en/getting-started/glossary/term-page.md rename to content/en/quick-reference/glossary/term-page.md diff --git a/content/en/getting-started/glossary/term.md b/content/en/quick-reference/glossary/term.md similarity index 100% rename from content/en/getting-started/glossary/term.md rename to content/en/quick-reference/glossary/term.md diff --git a/content/en/getting-started/glossary/theme.md b/content/en/quick-reference/glossary/theme.md similarity index 100% rename from content/en/getting-started/glossary/theme.md rename to content/en/quick-reference/glossary/theme.md diff --git a/content/en/getting-started/glossary/token.md b/content/en/quick-reference/glossary/token.md similarity index 100% rename from content/en/getting-started/glossary/token.md rename to content/en/quick-reference/glossary/token.md diff --git a/content/en/getting-started/glossary/type.md b/content/en/quick-reference/glossary/type.md similarity index 100% rename from content/en/getting-started/glossary/type.md rename to content/en/quick-reference/glossary/type.md diff --git a/content/en/quick-reference/glossary/ugly-url.md b/content/en/quick-reference/glossary/ugly-url.md new file mode 100644 index 000000000..4083f9378 --- /dev/null +++ b/content/en/quick-reference/glossary/ugly-url.md @@ -0,0 +1,5 @@ +--- +title: ugly URL +--- + +An _ugly URL_ is a URL that includes a file extension. diff --git a/content/en/getting-started/glossary/unmarshal.md b/content/en/quick-reference/glossary/unmarshal.md similarity index 100% rename from content/en/getting-started/glossary/unmarshal.md rename to content/en/quick-reference/glossary/unmarshal.md diff --git a/content/en/getting-started/glossary/variable.md b/content/en/quick-reference/glossary/variable.md similarity index 100% rename from content/en/getting-started/glossary/variable.md rename to content/en/quick-reference/glossary/variable.md diff --git a/content/en/getting-started/glossary/walk.md b/content/en/quick-reference/glossary/walk.md similarity index 100% rename from content/en/getting-started/glossary/walk.md rename to content/en/quick-reference/glossary/walk.md diff --git a/content/en/getting-started/glossary/weight.md b/content/en/quick-reference/glossary/weight.md similarity index 100% rename from content/en/getting-started/glossary/weight.md rename to content/en/quick-reference/glossary/weight.md diff --git a/content/en/getting-started/glossary/weighted-page.md b/content/en/quick-reference/glossary/weighted-page.md similarity index 100% rename from content/en/getting-started/glossary/weighted-page.md rename to content/en/quick-reference/glossary/weighted-page.md diff --git a/content/en/getting-started/glossary/zero-time.md b/content/en/quick-reference/glossary/zero-time.md similarity index 100% rename from content/en/getting-started/glossary/zero-time.md rename to content/en/quick-reference/glossary/zero-time.md diff --git a/content/en/quick-reference/methods.md b/content/en/quick-reference/methods.md index abd1db709..5b4797f3a 100644 --- a/content/en/quick-reference/methods.md +++ b/content/en/quick-reference/methods.md @@ -6,8 +6,8 @@ keywords: [] menu: docs: parent: quick-reference - weight: 40 -weight: 40 + weight: 50 +weight: 50 toc: true --- diff --git a/content/en/quick-reference/page-collections.md b/content/en/quick-reference/page-collections.md index c86929b5b..836af3ea2 100644 --- a/content/en/quick-reference/page-collections.md +++ b/content/en/quick-reference/page-collections.md @@ -6,8 +6,8 @@ keywords: [] menu: docs: parent: quick-reference - weight: 50 -weight: 50 + weight: 60 +weight: 60 toc: true --- diff --git a/layouts/_default/_markup/render-link.html b/layouts/_default/_markup/render-link.html index ea5ef1891..dac7da33d 100644 --- a/layouts/_default/_markup/render-link.html +++ b/layouts/_default/_markup/render-link.html @@ -271,7 +271,7 @@ either of these shortcodes in conjunction with this render hook. {{- $text := .text | transform.Plainify | strings.ToLower }} {{- /* Initialize. */}} - {{- $glossaryPath := "/getting-started/glossary" }} + {{- $glossaryPath := "/quick-reference/glossary" }} {{- $termGiven := $text }} {{- $termActual := "" }} {{- $termSingular := inflect.Singularize $termGiven }} diff --git a/layouts/shortcodes/glossary-term.html b/layouts/shortcodes/glossary-term.html index 92ad93340..7aace730e 100644 --- a/layouts/shortcodes/glossary-term.html +++ b/layouts/shortcodes/glossary-term.html @@ -9,12 +9,12 @@ Renders the definition of the given glossary term. */}} {{- with .Get 0 }} - {{- $path := printf "/getting-started/glossary/%s" (urlize .) }} + {{- $path := printf "/quick-reference/glossary/%s" (urlize .) }} {{- with site.GetPage $path }} -{{ .RenderShortcodes }}{{/* Do not indent. */}} +{{ .RenderShortcodes }} {{/* Do not indent. Do not remove non-breaking space. */}} {{- else }} {{- errorf "The glossary term (%s) shortcode was unable to find %s: see %s" $.Name $path $.Position }} {{- end }} {{- else }} {{- errorf "The glossary term (%s) shortcode requires one positional parameter: see %s" $.Name $.Position }} -{{- end }} +{{- end -}} diff --git a/layouts/shortcodes/glossary.html b/layouts/shortcodes/glossary.html index 2767612ab..e91be32ce 100644 --- a/layouts/shortcodes/glossary.html +++ b/layouts/shortcodes/glossary.html @@ -13,13 +13,12 @@ shortcode. @example {{% glossary %}} */}} -{{- $path := "/getting-started/glossary" }} +{{- $path := "/quick-reference/glossary" }} {{- with site.GetPage $path }} - {{- with $p := .Pages.ByTitle }} {{- /* Build and render alphabetical index. */}} {{- $m := dict }} - {{- range $p }} + {{- range $p := .Pages.ByTitle }} {{- $k := substr .Title 0 1 | strings.ToUpper }} {{- if index $m $k }} {{- continue }} @@ -32,17 +31,26 @@ shortcode. {{- end }} {{- /* Render glossary terms. */}} - {{- range $p }} + {{- range $p := .Pages.ByTitle }} ###### {{ .Title }}{{/* Do not indent. */}} {{ .RenderShortcodes }}{{/* Do not indent. */}} {{- with .Params.reference }} - {{- with site.GetPage . -}} - See [details]({{ .RelPermalink }}).{{/* Do not indent. */}} - {{- end }} + {{- $destination := "" }} + {{- with $u := urls.Parse . }} + {{- if $u.IsAbs }} + {{- $destination = $u.String }} + {{- else }} + {{- with site.GetPage $u.Path -}} + {{- $destination = .RelPermalink }} + {{- else }} + {{- errorf "The %q shortcode was unable to find the reference link %s: see %s" $.Name . $p.String }} + {{- end }} + {{- end }} + {{- end -}} + See [details]({{ $destination }}).{{/* Do not indent. */}} {{- end }} {{- end }} - {{- end }} {{- else }} {{- errorf "The %q shortcode was unable to get %s: see %s" .Name $path .Position}} {{- end }}