hugo-theme-relearn/pir/shortcodes/attachments/index.print.html

355 lines
20 KiB
HTML
Raw Normal View History

<!DOCTYPE html>
<html lang="pir" dir="rtl">
<head>
<meta charset="utf-8">
<meta name="viewport" content="height=device-height, width=device-width, initial-scale=1.0, minimum-scale=1.0">
<meta name="generator" content="Hugo 0.119.0">
<meta name="generator" content="Relearn 5.22.0+tip">
<meta name="description" content="Documentation for Hugo Relearn Theme">
<meta name="author" content="Sören Weber">
<title>Attachments :: Cap&#39;n Hugo Relearrrn Theme</title>
<link href="https://McShelby.github.io/hugo-theme-relearn/shortcodes/attachments/index.html" rel="alternate" hreflang="x-default">
<link href="https://McShelby.github.io/hugo-theme-relearn/shortcodes/attachments/index.html" rel="alternate" hreflang="en">
<link href="https://McShelby.github.io/hugo-theme-relearn/pir/shortcodes/attachments/index.html" rel="alternate" hreflang="pir">
<link href="https://McShelby.github.io/hugo-theme-relearn/pir/shortcodes/attachments/index.html" rel="canonical" type="text/html" title="Attachments :: Cap&#39;n Hugo Relearrrn Theme">
<link href="../../../pir/shortcodes/attachments/index.xml" rel="alternate" type="application/rss+xml" title="Attachments :: Cap&#39;n Hugo Relearrrn Theme">
<link href="../../../images/logo.svg?1696161528" rel="icon" type="image/svg+xml">
<!-- https://github.com/filamentgroup/loadCSS/blob/master/README.md#how-to-use -->
<link href="../../../css/fontawesome-all.min.css?1696161530" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="../../../css/fontawesome-all.min.css?1696161530" rel="stylesheet"></noscript>
<link href="../../../css/nucleus.css?1696161530" rel="stylesheet">
<link href="../../../css/auto-complete.css?1696161530" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="../../../css/auto-complete.css?1696161530" rel="stylesheet"></noscript>
<link href="../../../css/perfect-scrollbar.min.css?1696161530" rel="stylesheet">
<link href="../../../css/fonts.css?1696161530" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="../../../css/fonts.css?1696161530" rel="stylesheet"></noscript>
<link href="../../../css/theme.css?1696161530" rel="stylesheet">
<link href="../../../css/theme-auto.css?1696161530" rel="stylesheet" id="R-variant-style">
<link href="../../../css/variant.css?1696161530" rel="stylesheet">
<link href="../../../css/print.css?1696161530" rel="stylesheet" media="print">
<link href="../../../css/format-print.css?1696161530" rel="stylesheet">
<link href="../../../css/ie.css?1696161530" rel="stylesheet">
<script src="../../../js/url.js?1696161530"></script>
<script src="../../../js/variant.js?1696161530"></script>
<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
window.index_js_url="../../../pir/index.search.js";
var root_url="../../../";
var baseUri=root_url.replace(/\/$/, '');
// translations
window.T_Copy_to_clipboard = 'Copy t\u0027 clipboard';
window.T_Copied_to_clipboard = 'Copied t\u0027 clipboard!';
window.T_Copy_link_to_clipboard = 'Copy link t\u0027 clipboard';
window.T_Link_copied_to_clipboard = 'Copied link t\u0027 clipboard!';
window.T_Reset_view = 'Rrreset view';
window.T_View_reset = 'View rrreset!';
window.T_No_results_found = 'No rrresults found fer \u0022{0}\u0022';
window.T_N_results_found = '{1} rrresults found fer \u0022{0}\u0022';
// some further base stuff
var baseUriFull='https:\/\/McShelby.github.io\/hugo-theme-relearn/';
window.variants && variants.init( [ 'auto', 'relearn-bright', 'relearn-light', 'relearn-dark', 'zen-light', 'zen-dark', 'neon', 'learn', 'blue', 'green', 'red' ] );
</script>
<style>
#R-body img.bg-white {
background-color: white;
}
</style>
</head>
<body class="mobile-support print disableInlineCopyToClipboard" data-url="../../../pir/shortcodes/attachments/index.html">
<div id="R-body" class="default-animation">
<div id="R-body-overlay"></div>
<nav id="R-topbar">
<div class="topbar-wrapper">
<div class="topbar-sidebar-divider"></div>
<div class="topbar-area topbar-area-start" data-area="start">
<div class="topbar-button topbar-button-sidebar" data-content-empty="disable" data-width-s="show" data-width-m="hide" data-width-l="hide">
<button class="topbar-control" onclick="toggleNav()" type="button" title="Menu (CTRL&#43;ALT&#43;n)">
<i class="fa-fw fas fa-bars"></i>
</button>
</div>
</div>
<ol class="topbar-breadcrumbs breadcrumbs highlightable" itemscope itemtype="http://schema.org/BreadcrumbList"><li
itemscope itemtype="https://schema.org/ListItem" itemprop="itemListElement"><a itemprop="item" href="../../../pir/shortcodes/index.html"><span itemprop="name">Shorrrtcodes</span></a><meta itemprop="position" content="1">&nbsp;>&nbsp;</li><li
itemscope itemtype="https://schema.org/ListItem" itemprop="itemListElement"><span itemprop="name">Attachments</span><meta itemprop="position" content="2"></li>
</ol>
<div class="topbar-area topbar-area-end" data-area="end">
</div>
</div>
</nav>
<div id="R-main-overlay"></div>
<main id="R-body-inner" class="highlightable default" tabindex="-1">
<div class="flex-block-wrapper">
<article class="default">
<header class="headline">
</header>
<h1 id="attachments">Attachments</h1>
<div class="box attachments cstyle transparent">
<div class="box-label"><i class="fa-fw fas fa-paperclip"></i> Attachments</div>
<ul class="box-content attachments-files">
<li><a href="../../../pir/shortcodes/attachments/index.pir.files/NoTreasure.txt">NoTreasure.txt</a> (26 B)</li>
</ul>
</div>
<p>Th' <code>attachments</code> shortcode displays a list o' files attached t' a plank wit' adjust'ble color, title an' ay'con.</p>
<div class="box attachments cstyle transparent">
<div class="box-label"><i class="fa-fw fas fa-paperclip"></i> Attachments</div>
<ul class="box-content attachments-files">
<li><a href="../../../shortcodes/attachments/index.en.files/adivorciarsetoca00cape.pdf">adivorciarsetoca00cape.pdf</a> (361 KB)</li>
<li><a href="../../../shortcodes/attachments/index.en.files/BachGavotteShort.mp3">BachGavotteShort.mp3</a> (357 KB)</li>
<li><a href="../../../shortcodes/attachments/index.en.files/Carroll_AliceAuPaysDesMerveilles.pdf">Carroll_AliceAuPaysDesMerveilles.pdf</a> (175 KB)</li>
<li><a href="../../../shortcodes/attachments/index.en.files/hugo.png">hugo.png</a> (17 KB)</li>
<li><a href="../../../shortcodes/attachments/index.en.files/hugo.txt">hugo.txt</a> (20 B)</li>
<li><a href="../../../shortcodes/attachments/index.en.files/movieselectricsheep-flock-244-32500-2.mp4">movieselectricsheep-flock-244-32500-2.mp4</a> (340 KB)</li>
</ul>
</div>
<div class="box notices cstyle warning">
<div class="box-label"><i class="fa-fw fas fa-exclamation-triangle"></i> Arrr</div>
<div class="box-content">
<p>Since Cap'n Hugo <span class="badge cstyle default badge-with-title"><span class="badge-title"><i class="fab fa-hackerrank"></i></span><span class="badge-content" style="background-color: fuchsia;">0.112.0</span></span> this only works fer leaf bundles. Branch bundles an' simple planks must be switched t' leaf bundles or ye be currently locked t' a Cap'n Hugo version &lt; <code>0.112.0</code>.</p>
</div>
</div>
<h2 id="usage">Usage</h2>
<p>While th' examples be us'n shorrrtcodes wit' named parameter ye be free t' also call this shortcode from yer own partials.</p>
<div class="tab-panel" data-tab-group="shortcode-parameter">
<div class="tab-nav">
<div class="tab-nav-title">&#8203;</div>
<button
data-tab-item="shortcode"
class="tab-nav-button tab-panel-style cstyle initial active"
onclick="switchTab('shortcode-parameter','shortcode')"
>
<span>
<span class="tab-nav-hidden">shortcode</span>
<span class="tab-nav-text">shortcode</span>
</span>
</button>
<button
data-tab-item="partial"
class="tab-nav-button tab-panel-style cstyle initial"
onclick="switchTab('shortcode-parameter','partial')"
>
<span>
<span class="tab-nav-hidden">partial</span>
<span class="tab-nav-text">partial</span>
</span>
</button>
</div>
<div class="tab-content-container">
<div
data-tab-item="shortcode"
class="tab-content tab-panel-style cstyle initial active">
<div class="tab-content-text">
<div class="wrap-code 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">&#34;asc&#34;</span> <span class="o">/%</span><span class="p">}}</span></span></span></code></pre></div></div>
</div>
<div
data-tab-item="partial"
class="tab-content tab-panel-style cstyle initial">
<div class="tab-content-text">
<div class="wrap-code 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">&#34;shortcodes/attachments.html&#34;</span> <span class="p">(</span><span class="nx">dict</span>
</span></span><span class="line"><span class="cl"> <span class="s">&#34;page&#34;</span> <span class="p">.</span>
</span></span><span class="line"><span class="cl"> <span class="s">&#34;sort&#34;</span> <span class="s">&#34;asc&#34;</span>
</span></span><span class="line"><span class="cl"><span class="p">)}}</span></span></span></code></pre></div></div>
</div>
</div>
</div>
<h3 id="parameter">Parameter</h3>
<table>
<thead>
<tr>
<th>Name</th>
<th>Default</th>
<th>Notes</th>
</tr>
</thead>
<tbody>
<tr>
<td><strong>style</strong></td>
<td><code>transparent</code></td>
<td>Th' style scheme used fer th' box.<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>, <code>accent</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>, <code>code</code></td>
</tr>
<tr>
<td><strong>color</strong></td>
<td>see notes</td>
<td>Th' <a href="https://developer.mozilla.org/en-US/docs/Web/CSS/color_value" target="_blank">CSS color value</a> t' be used. If not set, th' chosen color depends on th' <strong>style</strong>. Any given value will overwrite th' default.<br><br>- fer severity styles: a nice match'n color fer th' severity<br>- fer all other styles: th' correspond'n color</td>
</tr>
<tr>
<td><strong>title</strong></td>
<td>see notes</td>
<td>Arbitrary text fer th' box title. Depend'n on th' <strong>style</strong> there may be a default title. Any given value will overwrite th' default.<br><br>- fer severity styles: th' match'n title fer th' severity<br>- fer all other styles: <code>Attachments</code><br><br>If ye want no title fer a severity style, ye have t' set this parameter t' <code>&quot; &quot;</code> (a non empty str'n filled wit' spaces)</td>
</tr>
<tr>
<td><strong>ay'con</strong></td>
<td>see notes</td>
<td><a href="../../../shortcodes/icon/#finding-an-icon">Font Awesome ay'con name</a> set t' th' left o' th' title. Depend'n on th' <strong>style</strong> there may be a default ay'con. Any given value will overwrite th' default.<br><br>- fer severity styles: a nice match'n ay'con fer th' severity<br>- fer all other styles: <code>paperclip</code><br><br>If ye want no ay'con, ye have t' set this parameter t' <code>&quot; &quot;</code> (a non empty d wit' spaces)</td>
</tr>
<tr>
<td><strong>sort</strong></td>
<td><code>asc</code></td>
<td>Sort'n th' output 'n <code>asc</code>end'n or <code>desc</code>end'n order.</td>
</tr>
<tr>
<td><strong>pattern</strong></td>
<td><code>.*</code></td>
<td>A <a href="https://en.wikipedia.org/wiki/Regular_expression" target="_blank">regular expressions</a>, used t' filter th' attachments by file name. For example:<br><br>- t' match a file suffix o' &lsquo;jpg&rsquo;, use <code>.*\.jpg</code> (not <code>*.\.jpg</code>)<br>- t' match file names end'n 'n <code>jpg</code> or <code>png</code>, use <code>.*\.(jpg|png)</code></td>
</tr>
</tbody>
</table>
<h2 id="setup">Setup</h2>
<h3 id="single-language">Single language</h3>
<p>Th' shortcode lists files found 'n a specific folder. Th' name o' th' folder depends on yer plank type (either branch bundle, leaf bundle or page).</p>
<ol>
<li>
<p>If yer plank be a leaf bundle, attachments must be placed 'n a nested <code>index.files</code> folder, accordingly.</p>
<blockquote>
<ul>
<li>rrrambl'n
<ul>
<li>_index.md</li>
<li>plank
<ul>
<li>_index.md</li>
<li><strong>_index.files</strong>
<ul>
<li>attachment.pdf</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</blockquote>
</li>
<li>
<p>If yer plank be a branch bundle, attachments must be placed 'n a nested <code>_index.files</code> folder, accordingly.</p>
<p><span class="badge cstyle warning badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-exclamation-triangle"></i></span><span class="badge-content">Arrr</span></span> This be only avail'ble fer Cap'n Hugo &lt; <code>0.112.0</code></p>
<blockquote>
<ul>
<li>rrrambl'n
<ul>
<li>_index.md</li>
<li>plank
<ul>
<li>index.md</li>
<li><strong>index.files</strong>
<ul>
<li>attachment.pdf</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</blockquote>
</li>
<li>
<p>For simple planks, attachments must be placed 'n a folder named like yer plank an' end'n wit' <code>.files</code>.</p>
<p><span class="badge cstyle warning badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-exclamation-triangle"></i></span><span class="badge-content">Arrr</span></span> This be only avail'ble fer Cap'n Hugo &lt; <code>0.112.0</code></p>
<blockquote>
<ul>
<li>rrrambl'n
<ul>
<li>_index.md</li>
<li><strong>plank.files</strong>
<ul>
<li>attachment.pdf</li>
</ul>
</li>
<li>plank.md</li>
</ul>
</li>
</ul>
</blockquote>
</li>
</ol>
<h3 id="multilingual">Multilingual</h3>
<p>Be aware that if ye use a multilingual website, ye will need t' have as many folders as languages an' th' language code must be part o' th' folder name.</p>
<p>Eg. fer a ship 'n English an' Piratish:</p>
<blockquote>
<ul>
<li>rrrambl'n
<ul>
<li>index.en.md</li>
<li>index.pir.md</li>
<li>plank
<ul>
<li>index.en.md</li>
<li>index.pir.md</li>
<li><strong>index.en.files</strong>
<ul>
<li>attachment.pdf</li>
</ul>
</li>
<li><strong>index.pir.files</strong>
<ul>
<li>attachment.pdf</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</blockquote>
<h2 id="examples">Examples</h2>
<h3 id="custom-title-list-of-attachments-ending-in-pdf-or-mp4">Custom Title, List o' Attachments End'n 'n pdf or mp4</h3>
<div class="wrap-code 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">&#34;Related **files**&#34;</span> <span class="nx">pattern</span><span class="p">=</span><span class="s">&#34;.*\.(pdf|mp4)&#34;</span> <span class="o">/%</span><span class="p">}}</span></span></span></code></pre></div>
<div class="box attachments cstyle transparent">
<div class="box-label"><i class="fa-fw fas fa-paperclip"></i> Related <strong>files</strong></div>
<ul class="box-content attachments-files">
<li><a href="../../../shortcodes/attachments/index.en.files/adivorciarsetoca00cape.pdf">adivorciarsetoca00cape.pdf</a> (361 KB)</li>
<li><a href="../../../shortcodes/attachments/index.en.files/Carroll_AliceAuPaysDesMerveilles.pdf">Carroll_AliceAuPaysDesMerveilles.pdf</a> (175 KB)</li>
<li><a href="../../../shortcodes/attachments/index.en.files/movieselectricsheep-flock-244-32500-2.mp4">movieselectricsheep-flock-244-32500-2.mp4</a> (340 KB)</li>
</ul>
</div>
<h3 id="info-styled-box-descending-sort-order">Ahoi Styled Box, Descend'n Sort Order</h3>
<div class="wrap-code 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">&#34;info&#34;</span> <span class="nx">sort</span><span class="p">=</span><span class="s">&#34;desc&#34;</span> <span class="o">/%</span><span class="p">}}</span></span></span></code></pre></div>
<div class="box attachments cstyle info">
<div class="box-label"><i class="fa-fw fas fa-info-circle"></i> Ahoi</div>
<ul class="box-content attachments-files">
<li><a href="../../../shortcodes/attachments/index.en.files/movieselectricsheep-flock-244-32500-2.mp4">movieselectricsheep-flock-244-32500-2.mp4</a> (340 KB)</li>
<li><a href="../../../shortcodes/attachments/index.en.files/hugo.txt">hugo.txt</a> (20 B)</li>
<li><a href="../../../shortcodes/attachments/index.en.files/hugo.png">hugo.png</a> (17 KB)</li>
<li><a href="../../../shortcodes/attachments/index.en.files/Carroll_AliceAuPaysDesMerveilles.pdf">Carroll_AliceAuPaysDesMerveilles.pdf</a> (175 KB)</li>
<li><a href="../../../shortcodes/attachments/index.en.files/BachGavotteShort.mp3">BachGavotteShort.mp3</a> (357 KB)</li>
<li><a href="../../../shortcodes/attachments/index.en.files/adivorciarsetoca00cape.pdf">adivorciarsetoca00cape.pdf</a> (361 KB)</li>
</ul>
</div>
<h3 id="with-user-defined-color-and-font-awesome-brand-icon">Wit' User-Defined Color an' Font Awesome Brand Ay'con</h3>
<div class="wrap-code 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">color</span><span class="p">=</span><span class="s">&#34;fuchsia&#34;</span> <span class="nx">ay'con</span><span class="p">=</span><span class="s">&#34;fab fa-hackerrank&#34;</span> <span class="o">/%</span><span class="p">}}</span></span></span></code></pre></div>
<div class="box attachments cstyle default" style="--VARIABLE-BOX-color: fuchsia;">
<div class="box-label"><i class="fab fa-hackerrank"></i> Attachments</div>
<ul class="box-content attachments-files">
<li><a href="../../../shortcodes/attachments/index.en.files/adivorciarsetoca00cape.pdf">adivorciarsetoca00cape.pdf</a> (361 KB)</li>
<li><a href="../../../shortcodes/attachments/index.en.files/BachGavotteShort.mp3">BachGavotteShort.mp3</a> (357 KB)</li>
<li><a href="../../../shortcodes/attachments/index.en.files/Carroll_AliceAuPaysDesMerveilles.pdf">Carroll_AliceAuPaysDesMerveilles.pdf</a> (175 KB)</li>
<li><a href="../../../shortcodes/attachments/index.en.files/hugo.png">hugo.png</a> (17 KB)</li>
<li><a href="../../../shortcodes/attachments/index.en.files/hugo.txt">hugo.txt</a> (20 B)</li>
<li><a href="../../../shortcodes/attachments/index.en.files/movieselectricsheep-flock-244-32500-2.mp4">movieselectricsheep-flock-244-32500-2.mp4</a> (340 KB)</li>
</ul>
</div>
<h3 id="style-color-title-and-icons">Style, Color, Title an' Ay'cons</h3>
<p>For further examples fer <strong>style</strong>, <strong>color</strong>, <strong>title</strong> an' <strong>ay'con</strong>, see th' <a href="../../../shortcodes/notice/"><code>notice</code> shortcode</a> documentat'n. Th' parameter be work'n th' same way fer both shorrrtcodes, besides hav'n different defaults.</p>
<footer class="footline">
</footer>
</article>
</div>
</main>
</div>
<script src="../../../js/clipboard.min.js?1696161530" defer></script>
<script src="../../../js/perfect-scrollbar.min.js?1696161530" defer></script>
<script src="../../../js/theme.js?1696161530" defer></script>
</body>
</html>