diff options
Diffstat (limited to 'docs/content/en/methods/page/Ref.md')
| -rw-r--r-- | docs/content/en/methods/page/Ref.md | 33 |
1 files changed, 13 insertions, 20 deletions
diff --git a/docs/content/en/methods/page/Ref.md b/docs/content/en/methods/page/Ref.md index e0d42424d..35f9460ba 100644 --- a/docs/content/en/methods/page/Ref.md +++ b/docs/content/en/methods/page/Ref.md @@ -3,27 +3,23 @@ title: Ref description: Returns the absolute URL of the page with the given path, language, and output format. categories: [] keywords: [] -action: - related: - - methods/page/RelRef - - functions/urls/RelRef - - functions/urls/Ref - returnType: string - signatures: [PAGE.Ref OPTIONS] +params: + functions_and_methods: + returnType: string + signatures: [PAGE.Ref OPTIONS] --- -The map of option contains: +## Usage -path -: (`string`) The path to the page, relative to the `content` directory. Required. +The `Ref` method accepts a single argument: an options map. -lang -: (`string`) The language (site) to search for the page. Default is the current language. Optional. +## Options -outputFormat -: (`string`) The output format to search for the page. Default is the current output format. Optional. +{{% include "_common/ref-and-relref-options.md" %}} -The examples below show the rendered output when visiting a page on the English language version of the site: +## Examples + +The following examples show the rendered output for a page on the English version of the site: ```go-html-template {{ $opts := dict "path" "/books/book-1" }} @@ -36,9 +32,6 @@ The examples below show the rendered output when visiting a page on the English {{ .Ref $opts }} → https://example.org/de/books/book-1/index.json ``` -By default, Hugo will throw an error and fail the build if it cannot resolve the path. You can change this to a warning in your site configuration, and specify a URL to return when the path cannot be resolved. +## Error handling -{{< code-toggle file=hugo >}} -refLinksErrorLevel = 'warning' -refLinksNotFoundURL = '/some/other/url' -{{< /code-toggle >}} +{{% include "_common/ref-and-relref-error-handling.md" %}} |