hugo-theme-relearn/exampleSite/content/shortcodes/attachments.en.md

96 lines
2.3 KiB
Markdown
Raw Normal View History

+++
description = "The Attachments shortcode displays a list of files attached to a page"
title = "Attachments"
+++
2017-08-20 15:10:29 +00:00
The Attachments shortcode displays a list of files attached to a page.
{{% attachments /%}}
## Usage
The shortcurt lists files found in a **specific folder**.
Currently, it support two implementations for pages
1. If your page is a Markdown file, attachements must be placed in a **folder** named like your page and ending with **.files**.
2017-08-20 15:10:29 +00:00
> * content
> * _index.md
> * page.files
> * attachment.pdf
> * page.md
2020-07-31 02:37:35 +00:00
2. If your page is a **folder**, attachements must be placed in a nested **'files'** folder.
2017-08-20 15:10:29 +00:00
> * content
> * _index.md
> * page
> * index.md
> * files
> * attachment.pdf
2017-08-20 20:29:35 +00:00
Be aware that if you use a multilingual website, you will need to have as many folders as languages.
2020-07-31 02:38:18 +00:00
That's all!
2017-08-20 15:10:29 +00:00
### Parameters
| Parameter | Default | Description |
|:--|:--|:--|
| title | "Attachments" | List's title |
| icon | "paperclip" | Sets the icon near the title; if you want no icon at all, you have to set this parameter to `" "` (a non empty string filled with spaces) |
2021-07-26 09:14:27 +00:00
| sort | "asc" | Sorting the output in `asc`ending or `desc`ending order |
| style | "" | Choose between `orange`, `grey`, `blue` and `green` for nice style |
2017-08-20 15:10:29 +00:00
| pattern | ".*" | A regular expressions, used to filter the attachments by file name. <br/><br/>The **pattern** parameter value must be [regular expressions](https://en.wikipedia.org/wiki/Regular_expression).
For example:
* To match a file suffix of 'jpg', use **.*jpg** (not *.jpg).
* To match file names ending in 'jpg' or 'png', use **.*(jpg|png)**
### Examples
#### List of attachments ending in pdf or mp4
````go
{{%/*attachments title="Related files" pattern=".*(pdf|mp4)"/*/%}}
````
2017-08-20 15:10:29 +00:00
renders as
{{%attachments title="Related files" pattern=".*(pdf|mp4)"/%}}
#### Colored styled box
````go
{{%/*attachments style="orange" /*/%}}
````
2017-08-20 15:10:29 +00:00
renders as
{{% attachments style="orange" /%}}
````go
{{%/*attachments style="grey" /*/%}}
````
2017-08-20 15:10:29 +00:00
renders as
2017-08-20 15:10:29 +00:00
{{% attachments style="grey" /%}}
````go
{{%/*attachments style="blue" /*/%}}
````
2017-08-20 15:10:29 +00:00
renders as
{{% attachments style="blue" /%}}
````go
{{%/*attachments style="green" /*/%}}
````
2017-08-20 15:10:29 +00:00
renders as
2020-07-31 02:38:18 +00:00
{{% attachments style="green" /%}}