Undocumented or Faulty: linking colocated assets on a slug page through template

[Yamavu]

Documentation issue

Summary

Listing all colocated assets of a page in a template page.html . The content index.md uses a slug

(tested on versions 0.18.0 and 0.19.1)

Files linked in markdown are unaffected.

file setup:

_index.md
page/
  image1.jpg
  image2.jpg
  index.jpg

From the documentation:

<div>
{% for asset in page.assets -%}
  {%- if asset is matching("[.](jpg|png)$") -%}
    {% set image = resize_image(path=asset, width=240, height=180) %}
    <a href="{{ get_url(path=asset) }}" target="_blank">
      <img src="{{ image.url }}" />
    </a>
  {%- endif %}
{%- endfor %}
</div>

If the page also uses a custom slug variable, {{ get_url(path=asset) }} doesn't provide this correctly,

Zola will only display the right output when the link is written like:

{{page.permalink | safe}}{{asset | split(pat='/') | last  | safe }}

Maybe I overlooked something, but linking all co-located assets seems to be quite essential for building almost any kind of art or photo gallery.

Proposed solution

Either current documentation should be expanded or get_url() should include this functionality.

[Raymi306]

I just ran into this as well.

[Yamavu]

as far as I understood, get_url ( path, lang="en", trailing_slash=false, cachebust=false ) is also used internally which is why is simple and optimized.

the function currently supposed to only work with MD files, not the page assets (even though the documentation suggests that).

The function has a fallback option to also link to the static directory, and happens to work with un-sluggified content nodes too. It feels pretty alpha to me

[Keats]

Basically it's for 2 things:

1. if it starts with @/, resolve the internal link
2. otherwise just make a permalink with what we've been given without checking anything

To handle 2 for assets with renamed slugs, it would require detecting it's a colocated asset, load the related page and generate the permalink from there (what you need to load exactly in the GetUrl fn is TBD, you don't want to add the whole site).
If someone wants to do a PR for that I would take it.

[ZzMzaw]

I was wondering if adding permalinks of colocated assets alongside the one of the page would be an acceptable solution.

This would allow 1. to find assets through internal links which would solve the initial statement by just adding '@/' to the asset's path used in get_url.

I am really new to Zola so it might be a complete non-sense and I have no idea if having much more permalinks could have a negative impact on performance.

Last but not least, it would introduce a difference between get_url(path='@/path/to/colocated/asset') and get_url(path='content/path/to/colocated/asset').
I am not sure how much it is a problem (and didn't check yet if it is not already the case for markdown files).

If the proposed solution is acceptable, I can try to do a PR in the coming weeks.

[Keats]

I think it could work.

Last but not least, it would introduce a difference between get_url(path='@/path/to/colocated/asset') and get_url(path='content/path/to/colocated/asset').

There's no expectation that those 2 are the same once this issue is fixed.

[ZzMzaw]

I tried to propose a PR which would solve this issue by using the internal resolution ('@') for assets.
It would allow to avoid the proposed workaround and the galery example could be adapted as follow:

<div>
{% for asset in page.assets -%}
  {%- if asset is matching("[.](jpg|png)$") -%}
    {% set image = resize_image(path=asset, width=240, height=180) %}
    <a href="{{ get_url(path='@' ~ asset, lang=lang) }}" target="_blank">
      <img src="{{ image.url }}" />
    </a>
  {%- endif %}
{%- endfor %}
</div>

Adding the lang is not mandatory but it would allow to retrieve the lang-aware permalink (i.e. with path starting with the lang) for the non-default languages.
Otherwise, only the permalink matching the default lang will be retrieved (which can be fine as well).