mw-ui/docs/codox/mw-ui.util.html

9 lines
6.5 KiB
HTML
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!DOCTYPE html PUBLIC ""
"">
<html><head><meta charset="UTF-8" /><title>mw-ui.util documentation</title><link rel="stylesheet" type="text/css" href="css/default.css" /><link rel="stylesheet" type="text/css" href="css/highlight.css" /><script type="text/javascript" src="js/highlight.min.js"></script><script type="text/javascript" src="js/jquery.min.js"></script><script type="text/javascript" src="js/page_effects.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body><div id="header"><h2>Generated by <a href="https://github.com/weavejester/codox">Codox</a></h2><h1><a href="index.html"><span class="project-title"><span class="project-name">Mw-ui</span> <span class="project-version">0.2.0-SNAPSHOT</span></span></a></h1></div><div class="sidebar primary"><h3 class="no-link"><span class="inner">Project</span></h3><ul class="index-link"><li class="depth-1 "><a href="index.html"><div class="inner">Index</div></a></li></ul><h3 class="no-link"><span class="inner">Namespaces</span></h3><ul><li class="depth-1"><div class="no-link"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>mw-ui</span></div></div></li><li class="depth-2 branch"><a href="mw-ui.handler.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>handler</span></div></a></li><li class="depth-2 branch"><a href="mw-ui.layout.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>layout</span></div></a></li><li class="depth-2 branch"><a href="mw-ui.middleware.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>middleware</span></div></a></li><li class="depth-2 branch"><a href="mw-ui.render-world.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>render-world</span></div></a></li><li class="depth-2 branch"><a href="mw-ui.repl.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>repl</span></div></a></li><li class="depth-2"><div class="no-link"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>routes</span></div></div></li><li class="depth-3 branch"><a href="mw-ui.routes.home.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>home</span></div></a></li><li class="depth-3 branch"><a href="mw-ui.routes.load.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>load</span></div></a></li><li class="depth-3 branch"><a href="mw-ui.routes.params.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>params</span></div></a></li><li class="depth-3 branch"><a href="mw-ui.routes.rules.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>rules</span></div></a></li><li class="depth-3"><a href="mw-ui.routes.save.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>save</span></div></a></li><li class="depth-2 current"><a href="mw-ui.util.html"><div class="inner"><span class="tree" style="top: -176px;"><span class="top" style="height: 185px;"></span><span class="bottom"></span></span><span>util</span></div></a></li></ul></div><div class="sidebar secondary"><h3><a href="#top"><span class="inner">Public Vars</span></a></h3><ul><li class="depth-1"><a href="mw-ui.util.html#var-cache-seq-match"><div class="inner"><span>cache-seq-match</span></div></a></li><li class="depth-1"><a href="mw-ui.util.html#var-compile-time-resources"><div class="inner"><span>compile-time-resources</span></div></a></li><li class="depth-1"><a href="mw-ui.util.html#var-list-resources"><div class="inner"><span>list-resources</span></div></a></li><li class="depth-1"><a href="mw-ui.util.html#var-md-.3Ehtml"><div class="inner"><span>md-&gt;html</span></div></a></li><li class="depth-1"><a href="mw-ui.util.html#var-running-from-filesystem"><div class="inner"><span>running-from-filesystem</span></div></a></li></ul></div><div class="namespace-docs" id="content"><h1 class="anchor" id="top">mw-ui.util</h1><div class="doc"><div class="markdown"><p>Utility functions used by other namespaces in this package.</p>
</div></div><div class="public anchor" id="var-cache-seq-match"><h3>cache-seq-match</h3><div class="usage"><code>(cache-seq-match path pattern)</code></div><div class="doc"><div class="markdown"><p>Do the same processing that list-resources does on names fetched from the file system, except on the resource list cached at compile time.</p>
</div></div><div class="src-link"><a href="https://github.com/simon-brooke/mw-ui/blob/master/src/mw_ui/util.clj#L60">view source</a></div></div><div class="public anchor" id="var-compile-time-resources"><h3>compile-time-resources</h3><div class="usage"></div><div class="doc"><div class="markdown"><p>The resources which were visible at compile time. If we are running from a JAR file, it is highly likely that these are all the resources available at run time.</p>
</div></div><div class="src-link"><a href="https://github.com/simon-brooke/mw-ui/blob/master/src/mw_ui/util.clj#L39">view source</a></div></div><div class="public anchor" id="var-list-resources"><h3>list-resources</h3><div class="usage"><code>(list-resources directory pattern)</code></div><div class="doc"><div class="markdown"><p>List resource files matching <code>pattern</code> in <code>directory</code>.</p>
</div></div><div class="src-link"><a href="https://github.com/simon-brooke/mw-ui/blob/master/src/mw_ui/util.clj#L74">view source</a></div></div><div class="public anchor" id="var-md-.3Ehtml"><h3>md-&gt;html</h3><div class="usage"><code>(md-&gt;html filename)</code></div><div class="doc"><div class="markdown"><p>reads a markdown file from public/md and returns an HTML string</p>
</div></div><div class="src-link"><a href="https://github.com/simon-brooke/mw-ui/blob/master/src/mw_ui/util.clj#L52">view source</a></div></div><div class="public anchor" id="var-running-from-filesystem"><h3>running-from-filesystem</h3><div class="usage"></div><div class="doc"><div class="markdown"><p>We assume were running from the filesystem unless we find were not.</p>
</div></div><div class="src-link"><a href="https://github.com/simon-brooke/mw-ui/blob/master/src/mw_ui/util.clj#L34">view source</a></div></div></div></body></html>