mirror of
https://github.com/McShelby/hugo-theme-relearn.git
synced 2024-11-23 15:57:57 +00:00
318 lines
18 KiB
HTML
318 lines
18 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="art-x-pir" dir="rtl" itemscope itemtype="http://schema.org/Article">
|
|
<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.133.1">
|
|
<meta name="generator" content="Relearn 6.2.0+tip">
|
|
<meta name="description" content="Th' Attachments shorrrtcode displays a list o' files attached t' a plank">
|
|
<meta name="author" content="Sören Weber">
|
|
<meta name="twitter:card" content="summary_large_image">
|
|
<meta name="twitter:image" content="https://mcshelby.github.io/hugo-theme-relearn/images/hero.png">
|
|
<meta name="twitter:title" content="Attachments :: Cap'n Hugo Relearrrn Theme">
|
|
<meta name="twitter:description" content="Th' Attachments shorrrtcode displays a list o' files attached t' a plank">
|
|
<meta property="og:url" content="https://mcshelby.github.io/hugo-theme-relearn/pir/shortcodes/attachments/index.html">
|
|
<meta property="og:site_name" content="Cap'n Hugo Relearrrn Theme">
|
|
<meta property="og:title" content="Attachments :: Cap'n Hugo Relearrrn Theme">
|
|
<meta property="og:description" content="Th' Attachments shorrrtcode displays a list o' files attached t' a plank">
|
|
<meta property="og:locale" content="art_x_pir">
|
|
<meta property="og:type" content="article">
|
|
<meta property="article:section" content="Shorrrtcodes">
|
|
<meta property="og:image" content="https://mcshelby.github.io/hugo-theme-relearn/images/hero.png">
|
|
<meta itemprop="name" content="Attachments :: Cap'n Hugo Relearrrn Theme">
|
|
<meta itemprop="description" content="Th' Attachments shorrrtcode displays a list o' files attached t' a plank">
|
|
<meta itemprop="wordCount" content="671">
|
|
<meta itemprop="image" content="https://mcshelby.github.io/hugo-theme-relearn/images/hero.png">
|
|
<title>Attachments :: Cap'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="art-x-pir">
|
|
<link href="https://mcshelby.github.io/hugo-theme-relearn/pir/shortcodes/attachments/index.html" rel="canonical" type="text/html" title="Attachments :: Cap'n Hugo Relearrrn Theme">
|
|
<link href="/hugo-theme-relearn/pir/shortcodes/attachments/index.xml" rel="alternate" type="application/rss+xml" title="Attachments :: Cap'n Hugo Relearrrn Theme">
|
|
<link href="/hugo-theme-relearn/images/logo.svg?1725191907" rel="icon" type="image/svg+xml">
|
|
<link href="/hugo-theme-relearn/css/fontawesome-all.min.css?1725191907" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="/hugo-theme-relearn/css/fontawesome-all.min.css?1725191907" rel="stylesheet"></noscript>
|
|
<link href="/hugo-theme-relearn/css/nucleus.css?1725191907" rel="stylesheet">
|
|
<link href="/hugo-theme-relearn/css/auto-complete.css?1725191907" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="/hugo-theme-relearn/css/auto-complete.css?1725191907" rel="stylesheet"></noscript>
|
|
<link href="/hugo-theme-relearn/css/perfect-scrollbar.min.css?1725191907" rel="stylesheet">
|
|
<link href="/hugo-theme-relearn/css/fonts.css?1725191907" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="/hugo-theme-relearn/css/fonts.css?1725191907" rel="stylesheet"></noscript>
|
|
<link href="/hugo-theme-relearn/css/theme.css?1725191907" rel="stylesheet">
|
|
<link href="/hugo-theme-relearn/css/theme-relearn-auto.css?1725191907" rel="stylesheet" id="R-variant-style">
|
|
<link href="/hugo-theme-relearn/css/chroma-relearn-auto.css?1725191907" rel="stylesheet" id="R-variant-chroma-style">
|
|
<link href="/hugo-theme-relearn/css/variant.css?1725191907" rel="stylesheet">
|
|
<link href="/hugo-theme-relearn/css/print.css?1725191907" rel="stylesheet" media="print">
|
|
<link href="/hugo-theme-relearn/css/format-print.css?1725191907" rel="stylesheet">
|
|
<script src="/hugo-theme-relearn/js/variant.js?1725191907"></script>
|
|
<script>
|
|
window.relearn = window.relearn || {};
|
|
window.relearn.relBasePath='..\/..\/..';
|
|
window.relearn.relBaseUri='..\/..\/..\/..';
|
|
window.relearn.absBaseUri='https:\/\/mcshelby.github.io\/hugo-theme-relearn';
|
|
window.relearn.disableAnchorCopy=false;
|
|
window.relearn.disableAnchorScrolling=false;
|
|
window.index_js_url="/hugo-theme-relearn/pir/index.search.js?1725191907";
|
|
// variant stuff
|
|
window.variants && variants.init( [ 'relearn-auto', 'relearn-light', 'relearn-dark', 'relearn-bright', 'zen-auto', 'zen-light', 'zen-dark', 'retro-auto', 'neon', 'learn', 'blue', 'green', 'red' ] );
|
|
// translations
|
|
window.T_Copy_to_clipboard = `Copy t' clipboard`;
|
|
window.T_Copied_to_clipboard = `Copied t' clipboard!`;
|
|
window.T_Copy_link_to_clipboard = `Copy link t' clipboard`;
|
|
window.T_Link_copied_to_clipboard = `Copied link t' clipboard!`;
|
|
window.T_Reset_view = `Rrreset view`;
|
|
window.T_View_reset = `View rrreset!`;
|
|
window.T_No_results_found = `No rrresults found fer "{0}"`;
|
|
window.T_N_results_found = `{1} rrresults found fer "{0}"`;
|
|
</script>
|
|
<style>
|
|
#R-body img.bg-white {
|
|
background-color: white;
|
|
}
|
|
</style>
|
|
</head>
|
|
<body class="mobile-support print disableInlineCopyToClipboard" data-url="/hugo-theme-relearn/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+ALT+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="/hugo-theme-relearn/pir/shortcodes/index.html"><span itemprop="name">Shorrrtcodes</span></a><meta itemprop="position" content="1"> > </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 class="topbar-button topbar-button-prev" data-content-empty="disable" data-width-s="show" data-width-m="show" data-width-l="show"><a class="topbar-control" href="/hugo-theme-relearn/pir/shortcodes/index.html" title="Shorrrtcodes (🡒)"><i class="fa-fw fas fa-chevron-left"></i></a>
|
|
</div>
|
|
<div class="topbar-button topbar-button-next" data-content-empty="disable" data-width-s="show" data-width-m="show" data-width-l="show"><a class="topbar-control" href="/hugo-theme-relearn/pir/shortcodes/badge/index.html" title="Badge (🡐)"><i class="fa-fw fas fa-chevron-right"></i></a>
|
|
</div>
|
|
</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 notices cstyle warning">
|
|
<div class="box-label">
|
|
<i class="fa-fw fas fa-exclamation-triangle"></i> Arrr
|
|
</div>
|
|
<div class="box-content">
|
|
|
|
<p>This shortcode be deprecated 'n favor o' th' new <a href="/hugo-theme-relearn/pir/shortcodes/resources/index.html"><code>resources</code> shortcode</a>. See <a href="/hugo-theme-relearn/pir/shortcodes/attachments/index.html#migration">migrat'n instruct'ns</a> below.</p>
|
|
<p>Th' examples on this plank were removed.</p>
|
|
</div>
|
|
</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>
|
|
<h2 id="migration">Migrat'n</h2>
|
|
<p>While this shortcode will still be avail'ble fer some time, it does not receive support anymore. Start t' migrate early, as it will be removed wit' th' next major update o' th' theme.</p>
|
|
<p>Th' <a href="/hugo-theme-relearn/pir/shortcodes/resources/index.html"><code>resources</code> shortcode</a> leverages Hugo’s resource feature fer plank bundles. It has all th' same parameter as th' <code>attachments</code> shortcode but applies th' <code>pattern</code> directly on a resources <code>Name</code> attribute.</p>
|
|
<p>T' migrate yer planks apply th' follow'n steps:</p>
|
|
<ol>
|
|
<li>If a plank be not already a <a href="https://gohugo.io/content-management/page-bundles/" rel="external" target="_self">plank bundle</a> convert it</li>
|
|
<li>Move yer files t' a valid destinat'n inside o' yer plank bundle (depend'n if ye have a branch or a leaf bundle)</li>
|
|
<li>Change th' calls from th' <code>attachments</code> shortcode t' th' <a href="/hugo-theme-relearn/pir/shortcodes/resources/index.html"><code>resources</code> shortcode</a> an' adjust th' <code>pattern</code> parameter t' th' new directory layout an' th' resources <a href="https://gohugo.io/methods/resource/name/" rel="external" target="_self"><code>Name</code> attribute</a>.</li>
|
|
</ol>
|
|
<p>Multilanguage features be not supported directly by th' shortcode anymore but rely on Hugo’s handl'n fer resource translat'ns.</p>
|
|
<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">​</div>
|
|
<button
|
|
data-tab-item="shortcode"
|
|
class="tab-nav-button tab-panel-style cstyle initial active" tabindex="-1"
|
|
onclick="switchTab('shortcode-parameter','shortcode')"
|
|
>
|
|
<span class="tab-nav-text">shortcode</span>
|
|
</button>
|
|
<button
|
|
data-tab-item="partial"
|
|
class="tab-nav-button tab-panel-style cstyle initial"
|
|
onclick="switchTab('shortcode-parameter','partial')"
|
|
>
|
|
<span class="tab-nav-text">partial</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="highlight wrap-code"><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>
|
|
<div
|
|
data-tab-item="partial"
|
|
class="tab-content tab-panel-style cstyle initial">
|
|
<div class="tab-content-text">
|
|
|
|
<div class="highlight wrap-code"><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">"page"</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>
|
|
</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>caut'n</code>, <code>important</code>, <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>cyan</code>, <code>green</code>, <code>grey</code>, <code>magenta</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" rel="external" target="_self">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>" "</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="/hugo-theme-relearn/pir/shortcodes/icon/index.html#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>" "</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" rel="external" target="_self">regular expressions</a>, used t' filter th' attachments by file name. For example:<br><br>- t' match a file suffix o' ‘jpg’, 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 < <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 < <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>
|
|
|
|
<footer class="footline">
|
|
</footer>
|
|
</article>
|
|
|
|
</div>
|
|
</main>
|
|
</div>
|
|
<script src="/hugo-theme-relearn/js/clipboard.min.js?1725191907" defer></script>
|
|
<script src="/hugo-theme-relearn/js/perfect-scrollbar.min.js?1725191907" defer></script>
|
|
<script src="/hugo-theme-relearn/js/theme.js?1725191907" defer></script>
|
|
</body>
|
|
</html>
|