<!DOCTYPE html> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <title>admonition (third party plugin)</title> <meta name="viewport" content="width=device-width, initial-scale=1" /> <link rel="stylesheet" href="../../style.css" type="text/css" /> <link rel="stylesheet" href="../../local.css" type="text/css" /> <meta name="author" content="anarcat" /> </head> <body> <div class="page"> <div class="pageheader"> <div class="header"> <span> <span class="parentlinks"> <a href="../../index.html">ikiwiki</a>/ <a href="../../plugins.html">plugins</a>/ <a href="../contrib.html">contrib</a>/ </span> <span class="title"> admonition (third party plugin) </span> </span> </div> </div> <div id="pagebody"> <div id="content" role="main"> <p><span class="infobox"> Plugin: admonition<br /> Author: <span class="createlink">anarcat</span><br /> Included in ikiwiki: no<br /> Enabled by default: no<br /> Included in <a href="../goodstuff.html">goodstuff</a>: no<br /> Currently enabled: no<br /> </span></p> <h1>Admonitions</h1> <p>This plugin adds directives that allow users to outline certain sections of text using a custom style sheet and bright icons.</p> <p>5 directives are available:</p> <ul> <li><span class="createlink">tip</span></li> <li><span class="createlink">note</span></li> <li><span class="createlink">important</span></li> <li><span class="createlink">caution</span></li> <li><span class="createlink">warning</span></li> </ul> <p>Or, in Ikiwiki markup:</p> <pre><code>[[!tip "Lorem ipsum dolor sit amet, consectetuer adipiscing elit."]] [[!note "Vivamus id enim."]] [[!important "In id erat non orci commodo lobortis."]] [[!caution "In id erat non orci commodo lobortis."]] [[!warning "Phasellus neque orci, porta a, aliquet quis, semper a, massa."]] </code></pre> <p>Those directives simply create a <code><div></code> elements in the right style. So the above can also be simply written as:</p> <pre><code><div class="tip">Lorem ipsum dolor sit amet, consectetuer adipiscing elit.</div> <div class="note">Vivamus id enim.</div> <div class="important">In id erat non orci commodo lobortis.</div> <div class="caution">In id erat non orci commodo lobortis.</div> <div class="warning">Phasellus neque orci, porta a, aliquet quis, semper a, massa.</div> </code></pre> <h1>Rationale</h1> <p>The idea behind the directives is to make the the CSS elements easier to discover through the builtin documentation. Obviously, more admonitions can be created simply by adding similar icons and CSS elements. Of course, you will not get the above directives expanded automatically unless you patch the admonition plugin, unfortunately.</p> <h1>Code</h1> <div class="infobox"> Available in a <a href="../../git.html">git</a> repository <a href="../../branches.html">branch</a>.<br /> Branch: anarcat/admonitions<br /> Author: <span class="createlink">anarcat</span><br /> </div> <p>The <a href="../../patch.html">patch</a> is available from <a href="http://src.anarc.at/ikiwiki.git/shortlog/refs/heads/admonitions">anarcat's "admonition" branch</a> and is designed to be merged in Ikiwiki directly:</p> <pre><code>git clone -b admonitions git://src.anarc.at/ikiwiki.git </code></pre> <p>See also <span class="createlink">admonitions</span> for the discussion leading to the creation of this plugin.</p> </div> </div> <div id="footer" class="pagefooter" role="contentinfo"> <div id="pageinfo"> <div class="tags"> Tags: <a href="../../branches.html" rel="tag">branches</a> <a href="../../git.html" rel="tag">git</a> <a href="../../patch.html" rel="tag">patch</a> <a href="../type/chrome.html" rel="tag">type/chrome</a> </div> <div class="pagedate"> Last edited <span class="date">Tue Feb 26 23:01:54 2019</span> <!-- Created <span class="date">Tue Feb 26 23:01:54 2019</span> --> </div> </div> <!-- from ikiwiki --> </div> </div> </body> </html>