<!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.117.0">
<meta name="generator" content="Relearn 5.19.0+tip">
<meta name="description" content="Documentation for Hugo Relearn Theme">
<meta name="author" content="Sören Weber">
<title>Children :: Cap'n Hugo Relearrrn Theme</title>
<link href="https://McShelby.github.io/hugo-theme-relearn/shortcodes/children/index.html" rel="alternate" hreflang="x-default">
<link href="https://McShelby.github.io/hugo-theme-relearn/shortcodes/children/index.html" rel="alternate" hreflang="en">
<link href="https://McShelby.github.io/hugo-theme-relearn/pir/shortcodes/children/index.html" rel="alternate" hreflang="pir">
<link href="https://McShelby.github.io/hugo-theme-relearn/pir/shortcodes/children/index.html" rel="canonical" type="text/html" title="Children :: Cap'n Hugo Relearrrn Theme">
<link href="../../../pir/shortcodes/children/index.xml" rel="alternate" type="application/rss+xml" title="Children :: Cap'n Hugo Relearrrn Theme">
<link href="../../../images/logo.svg?1692287900" 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?1692287903" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="../../../css/fontawesome-all.min.css?1692287903" rel="stylesheet"></noscript>
<link href="../../../css/nucleus.css?1692287903" rel="stylesheet">
<link href="../../../css/auto-complete.css?1692287903" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="../../../css/auto-complete.css?1692287903" rel="stylesheet"></noscript>
<link href="../../../css/perfect-scrollbar.min.css?1692287903" rel="stylesheet">
<link href="../../../css/fonts.css?1692287903" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="../../../css/fonts.css?1692287903" rel="stylesheet"></noscript>
<link href="../../../css/theme.css?1692287903" rel="stylesheet">
<link href="../../../css/theme-auto.css?1692287903" rel="stylesheet" id="variant-style">
<link href="../../../css/variant.css?1692287903" rel="stylesheet">
<link href="../../../css/print.css?1692287903" rel="stylesheet" media="print">
<link href="../../../css/format-print.css?1692287903" rel="stylesheet">
<link href="../../../css/ie.css?1692287903" rel="stylesheet">
<script src="../../../js/url.js?1692287903"></script>
<script src="../../../js/variant.js?1692287903"></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_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>
#body img.bg-white {
background-color: white;
}
</style>
</head>
<body class="mobile-support print disableInlineCopyToClipboard" data-url="../../../pir/shortcodes/children/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="../../../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>
<li itemscope itemtype="https://schema.org/ListItem" itemprop="itemListElement"><span itemprop="name">Children</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">
<article class="default">
<header class="headline">
</header>
<h1 id="children">Children</h1>
<p>Th' <code>children</code> shortcode lists th' child planks o' th' current plank an' its descendants.</p>
<ul class="children children-li children-sort-weight">
<li><a href="../../../shortcodes/children/test/index.html">plank X</a></li>
<li><a href="../../../shortcodes/children/children-1/index.html">plank 1</a></li>
<li><a href="../../../shortcodes/children/children-2/index.html">plank 2</a></li>
<li><a href="../../../shortcodes/children/children-3/index.html">plank 3</a></li>
</ul>
<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"
onclick="switchTab('shortcode-parameter','shortcode')"
>
<div>
<div class="tab-nav-hidden">shortcode</div>
<div class="tab-nav-text">shortcode</div>
</div>
</button>
<button
data-tab-item="partial"
class="tab-nav-button tab-panel-style cstyle initial"
onclick="switchTab('shortcode-parameter','partial')"
>
<div>
<div class="tab-nav-hidden">partial</div>
<div class="tab-nav-text">partial</div>
</div>
</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">children</span> <span class="nx">sort</span><span class="p">=</span><span class="s">"weight"</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">"shortcodes/children.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">"weight"</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>containerstyle</strong></td>
<td><code>ul</code></td>
<td>Choose th' style used t' group all children. It could be any HTML tag name.</td>
</tr>
<tr>
<td><strong>style</strong></td>
<td><code>li</code></td>
<td>Choose th' style used t' display each descendant. It could be any HTML tag name.</td>
</tr>
<tr>
<td><strong>showhidden</strong></td>
<td><code>false</code></td>
<td>When <code>true</code>, child planks hidden from th' menu will be displayed as well.</td>
</tr>
<tr>
<td><strong>descript'n</strong></td>
<td><code>false</code></td>
<td>When <code>true</code> shows a short text under each plank 'n th' list. When no descript'n or summary exists fer th' plank, th' first 70 words o' th' rrrambl'n be taken - <a href="https://gohugo.io/content/summaries/" target="_blank">read more info about summaries on gohugo.io</a>.</td>
</tr>
<tr>
<td><strong>depth</strong></td>
<td><code>1</code></td>
<td>Th' depth o' descendants t' display. For example, if th' value be <code>2</code>, th' shortcode will display two levels o' child planks. T' get all descendants, set this value t' a high number eg. <code>999</code>.</td>
</tr>
<tr>
<td><strong>sort</strong></td>
<td>see notes</td>
<td>Th' sort order o' th' displayed list.<br><br>If not set it be sorted by th' <a href="../../../basics/configuration/#global-site-parameters"><code>ordersectionsby</code></a> sett'n o' th' ship an' th' planks frontmatter<br><br>- <code>weight</code>: t' sort on menu order<br>- <code>title</code>: t' sort alphabetically on menu label.</td>
</tr>
</tbody>
</table>
<h2 id="examples">Examples</h2>
<h3 id="all-default">All Default</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">children</span> <span class="o">%</span><span class="p">}}</span></span></span></code></pre></div>
<ul class="children children-li children-sort-">
<li><a href="../../../shortcodes/children/test/index.html">plank X</a></li>
<li><a href="../../../shortcodes/children/children-1/index.html">plank 1</a></li>
<li><a href="../../../shortcodes/children/children-2/index.html">plank 2</a></li>
<li><a href="../../../shortcodes/children/children-3/index.html">plank 3</a></li>
</ul>
<h3 id="with-description">Wit' Descript'n</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">children</span> <span class="nx">descript'n</span><span class="p">=</span><span class="s">"true"</span> <span class="o">%</span><span class="p">}}</span></span></span></code></pre></div>
<ul class="children children-li children-sort-">
<li><a href="../../../shortcodes/children/test/index.html">plank X</a><p>This be a plain plank test, an' th' beginn'n o' a YAML multiline descript'n...
</p></li>
<li><a href="../../../shortcodes/children/children-1/index.html">plank 1</a><p>This be a demo child plank</p></li>
<li><a href="../../../shortcodes/children/children-2/index.html">plank 2</a><p>This be a demo child plank wit' no descript'n.
So its rrrambl'n be used as descript'n.</p></li>
<li><a href="../../../shortcodes/children/children-3/index.html">plank 3</a><p>This be a demo child plank</p></li>
</ul>
<h3 id="infinite-depth-and-hidden-pages">Infinite Depth an' Hidden Planks</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">children</span> <span class="nx">depth</span><span class="p">=</span><span class="s">"999"</span> <span class="nx">showhidden</span><span class="p">=</span><span class="s">"true"</span> <span class="o">%</span><span class="p">}}</span></span></span></code></pre></div>
<ul class="children children-li children-sort-">
<li><a href="../../../shortcodes/children/test/index.html">plank X</a><ul>
</ul></li>
<li><a href="../../../shortcodes/children/children-1/index.html">plank 1</a><ul>
<li><a href="../../../shortcodes/children/children-1/children-1-1/index.html">plank 1-1</a><ul>
<li><a href="../../../shortcodes/children/children-1/children-1-1/children-1-1-1/index.html">plank 1-1-1 (hidden)</a><ul>
<li><a href="../../../shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/index.html">plank 1-1-1-1</a><ul>
<li><a href="../../../shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/children-1-1-1-1-1/index.html">plank 1-1-1-1-1 (hidden)</a><ul>
<li><a href="../../../shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/children-1-1-1-1-1/children-1-1-1-1-1-1/index.html">plank 1-1-1-1-1-1</a><ul>
</ul></li></ul></li></ul></li></ul></li>
<li><a href="../../../shortcodes/children/children-1/children-1-1/children-1-1-2/index.html">plank 1-1-2</a><ul>
<li><a href="../../../shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-1/index.html">plank 1-1-2-1</a><ul>
</ul></li>
<li><a href="../../../shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-2/index.html">plank 1-1-2-2</a><ul>
</ul></li></ul></li>
<li><a href="../../../shortcodes/children/children-1/children-1-1/children-1-1-3/index.html">plank 1-1-3</a><ul>
</ul></li></ul></li></ul></li>
<li><a href="../../../shortcodes/children/children-2/index.html">plank 2</a><ul>
</ul></li>
<li><a href="../../../shortcodes/children/children-3/index.html">plank 3</a><ul>
<li><a href="../../../shortcodes/children/children-3/test3/index.html">plank 3-1</a><ul>
</ul></li></ul></li>
<li><a href="../../../shortcodes/children/children-4/index.html">plank 4 (hidden)</a><ul>
</ul></li>
</ul>
<h3 id="heading-styles-for-container-and-elements">Head'n Styles fer Container an' Elements</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">children</span> <span class="nx">containerstyle</span><span class="p">=</span><span class="s">"div"</span> <span class="nx">style</span><span class="p">=</span><span class="s">"h2"</span> <span class="nx">depth</span><span class="p">=</span><span class="s">"3"</span> <span class="nx">descript'n</span><span class="p">=</span><span class="s">"true"</span> <span class="o">%</span><span class="p">}}</span></span></span></code></pre></div>
<div class="children children-h2 children-sort-">
<h2><a href="../../../shortcodes/children/test/index.html">plank X</a></h2><p>This be a plain plank test, an' th' beginn'n o' a YAML multiline descript'n...
</p>
<h2><a href="../../../shortcodes/children/children-1/index.html">plank 1</a></h2><p>This be a demo child plank</p>
<h3><a href="../../../shortcodes/children/children-1/children-1-1/index.html">plank 1-1</a></h3><p>This be a demo child plank</p>
<h4><a href="../../../shortcodes/children/children-1/children-1-1/children-1-1-2/index.html">plank 1-1-2</a></h4><p>This be a demo child plank</p>
<h4><a href="../../../shortcodes/children/children-1/children-1-1/children-1-1-3/index.html">plank 1-1-3</a></h4><p>This be a demo child plank</p>
<h2><a href="../../../shortcodes/children/children-2/index.html">plank 2</a></h2><p>This be a demo child plank wit' no descript'n.
So its rrrambl'n be used as descript'n.</p>
<h2><a href="../../../shortcodes/children/children-3/index.html">plank 3</a></h2><p>This be a demo child plank</p>
<h3><a href="../../../shortcodes/children/children-3/test3/index.html">plank 3-1</a></h3><p>This be a plain plank test nested 'n a parent</p>
</div>
<h3 id="divs-for-group-and-element-styles">Divs fer Group an' Element Styles</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">children</span> <span class="nx">containerstyle</span><span class="p">=</span><span class="s">"div"</span> <span class="nx">style</span><span class="p">=</span><span class="s">"div"</span> <span class="nx">depth</span><span class="p">=</span><span class="s">"3"</span> <span class="o">%</span><span class="p">}}</span></span></span></code></pre></div>
<div class="children children-div children-sort-">
<div><a href="../../../shortcodes/children/test/index.html">plank X</a></div>
<div><a href="../../../shortcodes/children/children-1/index.html">plank 1</a></div>
<div><a href="../../../shortcodes/children/children-1/children-1-1/index.html">plank 1-1</a></div>
<div><a href="../../../shortcodes/children/children-1/children-1-1/children-1-1-2/index.html">plank 1-1-2</a></div>
<div><a href="../../../shortcodes/children/children-1/children-1-1/children-1-1-3/index.html">plank 1-1-3</a></div>
<div><a href="../../../shortcodes/children/children-2/index.html">plank 2</a></div>
<div><a href="../../../shortcodes/children/children-3/index.html">plank 3</a></div>
<div><a href="../../../shortcodes/children/children-3/test3/index.html">plank 3-1</a></div>
</div>
<footer class="footline">
</footer>
</article>
<section>
<h1 class="a11y-only">Subsct'ns o' Children</h1>
<article class="default">
<header class="headline">
<div class="tags">
<a class="tag-link" href="../../../pir/tags/children/index.html">Children</a>
</div>
</header>
<h1 id="plank-x">plank X</h1>
<p>This be a plain demo child plank.</p>
<footer class="footline">
</footer>
</article>
<article class="default">
<header class="headline">
<div class="tags">
<a class="tag-link" href="../../../pir/tags/children/index.html">children</a>
<a class="tag-link" href="../../../pir/tags/non-hidden/index.html">non-hidden</a>
</div>
</header>
<h1 id="plank-1">plank 1</h1>
<p>This be a demo child plank.</p>
<h2 id="subpages-of-this-page">Subpages o' this plank</h2>
<ul class="children children-li children-sort-">
<li><a href="../../../shortcodes/children/children-1/children-1-1/index.html">plank 1-1</a></li>
</ul>
<footer class="footline">
</footer>
</article>
<section>
<h1 class="a11y-only">Subsct'ns o' plank 1</h1>
<article class="default">
<header class="headline">
<div class="tags">
<a class="tag-link" href="../../../pir/tags/children/index.html">children</a>
<a class="tag-link" href="../../../pir/tags/non-hidden/index.html">non-hidden</a>
</div>
</header>
<h1 id="plank-1-1">plank 1-1</h1>
<p>This be a demo child plank wit' a hidden child. Ye can still access th' hidden child <a href="../../../shortcodes/children/children-1/children-1-1/children-1-1-1/">directly</a> or via th' search.</p>
<h2 id="subpages-of-this-page">Subpages o' this plank</h2>
<ul class="children children-li children-sort-">
<li><a href="../../../shortcodes/children/children-1/children-1-1/children-1-1-1/index.html">plank 1-1-1 (hidden)</a></li>
<li><a href="../../../shortcodes/children/children-1/children-1-1/children-1-1-2/index.html">plank 1-1-2</a></li>
<li><a href="../../../shortcodes/children/children-1/children-1-1/children-1-1-3/index.html">plank 1-1-3</a></li>
</ul>
<footer class="footline">
</footer>
</article>
<section>
<h1 class="a11y-only">Subsct'ns o' plank 1-1</h1>
<article class="default">
<header class="headline">
<div class="tags">
<a class="tag-link" href="../../../pir/tags/children/index.html">children</a>
<a class="tag-link" href="../../../pir/tags/non-hidden/index.html">non-hidden</a>
</div>
</header>
<h1 id="plank-1-1-2">plank 1-1-2</h1>
<p>This be a plain demo child plank.</p>
<h2 id="subpages-of-this-page">Subpages o' this plank</h2>
<ul class="children children-li children-sort-">
<li><a href="../../../shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-1/index.html">plank 1-1-2-1</a></li>
<li><a href="../../../shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-2/index.html">plank 1-1-2-2</a></li>
</ul>
<footer class="footline">
</footer>
</article>
<section>
<h1 class="a11y-only">Subsct'ns o' plank 1-1-2</h1>
<article class="default">
<header class="headline">
<div class="tags">
<a class="tag-link" href="../../../pir/tags/children/index.html">children</a>
<a class="tag-link" href="../../../pir/tags/non-hidden/index.html">non-hidden</a>
</div>
</header>
<h1 id="plank-1-1-2-1">plank 1-1-2-1</h1>
<p>This be a plain demo child plank.</p>
<footer class="footline">
</footer>
</article>
<article class="default">
<header class="headline">
<div class="tags">
<a class="tag-link" href="../../../pir/tags/children/index.html">children</a>
<a class="tag-link" href="../../../pir/tags/non-hidden/index.html">non-hidden</a>
</div>
</header>
<h1 id="plank-1-1-2-2">plank 1-1-2-2</h1>
<p>This be a plain demo child plank.</p>
<footer class="footline">
</footer>
</article>
</section>
<article class="default">
<header class="headline">
<div class="tags">
<a class="tag-link" href="../../../pir/tags/children/index.html">children</a>
<a class="tag-link" href="../../../pir/tags/non-hidden/index.html">non-hidden</a>
</div>
</header>
<h1 id="plank-1-1-3">plank 1-1-3</h1>
<p>This be a plain demo child plank.</p>
<footer class="footline">
</footer>
</article>
</section>
</section>
<article class="default">
<header class="headline">
<div class="tags">
<a class="tag-link" href="../../../pir/tags/children/index.html">children</a>
<a class="tag-link" href="../../../pir/tags/non-hidden/index.html">non-hidden</a>
</div>
</header>
<h1 id="plank-2">plank 2</h1>
<p>This be a demo child plank wit' no descript'n.</p>
<p>So its rrrambl'n be used as descript'n.</p>
<footer class="footline">
</footer>
</article>
<article class="default">
<header class="headline">
<div class="tags">
<a class="tag-link" href="../../../pir/tags/children/index.html">children</a>
<a class="tag-link" href="../../../pir/tags/non-hidden/index.html">non-hidden</a>
</div>
</header>
<h1 id="plank-3">plank 3</h1>
<p>This be a demo child plank.</p>
<h2 id="subpages-of-this-page">Subpages o' this plank</h2>
<ul class="children children-li children-sort-">
<li><a href="../../../shortcodes/children/children-3/test3/index.html">plank 3-1</a></li>
</ul>
<footer class="footline">
</footer>
</article>
<section>
<h1 class="a11y-only">Subsct'ns o' plank 3</h1>
<article class="default">
<header class="headline">
<div class="tags">
<a class="tag-link" href="../../../pir/tags/children/index.html">children</a>
<a class="tag-link" href="../../../pir/tags/non-hidden/index.html">non-hidden</a>
</div>
</header>
<h1 id="plank-3-1">plank 3-1</h1>
<p>This be a plain demo child plank.</p>
<footer class="footline">
</footer>
</article>
</section>
</section>
</div>
</main>
</div>
<script src="../../../js/clipboard.min.js?1692287903" defer></script>
<script src="../../../js/perfect-scrollbar.min.js?1692287903" defer></script>
<script src="../../../js/theme.js?1692287903" defer></script>
</body>
</html>