diff --git a/archetypes/glossary.md b/archetypes/glossary.md new file mode 100644 index 000000000..00c6e527f --- /dev/null +++ b/archetypes/glossary.md @@ -0,0 +1,21 @@ +--- +title: {{ replace .File.ContentBaseName "-" " " }} +--- + +{{% comment %}} +You can insert these definitions in other pages using the glossary term (gt) shortcode, so they must be self-contained. + +Do this: + + A _foo_ is big bar. + +Not this: + + A big bar. + +Italicize the term whenever you use it in the definition. + +An exception to this rule occurs when a term is an alias for another. In such cases, it is sufficient to use the phrase 'See [page kind]'." +{{% /comment %}} + +{{% include "/getting-started/glossary/_link-reference-definitions" %}} diff --git a/content/en/about/features.md b/content/en/about/features.md index 58d324853..b9c68220a 100644 --- a/content/en/about/features.md +++ b/content/en/about/features.md @@ -11,6 +11,7 @@ weight: 30 toc: true --- +{{% gt bool %}} ## Framework [Multiplatform] diff --git a/content/en/getting-started/configuration-build.md b/content/en/getting-started/configuration-build.md index 91a19a9be..1ae014eaa 100644 --- a/content/en/getting-started/configuration-build.md +++ b/content/en/getting-started/configuration-build.md @@ -6,8 +6,8 @@ keywords: [build,buildStats,cache] menu: docs: parent: getting-started - weight: 60 -weight: 60 + weight: 70 +weight: 70 slug: configuration-build toc: true --- diff --git a/content/en/getting-started/configuration-markup.md b/content/en/getting-started/configuration-markup.md index 3853a3a6a..2c3cfde91 100644 --- a/content/en/getting-started/configuration-markup.md +++ b/content/en/getting-started/configuration-markup.md @@ -6,8 +6,8 @@ keywords: [markup,markdown,goldmark,asciidoc,asciidoctor,highlighting] menu: docs: parent: getting-started - weight: 50 -weight: 50 + weight: 60 +weight: 60 slug: configuration-markup toc: true --- diff --git a/content/en/getting-started/configuration.md b/content/en/getting-started/configuration.md index 6fb09c164..0798be3b6 100644 --- a/content/en/getting-started/configuration.md +++ b/content/en/getting-started/configuration.md @@ -7,8 +7,8 @@ keywords: [configuration,toml,yaml,json] menu: docs: parent: getting-started - weight: 40 -weight: 40 + weight: 50 +weight: 50 toc: true aliases: [/overview/source-directory/,/overview/configuration/] --- diff --git a/content/en/getting-started/directory-structure.md b/content/en/getting-started/directory-structure.md index 823db20ff..e32f43557 100644 --- a/content/en/getting-started/directory-structure.md +++ b/content/en/getting-started/directory-structure.md @@ -6,8 +6,8 @@ keywords: [source, organization, directories] menu: docs: parent: getting-started - weight: 30 -weight: 30 + weight: 40 +weight: 40 toc: true aliases: [/overview/source-directory/] --- diff --git a/content/en/getting-started/external-learning-resources/index.md b/content/en/getting-started/external-learning-resources/index.md index d30305c2e..7d18c9334 100644 --- a/content/en/getting-started/external-learning-resources/index.md +++ b/content/en/getting-started/external-learning-resources/index.md @@ -6,8 +6,8 @@ keywords: [books, tutorials, learning, usage] menu: docs: parent: getting-started - weight: 70 -weight: 70 + weight: 90 +weight: 90 toc: true --- diff --git a/content/en/getting-started/glossary.md b/content/en/getting-started/glossary.md deleted file mode 100644 index 1b4fb2981..000000000 --- a/content/en/getting-started/glossary.md +++ /dev/null @@ -1,472 +0,0 @@ ---- -title: Glossary of terms -description: Terms commonly used throughout the documentation. -categories: [getting started] -keywords: [glossary] -menu: - docs: - parent: getting-started - weight: 60 -weight: 60 -# Use level 6 headings for each term in the glossary. ---- - -[A](#action)  -[B](#bool)  -[C](#cache)  -[D](#default-sort-order)  -[E](#environment)  -[F](#field)  -[G](#global-resource)  -[H](#headless-bundle)  -[I](#identifier)  -[K](#kind)  -[L](#layout)  -[M](#map)  -[N](#node)  -[O](#object)  -[P](#page-bundle)  -[R](#regular-page)  -[S](#scalar)  -[T](#taxonomic-weight)  -[U](#unmarshal)  -[V](#variable)  -[W](#walk)  -[Z](#zero-time)  - -###### action - -See [template action](#template-action). - -###### archetype - -A template for new content. See [details](/content-management/archetypes/). - -###### argument - -A [scalar](#scalar), [array](#array), [slice](#slice), [map](#map), or [object](#object) passed to a [function](#function), [method](#method), or [shortcode](#shortcode). - -###### array - -A numbered sequence of elements. Unlike Go's [slice](#slice) data type, an array has a fixed length. [Elements](#element) within an array can be [scalars](#scalar), slices, [maps](#map), pages, or other arrays. See the [Go documentation](https://go.dev/ref/spec#Array_types) for details. - -###### bool - -See [boolean](#boolean). - -###### boolean - -A data type with two possible values, either `true` or `false`. - -###### branch bundle - -A directory that contains an `_index.md` file and zero or more [resources](#resource). Analogous to a physical branch, a branch bundle may have descendants including leaf bundles and other branch bundles. Top level directories with or without `_index.md` files are also branch bundles. This includes the home page. See [details](/content-management/page-bundles/). - -###### build - -To generate a static site that includes HTML files and assets such as images, CSS, and JavaScript. The build process includes rendering and resource transformations. - -###### bundle - -See [page bundle](#page-bundle). - -###### cache - -A software component that stores data so that future requests for the same data are faster. - -###### chain - -Within a template, to connect one or more [identifiers](#identifier) with a dot. An identifier can represent a method, object, or field. For example, `.Site.Params.author.name` or `.Date.UTC.Hour`. - -###### CJK - -A collective term for the Chinese, Japanese, and Korean languages. See [details](https://en.wikipedia.org/wiki/CJK_characters). - -###### CLI - -Command line interface. - -###### collection - -An [array](#array), [slice](#slice), or [map](#map). - -###### content adapter - -A template that dynamically creates pages when building a site. For example, use a content adapter to create pages from a remote data source such as JSON, TOML, YAML, or XML. See [details](/content-management/content-adapters/). - -###### content format - -A markup language for creating content. Typically Markdown, but may also be HTML, AsciiDoc, Org, Pandoc, or reStructuredText. See [details](/content-management/formats/). - -###### content type - -A classification of content inferred from the top-level directory name or the `type` set in [front matter](#front-matter). Pages in the root of the `content` directory, including the home page, are of type "page". Accessed via `.Page.Type` in [templates](#template). See [details](/content-management/types/). - -###### content view - -A template called with the `.Page.Render` method. See [details](/templates/content-view/). - -###### context - -Represented by a dot "." within a [template action](#template-action), context is the current location in a data structure. For example, while iterating over a [collection](#collection) of pages, the context within each iteration is the page's data structure. The context received by each template depends on template type and/or how it was called. See [details](/templates/introduction/#context). - -###### default sort order - -The default sort order for page collections. Hugo sorts by [weight](#weight), then by date (descending), then by link title, and then by file path. - -###### element - -A member of a slice or array. - -###### environment - -Typically one of `development`, `staging`, or `production`, each environment may exhibit different behavior depending on configuration and template logic. For example, in a production environment you might minify and fingerprint CSS, but that probably doesn't make sense in a development environment. - -When running the built-in development server with the `hugo server` command, the environment is set to `development`. When building your site with the `hugo` command, the environment is set to `production`. To override the environment value, use the `--environment` command line flag or the `HUGO_ENVIRONMENT` environment variable. - -To determine the current environment within a template, use the [`hugo.Environment`] function. - -[`hugo.Environment`]: /functions/hugo/environment/ - -###### field - -A predefined key-value pair in front matter such as `date` or `title`. See also [parameter](#parameter). - -###### flag - -An option passed to a command-line program, beginning with one or two hyphens. See [details](/commands/hugo/). - -###### float - -See [floating point](#floating-point). - -###### floating point - -A numeric data type with a fractional component. For example, `3.14159`. - -###### fragment - -The final segment of a URL, beginning with a hash (`#`) mark, that references an `id` attribute of an HTML element on the page. - -###### front matter - -Metadata at the beginning of each content page, separated from the content by format-specific delimiters. See [details](/content-management/front-matter/). - -###### function - -Used within a [template action](#template-action), a function takes one or more [arguments](#argument) and returns a value. Unlike [methods](#method), functions are not associated with an [object](#object). See [details](/functions/). - -###### 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/ - -###### headless bundle - -An unpublished leaf or branch bundle whose content and resources you can include in other pages. See [build options](/content-management/build-options/). - -###### identifier - -A string that represents a variable, method, object, or field. It must conform to Go's [language specification](https://go.dev/ref/spec#Identifiers), beginning with a letter or underscore, followed by zero or more letters, digits, or underscores. - -###### int - -See [integer](#integer). - -###### integer - -A numeric data type without a fractional component. For example, `42`. - -###### internationalization - -Software design and development efforts that enable [localization](#localization). See the [W3C definition](https://www.w3.org/International/questions/qa-i18n). Abbreviated i18n. - -###### interval - -An [interval](https://en.wikipedia.org/wiki/Interval_(mathematics)) is a range of numbers between two endpoints: closed, open, or half-open. - -- A _closed_ interval, denoted by brackets, includes its endpoints. For example, [0, 1] is the interval where `0 <= x <= 1`. - -- An _open_ interval, denoted by parentheses, excludes its endpoints. For example, (0, 1) is the interval where `0 < x < 1`. - -- A _half-open_ interval includes only one of its endpoints. For example, (0, 1] is the _left-open_ interval where `0 < x <= 1`, while [0, 1) is the _right-open_ interval where `0 <= x < 1`. - -###### kind - -See [page kind](#page-kind). - -###### layout - -See [template](#template). - -###### leaf bundle - -A directory that contains an index.md file and zero or more [resources](#resource). Analogous to a physical leaf, a leaf bundle is at the end of a branch. It has no descendants. See [details](/content-management/page-bundles/). - -###### lexer - -A software component that identifies keywords, identifiers, operators, numbers, and other basic building blocks of a programming language within the input text. - -###### list page - -Any [page kind](#page-kind) that receives a page [collection](#collection) in [context](#context). This includes the home page, [section pages](#section-page), [taxonomy pages](#taxonomy-page), and [term pages](#term-page). - -###### list template - -Any template that renders a [list page](#list-page). This includes [home](/templates/types/#home), [section](/templates/types/#section), [taxonomy](/templates/types/#taxonomy), and [term](/templates/types/#term) templates. - -###### localization - -Adaptation of a site to meet language and regional requirements. This includes translations, language-specific media, date and currency formats, etc. See [details](/content-management/multilingual/) and the [W3C definition](https://www.w3.org/International/questions/qa-i18n). Abbreviated l10n. - -###### logical path - -{{< new-in 0.123.0 >}} - -A page or page resource identifier derived from the file path, excluding its extension and language identifier. This value is neither a file path nor a URL. Starting with a file path relative to the `content` directory, Hugo determines the logical path by stripping the file extension and language identifier, converting to lower case, then replacing spaces with hyphens. {{% comment %}}{{% /comment %}} See [examples](/methods/page/path/#examples). - -###### map - -An unordered group of elements, each indexed by a unique key. See the [Go documentation](https://go.dev/ref/spec#Map_types) for details. - -###### Markdown attribute - -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). - -###### marshal - -To transform a data structure into a serialized object. For example, transforming a [map](#map) into a JSON string. See [unmarshal](#unmarshal). - -###### method - -Used within a [template action](#template-action) and associated with an [object](#object), a method takes zero or more [arguments](#argument) and either returns a value or performs an action. For example, `.IsHome` is a method on the `.Page` object which returns `true` if the current page is the home page. See also [function](#function). - -###### module - -Like a [theme](#theme), a module is a packaged combination of [archetypes](#archetype), assets, content, data, [templates](#template), translation tables, static files, or configuration settings. A module may serve as the basis for a new site, or to augment an existing site. See [details](/hugo-modules/). - -###### node - -A class of [page kinds](#page-kind) including `home`, `section`, `taxonomy`, and `term`. - -###### noop - -An abbreviated form of "no operation", a _noop_ is a statement that does nothing. - -###### object - -A data structure with or without associated [methods](#method). - -###### ordered taxonomy - -Created by invoking the [`Alphabetical`] or [`ByCount`] method on a [`Taxonomy`](#taxonomy-object) object, which is a [map](#map), an ordered taxonomy is a [slice](#slice), where each element is an object that contains the [term](#term) and a slice of its [weighted pages](#weighted-page). - -[`Alphabetical`]: /methods/taxonomy/alphabetical/ -[`ByCount`]: /methods/taxonomy/bycount/ - -###### output format - -{{% include "methods/page/_common/output-format-definition.md" %}} - -###### page bundle - -A directory that encapsulates both content and associated [resources](#resource). There are two types of page bundles: [leaf bundles](#leaf-bundle) and [branch bundles](#branch-bundle). See [details](/content-management/page-bundles/). - -###### page collection - -A slice of `Page` objects. - -###### page kind - -A classification of pages, one of `home`, `page`, `section`, `taxonomy`, or `term`. See [details](/methods/page/kind/). - -Note that there are also `RSS`, `sitemap`, `robotsTXT`, and `404` page kinds, but these are only available during the rendering of each of these respective page's kind and therefore *not* available in any of the `Pages` collections. - -###### page resource - -A file within a [page bundle](#page-bundle). Capture one or more page resources using any of the [`Resources`] methods on a `Page` object. - -[`Resources`]: /methods/page/resources/#methods - -###### pager - -Created during [pagination](#pagination), a pager contains a subset of a list page and navigation links to other pagers. - -###### paginate - -To split a list page into two or more subsets. - -###### pagination - -The process of [paginating](#paginate) a list page. See [details](/templates/pagination/). - -###### paginator - -A collection of [pagers](#pager). - -###### parameter - -Typically, a user-defined key-value pair at the site or page level, but may also refer to a configuration setting or an [argument](#argument). See also [field](#field). - -###### partial - -A [template](#template) called from any other template including [shortcodes](#shortcode), [render hooks](#render-hook), and other partials. A partial either renders something or returns something. A partial can also call itself, for example, to [walk](#walk) a data structure. - -###### permalink - -The absolute URL of a published resource or a rendered page, including scheme and host. - -###### pipe - -See [pipeline](#pipeline). - -###### pipeline - -Within a [template action](#template-action), a pipeline is a possibly chained sequence of values, [function](#function) calls, or [method](#method) calls. Functions and methods in the pipeline may take multiple [arguments](#argument). - -A pipeline may be *chained* by separating a sequence of commands with pipeline characters "|". In a chained pipeline, the result of each command is passed as the last argument to the following command. The output of the final command in the pipeline is the value of the pipeline. See the [Go documentation](https://pkg.go.dev/text/template#hdr-Pipelines) for details. - -###### publish - -See [build](#build). - -###### regular page - -Content with the "page" [page kind](#page-kind). See also [section page](#section-page). - -###### relative permalink - -The host-relative URL of a published resource or a rendered page. - -###### render hook - -A [template](#template) that overrides standard Markdown rendering. See [details](/render-hooks). - -###### remote resource - -A file on a remote server, accessible via HTTP or HTTPS with the [`resources.GetRemote`](/functions/resources/getremote) function. - -###### resource - -Any file consumed by the build process to augment or generate content, structure, behavior, or presentation. For example: images, videos, content snippets, CSS, Sass, JavaScript, and data. - -Hugo supports three types of resources: [global](#global-resource), [page](#page-resource), and [remote](#remote-resource) - -###### resource type - -The main type of a resource's [media type]. Content files such as Markdown, HTML, AsciiDoc, Pandoc, reStructuredText, and Emacs Org Mode have resource type `page`. Other resource types include `image`, `video`, etc. Retrieve the resource type using the [`ResourceType`] method on a `Resource` object. - -[media type]: /methods/resource/mediatype/ -[`ResourceType`]: /methods/resource/resourcetype/ - -###### scalar - -A single value, one of [string](#string), [integer](#integer), [floating point](#floating-point), or [boolean](#boolean). - -###### scratch pad - -Conceptually, a [map](#map) with [methods](#method) to set, get, update, and delete values. Attach the data structure to a `Page` object using the [`Scratch`] or [`Store`] methods, or create a locally scoped scratch pad using the [`newScratch`] function. - -[`Scratch`]: /methods/page/scratch/ -[`Store`]: /methods/page/store/ -[`newScratch`]: /functions/collections/newscratch/ - -###### section - -A top-level content directory, or any content directory with an `_index.md` file. A content directory with an `_index.md` file is also known as a [branch bundle](/getting-started/glossary/#branch-bundle). Section templates receive one or more page [collections](#collection) in [context](#context). See [details](/content-management/sections/). - -###### section page - -Content with the "section" [page kind](#page-kind). Typically a listing of [regular pages](#regular-page) and/or [section pages](#section-page) within the current [section](#section). See also [regular page](#regular-page). - -###### shortcode - -A [template](#template) called from within Markdown, taking zero or more [arguments](#argument). See [details](/content-management/shortcodes/). - -###### slice - -A numbered sequence of elements. Unlike Go's [array](#array) data type, slices are dynamically sized. [Elements](#element) within a slice can be [scalars](#scalar), [arrays](#array), [maps](#map), pages, or other slices. See the [Go documentation](https://go.dev/ref/spec#Slice_types) for details. - -###### string - -A sequence of bytes. For example, `"What is 6 times 7?"` . - -###### string literal (interpreted) - -Interpreted string literals are character sequences between double quotes, as in "foo". Within the quotes, any character may appear except a newline and an unescaped double quote. The text between the quotes forms the value of the literal, with backslash escapes interpreted. See [details](https://go.dev/ref/spec#String_literals). - -###### string literal (raw) - -Raw string literals are character sequences between backticks, as in \`bar\`. Within the backticks, any character may appear except a backtick. Backslashes have no special meaning and the string may contain newlines. Carriage return characters ('\r') inside raw string literals are discarded from the raw string value. See [details](https://go.dev/ref/spec#String_literals). - -###### taxonomic weight - -Defined in front matter and unique to each taxonomy, this [weight](#weight) determines the sort order of page collections contained within a [`Taxonomy`](#taxonomy-object) object. See [details](/content-management/taxonomies/#order-taxonomies). - -###### taxonomy - -A group of related [terms](#term) used to classify content. For example, a "colors" taxonomy might include the terms "red", "green", and "blue". See [details](/content-management/taxonomies/). - -###### taxonomy object - -A [map](#map) of [terms](#term) and the [weighted pages](#weighted-page) associated with each term. - -###### taxonomy page - -Content with the "taxonomy" [page kind](#page-kind). Typically a listing of [terms](#term) within a given [taxonomy](#taxonomy). - -###### template - -A file with [template actions](#template-action), located within the `layouts` directory of a project, theme, or module. See [details](/templates/). - -###### template action - -A data evaluation or control structure within a [template](#template), delimited by "{{" and "}}". See the [Go documentation](https://pkg.go.dev/text/template#hdr-Actions) for details. - -###### term - -A member of a [taxonomy](#taxonomy), used to classify content. See [details](/content-management/taxonomies/). - -###### term page - -Content with the "term" [page kind](#page-kind). Typically a listing of [regular pages](#regular-page) and [section pages](#section-page) with a given [term](#term). - -###### theme - -A packaged combination of [archetypes](#archetype), assets, content, data, [templates](#template), translation tables, static files, or configuration settings. A theme may serve as the basis for a new site, or to augment an existing site. See also [module](#module). - -###### token - -An identifier within a format string, beginning with a colon and replaced with a value when rendered. For example, use tokens in format strings for both [permalinks](/content-management/urls/#permalinks) and [dates](/functions/time/format/#localization). - -###### type - -See [content type](#content-type). - -###### unmarshal - -To transform a serialized object into a data structure. For example, transforming a JSON file into a [map](#map) that you can access within a template. See [marshal](#marshal). - -###### variable - -A user-defined [identifier](#identifier) prepended with a `$` symbol, representing a value of any data type, initialized or assigned within a [template action](#template-action). For example, `$foo` and `$bar` are variables. - -###### walk - -To recursively traverse a nested data structure. For example, rendering a multilevel menu. - -###### weight - -Used to position an element within a collection sorted by weight. Assign weights using non-zero integers. Lighter items float to the top, while heavier items sink to the bottom. Unweighted or zero-weighted elements are placed at the end of the collection. Weights are typically assigned to pages, menu entries, languages, and output formats. - -###### weighted page - -Contained within a [`Taxonomy`](#taxonomy-object) object, a weighted page is a [map](#map) with two elements: a `Page` object, and its [taxonomic weight](#taxonomic-weight) as defined in front matter. Access the elements using the `Page` and `Weight` keys. - -###### zero time - -The _zero time_ is January 1, 0001, 00:00:00 UTC. Formatted per [RFC3339](https://www.rfc-editor.org/rfc/rfc3339) the _zero time_ is 0001-01-01T00:00:00-00:00. diff --git a/content/en/getting-started/glossary/_index.md b/content/en/getting-started/glossary/_index.md new file mode 100644 index 000000000..ee739e5fb --- /dev/null +++ b/content/en/getting-started/glossary/_index.md @@ -0,0 +1,21 @@ +--- +title: Glossary of terms +description: Terms commonly used throughout the documentation. +categories: [getting started] +keywords: [glossary] +menu: + docs: + parent: getting-started + weight: 80 +weight: 80 +layout: glossary +build: + render: always + list: always +cascade: + build: + render: never + list: local +--- + +{{% glossary %}} diff --git a/content/en/getting-started/glossary/_link-reference-definitions.md b/content/en/getting-started/glossary/_link-reference-definitions.md new file mode 100644 index 000000000..ae3439317 --- /dev/null +++ b/content/en/getting-started/glossary/_link-reference-definitions.md @@ -0,0 +1,117 @@ +--- +title: Glossary link reference definitions +build: + render: never + list: never +--- + +{{% comment %}} +Use the "include" shortcode to include this file in the Markdown page for each glossary term. This eliminates the need for separate link reference definitions for internal glossary term links. + +Do not create plural versions of these link reference definition. If you need to use the plural version of a glossary term, do this in Markdown: + + The plural of action is [actions][action]. + +You must include this file in the Markdown page for each glossary term because the terms can be independently included in other pages using the glossary term (gt) shortcode. +{{% /comment %}} + +[action]: /getting-started/glossary/#action +[archetype]: /getting-started/glossary/#archetype +[argument]: /getting-started/glossary/#argument +[array]: /getting-started/glossary/#array +[bool]: /getting-started/glossary/#bool +[boolean]: /getting-started/glossary/#boolean +[branch bundle]: /getting-started/glossary/#branch-bundle +[build]: /getting-started/glossary/#build +[bundle]: /getting-started/glossary/#bundle +[cache]: /getting-started/glossary/#cache +[chain]: /getting-started/glossary/#chain +[cjk]: /getting-started/glossary/#cjk +[cli]: /getting-started/glossary/#cli +[collection]: /getting-started/glossary/#collection +[content adapter]: /getting-started/glossary/#content-adapter +[content format]: /getting-started/glossary/#content-format +[content type]: /getting-started/glossary/#content-type +[content view]: /getting-started/glossary/#content-view +[context]: /getting-started/glossary/#context +[default sort order]: /getting-started/glossary/#default-sort-order +[element]: /getting-started/glossary/#element +[environment]: /getting-started/glossary/#environment +[field]: /getting-started/glossary/#field +[flag]: /getting-started/glossary/#flag +[float]: /getting-started/glossary/#float +[floating point]: /getting-started/glossary/#floating-point +[fragment]: /getting-started/glossary/#fragment +[front matter]: /getting-started/glossary/#front-matter +[function]: /getting-started/glossary/#function +[global resource]: /getting-started/glossary/#global-resource +[headless bundle]: /getting-started/glossary/#headless-bundle +[identifier]: /getting-started/glossary/#identifier +[int]: /getting-started/glossary/#int +[integer]: /getting-started/glossary/#integer +[internationalization]: /getting-started/glossary/#internationalization +[interval]: /getting-started/glossary/#interval +[kind]: /getting-started/glossary/#kind +[layout]: /getting-started/glossary/#layout +[leaf bundle]: /getting-started/glossary/#leaf-bundle +[lexer]: /getting-started/glossary/#lexer +[list page]: /getting-started/glossary/#list-page +[list template]: /getting-started/glossary/#list-template +[localization]: /getting-started/glossary/#localization +[logical path]: /getting-started/glossary/#logical-path +[map]: /getting-started/glossary/#map +[markdown attribute]: /getting-started/glossary/#markdown-attribute +[marshal]: /getting-started/glossary/#marshal +[method]: /getting-started/glossary/#method +[module]: /getting-started/glossary/#module +[node]: /getting-started/glossary/#node +[noop]: /getting-started/glossary/#noop +[object]: /getting-started/glossary/#object +[ordered taxonomy]: /getting-started/glossary/#ordered-taxonomy +[output format]: /getting-started/glossary/#output-format +[page bundle]: /getting-started/glossary/#page-bundle +[page collection]: /getting-started/glossary/#page-collection +[page kind]: /getting-started/glossary/#page-kind +[page resource]: /getting-started/glossary/#page-resource +[pager]: /getting-started/glossary/#pager +[paginate]: /getting-started/glossary/#paginate +[pagination]: /getting-started/glossary/#pagination +[paginator]: /getting-started/glossary/#paginator +[parameter]: /getting-started/glossary/#parameter +[partial]: /getting-started/glossary/#partial +[permalink]: /getting-started/glossary/#permalink +[pipe]: /getting-started/glossary/#pipe +[pipeline]: /getting-started/glossary/#pipeline +[publish]: /getting-started/glossary/#publish +[regular page]: /getting-started/glossary/#regular-page +[relative permalink]: /getting-started/glossary/#relative-permalink +[remote resource]: /getting-started/glossary/#remote-resource +[render hook]: /getting-started/glossary/#render-hook +[resource type]: /getting-started/glossary/#resource-type +[resource]: /getting-started/glossary/#resource +[scalar]: /getting-started/glossary/#scalar +[scratch pad]: /getting-started/glossary/#scratch-pad +[section page]: /getting-started/glossary/#section-page +[section]: /getting-started/glossary/#section +[shortcode]: /getting-started/glossary/#shortcode +[slice]: /getting-started/glossary/#slice +[string literal (interpreted)]: /getting-started/glossary/#string-literal-interpreted +[string literal (raw)]: /getting-started/glossary/#string-literal-raw +[string]: /getting-started/glossary/#string +[taxonomic weight]: /getting-started/glossary/#taxonomic-weight +[taxonomy object]: /getting-started/glossary/#taxonomy-object +[taxonomy page]: /getting-started/glossary/#taxonomy-page +[taxonomy]: /getting-started/glossary/#taxonomy +[template action]: /getting-started/glossary/#template-action +[template]: /getting-started/glossary/#template +[term page]: /getting-started/glossary/#term-page +[term]: /getting-started/glossary/#term +[theme]: /getting-started/glossary/#theme +[token]: /getting-started/glossary/#token +[type]: /getting-started/glossary/#type +[unmarshal]: /getting-started/glossary/#unmarshal +[variable]: /getting-started/glossary/#variable +[walk]: /getting-started/glossary/#walk +[weight]: /getting-started/glossary/#weight +[weighted page]: /getting-started/glossary/#weighted-page +[zero time]: /getting-started/glossary/#zero-time diff --git a/content/en/getting-started/glossary/action.md b/content/en/getting-started/glossary/action.md new file mode 100644 index 000000000..d9806e563 --- /dev/null +++ b/content/en/getting-started/glossary/action.md @@ -0,0 +1,7 @@ +--- +title: action +--- + +See [template action]. + +{{% include "/getting-started/glossary/_link-reference-definitions" %}} diff --git a/content/en/getting-started/glossary/archetype.md b/content/en/getting-started/glossary/archetype.md new file mode 100644 index 000000000..06a3a2b52 --- /dev/null +++ b/content/en/getting-started/glossary/archetype.md @@ -0,0 +1,7 @@ +--- +title: archetype +--- + +An archetype is a template for new content. See [details](/content-management/archetypes/). + +{{% include "/getting-started/glossary/_link-reference-definitions" %}} diff --git a/content/en/getting-started/glossary/argument.md b/content/en/getting-started/glossary/argument.md new file mode 100644 index 000000000..f0ded52e9 --- /dev/null +++ b/content/en/getting-started/glossary/argument.md @@ -0,0 +1,7 @@ +--- +title: argument +--- + +A [scalar], [array], [slice], [map], or [object] passed to a [function], [method], or [shortcode]. + +{{% include "/getting-started/glossary/_link-reference-definitions" %}} diff --git a/content/en/getting-started/glossary/array.md b/content/en/getting-started/glossary/array.md new file mode 100644 index 000000000..fac4e87c2 --- /dev/null +++ b/content/en/getting-started/glossary/array.md @@ -0,0 +1,7 @@ +--- +title: array +--- + +A numbered sequence of elements. Unlike Go's [slice] data type, an array has a fixed length. [Elements][element] within an array can be [scalars][scalar], slices, [maps][map], pages, or other arrays. See the [Go documentation](https://go.dev/ref/spec#Array_types) for details. + +{{% include "/getting-started/glossary/_link-reference-definitions" %}} diff --git a/content/en/getting-started/glossary/bool.md b/content/en/getting-started/glossary/bool.md new file mode 100644 index 000000000..4ff258f88 --- /dev/null +++ b/content/en/getting-started/glossary/bool.md @@ -0,0 +1,7 @@ +--- +title: bool +--- + +See [boolean]. + +{{% include "/getting-started/glossary/_link-reference-definitions" %}} diff --git a/content/en/getting-started/glossary/boolean.md b/content/en/getting-started/glossary/boolean.md new file mode 100644 index 000000000..bec56c4f2 --- /dev/null +++ b/content/en/getting-started/glossary/boolean.md @@ -0,0 +1,7 @@ +--- +title: boolean +--- + +A data type with two possible values, either `true` or `false`. + +{{% include "/getting-started/glossary/_link-reference-definitions" %}} diff --git a/content/en/getting-started/glossary/branch-bundle.md b/content/en/getting-started/glossary/branch-bundle.md new file mode 100644 index 000000000..5c99c1b7e --- /dev/null +++ b/content/en/getting-started/glossary/branch-bundle.md @@ -0,0 +1,7 @@ +--- +title: branch bundle +--- + +A directory that contains an `_index.md` file and zero or more [resources][resource]. Analogous to a physical branch, a branch bundle may have descendants including leaf bundles and other branch bundles. Top level directories with or without `_index.md` files are also branch bundles. This includes the home page. See [details](/content-management/page-bundles/). + +{{% include "/getting-started/glossary/_link-reference-definitions" %}} diff --git a/content/en/getting-started/glossary/build.md b/content/en/getting-started/glossary/build.md new file mode 100644 index 000000000..1f4e9e004 --- /dev/null +++ b/content/en/getting-started/glossary/build.md @@ -0,0 +1,7 @@ +--- +title: build +--- + +To generate a static site that includes HTML files and assets such as images, CSS, and JavaScript. The build process includes rendering and resource transformations. + +{{% include "/getting-started/glossary/_link-reference-definitions" %}} diff --git a/content/en/getting-started/glossary/bundle.md b/content/en/getting-started/glossary/bundle.md new file mode 100644 index 000000000..16e473895 --- /dev/null +++ b/content/en/getting-started/glossary/bundle.md @@ -0,0 +1,7 @@ +--- +title: bundle +--- + +See [page bundle]. + +{{% include "/getting-started/glossary/_link-reference-definitions" %}} diff --git a/content/en/getting-started/glossary/cache.md b/content/en/getting-started/glossary/cache.md new file mode 100644 index 000000000..990c26f24 --- /dev/null +++ b/content/en/getting-started/glossary/cache.md @@ -0,0 +1,7 @@ +--- +title: cache +--- + +A software component that stores data so that future requests for the same data are faster. + +{{% include "/getting-started/glossary/_link-reference-definitions" %}} diff --git a/content/en/getting-started/glossary/chain.md b/content/en/getting-started/glossary/chain.md new file mode 100644 index 000000000..ce5df6730 --- /dev/null +++ b/content/en/getting-started/glossary/chain.md @@ -0,0 +1,7 @@ +--- +title: chain +--- + +Within a template, to connect one or more [identifiers][identifier] with a dot. An identifier can represent a method, object, or field. For example, `.Site.Params.author.name` or `.Date.UTC.Hour`. + +{{% include "/getting-started/glossary/_link-reference-definitions" %}} diff --git a/content/en/getting-started/glossary/cjk.md b/content/en/getting-started/glossary/cjk.md new file mode 100644 index 000000000..f93303dce --- /dev/null +++ b/content/en/getting-started/glossary/cjk.md @@ -0,0 +1,7 @@ +--- +title: CJK +--- + +A collective term for the Chinese, Japanese, and Korean languages. See [details](https://en.wikipedia.org/wiki/CJK_characters). + +{{% include "/getting-started/glossary/_link-reference-definitions" %}} diff --git a/content/en/getting-started/glossary/cli.md b/content/en/getting-started/glossary/cli.md new file mode 100644 index 000000000..d662e287d --- /dev/null +++ b/content/en/getting-started/glossary/cli.md @@ -0,0 +1,7 @@ +--- +title: CLI +--- + +Command line interface. + +{{% include "/getting-started/glossary/_link-reference-definitions" %}} diff --git a/content/en/getting-started/glossary/collection.md b/content/en/getting-started/glossary/collection.md new file mode 100644 index 000000000..4928ede15 --- /dev/null +++ b/content/en/getting-started/glossary/collection.md @@ -0,0 +1,7 @@ +--- +title: collection +--- + +An [array], [slice], or [map]. + +{{% include "/getting-started/glossary/_link-reference-definitions" %}} diff --git a/content/en/getting-started/glossary/content-adapter.md b/content/en/getting-started/glossary/content-adapter.md new file mode 100644 index 000000000..958c43cc4 --- /dev/null +++ b/content/en/getting-started/glossary/content-adapter.md @@ -0,0 +1,7 @@ +--- +title: content adapter +--- + +A template that dynamically creates pages when building a site. For example, use a content adapter to create pages from a remote data source such as JSON, TOML, YAML, or XML. See [details](/content-management/content-adapters/). + +{{% include "/getting-started/glossary/_link-reference-definitions" %}} diff --git a/content/en/getting-started/glossary/content-format.md b/content/en/getting-started/glossary/content-format.md new file mode 100644 index 000000000..83cc9d2a2 --- /dev/null +++ b/content/en/getting-started/glossary/content-format.md @@ -0,0 +1,7 @@ +--- +title: content format +--- + +A markup language for creating content. Typically Markdown, but may also be HTML, AsciiDoc, Org, Pandoc, or reStructuredText. See [details](/content-management/formats/). + +{{% include "/getting-started/glossary/_link-reference-definitions" %}} diff --git a/content/en/getting-started/glossary/content-type.md b/content/en/getting-started/glossary/content-type.md new file mode 100644 index 000000000..b55e6c585 --- /dev/null +++ b/content/en/getting-started/glossary/content-type.md @@ -0,0 +1,7 @@ +--- +title: content type +--- + +A classification of content inferred from the top-level directory name or the `type` set in [front matter]. Pages in the root of the `content` directory, including the home page, are of type "page". Accessed via `.Page.Type` in [templates][template]. See [details](/content-management/types/) + +{{% include "/getting-started/glossary/_link-reference-definitions" %}} diff --git a/content/en/getting-started/glossary/content-view.md b/content/en/getting-started/glossary/content-view.md new file mode 100644 index 000000000..c35b9d468 --- /dev/null +++ b/content/en/getting-started/glossary/content-view.md @@ -0,0 +1,7 @@ +--- +title: content view +--- + +A template called with the `.Page.Render` method. See [details](/templates/content-view/). + +{{% include "/getting-started/glossary/_link-reference-definitions" %}} diff --git a/content/en/getting-started/glossary/context.md b/content/en/getting-started/glossary/context.md new file mode 100644 index 000000000..a4413cc77 --- /dev/null +++ b/content/en/getting-started/glossary/context.md @@ -0,0 +1,7 @@ +--- +title: context +--- + +Represented by a dot "." within a [template action], context is the current location in a data structure. For example, while iterating over a [collection] of pages, the context within each iteration is the page's data structure. The context received by each template depends on template type and/or how it was called. See [details](/templates/introduction/#context). + +{{% include "/getting-started/glossary/_link-reference-definitions" %}} diff --git a/content/en/getting-started/glossary/default-sort-order.md b/content/en/getting-started/glossary/default-sort-order.md new file mode 100644 index 000000000..42012b13c --- /dev/null +++ b/content/en/getting-started/glossary/default-sort-order.md @@ -0,0 +1,7 @@ +--- +title: default sort order +--- + +The default sort order for page collections. Hugo sorts by [weight], then by date (descending), then by link title, and then by file path. + +{{% include "/getting-started/glossary/_link-reference-definitions" %}} diff --git a/content/en/getting-started/glossary/element.md b/content/en/getting-started/glossary/element.md new file mode 100644 index 000000000..0d1a46c97 --- /dev/null +++ b/content/en/getting-started/glossary/element.md @@ -0,0 +1,7 @@ +--- +title: element +--- + +A member of a slice or array. + +{{% include "/getting-started/glossary/_link-reference-definitions" %}} diff --git a/content/en/getting-started/glossary/environment.md b/content/en/getting-started/glossary/environment.md new file mode 100644 index 000000000..87f2bfb47 --- /dev/null +++ b/content/en/getting-started/glossary/environment.md @@ -0,0 +1,13 @@ +--- +title: environment +--- + +Typically one of `development`, `staging`, or `production`, each environment may exhibit different behavior depending on configuration and template logic. For example, in a production environment you might minify and fingerprint CSS, but that probably doesn't make sense in a development environment. + +When running the built-in development server with the `hugo server` command, the environment is set to `development`. When building your site with the `hugo` command, the environment is set to `production`. To override the environment value, use the `--environment` command line flag or the `HUGO_ENVIRONMENT` environment variable. + +To determine the current environment within a template, use the [`hugo.Environment`] function. + +[`hugo.Environment`]: /functions/hugo/environment/ + +{{% include "/getting-started/glossary/_link-reference-definitions" %}} diff --git a/content/en/getting-started/glossary/field.md b/content/en/getting-started/glossary/field.md new file mode 100644 index 000000000..79d166178 --- /dev/null +++ b/content/en/getting-started/glossary/field.md @@ -0,0 +1,7 @@ +--- +title: field +--- + +A predefined key-value pair in front matter such as `date` or `title`. See also [parameter]. + +{{% include "/getting-started/glossary/_link-reference-definitions" %}} diff --git a/content/en/getting-started/glossary/flag.md b/content/en/getting-started/glossary/flag.md new file mode 100644 index 000000000..856a81fa8 --- /dev/null +++ b/content/en/getting-started/glossary/flag.md @@ -0,0 +1,7 @@ +--- +title: flag +--- + +An option passed to a command-line program, beginning with one or two hyphens. See [details](/commands/hugo/). + +{{% include "/getting-started/glossary/_link-reference-definitions" %}} diff --git a/content/en/getting-started/glossary/float.md b/content/en/getting-started/glossary/float.md new file mode 100644 index 000000000..9fa70f8e6 --- /dev/null +++ b/content/en/getting-started/glossary/float.md @@ -0,0 +1,8 @@ +--- +title: float +alias: true +--- + +See [floating point]. + +{{% include "/getting-started/glossary/_link-reference-definitions" %}} diff --git a/content/en/getting-started/glossary/floating-point.md b/content/en/getting-started/glossary/floating-point.md new file mode 100644 index 000000000..51cb52c15 --- /dev/null +++ b/content/en/getting-started/glossary/floating-point.md @@ -0,0 +1,7 @@ +--- +title: floating point +--- + +A numeric data type with a fractional component. For example, `3.14159`. + +{{% include "/getting-started/glossary/_link-reference-definitions" %}} diff --git a/content/en/getting-started/glossary/fragment.md b/content/en/getting-started/glossary/fragment.md new file mode 100644 index 000000000..b1e3fd7eb --- /dev/null +++ b/content/en/getting-started/glossary/fragment.md @@ -0,0 +1,5 @@ +--- +title: fragment +--- + +The final segment of a URL, beginning with a hash (`#`) mark, that references an `id` attribute of an HTML element on the page. diff --git a/content/en/getting-started/glossary/front-matter.md b/content/en/getting-started/glossary/front-matter.md new file mode 100644 index 000000000..f204aebe0 --- /dev/null +++ b/content/en/getting-started/glossary/front-matter.md @@ -0,0 +1,7 @@ +--- +title: front matter +--- + +Metadata at the beginning of each content page, separated from the content by format-specific delimiters. See [details](/content-management/front-matter/). + +{{% include "/getting-started/glossary/_link-reference-definitions" %}} diff --git a/content/en/getting-started/glossary/function.md b/content/en/getting-started/glossary/function.md new file mode 100644 index 000000000..92a2798ea --- /dev/null +++ b/content/en/getting-started/glossary/function.md @@ -0,0 +1,7 @@ +--- +title: function +--- + +Used within a [template action], a function takes one or more [arguments][argument] and returns a value. Unlike [methods][method], functions are not associated with an [object]. See [details](/functions/). + +{{% include "/getting-started/glossary/_link-reference-definitions" %}} diff --git a/content/en/getting-started/glossary/global-resource.md b/content/en/getting-started/glossary/global-resource.md new file mode 100644 index 000000000..04dda2b2d --- /dev/null +++ b/content/en/getting-started/glossary/global-resource.md @@ -0,0 +1,12 @@ +--- +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/ + +{{% include "/getting-started/glossary/_link-reference-definitions" %}} diff --git a/content/en/getting-started/glossary/headless-bundle.md b/content/en/getting-started/glossary/headless-bundle.md new file mode 100644 index 000000000..573168935 --- /dev/null +++ b/content/en/getting-started/glossary/headless-bundle.md @@ -0,0 +1,7 @@ +--- +title: headless bundle +--- + +An unpublished leaf or branch bundle whose content and resources you can include in other pages. See [build options](/content-management/build-options/). + +{{% include "/getting-started/glossary/_link-reference-definitions" %}} diff --git a/content/en/getting-started/glossary/identifier.md b/content/en/getting-started/glossary/identifier.md new file mode 100644 index 000000000..7917f479d --- /dev/null +++ b/content/en/getting-started/glossary/identifier.md @@ -0,0 +1,7 @@ +--- +title: identifier +--- + +A string that represents a variable, method, object, or field. It must conform to Go's [language specification](https://go.dev/ref/spec#Identifiers), beginning with a letter or underscore, followed by zero or more letters, digits, or underscores. + +{{% include "/getting-started/glossary/_link-reference-definitions" %}} diff --git a/content/en/getting-started/glossary/int.md b/content/en/getting-started/glossary/int.md new file mode 100644 index 000000000..ba68189fe --- /dev/null +++ b/content/en/getting-started/glossary/int.md @@ -0,0 +1,7 @@ +--- +title: int +--- + +See [integer]. + +{{% include "/getting-started/glossary/_link-reference-definitions" %}} diff --git a/content/en/getting-started/glossary/integer.md b/content/en/getting-started/glossary/integer.md new file mode 100644 index 000000000..dd79ed045 --- /dev/null +++ b/content/en/getting-started/glossary/integer.md @@ -0,0 +1,7 @@ +--- +title: integer +--- + +A numeric data type without a fractional component. For example, `42`. + +{{% include "/getting-started/glossary/_link-reference-definitions" %}} diff --git a/content/en/getting-started/glossary/internationalization.md b/content/en/getting-started/glossary/internationalization.md new file mode 100644 index 000000000..c4eb20995 --- /dev/null +++ b/content/en/getting-started/glossary/internationalization.md @@ -0,0 +1,7 @@ +--- +title: internationalization +--- + +Software design and development efforts that enable [localization]. See the [W3C definition](https://www.w3.org/International/questions/qa-i18n). Abbreviated i18n. + +{{% include "/getting-started/glossary/_link-reference-definitions" %}} diff --git a/content/en/getting-started/glossary/interval.md b/content/en/getting-started/glossary/interval.md new file mode 100644 index 000000000..5a0e20c4a --- /dev/null +++ b/content/en/getting-started/glossary/interval.md @@ -0,0 +1,13 @@ +--- +title: interval +--- + +An [interval](https://en.wikipedia.org/wiki/Interval_(mathematics)) is a range of numbers between two endpoints: closed, open, or half-open. + +- A _closed_ interval, denoted by brackets, includes its endpoints. For example, [0, 1] is the interval where `0 <= x <= 1`. + +- An _open_ interval, denoted by parentheses, excludes its endpoints. For example, (0, 1) is the interval where `0 < x < 1`. + +- A _half-open_ interval includes only one of its endpoints. For example, (0, 1] is the _left-open_ interval where `0 < x <= 1`, while [0, 1) is the _right-open_ interval where `0 <= x < 1`. + +{{% include "/getting-started/glossary/_link-reference-definitions" %}} diff --git a/content/en/getting-started/glossary/kind.md b/content/en/getting-started/glossary/kind.md new file mode 100644 index 000000000..5fc9831f3 --- /dev/null +++ b/content/en/getting-started/glossary/kind.md @@ -0,0 +1,7 @@ +--- +title: kind +--- + +See [page kind]. + +{{% include "/getting-started/glossary/_link-reference-definitions" %}} diff --git a/content/en/getting-started/glossary/layout.md b/content/en/getting-started/glossary/layout.md new file mode 100644 index 000000000..41cfdb3e2 --- /dev/null +++ b/content/en/getting-started/glossary/layout.md @@ -0,0 +1,7 @@ +--- +title: layout +--- + +See [template]. + +{{% include "/getting-started/glossary/_link-reference-definitions" %}} diff --git a/content/en/getting-started/glossary/leaf-bundle.md b/content/en/getting-started/glossary/leaf-bundle.md new file mode 100644 index 000000000..de0f0249c --- /dev/null +++ b/content/en/getting-started/glossary/leaf-bundle.md @@ -0,0 +1,7 @@ +--- +title: leaf bundle +--- + +A directory that contains an index.md file and zero or more [resources][resource]. Analogous to a physical leaf, a leaf bundle is at the end of a branch. It has no descendants. See [details](/content-management/page-bundles/). + +{{% include "/getting-started/glossary/_link-reference-definitions" %}} diff --git a/content/en/getting-started/glossary/lexer.md b/content/en/getting-started/glossary/lexer.md new file mode 100644 index 000000000..1b1017ced --- /dev/null +++ b/content/en/getting-started/glossary/lexer.md @@ -0,0 +1,7 @@ +--- +title: lexer +--- + +A software component that identifies keywords, identifiers, operators, numbers, and other basic building blocks of a programming language within the input text. + +{{% include "/getting-started/glossary/_link-reference-definitions" %}} diff --git a/content/en/getting-started/glossary/list-page.md b/content/en/getting-started/glossary/list-page.md new file mode 100644 index 000000000..ab0f59ce4 --- /dev/null +++ b/content/en/getting-started/glossary/list-page.md @@ -0,0 +1,7 @@ +--- +title: list page +--- + +Any [page kind] that receives a page [collection] in [context]. This includes the home page, [section pages][section page], [taxonomy pages][taxonomy page], and [term pages][term page]. + +{{% include "/getting-started/glossary/_link-reference-definitions" %}} diff --git a/content/en/getting-started/glossary/list-template.md b/content/en/getting-started/glossary/list-template.md new file mode 100644 index 000000000..34fa2a2c6 --- /dev/null +++ b/content/en/getting-started/glossary/list-template.md @@ -0,0 +1,7 @@ +--- +title: list template +--- + +Any template that renders a [list page]. This includes [home](/templates/types/#home), [section](/templates/types/#section), [taxonomy](/templates/types/#taxonomy), and [term](/templates/types/#term) templates. + +{{% include "/getting-started/glossary/_link-reference-definitions" %}} diff --git a/content/en/getting-started/glossary/localization.md b/content/en/getting-started/glossary/localization.md new file mode 100644 index 000000000..c53a9a1f6 --- /dev/null +++ b/content/en/getting-started/glossary/localization.md @@ -0,0 +1,7 @@ +--- +title: localization +--- + +Adaptation of a site to meet language and regional requirements. This includes translations, language-specific media, date and currency formats, etc. See [details](/content-management/multilingual/) and the [W3C definition](https://www.w3.org/International/questions/qa-i18n). Abbreviated l10n. + +{{% include "/getting-started/glossary/_link-reference-definitions" %}} diff --git a/content/en/getting-started/glossary/logical-path.md b/content/en/getting-started/glossary/logical-path.md new file mode 100644 index 000000000..87101f393 --- /dev/null +++ b/content/en/getting-started/glossary/logical-path.md @@ -0,0 +1,9 @@ +--- +title: logical path +--- + +{{< new-in 0.123.0 >}} + +A page or page resource identifier derived from the file path, excluding its extension and language identifier. This value is neither a file path nor a URL. Starting with a file path relative to the `content` directory, Hugo determines the logical path by stripping the file extension and language identifier, converting to lower case, then replacing spaces with hyphens. {{% comment %}}{{% /comment %}} See [examples](/methods/page/path/#examples). + +{{% include "/getting-started/glossary/_link-reference-definitions" %}} diff --git a/content/en/getting-started/glossary/map.md b/content/en/getting-started/glossary/map.md new file mode 100644 index 000000000..a9d1de59b --- /dev/null +++ b/content/en/getting-started/glossary/map.md @@ -0,0 +1,7 @@ +--- +title: map +--- + +An unordered group of elements, each indexed by a unique key. See the [Go documentation](https://go.dev/ref/spec#Map_types) for details. + +{{% include "/getting-started/glossary/_link-reference-definitions" %}} diff --git a/content/en/getting-started/glossary/markdown-attribute.md b/content/en/getting-started/glossary/markdown-attribute.md new file mode 100644 index 000000000..ac82afde6 --- /dev/null +++ b/content/en/getting-started/glossary/markdown-attribute.md @@ -0,0 +1,7 @@ +--- +title: Markdown attribute +--- + +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). + +{{% include "/getting-started/glossary/_link-reference-definitions" %}} diff --git a/content/en/getting-started/glossary/marshal.md b/content/en/getting-started/glossary/marshal.md new file mode 100644 index 000000000..75af7c0d7 --- /dev/null +++ b/content/en/getting-started/glossary/marshal.md @@ -0,0 +1,7 @@ +--- +title: marshal +--- + +To transform a data structure into a serialized object. For example, transforming a [map] into a JSON string. See [unmarshal]. + +{{% include "/getting-started/glossary/_link-reference-definitions" %}} diff --git a/content/en/getting-started/glossary/method.md b/content/en/getting-started/glossary/method.md new file mode 100644 index 000000000..3996d5cba --- /dev/null +++ b/content/en/getting-started/glossary/method.md @@ -0,0 +1,7 @@ +--- +title: method +--- + +Used within a [template action] and associated with an [object], a method takes zero or more [arguments][argument] and either returns a value or performs an action. For example, `.IsHome` is a method on the `.Page` object which returns `true` if the current page is the home page. See also [function]. + +{{% include "/getting-started/glossary/_link-reference-definitions" %}} diff --git a/content/en/getting-started/glossary/module.md b/content/en/getting-started/glossary/module.md new file mode 100644 index 000000000..e35b49344 --- /dev/null +++ b/content/en/getting-started/glossary/module.md @@ -0,0 +1,7 @@ +--- +title: module +--- + +Like a [theme], a module is a packaged combination of [archetypes][archetype], assets, content, data, [templates][template], translation tables, static files, or configuration settings. A module may serve as the basis for a new site, or to augment an existing site. See [details](/hugo-modules/). + +{{% include "/getting-started/glossary/_link-reference-definitions" %}} diff --git a/content/en/getting-started/glossary/node.md b/content/en/getting-started/glossary/node.md new file mode 100644 index 000000000..a1aa779d4 --- /dev/null +++ b/content/en/getting-started/glossary/node.md @@ -0,0 +1,7 @@ +--- +title: node +--- + +A class of [page kinds][page kind] including `home`, `section`, `taxonomy`, and `term`. + +{{% include "/getting-started/glossary/_link-reference-definitions" %}} diff --git a/content/en/getting-started/glossary/noop.md b/content/en/getting-started/glossary/noop.md new file mode 100644 index 000000000..f7043ad7c --- /dev/null +++ b/content/en/getting-started/glossary/noop.md @@ -0,0 +1,7 @@ +--- +title: noop +--- + +An abbreviated form of "no operation", a _noop_ is a statement that does nothing. + +{{% include "/getting-started/glossary/_link-reference-definitions" %}} diff --git a/content/en/getting-started/glossary/object.md b/content/en/getting-started/glossary/object.md new file mode 100644 index 000000000..627c2c2f6 --- /dev/null +++ b/content/en/getting-started/glossary/object.md @@ -0,0 +1,7 @@ +--- +title: object +--- + +A data structure with or without associated [methods][method]. + +{{% include "/getting-started/glossary/_link-reference-definitions" %}} diff --git a/content/en/getting-started/glossary/ordered-taxonomy.md b/content/en/getting-started/glossary/ordered-taxonomy.md new file mode 100644 index 000000000..bec09d2d1 --- /dev/null +++ b/content/en/getting-started/glossary/ordered-taxonomy.md @@ -0,0 +1,10 @@ +--- +title: ordered taxonomy +--- + +Created by invoking the [`Alphabetical`] or [`ByCount`] method on a [`Taxonomy`][taxonomy] object, which is a [map], an ordered taxonomy is a [slice], where each element is an object that contains the [term] and a slice of its [weighted pages][weighted page]. + +[`Alphabetical`]: /methods/taxonomy/alphabetical/ +[`ByCount`]: /methods/taxonomy/bycount/ + +{{% include "/getting-started/glossary/_link-reference-definitions" %}} diff --git a/content/en/methods/page/_common/output-format-definition.md b/content/en/getting-started/glossary/output-format.md similarity index 66% rename from content/en/methods/page/_common/output-format-definition.md rename to content/en/getting-started/glossary/output-format.md index df89447f7..3225efe04 100644 --- a/content/en/methods/page/_common/output-format-definition.md +++ b/content/en/getting-started/glossary/output-format.md @@ -1,10 +1,9 @@ --- -_comment: Do not remove front matter. +title: output format --- + Hugo generates one or more files per page when building a site. For example, when rendering home, [section], [taxonomy], and [term] pages, Hugo generates an HTML file and an RSS file. Both HTML and RSS are built-in _output formats_. Create multiple output formats, and control generation based on [page kind], or by enabling one or more output formats for one or more pages. See [details]. -[section]: /getting-started/glossary/#section -[taxonomy]: /getting-started/glossary/#taxonomy -[term]: /getting-started/glossary/#term -[page kind]: /getting-started/glossary/#page-kind [details]: /templates/output-formats/ + +{{% include "/getting-started/glossary/_link-reference-definitions" %}} diff --git a/content/en/getting-started/glossary/page-bundle.md b/content/en/getting-started/glossary/page-bundle.md new file mode 100644 index 000000000..5b56a632e --- /dev/null +++ b/content/en/getting-started/glossary/page-bundle.md @@ -0,0 +1,7 @@ +--- +title: page bundle +--- + +A directory that encapsulates both content and associated [resources][resource]. There are two types of page bundles: [leaf bundles][leaf bundle]and [branch bundles][branch bundle]. See [details](/content-management/page-bundles/). + +{{% include "/getting-started/glossary/_link-reference-definitions" %}} diff --git a/content/en/getting-started/glossary/page-collection.md b/content/en/getting-started/glossary/page-collection.md new file mode 100644 index 000000000..527c88f76 --- /dev/null +++ b/content/en/getting-started/glossary/page-collection.md @@ -0,0 +1,7 @@ +--- +title: page collection +--- + +A slice of `Page` objects. + +{{% include "/getting-started/glossary/_link-reference-definitions" %}} diff --git a/content/en/getting-started/glossary/page-kind.md b/content/en/getting-started/glossary/page-kind.md new file mode 100644 index 000000000..cae7fcfc8 --- /dev/null +++ b/content/en/getting-started/glossary/page-kind.md @@ -0,0 +1,9 @@ +--- +title: page kind +--- + +A classification of pages, one of `home`, `page`, `section`, `taxonomy`, or `term`. See [details](/methods/page/kind/). + +Note that there are also `RSS`, `sitemap`, `robotsTXT`, and `404` page kinds, but these are only available during the rendering of each of these respective page's kind and therefore *not* available in any of the `Pages` collections. + +{{% include "/getting-started/glossary/_link-reference-definitions" %}} diff --git a/content/en/getting-started/glossary/page-resource.md b/content/en/getting-started/glossary/page-resource.md new file mode 100644 index 000000000..9fe1813bb --- /dev/null +++ b/content/en/getting-started/glossary/page-resource.md @@ -0,0 +1,9 @@ +--- +title: page resource +--- + +A file within a [page bundle]. Capture one or more page resources using any of the [`Resources`] methods on a `Page` object. + +[`Resources`]: /methods/page/resources/#methods + +{{% include "/getting-started/glossary/_link-reference-definitions" %}} diff --git a/content/en/getting-started/glossary/pager.md b/content/en/getting-started/glossary/pager.md new file mode 100644 index 000000000..ffb821d5f --- /dev/null +++ b/content/en/getting-started/glossary/pager.md @@ -0,0 +1,7 @@ +--- +title: pager +--- + +Created during [pagination], a pager contains a subset of a list page and navigation links to other pagers. + +{{% include "/getting-started/glossary/_link-reference-definitions" %}} diff --git a/content/en/getting-started/glossary/paginate.md b/content/en/getting-started/glossary/paginate.md new file mode 100644 index 000000000..2a6207c9d --- /dev/null +++ b/content/en/getting-started/glossary/paginate.md @@ -0,0 +1,7 @@ +--- +title: paginate +--- + +To split a list page into two or more subsets. + +{{% include "/getting-started/glossary/_link-reference-definitions" %}} diff --git a/content/en/getting-started/glossary/pagination.md b/content/en/getting-started/glossary/pagination.md new file mode 100644 index 000000000..113e91752 --- /dev/null +++ b/content/en/getting-started/glossary/pagination.md @@ -0,0 +1,7 @@ +--- +title: pagination +--- + +The process of [paginating][paginate] a list page. See [details](/templates/pagination/). + +{{% include "/getting-started/glossary/_link-reference-definitions" %}} diff --git a/content/en/getting-started/glossary/paginator.md b/content/en/getting-started/glossary/paginator.md new file mode 100644 index 000000000..b5565daac --- /dev/null +++ b/content/en/getting-started/glossary/paginator.md @@ -0,0 +1,7 @@ +--- +title: paginator +--- + +A collection of [pagers][pager]. + +{{% include "/getting-started/glossary/_link-reference-definitions" %}} diff --git a/content/en/getting-started/glossary/parameter.md b/content/en/getting-started/glossary/parameter.md new file mode 100644 index 000000000..dfc04637d --- /dev/null +++ b/content/en/getting-started/glossary/parameter.md @@ -0,0 +1,7 @@ +--- +title: parameter +--- + +Typically, a user-defined key-value pair at the site or page level, but may also refer to a configuration setting or an [argument]. See also [field]. + +{{% include "/getting-started/glossary/_link-reference-definitions" %}} diff --git a/content/en/getting-started/glossary/partial.md b/content/en/getting-started/glossary/partial.md new file mode 100644 index 000000000..e9dad752f --- /dev/null +++ b/content/en/getting-started/glossary/partial.md @@ -0,0 +1,7 @@ +--- +title: partial +--- + +A [template] called from any other template including [shortcodes][shortcode], [render hooks][render hook], and other partials. A partial either renders something or returns something. A partial can also call itself, for example, to [walk] a data structure. + +{{% include "/getting-started/glossary/_link-reference-definitions" %}} diff --git a/content/en/getting-started/glossary/permalink.md b/content/en/getting-started/glossary/permalink.md new file mode 100644 index 000000000..1504a7d03 --- /dev/null +++ b/content/en/getting-started/glossary/permalink.md @@ -0,0 +1,7 @@ +--- +title: permalink +--- + +The absolute URL of a published resource or a rendered page, including scheme and host. + +{{% include "/getting-started/glossary/_link-reference-definitions" %}} diff --git a/content/en/getting-started/glossary/pipe.md b/content/en/getting-started/glossary/pipe.md new file mode 100644 index 000000000..7ed675785 --- /dev/null +++ b/content/en/getting-started/glossary/pipe.md @@ -0,0 +1,7 @@ +--- +title: pipe +--- + +See [pipeline]. + +{{% include "/getting-started/glossary/_link-reference-definitions" %}} diff --git a/content/en/getting-started/glossary/pipeline.md b/content/en/getting-started/glossary/pipeline.md new file mode 100644 index 000000000..671b52cd3 --- /dev/null +++ b/content/en/getting-started/glossary/pipeline.md @@ -0,0 +1,9 @@ +--- +title: pipeline +--- + +Within a [template action], a pipeline is a possibly chained sequence of values, [function] calls, or [method] calls. Functions and methods in the pipeline may take multiple [arguments][argument]. + +A pipeline may be *chained* by separating a sequence of commands with pipeline characters "|". In a chained pipeline, the result of each command is passed as the last argument to the following command. The output of the final command in the pipeline is the value of the pipeline. See the [Go documentation](https://pkg.go.dev/text/template#hdr-Pipelines) for details. + +{{% include "/getting-started/glossary/_link-reference-definitions" %}} diff --git a/content/en/getting-started/glossary/publish.md b/content/en/getting-started/glossary/publish.md new file mode 100644 index 000000000..b90250ccd --- /dev/null +++ b/content/en/getting-started/glossary/publish.md @@ -0,0 +1,7 @@ +--- +title: publish +--- + +See [build]. + +{{% include "/getting-started/glossary/_link-reference-definitions" %}} diff --git a/content/en/getting-started/glossary/regular-page.md b/content/en/getting-started/glossary/regular-page.md new file mode 100644 index 000000000..ec3c41634 --- /dev/null +++ b/content/en/getting-started/glossary/regular-page.md @@ -0,0 +1,7 @@ +--- +title: regular page +--- + +Content with the "page" [page kind]. See also [section page]. + +{{% include "/getting-started/glossary/_link-reference-definitions" %}} diff --git a/content/en/getting-started/glossary/relative-permalink.md b/content/en/getting-started/glossary/relative-permalink.md new file mode 100644 index 000000000..38eac118a --- /dev/null +++ b/content/en/getting-started/glossary/relative-permalink.md @@ -0,0 +1,7 @@ +--- +title: relative permalink +--- + +The host-relative URL of a published resource or a rendered page. + +{{% include "/getting-started/glossary/_link-reference-definitions" %}} diff --git a/content/en/getting-started/glossary/remote-resource.md b/content/en/getting-started/glossary/remote-resource.md new file mode 100644 index 000000000..9e3634ff6 --- /dev/null +++ b/content/en/getting-started/glossary/remote-resource.md @@ -0,0 +1,7 @@ +--- +title: remote resource +--- + +A file on a remote server, accessible via HTTP or HTTPS with the [`resources.GetRemote`](/functions/resources/getremote) function. + +{{% include "/getting-started/glossary/_link-reference-definitions" %}} diff --git a/content/en/getting-started/glossary/render-hook.md b/content/en/getting-started/glossary/render-hook.md new file mode 100644 index 000000000..a2951e5c9 --- /dev/null +++ b/content/en/getting-started/glossary/render-hook.md @@ -0,0 +1,7 @@ +--- +title: render hook +--- + +A [template] that overrides standard Markdown rendering. See [details](/render-hooks). + +{{% include "/getting-started/glossary/_link-reference-definitions" %}} diff --git a/content/en/getting-started/glossary/resource-type.md b/content/en/getting-started/glossary/resource-type.md new file mode 100644 index 000000000..098b42f56 --- /dev/null +++ b/content/en/getting-started/glossary/resource-type.md @@ -0,0 +1,10 @@ +--- +title: resource type +--- + +The main type of a resource's [media type]. Content files such as Markdown, HTML, AsciiDoc, Pandoc, reStructuredText, and Emacs Org Mode have resource type `page`. Other resource types include `image`, `video`, etc. Retrieve the resource type using the [`ResourceType`] method on a `Resource` object. + +[media type]: /methods/resource/mediatype/ +[`ResourceType`]: /methods/resource/resourcetype/ + +{{% include "/getting-started/glossary/_link-reference-definitions" %}} diff --git a/content/en/getting-started/glossary/resource.md b/content/en/getting-started/glossary/resource.md new file mode 100644 index 000000000..cbf104831 --- /dev/null +++ b/content/en/getting-started/glossary/resource.md @@ -0,0 +1,9 @@ +--- +title: resource +--- + +Any file consumed by the build process to augment or generate content, structure, behavior, or presentation. For example: images, videos, content snippets, CSS, Sass, JavaScript, and data. + +Hugo supports three types of resources: [global][global resource], [page][page resource], and [remote][remote resource]. + +{{% include "/getting-started/glossary/_link-reference-definitions" %}} diff --git a/content/en/getting-started/glossary/scalar.md b/content/en/getting-started/glossary/scalar.md new file mode 100644 index 000000000..539142b2b --- /dev/null +++ b/content/en/getting-started/glossary/scalar.md @@ -0,0 +1,7 @@ +--- +title: scalar +--- + +A single value, one of [string], [integer], [floating point], or [boolean]. + +{{% include "/getting-started/glossary/_link-reference-definitions" %}} diff --git a/content/en/getting-started/glossary/scratch-pad.md b/content/en/getting-started/glossary/scratch-pad.md new file mode 100644 index 000000000..5e57ce0d9 --- /dev/null +++ b/content/en/getting-started/glossary/scratch-pad.md @@ -0,0 +1,10 @@ +--- +title: scratch pad +--- + +Conceptually, a [map] with [methods][method] to set, get, update, and delete values. Attach the data structure to a `Page` or `Site` object using the [`Store`] method, or create a locally scoped scratch pad using the [`newScratch`] function. + +[`Store`]: /methods/page/store/ +[`newScratch`]: /functions/collections/newscratch/ + +{{% include "/getting-started/glossary/_link-reference-definitions" %}} diff --git a/content/en/getting-started/glossary/section-page.md b/content/en/getting-started/glossary/section-page.md new file mode 100644 index 000000000..e4672162d --- /dev/null +++ b/content/en/getting-started/glossary/section-page.md @@ -0,0 +1,9 @@ +--- +title: section page +--- + +Content with the "section" [page kind]. Typically a listing of [regular pages][regular page] and/or other section pages within the current [section]. + +{{% include "/getting-started/glossary/_link-reference-definitions" %}} + +{{% include "/getting-started/glossary/_link-reference-definitions" %}} diff --git a/content/en/getting-started/glossary/section.md b/content/en/getting-started/glossary/section.md new file mode 100644 index 000000000..31c79dbb4 --- /dev/null +++ b/content/en/getting-started/glossary/section.md @@ -0,0 +1,7 @@ +--- +title: section +--- + +A section is a top-level content directory, or any content directory with an `_index.md` file. A content directory with an `_index.md` file is also known as a [branch bundle]. Section templates receive one or more page [collections][collection] in [context]. See [details](/content-management/sections/). + +{{% include "/getting-started/glossary/_link-reference-definitions" %}} diff --git a/content/en/getting-started/glossary/shortcode.md b/content/en/getting-started/glossary/shortcode.md new file mode 100644 index 000000000..cd9347cb8 --- /dev/null +++ b/content/en/getting-started/glossary/shortcode.md @@ -0,0 +1,7 @@ +--- +title: shortcode +--- + +A [template] called from within Markdown, taking zero or more [arguments][argument]. See [details](/content-management/shortcodes/). + +{{% include "/getting-started/glossary/_link-reference-definitions" %}} diff --git a/content/en/getting-started/glossary/slice.md b/content/en/getting-started/glossary/slice.md new file mode 100644 index 000000000..2f21d9fab --- /dev/null +++ b/content/en/getting-started/glossary/slice.md @@ -0,0 +1,7 @@ +--- +title: slice +--- + +A numbered sequence of elements. Unlike Go's [array] data type, slices are dynamically sized. [Elements][element] within a slice can be [scalars][scalar], [arrays][array], [maps][map], pages, or other slices. See the [Go documentation](https://go.dev/ref/spec#Slice_types) for details. + +{{% include "/getting-started/glossary/_link-reference-definitions" %}} diff --git a/content/en/getting-started/glossary/string-literal-interpreted.md b/content/en/getting-started/glossary/string-literal-interpreted.md new file mode 100644 index 000000000..75ea93658 --- /dev/null +++ b/content/en/getting-started/glossary/string-literal-interpreted.md @@ -0,0 +1,7 @@ +--- +title: string literal (interpreted) +--- + +Interpreted string literals are character sequences between double quotes, as in "foo". Within the quotes, any character may appear except a newline and an unescaped double quote. The text between the quotes forms the value of the literal, with backslash escapes interpreted. See [details](https://go.dev/ref/spec#String_literals). + +{{% include "/getting-started/glossary/_link-reference-definitions" %}} diff --git a/content/en/getting-started/glossary/string-literal-raw.md b/content/en/getting-started/glossary/string-literal-raw.md new file mode 100644 index 000000000..360634da4 --- /dev/null +++ b/content/en/getting-started/glossary/string-literal-raw.md @@ -0,0 +1,7 @@ +--- +title: string literal (raw) +--- + +Raw string literals are character sequences between backticks, as in \`bar\`. Within the backticks, any character may appear except a backtick. Backslashes have no special meaning and the string may contain newlines. Carriage return characters (`\r`) inside raw string literals are discarded from the raw string value. See [details](https://go.dev/ref/spec#String_literals). + +{{% include "/getting-started/glossary/_link-reference-definitions" %}} diff --git a/content/en/getting-started/glossary/string.md b/content/en/getting-started/glossary/string.md new file mode 100644 index 000000000..97cb6a73b --- /dev/null +++ b/content/en/getting-started/glossary/string.md @@ -0,0 +1,7 @@ +--- +title: string +--- + +A sequence of bytes. For example, `"What is 6 times 7?"`. + +{{% include "/getting-started/glossary/_link-reference-definitions" %}} diff --git a/content/en/getting-started/glossary/taxonomic-weight.md b/content/en/getting-started/glossary/taxonomic-weight.md new file mode 100644 index 000000000..529f881f8 --- /dev/null +++ b/content/en/getting-started/glossary/taxonomic-weight.md @@ -0,0 +1,7 @@ +--- +title: taxonomic weight +--- + +Defined in front matter and unique to each taxonomy, this [weight] determines the sort order of page collections contained within a [`Taxonomy`][taxonomy] object. See [details](/content-management/taxonomies/#order-taxonomies). + +{{% include "/getting-started/glossary/_link-reference-definitions" %}} diff --git a/content/en/getting-started/glossary/taxonomy-object.md b/content/en/getting-started/glossary/taxonomy-object.md new file mode 100644 index 000000000..5847898aa --- /dev/null +++ b/content/en/getting-started/glossary/taxonomy-object.md @@ -0,0 +1,7 @@ +--- +title: taxonomy object +--- + +A [map] of [terms][term] and the [weighted pages][weighted page] associated with each term. + +{{% include "/getting-started/glossary/_link-reference-definitions" %}} diff --git a/content/en/getting-started/glossary/taxonomy-page.md b/content/en/getting-started/glossary/taxonomy-page.md new file mode 100644 index 000000000..d3cad5912 --- /dev/null +++ b/content/en/getting-started/glossary/taxonomy-page.md @@ -0,0 +1,7 @@ +--- +title: taxonomy page +--- + +Content with the "taxonomy" [page kind]. Typically a listing of [terms][term] within a given [taxonomy]. + +{{% include "/getting-started/glossary/_link-reference-definitions" %}} diff --git a/content/en/getting-started/glossary/taxonomy.md b/content/en/getting-started/glossary/taxonomy.md new file mode 100644 index 000000000..3756aea93 --- /dev/null +++ b/content/en/getting-started/glossary/taxonomy.md @@ -0,0 +1,7 @@ +--- +title: taxonomy +--- + +A group of related [terms][term] used to classify content. For example, a "colors" taxonomy might include the terms "red", "green", and "blue". See [details](/content-management/taxonomies/). + +{{% include "/getting-started/glossary/_link-reference-definitions" %}} diff --git a/content/en/getting-started/glossary/template-action.md b/content/en/getting-started/glossary/template-action.md new file mode 100644 index 000000000..aa28bac68 --- /dev/null +++ b/content/en/getting-started/glossary/template-action.md @@ -0,0 +1,7 @@ +--- +title: template action +--- + +A data evaluation or control structure within a [template], delimited by "{{" and "}}". See the [Go documentation](https://pkg.go.dev/text/template#hdr-Actions) for details. + +{{% include "/getting-started/glossary/_link-reference-definitions" %}} diff --git a/content/en/getting-started/glossary/template.md b/content/en/getting-started/glossary/template.md new file mode 100644 index 000000000..a27b41c2d --- /dev/null +++ b/content/en/getting-started/glossary/template.md @@ -0,0 +1,7 @@ +--- +title: template +--- + +A file with [template actions][template action], located within the `layouts` directory of a project, theme, or module. See [details](/templates/). + +{{% include "/getting-started/glossary/_link-reference-definitions" %}} diff --git a/content/en/getting-started/glossary/term-page.md b/content/en/getting-started/glossary/term-page.md new file mode 100644 index 000000000..773c98fb9 --- /dev/null +++ b/content/en/getting-started/glossary/term-page.md @@ -0,0 +1,7 @@ +--- +title: term page +--- + +Content with the "term" [page kind]. Typically a listing of [regular pages][regular page] and [section pages][section page] with a given [term]. + +{{% include "/getting-started/glossary/_link-reference-definitions" %}} diff --git a/content/en/getting-started/glossary/term.md b/content/en/getting-started/glossary/term.md new file mode 100644 index 000000000..ed6df19f1 --- /dev/null +++ b/content/en/getting-started/glossary/term.md @@ -0,0 +1,7 @@ +--- +title: term +--- + +A member of a [taxonomy], used to classify content. See [details](/content-management/taxonomies/). + +{{% include "/getting-started/glossary/_link-reference-definitions" %}} diff --git a/content/en/getting-started/glossary/theme.md b/content/en/getting-started/glossary/theme.md new file mode 100644 index 000000000..d9a294e05 --- /dev/null +++ b/content/en/getting-started/glossary/theme.md @@ -0,0 +1,7 @@ +--- +title: theme +--- + +A packaged combination of [archetypes][archetype], assets, content, data, [templates][template], translation tables, static files, or configuration settings. A theme may serve as the basis for a new site, or to augment an existing site. See also [module]. + +{{% include "/getting-started/glossary/_link-reference-definitions" %}} diff --git a/content/en/getting-started/glossary/token.md b/content/en/getting-started/glossary/token.md new file mode 100644 index 000000000..46e88fc35 --- /dev/null +++ b/content/en/getting-started/glossary/token.md @@ -0,0 +1,7 @@ +--- +title: token +--- + +An identifier within a format string, beginning with a colon and replaced with a value when rendered. For example, use tokens in format strings for both [permalinks](/content-management/urls/#permalinks) and [dates](/functions/time/format/#localization). + +{{% include "/getting-started/glossary/_link-reference-definitions" %}} diff --git a/content/en/getting-started/glossary/type.md b/content/en/getting-started/glossary/type.md new file mode 100644 index 000000000..a18f19f19 --- /dev/null +++ b/content/en/getting-started/glossary/type.md @@ -0,0 +1,7 @@ +--- +title: type +--- + +See [content type]. + +{{% include "/getting-started/glossary/_link-reference-definitions" %}} diff --git a/content/en/getting-started/glossary/unmarshal.md b/content/en/getting-started/glossary/unmarshal.md new file mode 100644 index 000000000..6cea92098 --- /dev/null +++ b/content/en/getting-started/glossary/unmarshal.md @@ -0,0 +1,7 @@ +--- +title: unmarshal +--- + +To transform a serialized object into a data structure. For example, transforming a JSON file into a [map] that you can access within a template. See [marshal]. + +{{% include "/getting-started/glossary/_link-reference-definitions" %}} diff --git a/content/en/getting-started/glossary/variable.md b/content/en/getting-started/glossary/variable.md new file mode 100644 index 000000000..bcc44d034 --- /dev/null +++ b/content/en/getting-started/glossary/variable.md @@ -0,0 +1,7 @@ +--- +title: variable +--- + +A user-defined [identifier] prepended with a `$` symbol, representing a value of any data type, initialized or assigned within a [template action]. For example, `$foo` and `$bar` are variables. + +{{% include "/getting-started/glossary/_link-reference-definitions" %}} diff --git a/content/en/getting-started/glossary/walk.md b/content/en/getting-started/glossary/walk.md new file mode 100644 index 000000000..281eab16f --- /dev/null +++ b/content/en/getting-started/glossary/walk.md @@ -0,0 +1,7 @@ +--- +title: walk +--- + +To recursively traverse a nested data structure. For example, rendering a multilevel menu. + +{{% include "/getting-started/glossary/_link-reference-definitions" %}} diff --git a/content/en/getting-started/glossary/weight.md b/content/en/getting-started/glossary/weight.md new file mode 100644 index 000000000..0832369cc --- /dev/null +++ b/content/en/getting-started/glossary/weight.md @@ -0,0 +1,7 @@ +--- +title: weight +--- + +Used to position an element within a collection sorted by weight. Assign weights using non-zero integers. Lighter items float to the top, while heavier items sink to the bottom. Unweighted or zero-weighted elements are placed at the end of the collection. Weights are typically assigned to pages, menu entries, languages, and output formats. + +{{% include "/getting-started/glossary/_link-reference-definitions" %}} diff --git a/content/en/getting-started/glossary/weighted-page.md b/content/en/getting-started/glossary/weighted-page.md new file mode 100644 index 000000000..d6de7ad76 --- /dev/null +++ b/content/en/getting-started/glossary/weighted-page.md @@ -0,0 +1,7 @@ +--- +title: weighted page +--- + +Contained within a [`Taxonomy`][taxonomy] object, a weighted page is a [map] with two elements: a `Page` object, and its [taxonomic weight] as defined in front matter. Access the elements using the `Page` and `Weight` keys. + +{{% include "/getting-started/glossary/_link-reference-definitions" %}} diff --git a/content/en/getting-started/glossary/zero-time.md b/content/en/getting-started/glossary/zero-time.md new file mode 100644 index 000000000..de2214955 --- /dev/null +++ b/content/en/getting-started/glossary/zero-time.md @@ -0,0 +1,7 @@ +--- +title: zero time +--- + +The _zero time_ is January 1, 0001, 00:00:00 UTC. Formatted per [RFC3339](https://www.rfc-editor.org/rfc/rfc3339) the _zero time_ is 0001-01-01T00:00:00-00:00. + +{{% include "/getting-started/glossary/_link-reference-definitions" %}} diff --git a/content/en/methods/page/AlternativeOutputFormats.md b/content/en/methods/page/AlternativeOutputFormats.md index b48d1adf4..c3b96b983 100644 --- a/content/en/methods/page/AlternativeOutputFormats.md +++ b/content/en/methods/page/AlternativeOutputFormats.md @@ -10,7 +10,7 @@ action: signatures: [PAGE.AlternativeOutputFormats] --- -{{% include "methods/page/_common/output-format-definition.md" %}} +{{% gt "output format" %}} The `AlternativeOutputFormats` method on a `Page` object returns a slice of `OutputFormat` objects, excluding the current output format, each representing one of the output formats enabled for the given page.. See [details](/templates/output-formats/). diff --git a/content/en/methods/page/OutputFormats.md b/content/en/methods/page/OutputFormats.md index 03343cf8c..94831a163 100644 --- a/content/en/methods/page/OutputFormats.md +++ b/content/en/methods/page/OutputFormats.md @@ -11,7 +11,7 @@ action: toc: true --- -{{% include "methods/page/_common/output-format-definition.md" %}} +{{% gt "output format" %}} The `OutputFormats` method on a `Page` object returns a slice of `OutputFormat` objects, each representing one of the output formats enabled for the given page. See [details](/templates/output-formats/). diff --git a/layouts/_default/glossary.html b/layouts/_default/glossary.html new file mode 100644 index 000000000..8280a3f97 --- /dev/null +++ b/layouts/_default/glossary.html @@ -0,0 +1,34 @@ +{{ define "main" }} +
+
+ +
+ {{ partial "nav-links-docs.html" . }} +
+
+
+
+ {{ .Render "page" }} +
+
+ + {{/* + The only reason this template exists is to render the glossary as a + single page instead of a section. Yes, it's a section, but its members + are not published. + */}} + + +
+
+ +
+
+ {{ partial "docs/page-meta-data.html" . }} + {{ partial "page-edit.html" . }} + {{ partial "tags.html" . }} +
+
+{{ end }} diff --git a/layouts/shortcodes/glossary.html b/layouts/shortcodes/glossary.html new file mode 100644 index 000000000..7a9fbf7b7 --- /dev/null +++ b/layouts/shortcodes/glossary.html @@ -0,0 +1,43 @@ +{{- /* +Renders the glossary of terms. + +When you call this shortcode using the {{% %}} notation, the glossary terms are +Markdown headings (level 6) which means they are members of .Page.Fragments. +This allows the link render hook to verify links to glossary terms. + +Yes, the terms themselves are pages, but we don't want to link to the pages, at +least not right now. Instead, we want to link to the fragments rendered by this +shortcode. + +@returns {template.HTML} + +@example {{% glossary %}} +*/}} +{{- $path := "/getting-started/glossary" }} +{{- with site.GetPage $path }} + {{- with $p := .Pages.ByTitle }} + + {{- /* Build and render alphabetical index. */}} + {{- $m := dict }} + {{- range $p }} + {{- $k := substr .Title 0 1 | strings.ToUpper }} + {{- if index $m $k }} + {{- continue }} + {{- end }} + {{- $anchor := path.BaseName .Path | anchorize }} + {{- $m = merge $m (dict $k ($anchor | anchorize)) }} + {{- end }} + {{- range $k, $v := $m }} +[{{ $k }}](#{{ $v }}) {{/* Do not indent. */}} + {{- end }} + + {{- /* Render glossary terms. */}} + {{- range $p }} +###### {{ .Title }}{{/* Do not indent. */}} +{{ .RenderShortcodes }}{{/* Do not indent. */}} + {{- end }} + + {{- end }} +{{- else }} + {{- errorf "The %q shortcode was unable to get %s: see %s" .Name $path .Position}} +{{- end }} diff --git a/layouts/shortcodes/gt.html b/layouts/shortcodes/gt.html new file mode 100644 index 000000000..7d2a7fa65 --- /dev/null +++ b/layouts/shortcodes/gt.html @@ -0,0 +1,19 @@ +{{- /* +Renders a glossary term. + +@param {string} (.Get 0) The glossary term. +@returns {template.HTML} + +@example {{% gt float %}} +@example {{% gt "floating point" %}} +*/}} +{{- with .Get 0 }} + {{- $path := printf "/getting-started/glossary/%s" (urlize .) }} + {{- with site.GetPage $path }} +{{ .RenderShortcodes }}{{/* Do not indent this line. */}} + {{- 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 }}