blob: aa7acf50b5b94210a2dce5458eae4fa9804759fe (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
|
---
title: urls.RelRef
description: Returns the relative URL of the page with the given path, language, and output format.
categories: []
keywords: []
params:
functions_and_methods:
aliases: [relref]
returnType: string
signatures:
- urls.RelRef PAGE PATH
- urls.RelRef PAGE OPTIONS
aliases: [/functions/relref]
---
## Usage
The `relref` function takes two arguments:
1. The context for resolving relative paths (typically the current page).
1. Either the target page's path or an options map (see below).
## Options
{{% include "_common/ref-and-relref-options.md" %}}
## Examples
The following examples show the rendered output for a page on the English version of the site:
```go-html-template
{{ relref . "/books/book-1" }} → /en/books/book-1/
{{ $opts := dict "path" "/books/book-1" }}
{{ relref . $opts }} → /en/books/book-1/
{{ $opts := dict "path" "/books/book-1" "lang" "de" }}
{{ relref . $opts }} → /de/books/book-1/
{{ $opts := dict "path" "/books/book-1" "lang" "de" "outputFormat" "json" }}
{{ relref . $opts }} → /de/books/book-1/index.json
```
## Error handling
{{% include "_common/ref-and-relref-error-handling.md" %}}
|
