Documentation: provide details on storage engine album naming #6812
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jrasm91
reviewed
Jan 31, 2024
| @@ -17,7 +17,7 @@ Year/Year-Month-Day/Filename.Extension | |||
| <img src={require('./img/storage-template.png').default} width="100%" title="Storage Template Setting" /> | |||
|
|
|||
| :::tip | |||
| By default, special characters will be converted to an HTML entity (for example, `&` -> `&`). To prevent this, wrap the variable in an extra set of braces (for example, `{{{album}}}`). You can learn more about this [here](https://handlebarsjs.com/guide/expressions.html#html-escaping) and [here](https://github.com/immich-app/immich/issues/4917). | |||
| The `{{album}}` variable will expand to the name of the album to which the file was most recently added to. By default, special characters will be converted to an HTML entity (for example, `&` -> `&`). To prevent this, wrap the variable in an extra set of braces (for example, `{{{album}}}`). You can learn more about this [here](https://handlebarsjs.com/guide/expressions.html#html-escaping) and [here](https://github.com/immich-app/immich/issues/4917). | |||
There was a problem hiding this comment.
I don't think it is "most recently added to". It is actually based on when the album was created. We might want to change this, but that is what it looks like it does right now.
|
Updated. I started a discussion in #6810 with a feature request to improve this handling, but for now I think we can document what the current behavior is. |
jrasm91
approved these changes
Feb 1, 2024
|
Perfect! Although that seems like an unrelated discussion you linked. |
|
Sorry, I meant #6810 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Explain how the
{{album}}variable is handled in file paths.