2022-04-02 13:30:16 +00:00
<!DOCTYPE html>
2022-11-01 01:10:49 +00:00
< html lang = "en" dir = "ltr" >
2022-04-02 13:30:16 +00:00
< head >
< meta charset = "utf-8" >
< meta name = "viewport" content = "height=device-height, width=device-width, initial-scale=1.0, minimum-scale=1.0" >
2023-01-22 21:19:30 +00:00
< meta name = "generator" content = "Hugo 0.110.0" >
2023-01-23 12:49:43 +00:00
< meta name = "generator" content = "Relearn 5.9.4+tip" >
2022-05-25 21:31:08 +00:00
< meta name = "description" content = "List of files attached to a page" >
2022-04-02 13:30:16 +00:00
< meta name = "author" content = "Sören Weber" >
< title > Attachments :: Hugo Relearn Theme< / title >
2022-11-15 06:35:08 +00:00
< link href = "https://McShelby.github.io/hugo-theme-relearn/shortcodes/attachments/index.html" rel = "canonical" type = "text/html" title = "Attachments :: Hugo Relearn Theme" >
2022-11-06 00:38:34 +00:00
< link href = "../../shortcodes/attachments/index.xml" rel = "alternate" type = "application/rss+xml" title = "Attachments :: Hugo Relearn Theme" >
2023-01-23 12:49:43 +00:00
< link href = "../../images/logo.svg?1674478176" rel = "icon" type = "image/svg+xml" >
2022-07-15 13:20:02 +00:00
<!-- https://github.com/filamentgroup/loadCSS/blob/master/README.md#how - to - use -->
2023-01-23 12:49:43 +00:00
< link href = "../../css/fontawesome-all.min.css?1674478178" rel = "stylesheet" media = "print" onload = "this.media='all';this.onload=null;" > < noscript > < link href = "../../css/fontawesome-all.min.css?1674478178" rel = "stylesheet" > < / noscript >
< link href = "../../css/featherlight.min.css?1674478178" rel = "stylesheet" media = "print" onload = "this.media='all';this.onload=null;" > < noscript > < link href = "../../css/featherlight.min.css?1674478178" rel = "stylesheet" > < / noscript >
< link href = "../../css/auto-complete.css?1674478178" rel = "stylesheet" media = "print" onload = "this.media='all';this.onload=null;" > < noscript > < link href = "../../css/auto-complete.css?1674478178" rel = "stylesheet" > < / noscript >
< link href = "../../css/perfect-scrollbar.min.css?1674478178" rel = "stylesheet" >
< link href = "../../css/nucleus.css?1674478178" rel = "stylesheet" >
< link href = "../../css/fonts.css?1674478178" rel = "stylesheet" media = "print" onload = "this.media='all';this.onload=null;" > < noscript > < link href = "../../css/fonts.css?1674478178" rel = "stylesheet" > < / noscript >
< link href = "../../css/theme.css?1674478178" rel = "stylesheet" >
< link href = "../../css/theme-relearn-light.css?1674478178" rel = "stylesheet" id = "variant-style" >
< link href = "../../css/ie.css?1674478178" rel = "stylesheet" >
< link href = "../../css/variant.css?1674478178" rel = "stylesheet" >
< link href = "../../css/print.css?1674478178" rel = "stylesheet" media = "print" >
< link href = "../../css/format-print.css?1674478178" rel = "stylesheet" >
< script src = "../../js/url.js?1674478178" > < / script >
< script src = "../../js/variant.js?1674478178" > < / script >
2022-04-02 13:30:16 +00:00
< script >
// hack to let hugo tell us how to get to the root when using relativeURLs, it needs to be called *url= for it to do its magic:
// https://github.com/gohugoio/hugo/blob/145b3fcce35fbac25c7033c91c1b7ae6d1179da8/transform/urlreplacers/absurlreplacer.go#L72
2022-11-05 23:35:48 +00:00
window.index_js_url="../../index.search.js";
var root_url="../../";
2022-04-02 13:30:16 +00:00
var baseUri=root_url.replace(/\/$/, '');
// translations
window.T_Copy_to_clipboard = 'Copy to clipboard';
window.T_Copied_to_clipboard = 'Copied to clipboard!';
window.T_Copy_link_to_clipboard = 'Copy link to clipboard';
window.T_Link_copied_to_clipboard = 'Copied link to clipboard!';
2022-11-17 21:13:11 +00:00
window.T_No_results_found = 'No results found for \u0022{0}\u0022';
window.T_N_results_found = '{1} results found for \u0022{0}\u0022';
2022-04-02 13:30:16 +00:00
// some further base stuff
var baseUriFull='https:\/\/McShelby.github.io\/hugo-theme-relearn/';
2022-07-14 20:20:11 +00:00
window.variants & & variants.init( [ 'relearn-light', 'relearn-dark', 'learn', 'neon', 'blue', 'green', 'red' ] );
2022-04-02 13:30:16 +00:00
< / script >
2023-01-23 12:49:43 +00:00
< script src = "../../js/jquery.min.js?1674478178" defer > < / script >
2022-12-02 15:05:54 +00:00
< style >
#body img.bg-white {
background-color: white;
}
< / style >
2022-04-02 13:30:16 +00:00
< / head >
2022-11-15 06:35:08 +00:00
< body class = "mobile-support print disableInlineCopyToClipboard" data-url = "../../shortcodes/attachments/index.html" >
2022-04-02 13:30:16 +00:00
< div id = "body" class = "default-animation" >
< div id = "sidebar-overlay" > < / div >
< div id = "toc-overlay" > < / div >
2022-11-07 19:58:08 +00:00
< nav id = "topbar" class = "highlightable" dir = "ltr" >
2022-04-02 13:30:16 +00:00
< div >
< div id = "breadcrumbs" >
< span id = "sidebar-toggle-span" >
2022-10-08 20:51:04 +00:00
< a href = "#" id = "sidebar-toggle" title = 'Menu (CTRL+ALT+n)' > < i class = "fas fa-bars fa-fw" > < / i > < / a >
2022-04-02 13:30:16 +00:00
< / span >
< ol class = "links" itemscope itemtype = "http://schema.org/BreadcrumbList" >
2022-11-05 23:35:48 +00:00
< li itemscope itemtype = "https://schema.org/ListItem" itemprop = "itemListElement" > < a itemprop = "item" href = "../../index.html" > < span itemprop = "name" > Hugo Relearn Theme< / span > < / a > < meta itemprop = "position" content = "1" > > < / li >
< li itemscope itemtype = "https://schema.org/ListItem" itemprop = "itemListElement" > < a itemprop = "item" href = "../../shortcodes/index.html" > < span itemprop = "name" > Shortcodes< / span > < / a > < meta itemprop = "position" content = "2" > > < / li >
2022-10-02 22:25:49 +00:00
< li itemscope itemtype = "https://schema.org/ListItem" itemprop = "itemListElement" > < span itemprop = "name" > Attachments< / span > < meta itemprop = "position" content = "3" > < / li >
2022-04-02 13:30:16 +00:00
< / ol >
< / div >
< / div >
< / nav >
2022-07-05 22:16:52 +00:00
< main id = "body-inner" class = "highlightable default" tabindex = "-1" >
2022-04-02 13:30:16 +00:00
< div class = "flex-block-wrapper" >
< div id = "head-tags" >
< / div >
2022-11-07 19:58:08 +00:00
< article class = "default" >
2022-11-13 21:34:47 +00:00
< h1 id = "attachments" > Attachments< / h1 >
2022-07-05 22:16:52 +00:00
2022-05-25 21:31:08 +00:00
< p > The < code > attachments< / code > shortcode displays a list of files attached to a page with adjustable color, title and icon.< / p >
2022-04-02 13:30:16 +00:00
2022-05-29 21:00:53 +00:00
< div class = "box attachments cstyle transparent" >
< div class = "box-label" > < i class = "fa-fw fas fa-paperclip" > < / i > Attachments< / div >
2022-04-02 13:30:16 +00:00
< ul class = "box-content attachments-files" >
2022-11-05 23:35:48 +00:00
< li > < a href = "../../shortcodes/attachments.en.files/adivorciarsetoca00cape.pdf" > adivorciarsetoca00cape.pdf< / a > (361 KB)< / li >
< li > < a href = "../../shortcodes/attachments.en.files/BachGavotteShort.mp3" > BachGavotteShort.mp3< / a > (357 KB)< / li >
< li > < a href = "../../shortcodes/attachments.en.files/Carroll_AliceAuPaysDesMerveilles.pdf" > Carroll_AliceAuPaysDesMerveilles.pdf< / a > (175 KB)< / li >
< li > < a href = "../../shortcodes/attachments.en.files/hugo.png" > hugo.png< / a > (17 KB)< / li >
< li > < a href = "../../shortcodes/attachments.en.files/hugo.txt" > hugo.txt< / a > (20 B)< / li >
< li > < a href = "../../shortcodes/attachments.en.files/movieselectricsheep-flock-244-32500-2.mp4" > movieselectricsheep-flock-244-32500-2.mp4< / a > (340 KB)< / li >
2022-04-02 13:30:16 +00:00
< / ul >
< / div >
< h2 id = "usage" > Usage< / h2 >
2022-06-22 22:08:50 +00:00
< p > While the examples are using shortcodes with named parameter you are free to also call this shortcode from your own partials.< / p >
< div class = "tab-panel" >
< div class = "tab-nav" >
< button
data-tab-item="shortcode"
data-tab-group="shortcode-parameter"
2022-11-01 01:10:49 +00:00
class="tab-nav-button direction-ltr active"
2022-06-22 22:08:50 +00:00
onclick="switchTab('shortcode-parameter','shortcode')"
>< span > shortcode< / span > < / button >
< button
data-tab-item="partial"
data-tab-group="shortcode-parameter"
2022-11-01 01:10:49 +00:00
class="tab-nav-button direction-ltr "
2022-06-22 22:08:50 +00:00
onclick="switchTab('shortcode-parameter','partial')"
>< span > partial< / span > < / button >
< / div >
< div class = "tab-content" >
< div data-tab-item = "shortcode" data-tab-group = "shortcode-parameter" class = "tab-item active" >
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-go" data-lang = "go" > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "nx" > attachments< / span > < span class = "nx" > sort< / span > < span class = "p" > =< / span > < span class = "s" > " asc" < / span > < span class = "o" > /%< / span > < span class = "p" > }}< / span >
< / span > < / span > < / code > < / pre > < / div >
< / div >
< div data-tab-item = "partial" data-tab-group = "shortcode-parameter" class = "tab-item " >
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-go" data-lang = "go" > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "nx" > partial< / span > < span class = "s" > " shortcodes/attachments.html" < / span > < span class = "p" > (< / span > < span class = "nx" > dict< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > " context" < / span > < span class = "p" > .< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > " sort" < / span > < span class = "s" > " asc" < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > )}}< / span >
< / span > < / span > < / code > < / pre > < / div >
< / div >
< / div >
< / div >
2022-12-23 02:25:15 +00:00
< p > The shortcode lists files found in a specific folder. The name of the folder depends on your page type (either branch bundle, leaf bundle or page).< / p >
2022-04-02 13:30:16 +00:00
< ol >
< li >
2022-12-23 02:25:15 +00:00
< p > For simple pages, attachments must be placed in a folder named like your page and ending with < code > .files< / code > .< / p >
2022-04-02 13:30:16 +00:00
< blockquote >
< ul >
< li > content
< ul >
< li > _index.md< / li >
2022-06-05 17:32:37 +00:00
< li > < strong > page.files< / strong >
2022-04-02 13:30:16 +00:00
< ul >
< li > attachment.pdf< / li >
< / ul >
< / li >
< li > page.md< / li >
< / ul >
< / li >
< / ul >
< / blockquote >
< / li >
< li >
2023-01-14 00:40:32 +00:00
< p > If your page is a branch or leaf bundle, attachments must be placed in a nested < code > _index.files< / code > or < code > index.files< / code > folder, accordingly.< / p >
2022-12-23 02:25:15 +00:00
< p > For branch bundles:< / p >
2022-04-02 13:30:16 +00:00
< blockquote >
< ul >
< li > content
< ul >
< li > _index.md< / li >
< li > page
< ul >
< li > index.md< / li >
2022-12-23 02:25:15 +00:00
< li > < strong > index.files< / strong >
< ul >
< li > attachment.pdf< / li >
< / ul >
< / li >
< / ul >
< / li >
< / ul >
< / li >
< / ul >
< / blockquote >
< p > For leaf bundles:< / p >
< blockquote >
< ul >
< li > content
< ul >
< li > _index.md< / li >
< li > page
< ul >
< li > _index.md< / li >
< li > < strong > _index.files< / strong >
2022-04-02 13:30:16 +00:00
< ul >
< li > attachment.pdf< / li >
< / ul >
< / li >
< / ul >
< / li >
< / ul >
< / li >
< / ul >
< / blockquote >
< / li >
< / ol >
2022-12-23 02:25:15 +00:00
< p > Be aware that if you use a multilingual website, you will need to have as many folders as languages and the language code must be part of the folder name.< / p >
< p > Eg. for a site in English and Piratish:< / p >
< blockquote >
< ul >
< li > content
< ul >
< li > _index.en.md< / li >
< li > _index.pir.md< / li >
< li > < strong > page.en.files< / strong >
< ul >
< li > attachment.pdf< / li >
< / ul >
< / li >
< li > < strong > page.pir.files< / strong >
< ul >
< li > attachment.pdf< / li >
< / ul >
< / li >
< li > page.en.md< / li >
< li > page.pir.md< / li >
< / ul >
< / li >
< / ul >
< / blockquote >
2022-05-25 21:31:08 +00:00
< h3 id = "parameter" > Parameter< / h3 >
2022-04-02 13:30:16 +00:00
< table >
< thead >
< tr >
2022-05-25 21:31:08 +00:00
< th style = "text-align:left" > Name< / th >
2022-04-02 13:30:16 +00:00
< th style = "text-align:left" > Default< / th >
2022-05-25 21:31:08 +00:00
< th style = "text-align:left" > Notes< / th >
2022-04-02 13:30:16 +00:00
< / tr >
< / thead >
< tbody >
< tr >
2022-05-25 21:31:08 +00:00
< td style = "text-align:left" > < strong > style< / strong > < / td >
< td style = "text-align:left" > < code > transparent< / code > < / td >
2023-01-14 00:40:32 +00:00
< td style = "text-align:left" > The color scheme used to highlight the box content.< br > < br > - by severity: < code > info< / code > , < code > note< / code > , < code > tip< / code > , < code > warning< / code > < br > - by brand color: < code > primary< / code > , < code > secondary< / code > < br > - by color: < code > blue< / code > , < code > green< / code > , < code > grey< / code > , < code > orange< / code > , < code > red< / code > < br > - by special color: < code > default< / code > , < code > transparent< / code > < / td >
2022-04-02 13:30:16 +00:00
< / tr >
< tr >
2022-05-25 21:31:08 +00:00
< td style = "text-align:left" > < strong > title< / strong > < / td >
< td style = "text-align:left" > see notes< / td >
2023-01-14 00:40:32 +00:00
< td style = "text-align:left" > Arbitrary text for the box title. Depending on the < strong > style< / strong > there may be a default title. Any given value will overwrite the default.< br > < br > - for severity styles: the matching title for the severity< br > - for all other colors: < code > Attachments< / code > < br > < br > If you want no title for a severity style, you have to set this parameter to < code > " " < / code > (a non empty string filled with spaces)< / td >
2022-04-02 13:30:16 +00:00
< / tr >
< tr >
2022-05-25 21:31:08 +00:00
< td style = "text-align:left" > < strong > icon< / strong > < / td >
< td style = "text-align:left" > see notes< / td >
2023-01-14 00:40:32 +00:00
< td style = "text-align:left" > < a href = "../../shortcodes/icon/#finding-an-icon" > Font Awesome icon name< / a > set to the left of the title. Depending on the < strong > style< / strong > there may be a default icon. Any given value will overwrite the default.< br > < br > - for severity styles: a nice matching icon for the severity< br > - for all other colors: < code > paperclip< / code > < br > < br > If you want no icon, you have to set this parameter to < code > " " < / code > (a non empty d with spaces)< / td >
2022-04-02 13:30:16 +00:00
< / tr >
< tr >
2022-05-25 21:31:08 +00:00
< td style = "text-align:left" > < strong > sort< / strong > < / td >
< td style = "text-align:left" > < code > asc< / code > < / td >
< td style = "text-align:left" > Sorting the output in < code > asc< / code > ending or < code > desc< / code > ending order.< / td >
2022-04-02 13:30:16 +00:00
< / tr >
< tr >
2022-05-25 21:31:08 +00:00
< td style = "text-align:left" > < strong > pattern< / strong > < / td >
< td style = "text-align:left" > < code > .*< / code > < / td >
2023-01-14 00:40:32 +00:00
< td style = "text-align:left" > A < a href = "https://en.wikipedia.org/wiki/Regular_expression" target = "_blank" > regular expressions< / a > , used to filter the attachments by file name. For example:< br > < br > - to match a file suffix of ‘ jpg’ , use < code > .*\.jpg< / code > (not < code > *.\.jpg< / code > )< br > - to match file names ending in < code > jpg< / code > or < code > png< / code > , use < code > .*\.(jpg|png)< / code > < / td >
2022-04-02 13:30:16 +00:00
< / tr >
< / tbody >
< / table >
2022-05-25 21:31:08 +00:00
< h2 id = "examples" > Examples< / h2 >
2022-06-05 17:32:37 +00:00
< h3 id = "custom-title-list-of-attachments-ending-in-pdf-or-mp4" > Custom Title, List of Attachments Ending in pdf or mp4< / h3 >
2023-01-14 00:40:32 +00:00
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-go" data-lang = "go" > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "nx" > attachments< / span > < span class = "nx" > title< / span > < span class = "p" > =< / span > < span class = "s" > " Related files" < / span > < span class = "nx" > pattern< / span > < span class = "p" > =< / span > < span class = "s" > " .*\.(pdf|mp4)" < / span > < span class = "o" > /%< / span > < span class = "p" > }}< / span >
2022-06-05 17:32:37 +00:00
< / span > < / span > < / code > < / pre > < / div >
2022-05-29 21:00:53 +00:00
< div class = "box attachments cstyle transparent" >
< div class = "box-label" > < i class = "fa-fw fas fa-paperclip" > < / i > Related files< / div >
2022-04-02 13:30:16 +00:00
< ul class = "box-content attachments-files" >
2022-11-05 23:35:48 +00:00
< li > < a href = "../../shortcodes/attachments.en.files/adivorciarsetoca00cape.pdf" > adivorciarsetoca00cape.pdf< / a > (361 KB)< / li >
< li > < a href = "../../shortcodes/attachments.en.files/Carroll_AliceAuPaysDesMerveilles.pdf" > Carroll_AliceAuPaysDesMerveilles.pdf< / a > (175 KB)< / li >
< li > < a href = "../../shortcodes/attachments.en.files/movieselectricsheep-flock-244-32500-2.mp4" > movieselectricsheep-flock-244-32500-2.mp4< / a > (340 KB)< / li >
2022-04-02 13:30:16 +00:00
< / ul >
< / div >
2022-06-05 17:32:37 +00:00
< h3 id = "info-styled-box-descending-sort-order" > Info Styled Box, Descending Sort Order< / h3 >
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-go" data-lang = "go" > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "nx" > attachments< / span > < span class = "nx" > style< / span > < span class = "p" > =< / span > < span class = "s" > " info" < / span > < span class = "nx" > sort< / span > < span class = "p" > =< / span > < span class = "s" > " desc" < / span > < span class = "o" > /%< / span > < span class = "p" > }}< / span >
2022-05-25 21:31:08 +00:00
< / span > < / span > < / code > < / pre > < / div >
2022-05-29 21:00:53 +00:00
< div class = "box attachments cstyle info" >
< div class = "box-label" > < i class = "fa-fw fas fa-info-circle" > < / i > Info< / div >
2022-04-02 13:30:16 +00:00
< ul class = "box-content attachments-files" >
2022-11-05 23:35:48 +00:00
< li > < a href = "../../shortcodes/attachments.en.files/movieselectricsheep-flock-244-32500-2.mp4" > movieselectricsheep-flock-244-32500-2.mp4< / a > (340 KB)< / li >
< li > < a href = "../../shortcodes/attachments.en.files/hugo.txt" > hugo.txt< / a > (20 B)< / li >
< li > < a href = "../../shortcodes/attachments.en.files/hugo.png" > hugo.png< / a > (17 KB)< / li >
< li > < a href = "../../shortcodes/attachments.en.files/Carroll_AliceAuPaysDesMerveilles.pdf" > Carroll_AliceAuPaysDesMerveilles.pdf< / a > (175 KB)< / li >
< li > < a href = "../../shortcodes/attachments.en.files/BachGavotteShort.mp3" > BachGavotteShort.mp3< / a > (357 KB)< / li >
< li > < a href = "../../shortcodes/attachments.en.files/adivorciarsetoca00cape.pdf" > adivorciarsetoca00cape.pdf< / a > (361 KB)< / li >
2022-04-02 13:30:16 +00:00
< / ul >
< / div >
2022-06-05 17:32:37 +00:00
< h3 id = "style-and-icons" > Style and Icons< / h3 >
2022-12-16 17:42:17 +00:00
< p > For further examples for < strong > style< / strong > , < strong > title< / strong > and < strong > icon< / strong > , see the < a href = "../../shortcodes/notice/" > < code > notice< / code > shortcode< / a > documentation. The parameter are working the same way for both shortcodes, besides having different defaults.< / p >
2022-04-02 13:30:16 +00:00
< footer class = "footline" >
< / footer >
< / article >
< / div >
< / main >
< / div >
2023-01-23 12:49:43 +00:00
< script src = "../../js/clipboard.min.js?1674478178" defer > < / script >
< script src = "../../js/perfect-scrollbar.min.js?1674478178" defer > < / script >
< script src = "../../js/featherlight.min.js?1674478178" defer > < / script >
< script src = "../../js/theme.js?1674478178" defer > < / script >
2022-04-02 13:30:16 +00:00
< / body >
< / html >
