diff --git a/content/en/configuration/all.md b/content/en/configuration/all.md index c64638499..28fe970b2 100644 --- a/content/en/configuration/all.md +++ b/content/en/configuration/all.md @@ -59,10 +59,26 @@ dataDir : (`string`) The designated directory for data files. Default is `data`. {{% module-mounts-note %}} defaultContentLanguage -: (`string`) The project's default language key, conforming to the syntax described in [RFC 5646]. This value must match one of the defined language keys. Default is `en`. +: (`string`) The project's default content language key, conforming to the syntax described in [RFC 5646]. This value must match one of the defined language keys. Default is `en`. defaultContentLanguageInSubdir -: (`bool`) Whether to publish the default language site to a subdirectory matching the `defaultContentLanguage`. Default is `false`. +: (`bool`) Whether to publish the default content language site to a subdirectory matching the `defaultContentLanguage`. Default is `false`. + +defaultContentRole +: {{< new-in 0.149.0 />}} +: (`string`) The site's default content role. Default is `guest`. + +defaultContentRoleInSubdir +: {{< new-in 0.149.0 />}} +: (`bool`) Whether to publish the default content role to a subdirectory matching the `defaultContentRole`. Default is `false`. + +defaultContentVersion +: {{< new-in 0.149.0 />}} +: (`string`) The site's default content version. Default is `TODO`. + +defaultContentVersionInSubdir +: {{< new-in 0.149.0 />}} +: (`bool`) Whether to publish the default content version to a subdirectory matching the `defaultContentVersion`. Default is `false`. defaultOutputFormat : (`string`) The default output format for the site. If unspecified, the first available format in the defined order (by weight, then alphabetically) will be used. @@ -240,6 +256,9 @@ renderSegments resourceDir : (`string`) The designated directory for caching output from [asset pipelines](g). Default is `resources`. +roles +: See [configure roles](/configuration/roles/). + security : See [configure security](/configuration/security/). @@ -294,6 +313,9 @@ titleCaseStyle uglyurls : See [configure ugly URLs](/configuration/ugly-urls/). +versions +: See [configure versions](/configuration/versions/). + ## Cache directory Hugo's file cache directory is configurable via the [`cacheDir`] configuration option or the `HUGO_CACHEDIR` environment variable. If neither is set, Hugo will use, in order of preference: diff --git a/content/en/configuration/roles.md b/content/en/configuration/roles.md new file mode 100644 index 000000000..0ddb58f80 --- /dev/null +++ b/content/en/configuration/roles.md @@ -0,0 +1,13 @@ +--- +title: Configure roles +linkTitle: Roles +description: Configure roles. +categories: [] +keywords: [] +--- + +{{< new-in 0.149.0 />}} + +This is the default configuration: + +{{< code-toggle config=rolls />}} diff --git a/content/en/configuration/versions.md b/content/en/configuration/versions.md new file mode 100644 index 000000000..c953bc327 --- /dev/null +++ b/content/en/configuration/versions.md @@ -0,0 +1,13 @@ +--- +title: Configure versions +linkTitle: Versions +description: Configure versions. +categories: [] +keywords: [] +--- + +{{< new-in 0.149.0 />}} + +This is the default configuration: + +{{< code-toggle config=versions />}} diff --git a/content/en/content-management/dimensions.md b/content/en/content-management/dimensions.md new file mode 100644 index 000000000..46c88849c --- /dev/null +++ b/content/en/content-management/dimensions.md @@ -0,0 +1,47 @@ +--- +title: Dimensions +description: TODO +categories: [] +keywords: [] +--- + +{{< new-in 0.149.0 />}} + +TODO + + + +See [configure languages](/configuration/languages/). + +See [configure roles](/configuration/roles/). + +See [configure versions](/configuration/versions/). + + + + + +[`defaultContentLanguage`]: /configuration/all/#defaultcontentlanguage +[`defaultContentLanguageInSubdir`]: /configuration/all/#defaultcontentlanguageinsubdir +[`defaultContentRoleInSubdir`]: /configuration/all/#defaultcontentrole +[`defaultContentRole`]: /configuration/all/#defaultcontentrole +[`defaultContentRoleInSubdir`]: /configuration/all/#defaultcontentrole +[`defaultContentVersion`]: /configuration/all/#defaultcontentversion +[`defaultContentVersionInSubdir`]: /configuration/all/#defaultcontentversioninsubdir + + +[`Dimension`]: /methods/site/dimension/ +[`Language`]: /methods/site/language/ +[`Languages`]: /methods/site/languages/ +[`Role`]: /methods/site/role/ +[`Roles`]: /methods/site/roles/ +[`Version`]: /methods/site/version/ +[`Versions`]: /methods/site/versions/ + + +[front matter languageDelegees]: /content-management/front-matter/#languagedelegees +[front matter languages]: /content-management/front-matter/#languages +[front matter roleDelegees]: /content-management/front-matter/#roledelegees +[front matter roles]: /content-management/front-matter/#roles +[front matter versionDelegees]: /content-management/front-matter/#versiondelegees +[front matter versions]: /content-management/front-matter/#versions diff --git a/content/en/content-management/front-matter.md b/content/en/content-management/front-matter.md index d99475f4c..14a8e1a3e 100644 --- a/content/en/content-management/front-matter.md +++ b/content/en/content-management/front-matter.md @@ -74,6 +74,14 @@ isCJKLanguage keywords : (`string array`) An array of keywords, typically rendered within a `meta` element within the `head` element of the published HTML file, or used as a [taxonomy](g) to classify content. Access these values from a template using the [`Keywords`] method on a `Page` object. +languageDelegees +: {{< new-in 0.149.0 />}} +: (`TODO`) TODO. + +languages +: {{< new-in 0.149.0 />}} +: (`TODO`) TODO. + lastmod : (`string`) The date that the page was last modified. Note that the TOML format also supports unquoted date/time values. See the [dates](#dates) section for examples. Access this value from a template using the [`Lastmod`] method on a `Page` object. @@ -111,6 +119,14 @@ published resources : (`map array`) An array of maps to provide metadata for [page resources]. +roleDelegees +: {{< new-in 0.149.0 />}} +: (`TODO`) TODO. + +roles +: {{< new-in 0.149.0 />}} +: (`TODO`) TODO. + sitemap : (`map`) A map of sitemap options. See the [sitemap templates] page for details. Access these values from a template using the [`Sitemap`] method on a `Page` object. @@ -135,6 +151,14 @@ unpublishdate url : (`string`) Overrides the entire URL path. Applicable to regular pages and section pages. See the [URL management] page for details. +versionDelegees +: {{< new-in 0.149.0 />}} +: (`TODO`) TODO. + +versions +: {{< new-in 0.149.0 />}} +: (`TODO`) TODO. + weight : (`int`) The page [weight](g), used to order the page within a [page collection](g). Access this value from a template using the [`Weight`] method on a `Page` object. diff --git a/content/en/methods/page/Rotate.md b/content/en/methods/page/Rotate.md new file mode 100644 index 000000000..0e0c2caae --- /dev/null +++ b/content/en/methods/page/Rotate.md @@ -0,0 +1,20 @@ +--- +title: Rotate +description: TODO +categories: [] +keywords: [] +params: + functions_and_methods: + returnType: page.Pages + signatures: [PAGE.Rotate DIMENSION] +--- + +{{< new-in 0.149.0 />}} + +TODO + + + +```go-html-template +{{ .Rotate "language" }} +``` diff --git a/content/en/methods/site/Dimension.md b/content/en/methods/site/Dimension.md new file mode 100644 index 000000000..98a9f6eca --- /dev/null +++ b/content/en/methods/site/Dimension.md @@ -0,0 +1,28 @@ +--- +title: Dimension +description: TODO +categories: [] +keywords: [] +params: + functions_and_methods: + returnType: TODO + signatures: [SITE.Dimension DIMENSION] +--- + +{{< new-in 0.149.0 />}} + +TODO + + + + +```go-html-template +{{ .Site.Dimension "language" }} +``` diff --git a/content/en/methods/site/Role.md b/content/en/methods/site/Role.md new file mode 100644 index 000000000..aa3f00f9b --- /dev/null +++ b/content/en/methods/site/Role.md @@ -0,0 +1,18 @@ +--- +title: Role +description: Returns the role configured for this site. +categories: [] +keywords: [] +params: + functions_and_methods: + returnType: roles.RoleSite + signatures: [SITE.Role] +--- + +{{< new-in 0.149.0 />}} + +TODO + +```go-html-template +{{ .Site.Role }} +``` diff --git a/content/en/methods/site/Roles.md b/content/en/methods/site/Roles.md new file mode 100644 index 000000000..0b23485f6 --- /dev/null +++ b/content/en/methods/site/Roles.md @@ -0,0 +1,18 @@ +--- +title: Roles +description: Returns the roles configured for this site. +categories: [] +keywords: [] +params: + functions_and_methods: + returnType: roles.Roles + signatures: [SITE.Roles] +--- + +{{< new-in 0.149.0 />}} + +TODO + +```go-html-template +{{ .Site.Roles }} +``` diff --git a/content/en/methods/site/Version.md b/content/en/methods/site/Version.md new file mode 100644 index 000000000..c295e5d35 --- /dev/null +++ b/content/en/methods/site/Version.md @@ -0,0 +1,18 @@ +--- +title: Version +description: Returns the version configured for this site. +categories: [] +keywords: [] +params: + functions_and_methods: + returnType: versions.VersionSite + signatures: [SITE.Version] +--- + +{{< new-in 0.149.0 />}} + +TODO + +```go-html-template +{{ .Site.Version }} +``` diff --git a/content/en/methods/site/Versions.md b/content/en/methods/site/Versions.md new file mode 100644 index 000000000..6bdfd6fc6 --- /dev/null +++ b/content/en/methods/site/Versions.md @@ -0,0 +1,18 @@ +--- +title: Versions +description: Returns the versions configured for this site. +categories: [] +keywords: [] +params: + functions_and_methods: + returnType: versions.Versions + signatures: [SITE.Versions] +--- + +{{< new-in 0.149.0 />}} + +TODO + +```go-html-template +{{ .Site.Versions }} +```