mirror of
https://github.com/McShelby/hugo-theme-relearn.git
synced 2024-11-24 00:03:10 +00:00
316 lines
18 KiB
HTML
316 lines
18 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en" dir="ltr">
|
|
<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.111.3">
|
|
<meta name="generator" content="Relearn 5.13.1+tip">
|
|
<meta name="description" content="List of files attached to a page">
|
|
<meta name="author" content="Sören Weber">
|
|
<title>Attachments :: Hugo Relearn 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/shortcodes/attachments/index.html" rel="canonical" type="text/html" title="Attachments :: Hugo Relearn Theme">
|
|
<link href="../../shortcodes/attachments/index.xml" rel="alternate" type="application/rss+xml" title="Attachments :: Hugo Relearn Theme">
|
|
<link href="../../images/logo.svg?1684202764" 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?1684202766" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="../../css/fontawesome-all.min.css?1684202766" rel="stylesheet"></noscript>
|
|
<link href="../../css/nucleus.css?1684202766" rel="stylesheet">
|
|
<link href="../../css/auto-complete.css?1684202766" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="../../css/auto-complete.css?1684202766" rel="stylesheet"></noscript>
|
|
<link href="../../css/perfect-scrollbar.min.css?1684202766" rel="stylesheet">
|
|
<link href="../../css/fonts.css?1684202766" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="../../css/fonts.css?1684202766" rel="stylesheet"></noscript>
|
|
<link href="../../css/theme.css?1684202766" rel="stylesheet">
|
|
<link href="../../css/theme-auto.css?1684202766" rel="stylesheet" id="variant-style">
|
|
<link href="../../css/variant.css?1684202766" rel="stylesheet">
|
|
<link href="../../css/print.css?1684202766" rel="stylesheet" media="print">
|
|
<link href="../../css/format-print.css?1684202766" rel="stylesheet">
|
|
<link href="../../css/ie.css?1684202766" rel="stylesheet">
|
|
<script src="../../js/url.js?1684202766"></script>
|
|
<script src="../../js/variant.js?1684202766"></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="../../index.search.js";
|
|
var root_url="../../";
|
|
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!';
|
|
window.T_No_results_found = 'No results found for \u0022{0}\u0022';
|
|
window.T_N_results_found = '{1} results found for \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', 'learn', 'neon', 'blue', 'green', 'red' ] );
|
|
</script>
|
|
<style>
|
|
#body img.bg-white {
|
|
background-color: white;
|
|
}
|
|
</style>
|
|
</head>
|
|
<body class="mobile-support print disableInlineCopyToClipboard" data-url="../../shortcodes/attachments/index.html">
|
|
<div id="body" class="default-animation">
|
|
<div id="sidebar-overlay"></div>
|
|
<div id="toc-overlay"></div>
|
|
<nav id="topbar" class="highlightable">
|
|
<div>
|
|
<div id="breadcrumbs">
|
|
<span id="sidebar-toggle-span">
|
|
<a href="#" id="sidebar-toggle" class="topbar-link" title='Menu (CTRL+ALT+n)'><i class="fas fa-bars fa-fw"></i></a>
|
|
</span>
|
|
<ol class="links" itemscope itemtype="http://schema.org/BreadcrumbList">
|
|
<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>
|
|
<li itemscope itemtype="https://schema.org/ListItem" itemprop="itemListElement"><span itemprop="name">Attachments</span><meta itemprop="position" content="3"></li>
|
|
</ol>
|
|
</div>
|
|
</div>
|
|
</nav>
|
|
<main id="body-inner" class="highlightable default" tabindex="-1">
|
|
<div class="flex-block-wrapper">
|
|
<div id="head-tags">
|
|
</div>
|
|
<article class="default">
|
|
<h1 id="attachments">Attachments</h1>
|
|
|
|
<p>The <code>attachments</code> shortcode displays a list of files attached to a page with adjustable color, title and icon.</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.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>
|
|
</ul>
|
|
</div>
|
|
<h2 id="usage">Usage</h2>
|
|
<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" data-tab-group="shortcode-parameter">
|
|
<div class="tab-nav">
|
|
<button
|
|
data-tab-item="shortcode"
|
|
class="tab-nav-button active"
|
|
onclick="switchTab('shortcode-parameter','shortcode')"
|
|
>
|
|
<span>shortcode</span></button>
|
|
<button
|
|
data-tab-item="partial"
|
|
class="tab-nav-button"
|
|
onclick="switchTab('shortcode-parameter','partial')"
|
|
>
|
|
<span>partial</span></button>
|
|
</div>
|
|
<div class="tab-content">
|
|
<div
|
|
data-tab-item="shortcode"
|
|
class="tab-content-text 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"
|
|
class="tab-content-text"
|
|
>
|
|
<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>
|
|
<h3 id="parameter">Parameter</h3>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th style="text-align:left">Name</th>
|
|
<th style="text-align:left">Default</th>
|
|
<th style="text-align:left">Notes</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td style="text-align:left"><strong>style</strong></td>
|
|
<td style="text-align:left"><code>transparent</code></td>
|
|
<td style="text-align:left">The style scheme used for the 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></td>
|
|
</tr>
|
|
<tr>
|
|
<td style="text-align:left"><strong>color</strong></td>
|
|
<td style="text-align:left">see notes</td>
|
|
<td style="text-align:left">The <a href="https://developer.mozilla.org/en-US/docs/Web/CSS/color_value" target="_blank">CSS color value</a> to be used. If not set, the chosen color depends on the <strong>style</strong>. Any given value will overwrite the default.<br><br>- for severity styles: a nice matching color for the severity<br>- for all other styles: the corresponding color</td>
|
|
</tr>
|
|
<tr>
|
|
<td style="text-align:left"><strong>title</strong></td>
|
|
<td style="text-align:left">see notes</td>
|
|
<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 styles: <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>
|
|
</tr>
|
|
<tr>
|
|
<td style="text-align:left"><strong>icon</strong></td>
|
|
<td style="text-align:left">see notes</td>
|
|
<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 styles: <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>
|
|
</tr>
|
|
<tr>
|
|
<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>
|
|
</tr>
|
|
<tr>
|
|
<td style="text-align:left"><strong>pattern</strong></td>
|
|
<td style="text-align:left"><code>.*</code></td>
|
|
<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>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h2 id="setup">Setup</h2>
|
|
<h3 id="single-language">Single language</h3>
|
|
<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>
|
|
<ol>
|
|
<li>
|
|
<p>For simple pages, attachments must be placed in a folder named like your page and ending with <code>.files</code>.</p>
|
|
<blockquote>
|
|
<ul>
|
|
<li>content
|
|
<ul>
|
|
<li>_index.md</li>
|
|
<li><strong>page.files</strong>
|
|
<ul>
|
|
<li>attachment.pdf</li>
|
|
</ul>
|
|
</li>
|
|
<li>page.md</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</blockquote>
|
|
</li>
|
|
<li>
|
|
<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>
|
|
<p>For branch bundles:</p>
|
|
<blockquote>
|
|
<ul>
|
|
<li>content
|
|
<ul>
|
|
<li>_index.md</li>
|
|
<li>page
|
|
<ul>
|
|
<li>index.md</li>
|
|
<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>
|
|
<ul>
|
|
<li>attachment.pdf</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</blockquote>
|
|
</li>
|
|
</ol>
|
|
<h3 id="multilingual">Multilingual</h3>
|
|
<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>
|
|
<h2 id="examples">Examples</h2>
|
|
<h3 id="custom-title-list-of-attachments-ending-in-pdf-or-mp4">Custom Title, List of Attachments Ending in pdf or mp4</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">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>
|
|
</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.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>
|
|
</ul>
|
|
</div>
|
|
<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>
|
|
</span></span></code></pre></div>
|
|
<div class="box attachments cstyle info">
|
|
<div class="box-label"><i class="fa-fw fas fa-info-circle"></i> Info</div>
|
|
<ul class="box-content attachments-files">
|
|
<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>
|
|
</ul>
|
|
</div>
|
|
<h3 id="with-user-defined-color-and-font-awesome-brand-icon">With User-Defined Color and Font Awesome Brand Icon</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">color</span><span class="p">=</span><span class="s">"fuchsia"</span> <span class="nx">icon</span><span class="p">=</span><span class="s">"fab fa-hackerrank"</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.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>
|
|
</ul>
|
|
</div>
|
|
<h3 id="style-color-title-and-icons">Style, Color, Title and Icons</h3>
|
|
<p>For further examples for <strong>style</strong>, <strong>color</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>
|
|
|
|
<footer class="footline">
|
|
</footer>
|
|
</article>
|
|
</div>
|
|
</main>
|
|
</div>
|
|
<script src="../../js/clipboard.min.js?1684202766" defer></script>
|
|
<script src="../../js/perfect-scrollbar.min.js?1684202766" defer></script>
|
|
<script src="../../js/theme.js?1684202766" defer></script>
|
|
</body>
|
|
</html>
|