Skip to content

Commit

Permalink
Document PAGE.String
Browse files Browse the repository at this point in the history
  • Loading branch information
jmooring authored Dec 17, 2024
1 parent 2d151d7 commit bb30e7c
Show file tree
Hide file tree
Showing 2 changed files with 45 additions and 1 deletion.
1 change: 0 additions & 1 deletion content/en/methods/page/Store.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
title: Store
linktitle: PAGE.Store
description: Returns a persistent "scratch pad" on the given page to store and manipulate data.
categories: []
keywords: []
Expand Down
45 changes: 45 additions & 0 deletions content/en/methods/page/String.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
---
title: String
description: Returns the absolute path to the file backing the given page.
categories: []
keywords: []
action:
related: []
returnType: string
signatures: [PAGE.String]
toc: true
---

{{< new-in 0.137.0 >}}

With content from the file system:

```go-html-template
{{ .String }} → /home/user/project/content/posts/post-1.md
```

With content from a content adapter:

```go-html-template
{{ .String }} → /home/user/project/content/posts/_content.gotmpl:/posts/post-1.md
```

With content from a module:

```go-html-template
{{ .String }} → /home/user/.cache/hugo_cache/modules/filecache/modules/pkg/mod/github.com/user/[email protected]/content/posts/post-1.md
```

Use this method to provide useful information when displaying error and warning messages in the console:

{{< code file="layouts/partials/featured-image.html" lang="go-html-template" >}}
{{ with .Resources.GetMatch "*featured*" }}
{{ with .Resize "300x webp" }}
<img src="{{ .RelPermalink }}" width="{{ .Width }}" height="{{ .Height }}" alt="">
{{ end }}
{{ else }}
{{ errorf "The featured-image partial was unable to find a featured image. See %s" .String }}
{{ end }}
{{< /code >}}

With shortcodes and render hooks use the `Position` method instead. Note that the `Position` method is not available to heading, image, and link render hooks.

0 comments on commit bb30e7c

Please sign in to comment.