2022-04-02 13:30:16 +00:00
|
|
|
<!DOCTYPE html>
|
2023-02-08 21:24:18 +00:00
|
|
|
<html lang="pir" dir="rtl">
|
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-02-07 17:09:51 +00:00
|
|
|
<meta name="generator" content="Relearn 5.11.2+tip">
|
2022-04-02 13:30:16 +00:00
|
|
|
<meta name="description" content="Documentation for Hugo Relearn Theme">
|
|
|
|
|
<meta name="author" content="Sören Weber">
|
|
|
|
|
<title>Ship param :: Cap'n Hugo Relearrrn Theme</title>
|
2023-01-25 11:42:06 +00:00
|
|
|
<link href="https://McShelby.github.io/hugo-theme-relearn/shortcodes/siteparam/index.html" rel="alternate" hreflang="x-default">
|
|
|
|
|
<link href="https://McShelby.github.io/hugo-theme-relearn/shortcodes/siteparam/index.html" rel="alternate" hreflang="en">
|
|
|
|
|
<link href="https://McShelby.github.io/hugo-theme-relearn/pir/shortcodes/siteparam/index.html" rel="alternate" hreflang="pir">
|
2022-11-15 06:35:08 +00:00
|
|
|
<link href="https://McShelby.github.io/hugo-theme-relearn/pir/shortcodes/siteparam/index.html" rel="canonical" type="text/html" title="Ship param :: Cap'n Hugo Relearrrn Theme">
|
2022-11-06 00:38:34 +00:00
|
|
|
<link href="../../../pir/shortcodes/siteparam/index.xml" rel="alternate" type="application/rss+xml" title="Ship param :: Cap'n Hugo Relearrrn Theme">
|
2023-02-10 21:28:02 +00:00
|
|
|
<link href="../../../images/logo.svg?1676064474" 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-02-10 21:28:02 +00:00
|
|
|
<link href="../../../css/fontawesome-all.min.css?1676064477" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="../../../css/fontawesome-all.min.css?1676064477" rel="stylesheet"></noscript>
|
|
|
|
|
<link href="../../../css/nucleus.css?1676064477" rel="stylesheet">
|
|
|
|
|
<link href="../../../css/auto-complete.css?1676064477" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="../../../css/auto-complete.css?1676064477" rel="stylesheet"></noscript>
|
|
|
|
|
<link href="../../../css/perfect-scrollbar.min.css?1676064477" rel="stylesheet">
|
|
|
|
|
<link href="../../../css/fonts.css?1676064477" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="../../../css/fonts.css?1676064477" rel="stylesheet"></noscript>
|
|
|
|
|
<link href="../../../css/theme.css?1676064477" rel="stylesheet">
|
|
|
|
|
<link href="../../../css/theme-auto.css?1676064477" rel="stylesheet" id="variant-style">
|
|
|
|
|
<link href="../../../css/variant.css?1676064477" rel="stylesheet">
|
|
|
|
|
<link href="../../../css/print.css?1676064477" rel="stylesheet" media="print">
|
|
|
|
|
<link href="../../../css/format-print.css?1676064477" rel="stylesheet">
|
|
|
|
|
<link href="../../../css/ie.css?1676064477" rel="stylesheet">
|
|
|
|
|
<script src="../../../js/url.js?1676064477"></script>
|
|
|
|
|
<script src="../../../js/variant.js?1676064477"></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="../../../pir/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 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!';
|
2022-11-17 21:13:11 +00:00
|
|
|
window.T_No_results_found = 'No rrresults found fer \u0022{0}\u0022';
|
|
|
|
|
window.T_N_results_found = '{1} rrresults found fer \u0022{0}\u0022';
|
2022-04-02 13:30:16 +00:00
|
|
|
// some further base stuff
|
|
|
|
|
var baseUriFull='https:\/\/McShelby.github.io\/hugo-theme-relearn/';
|
2023-02-04 21:34:28 +00:00
|
|
|
window.variants && variants.init( [ 'auto', 'relearn-light', 'relearn-dark', 'learn', 'neon', 'blue', 'green', 'red' ] );
|
2022-04-02 13:30:16 +00:00
|
|
|
</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="../../../pir/shortcodes/siteparam/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>
|
2023-02-08 23:54:12 +00:00
|
|
|
<nav id="topbar" class="highlightable">
|
2022-04-02 13:30:16 +00:00
|
|
|
<div>
|
|
|
|
|
<div id="breadcrumbs">
|
|
|
|
|
<span id="sidebar-toggle-span">
|
2023-02-04 15:02:34 +00:00
|
|
|
<a href="#" id="sidebar-toggle" class="topbar-link" 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="../../../pir/index.html"><span itemprop="name">Cap'n Hugo Relearrrn Theme</span></a><meta itemprop="position" content="1"> > </li>
|
|
|
|
|
<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="2"> > </li>
|
2022-10-02 22:25:49 +00:00
|
|
|
<li itemscope itemtype="https://schema.org/ListItem" itemprop="itemListElement"><span itemprop="name">Ship param</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="ship-param">Ship param</h1>
|
2022-04-02 13:30:16 +00:00
|
|
|
|
2022-07-05 22:16:52 +00:00
|
|
|
|
2023-01-24 22:59:44 +00:00
|
|
|
<p>Th' <code>siteparam</code> shortcode prints values o' ship params.</p>
|
2022-04-02 13:30:16 +00:00
|
|
|
<h2 id="usage">Usage</h2>
|
2023-01-24 22:59:44 +00:00
|
|
|
<p>While th' examples be us'n shorrrtcodes wit' named parameter ye be free t' use positional aswell or call this shortcode from yer own partials.</p>
|
2022-06-05 17:32:37 +00:00
|
|
|
|
2023-01-29 16:05:10 +00:00
|
|
|
<div class="tab-panel" data-tab-group="shortcode-parameter">
|
2022-06-05 17:32:37 +00:00
|
|
|
<div class="tab-nav">
|
|
|
|
|
<button
|
2022-06-22 22:08:50 +00:00
|
|
|
data-tab-item="shortcode"
|
2023-02-08 21:24:18 +00:00
|
|
|
class="tab-nav-button active"
|
2022-06-22 22:08:50 +00:00
|
|
|
onclick="switchTab('shortcode-parameter','shortcode')"
|
2023-01-29 16:05:10 +00:00
|
|
|
>
|
|
|
|
|
<span>shortcode</span></button>
|
2022-06-05 17:32:37 +00:00
|
|
|
<button
|
2022-06-22 22:08:50 +00:00
|
|
|
data-tab-item="shortcode (positional)"
|
2023-02-08 21:24:18 +00:00
|
|
|
class="tab-nav-button"
|
2022-06-22 22:08:50 +00:00
|
|
|
onclick="switchTab('shortcode-parameter','shortcode (positional)')"
|
2023-01-29 16:05:10 +00:00
|
|
|
>
|
|
|
|
|
<span>shortcode (positional)</span></button>
|
2022-06-22 22:08:50 +00:00
|
|
|
<button
|
|
|
|
|
data-tab-item="partial"
|
2023-02-08 21:24:18 +00:00
|
|
|
class="tab-nav-button"
|
2022-06-22 22:08:50 +00:00
|
|
|
onclick="switchTab('shortcode-parameter','partial')"
|
2023-01-29 16:05:10 +00:00
|
|
|
>
|
|
|
|
|
<span>partial</span></button>
|
2022-06-05 17:32:37 +00:00
|
|
|
</div>
|
|
|
|
|
<div class="tab-content">
|
2023-01-29 16:05:10 +00:00
|
|
|
<div
|
|
|
|
|
data-tab-item="shortcode"
|
2023-02-07 17:07:26 +00:00
|
|
|
class="tab-content-text active"
|
2023-01-29 16:05:10 +00:00
|
|
|
>
|
2022-06-05 17:32:37 +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">siteparam</span> <span class="nx">name</span><span class="p">=</span><span class="s">"editURL"</span> <span class="o">%</span><span class="p">}}</span>
|
|
|
|
|
</span></span></code></pre></div>
|
|
|
|
|
</div>
|
2023-01-29 16:05:10 +00:00
|
|
|
<div
|
|
|
|
|
data-tab-item="shortcode (positional)"
|
2023-02-08 21:24:18 +00:00
|
|
|
class="tab-content-text"
|
2023-01-29 16:05:10 +00:00
|
|
|
>
|
2022-06-05 17:32:37 +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">siteparam</span> <span class="s">"editURL"</span> <span class="o">%</span><span class="p">}}</span>
|
2022-06-22 22:08:50 +00:00
|
|
|
</span></span></code></pre></div>
|
|
|
|
|
</div>
|
2023-01-29 16:05:10 +00:00
|
|
|
<div
|
|
|
|
|
data-tab-item="partial"
|
2023-02-08 21:24:18 +00:00
|
|
|
class="tab-content-text"
|
2023-01-29 16:05:10 +00:00
|
|
|
>
|
2022-06-22 22:08:50 +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="nx">partial</span> <span class="s">"shortcodes/siteparam.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">"name"</span> <span class="s">"editURL"</span>
|
|
|
|
|
</span></span><span class="line"><span class="cl"><span class="p">)}}</span>
|
2022-06-05 17:32:37 +00:00
|
|
|
</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">Posit'n</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>name</strong></td>
|
|
|
|
|
<td style="text-align:left">1</td>
|
|
|
|
|
<td style="text-align:left"><em><empty></em></td>
|
|
|
|
|
<td style="text-align:left">Th' name o' th' ship param t' be displayed.</td>
|
|
|
|
|
</tr>
|
|
|
|
|
</tbody>
|
|
|
|
|
</table>
|
2022-04-02 13:30:16 +00:00
|
|
|
<h2 id="examples">Examples</h2>
|
2022-06-05 17:32:37 +00:00
|
|
|
<h3 id="editurl-from-configtoml"><code>editURL</code> from <code>config.toml</code></h3>
|
|
|
|
|
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="s">`editURL`</span> <span class="nx">value</span><span class="p">:</span> <span class="p">{{</span><span class="o">%</span> <span class="nx">siteparam</span> <span class="nx">name</span><span class="p">=</span><span class="s">"editURL"</span> <span class="o">%</span><span class="p">}}</span>
|
2022-12-23 11:24:54 +00:00
|
|
|
</span></span></code></pre></div><p><code>editURL</code> value: <a href="https://github.com/McShelby/hugo-theme-relearn/edit/main/exampleSite/content/" target="_blank">https://github.com/McShelby/hugo-theme-relearn/edit/main/exampleSite/content/</a></p>
|
2022-04-02 13:30:16 +00:00
|
|
|
|
|
|
|
|
|
|
|
|
|
<footer class="footline">
|
|
|
|
|
</footer>
|
|
|
|
|
</article>
|
|
|
|
|
</div>
|
|
|
|
|
</main>
|
|
|
|
|
</div>
|
2023-02-10 21:28:02 +00:00
|
|
|
<script src="../../../js/clipboard.min.js?1676064477" defer></script>
|
|
|
|
|
<script src="../../../js/perfect-scrollbar.min.js?1676064477" defer></script>
|
|
|
|
|
<script src="../../../js/theme.js?1676064477" defer></script>
|
2022-04-02 13:30:16 +00:00
|
|
|
</body>
|
|
|
|
|
</html>
|
