hugo-theme-relearn/pir/introduction/releasenotes/2/9/index.print.html

195 lines
16 KiB
HTML
Raw Normal View History

<!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.138.0">
<meta name="generator" content="Relearn 7.1.1+85d43bcef3403a38c509d04606f2cd8ca91c8bd5">
<meta name="robots" content="noindex, nofollow, noarchive, noimageindex">
<meta name="description" content="2.9.0 (2021-11-19) Break&#39;n Break&#39;n This release removes th&#39; themes implementat&#39;n o&#39; ref/relref &#39;n favor fer Hugos standard implementat&#39;n. This be because o&#39; inconsistencies wit&#39; th&#39; themes implementat&#39;n. In advantage, yer project becomes standard compliant an&#39; exchang&#39;n this theme &#39;n yer project t&#39; some other theme will be effortless.">
<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="Version 2.9 :: Cap&#39;n Hugo Relearrrn Theme">
<meta name="twitter:description" content="2.9.0 (2021-11-19) Break&#39;n Break&#39;n This release removes th&#39; themes implementat&#39;n o&#39; ref/relref &#39;n favor fer Hugos standard implementat&#39;n. This be because o&#39; inconsistencies wit&#39; th&#39; themes implementat&#39;n. In advantage, yer project becomes standard compliant an&#39; exchang&#39;n this theme &#39;n yer project t&#39; some other theme will be effortless.">
<meta property="og:url" content="https://mcshelby.github.io/hugo-theme-relearn/pir/introduction/releasenotes/2/9/index.html">
<meta property="og:site_name" content="Cap&#39;n Hugo Relearrrn Theme">
<meta property="og:title" content="Version 2.9 :: Cap&#39;n Hugo Relearrrn Theme">
<meta property="og:description" content="2.9.0 (2021-11-19) Break&#39;n Break&#39;n This release removes th&#39; themes implementat&#39;n o&#39; ref/relref &#39;n favor fer Hugos standard implementat&#39;n. This be because o&#39; inconsistencies wit&#39; th&#39; themes implementat&#39;n. In advantage, yer project becomes standard compliant an&#39; exchang&#39;n this theme &#39;n yer project t&#39; some other theme will be effortless.">
<meta property="og:locale" content="art_x_pir">
<meta property="og:type" content="article">
<meta property="article:section" content="Introduction">
<meta property="og:image" content="https://mcshelby.github.io/hugo-theme-relearn/images/hero.png">
<meta itemprop="name" content="Version 2.9 :: Cap&#39;n Hugo Relearrrn Theme">
<meta itemprop="description" content="2.9.0 (2021-11-19) Break&#39;n Break&#39;n This release removes th&#39; themes implementat&#39;n o&#39; ref/relref &#39;n favor fer Hugos standard implementat&#39;n. This be because o&#39; inconsistencies wit&#39; th&#39; themes implementat&#39;n. In advantage, yer project becomes standard compliant an&#39; exchang&#39;n this theme &#39;n yer project t&#39; some other theme will be effortless.">
<meta itemprop="wordCount" content="302">
<meta itemprop="image" content="https://mcshelby.github.io/hugo-theme-relearn/images/hero.png">
<title>Version 2.9 :: Cap&#39;n Hugo Relearrrn Theme</title>
<link href="https://mcshelby.github.io/hugo-theme-relearn/introduction/releasenotes/2/9/index.html" rel="alternate" hreflang="x-default">
<link href="https://mcshelby.github.io/hugo-theme-relearn/introduction/releasenotes/2/9/index.html" rel="alternate" hreflang="en">
<link href="https://mcshelby.github.io/hugo-theme-relearn/pir/introduction/releasenotes/2/9/index.html" rel="alternate" hreflang="art-x-pir">
<link href="https://mcshelby.github.io/hugo-theme-relearn/pir/introduction/releasenotes/2/9/index.html" rel="canonical" type="text/html" title="Version 2.9 :: Cap&#39;n Hugo Relearrrn Theme">
<link href="/hugo-theme-relearn/pir/introduction/releasenotes/2/9/index.xml" rel="alternate" type="application/rss+xml" title="Version 2.9 :: Cap&#39;n Hugo Relearrrn Theme">
<link href="/hugo-theme-relearn/images/logo.svg?1731710362" rel="icon" type="image/svg+xml">
<link href="/hugo-theme-relearn/css/fontawesome-all.min.css?1731710362" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="/hugo-theme-relearn/css/fontawesome-all.min.css?1731710362" rel="stylesheet"></noscript>
<link href="/hugo-theme-relearn/css/nucleus.css?1731710362" rel="stylesheet">
<link href="/hugo-theme-relearn/css/auto-complete.css?1731710362" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="/hugo-theme-relearn/css/auto-complete.css?1731710362" rel="stylesheet"></noscript>
<link href="/hugo-theme-relearn/css/perfect-scrollbar.min.css?1731710362" rel="stylesheet">
<link href="/hugo-theme-relearn/css/fonts.css?1731710362" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="/hugo-theme-relearn/css/fonts.css?1731710362" rel="stylesheet"></noscript>
<link href="/hugo-theme-relearn/css/theme.css?1731710362" rel="stylesheet">
<link href="/hugo-theme-relearn/css/theme-relearn-auto.css?1731710362" rel="stylesheet" id="R-variant-style">
<link href="/hugo-theme-relearn/css/chroma-relearn-auto.css?1731710362" rel="stylesheet" id="R-variant-chroma-style">
<link href="/hugo-theme-relearn/css/print.css?1731710362" rel="stylesheet" media="print">
<link href="/hugo-theme-relearn/css/format-print.css?1731710362" rel="stylesheet">
<script src="/hugo-theme-relearn/js/variant.js?1731710362"></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;
// 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/introduction/releasenotes/2/9/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 class="topbar-button topbar-button-toc" data-content-empty="hide" data-width-s="show" data-width-m="show" data-width-l="show"><button class="topbar-control" onclick="toggleTopbarFlyout(this)" type="button" title="Table o&#39; Contents (CTRL&#43;ALT&#43;t)"><i class="fa-fw fas fa-list-alt"></i></button>
<div class="topbar-content">
<div class="topbar-content-wrapper">
<nav class="TableOfContents">
<ul>
<li><a href="#2-9-0">2.9.0 (2021-11-19)</a>
<ul>
<li><a href="#breaking">Break'n</a></li>
</ul>
</li>
</ul>
</nav>
</div>
</div>
</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/introduction/index.html"><span itemprop="name">Introduction</span></a><meta itemprop="position" content="1">&nbsp;>&nbsp;</li><li
itemscope itemtype="https://schema.org/ListItem" itemprop="itemListElement"><a itemprop="item" href="/hugo-theme-relearn/pir/introduction/releasenotes/index.html"><span itemprop="name">What&#39;s New</span></a><meta itemprop="position" content="2">&nbsp;>&nbsp;</li><li
itemscope itemtype="https://schema.org/ListItem" itemprop="itemListElement"><a itemprop="item" href="/hugo-theme-relearn/pir/introduction/releasenotes/2/index.html"><span itemprop="name">Version 2</span></a><meta itemprop="position" content="3">&nbsp;>&nbsp;</li><li
itemscope itemtype="https://schema.org/ListItem" itemprop="itemListElement"><span itemprop="name">Version 2.9</span><meta itemprop="position" content="4"></li>
</ol>
<div class="topbar-area topbar-area-end" data-area="end">
<div class="topbar-button topbar-button-edit" data-content-empty="disable" data-width-s="area-more" data-width-m="show" data-width-l="show"><a class="topbar-control" href="https://github.com/McShelby/hugo-theme-relearn/edit/main/exampleSite/content/introduction/releasenotes/2/9.pir.md" target="_self" title="Edit (CTRL&#43;ALT&#43;w)"><i class="fa-fw fas fa-pen"></i></a>
</div>
<div class="topbar-button topbar-button-print" data-content-empty="disable" data-width-s="area-more" data-width-m="show" data-width-l="show"><a class="topbar-control" href="/hugo-theme-relearn/pir/introduction/releasenotes/2/9/index.print.html" title="Prrrint whole chapterrr (CTRL&#43;ALT&#43;p)"><i class="fa-fw fas fa-print"></i></a>
</div>
<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/introduction/releasenotes/2/index.html" title="Version 2 (🡒)"><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/introduction/releasenotes/1/index.html" title="Version 1 (🡐)"><i class="fa-fw fas fa-chevron-right"></i></a>
</div>
<div class="topbar-button topbar-button-more" data-content-empty="hide" data-width-s="show" data-width-m="show" data-width-l="show"><button class="topbar-control" onclick="toggleTopbarFlyout(this)" type="button" title="Morrre"><i class="fa-fw fas fa-ellipsis-v"></i></button>
<div class="topbar-content">
<div class="topbar-content-wrapper">
<div class="topbar-area topbar-area-more" data-area="more">
</div>
</div>
</div>
</div>
</div>
</div>
</nav>
<div id="R-main-overlay"></div>
<main id="R-body-inner" class="highlightable releasenotes" tabindex="-1">
<div class="flex-block-wrapper">
<article class="default">
<header class="headline">
</header>
<h1 id="version-29">Version 2.9</h1>
See the <a href="/hugo-theme-relearn/pir/introduction/changelog/2/9/index.html">changelog of this version</a> for a detailed list of changes.
<hr>
<h2 id="2-9-0">2.9.0 (2021-11-19)</h2>
<h3 id="breaking">Break'n</h3>
<ul>
<li>
<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">Break'n</span></span> This release removes th' themes implementat'n o' <code>ref</code>/<code>relref</code> 'n favor fer Hugo&rsquo;s standard implementat'n. This be because o' inconsistencies wit' th' themes implementat'n. In advantage, yer project becomes standard compliant an' exchang'n this theme 'n yer project t' some other theme will be effortless.</p>
<p>In a standard compliant form ye must not link t' th' <code>*.md</code> file but t' its logical name. You&rsquo;ll see, referenc'n other planks becomes much easier. All three types result 'n th' same reference:</p>
<table>
<thead>
<tr>
<th>Type</th>
<th>Non-Standard</th>
<th>Standard</th>
</tr>
</thead>
<tbody>
<tr>
<td>Branch bundle</td>
<td><code>configuration/reference/_index.md</code></td>
<td><code>configuration/reference</code></td>
</tr>
<tr>
<td>Leaf bundle</td>
<td><code>configuration/reference/index.md</code></td>
<td><code>configuration/reference</code></td>
</tr>
<tr>
<td>Plank</td>
<td><code>configuration/reference.md</code></td>
<td><code>configuration/reference</code></td>
</tr>
</tbody>
</table>
<p>If you&rsquo;ve linked from a plank o' one language t' a plank o' another language, conversion be a bit more difficult but <a href="https://gohugo.io/content-management/cross-references/#link-to-another-language-version" rel="external" target="_self">Cap'n Hugo got ye covered</a> as well.</p>
<p>Also, th' old themes implementat'n allowed refs t' non-exist'n rrrambl'n. This will cause Hugo&rsquo;s implementat'n t' show th' error below an' abort th' generat'n. If yer project relies on this old behavior, ye can <a href="https://gohugo.io/content-management/cross-references/#link-to-another-language-version" rel="external" target="_self">reconfigure th' error handl'n</a> o' Hugo&rsquo;s implementat'n.</p>
<p>In th' best case yer usage o' th' old implementat'n be already standard compliant an' ye don&rsquo;t need t' change anyth'n. You&rsquo;ll notice this very easily once you&rsquo;ve started <code>hugo server</code> after an upgrade an' no errors be written t' th' console.</p>
<p>Ye may see errors on th' console after th' update 'n th' form:</p>
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-shell" data-lang="shell"><span class="line"><span class="cl">ERROR 2021/11/19 22:29:10 <span class="o">[</span>en<span class="o">]</span> REF_NOT_FOUND: Ref <span class="s2">&#34;configuration/reference/_index.md&#34;</span>: <span class="s2">&#34;hugo-theme-relearn\exampleSite\content\_index.en.md:19:22&#34;</span>: plank not found</span></span></code></pre></div>
<p>In this case, ye must apply one o' two opt'ns:</p>
<ol>
<li>
<p>Start up a text editor wit' regular expression support fer search an' replace. Search fer <code>(ref\s+&quot;[^&quot;]*?)(?:/_index|/index)?(?:\.md)?(#[^&quot;]*?)?&quot;</code> an' replace it by <code>$1$2&quot;</code> 'n all <code>*.md</code> files. <strong>This be th' recommended choice</strong>.</p>
</li>
<li>
<p>Copy th' old implementat'n files <code>theme/hugo-theme-relearn/layouts/shortcode/ref.html</code> an' <code>theme/hugo-theme-relearn/layouts/shortcode/relref.html</code> t' yer own projects <code>layouts/shortcode/ref.html</code> an' <code>layouts/shortcode/relref.html</code> respectively. <strong>This be not recommended</strong> as yer project will still rely on non-standard behavior afterwards.</p>
</li>
</ol>
</li>
</ul>
<footer class="footline">
</footer>
</article>
</div>
</main>
</div>
<script src="/hugo-theme-relearn/js/clipboard.min.js?1731710362" defer></script>
<script src="/hugo-theme-relearn/js/perfect-scrollbar.min.js?1731710362" defer></script>
<script src="/hugo-theme-relearn/js/theme.js?1731710362" defer></script>
</body>
</html>