ayakael.net/ikiwiki/directive/index.html

183 lines
6.4 KiB
HTML
Raw Normal View History

2024-08-25 22:56:19 +00:00
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
2024-09-12 13:15:20 +00:00
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<!-- The above 3 meta tags *must* come first in the head; any other head content must come *after* these tags -->
<meta name="robots" content="noindex, follow" />
<title>directive - Ayakael</title>
<!-- cargo-culted from https://realfavicongenerator.net/ -->
<!-- for the record: it is absolutely ridiculous that new browsers
*and* operating systems each want their own little precious
snowflake just for a frigging icon -->
<link rel="apple-touch-icon" sizes="180x180" href="../../apple-touch-icon.png">
<link rel="icon" type="image/png" sizes="32x32" href="../../favicon-32x32.png">
<link rel="icon" type="image/png" sizes="16x16" href="../../favicon-16x16.png">
<link rel="manifest" href="../../site.webmanifest">
<meta name="msapplication-TileColor" content="#da532c">
<meta name="theme-color" content="#ffffff">
<!-- ikiwiki CSS -->
<link href="../../css/style.css" rel="stylesheet" />
<!-- Bootstrap core CSS -->
<!-- those checksums can be verified with: shasum -b -a 384 $file | xxd -r -p | base64 -->
<link href="https://cdn.jsdelivr.net/npm/bootstrap@5.2.3/dist/css/bootstrap.min.css" rel="stylesheet" integrity="sha384-rbsA2VBKQhggwzxH7pPCaAqO46MgnOM80zW1RWuH61DGLwZJEdK2Kadq2F9CUG65" crossorigin="anonymous">
<!-- Custom styles for this template -->
<link href="../../css/bootstrap.local.css" rel="stylesheet" />
<!-- Custom styles for derivatives -->
<link rel="stylesheet" href="../../css/local.css" type="text/css" />
<meta name="robots" content="noindex, follow" />
</head>
<body>
<nav class="navbar fixed-top navbar-expand-lg navbar-light bg-light border">
<div class="container-fluid">
<a class="navbar-brand me-auto" href="../../">
<img alt="Ayakael" src="../../favicon.png" width="48" height="48" />
</a>
<button class="navbar-toggler collapsed" type="button" data-bs-toggle="collapse" data-bs-target="#navbar" aria-controls="navbarScroll" aria-expanded="false" aria-label="Toggle navigation">
<span class="navbar-toggler-icon"></span>
</button>
<div id="navbar" class="collapse navbar-collapse">
<!-- the anchors force ikiwiki to use a tags instead of spans. hopefully. -->
<ul class="navbar-nav nav-link align-items-center ms-auto">
2024-08-25 22:56:19 +00:00
<li><a href="../../index.en.html">Home</a></li>
<li><a href="https://ayakael.net/forge/">Forge</a></li>
<li><a href="../../contact/index.en.html">Contact</a></li>
</ul>
2024-09-12 13:15:20 +00:00
<ul class="navbar-nav nav-link align-items-center ms-auto">
</ul>
</div>
</div>
</nav>
2024-08-25 22:56:19 +00:00
2024-09-12 13:15:20 +00:00
<div class="container" id="content">
<p>Directives are similar to a <a href="../wikilink/">WikiLink</a> in form, except they
2024-08-25 22:56:19 +00:00
begin with <code>!</code> and may contain parameters. The general form is:</p>
<pre><code>[[!directive param="value" param="value"]]
</code></pre>
<p>This gets expanded before the rest of the page is processed, and can be used
to transform the page in various ways.</p>
<p>The quotes around values can be omitted if the value is a simple word.
Also, some directives may use parameters without values, for example:</p>
<pre><code>[[!tag foo]]
</code></pre>
<p>A directive does not need to all be on one line, it can be
wrapped to multiple lines if you like:</p>
<pre><code>[[!directive foo="baldersnatch"
bar="supercalifragilisticexpialidocious" baz=11]]
</code></pre>
<p>Also, multiple lines of <em>quoted</em> text can be used for a value.
To allow quote marks inside the quoted text, delimit the block
of text with triple-double-quotes or triple-single-quotes:</p>
<pre><code>[[!directive text="""
1. "foo"
2. "bar"
3. "baz"
""" othertext='''
1. 'quux'
2. "foo"
''']]
</code></pre>
<p>If you want to put text with triple quotes into a parameter value, you can
use perl-style here-doc syntax, even nesting it like this:</p>
<pre><code>[[!directive text=&lt;&lt;OUTER
[[!otherdirective &lt;&lt;INNER
inner text
INNER]]
outer text
OUTER]]
</code></pre>
<p>ikiwiki also has an older syntax for directives, which requires a space in
directives to distinguish them from <a href="../wikilink/">wikilinks</a>. This
syntax has several disadvantages: it requires a space after directives with
no parameters (such as <code>[[pagecount ]]</code>), and it prohibits spaces in
<a href="../wikilink/">wikilinks</a>. ikiwiki now provides the <code>!</code>-prefixed
syntax shown above as default. However, ikiwiki still supports wikis using
the older syntax, if the <code>prefix_directives</code> option is disabled.</p>
2024-09-12 13:15:20 +00:00
2024-08-25 22:56:19 +00:00
2024-09-12 13:15:20 +00:00
2024-08-25 22:56:19 +00:00
2024-09-12 13:15:20 +00:00
<!-- legacy Ikiwiki comments.pm section -->
2024-08-25 22:56:19 +00:00
2024-09-12 13:15:20 +00:00
<!-- Mastodon comments -->
2024-08-25 22:56:19 +00:00
2024-09-12 13:15:20 +00:00
<div class="pagedate text-muted">
<span class="created">Created <time datetime="2024-09-12T13:15:12Z" class="dt-published">Thu Sep 12 13:15:12 2024</time>.</span>
<span class="edited">
Edited <time datetime="2024-09-12T13:15:12Z">Thu Sep 12 13:15:12 2024</time>.
</span>
</div>
</div> <!-- /container -->
2024-08-25 22:56:19 +00:00
2024-09-12 13:15:20 +00:00
<footer class="footer pb-3 pt-3" role="contentinfo">
<div class="container">
<div class="row text-muted">
<div class="col-sm">
Copyleft © 2024 ayakael <a href="../../meta/license/">CC-BY-SA</a>
</div>
<div class="col-sm text-sm-end">
Powered by <a href="http://ikiwiki.info/">ikiwiki</a>.
</div>
</div>
2024-08-25 22:56:19 +00:00
2024-09-12 13:15:20 +00:00
</div>
</footer>
2024-08-25 22:56:19 +00:00
2024-09-12 13:15:20 +00:00
<!-- Bootstrap core JavaScript
================================================== -->
<!-- Placed at the end of the document so the pages load faster -->
<script src="https://cdn.jsdelivr.net/npm/@popperjs/core@2.11.6/dist/umd/popper.min.js" integrity="sha384-oBqDVmMz9ATKxIep9tiCxS/Z9fNfEXiDAYTujMAeBAsjFuCZSmKbSSUnQlmh/jp3" crossorigin="anonymous"></script>
<script src="https://cdn.jsdelivr.net/npm/bootstrap@5.2.3/dist/js/bootstrap.bundle.min.js" integrity="sha384-kenU1KFdBIe4zVF0s0G1M5b4hcpxyD9F7jL+jjXkk+Q2h455rYXK/7HAuoJl+0I4" crossorigin="anonymous"></script>
2024-08-25 22:56:19 +00:00
<!-- TODO: Find other ways to setup analytics
2024-09-12 13:15:20 +00:00
<script data-goatcounter="https://analytics.anarc.at/count" async src="//analytics.anarc.at/count.js"></script>
<noscript>
<img src="https://analytics.anarc.at/count?p=ikiwiki/directive&t=directive" alt="tracking pixel to count visitors when Javascript is disabled" />
</noscript>
2024-08-25 22:56:19 +00:00
-->
2024-09-12 13:15:20 +00:00
</body>
2024-08-25 22:56:19 +00:00
</html>