14 lines
9.6 KiB
HTML
14 lines
9.6 KiB
HTML
<!DOCTYPE html PUBLIC ""
|
|
"">
|
|
<html><head><meta charset="UTF-8" /><title>Mw-ui 0.2.0-SNAPSHOT</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 current"><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"><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="namespace-index" id="content"><h1><span class="project-title"><span class="project-name">Mw-ui</span> <span class="project-version">0.2.0-SNAPSHOT</span></span></h1><div class="doc"><p>Web-based user interface for MicroWorld.</p></div><h2>Installation</h2><p>To install, add the following dependency to your project or build file:</p><pre class="deps">[mw-ui "0.2.0-SNAPSHOT"]</pre><h2>Namespaces</h2><div class="namespace"><h3><a href="mw-ui.handler.html">mw-ui.handler</a></h3><div class="doc"><div class="markdown"><p>Set up and tear down the request handler.</p>
|
|
</div></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="mw-ui.handler.html#var-app">app</a> </li><li> <a href="mw-ui.handler.html#var-app-routes">app-routes</a> </li><li> <a href="mw-ui.handler.html#var-destroy">destroy</a> </li><li> <a href="mw-ui.handler.html#var-init">init</a> </li></ul></div></div><div class="namespace"><h3><a href="mw-ui.layout.html">mw-ui.layout</a></h3><div class="doc"><div class="markdown"><p>Layout content as HTML.</p>
|
|
</div></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="mw-ui.layout.html#var-render">render</a> </li><li> <a href="mw-ui.layout.html#var-template-path">template-path</a> </li></ul></div></div><div class="namespace"><h3><a href="mw-ui.middleware.html">mw-ui.middleware</a></h3><div class="doc"><div class="markdown"><p>In truth, boilerplate from Luminus.</p>
|
|
</div></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="mw-ui.middleware.html#var-development-middleware">development-middleware</a> </li><li> <a href="mw-ui.middleware.html#var-load-middleware">load-middleware</a> </li><li> <a href="mw-ui.middleware.html#var-log-request">log-request</a> </li><li> <a href="mw-ui.middleware.html#var-production-middleware">production-middleware</a> </li></ul></div></div><div class="namespace"><h3><a href="mw-ui.render-world.html">mw-ui.render-world</a></h3><div class="doc"><div class="markdown"><p>Render the state of the world as an HTML table.</p>
|
|
</div></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="mw-ui.render-world.html#var-format-css-class">format-css-class</a> </li><li> <a href="mw-ui.render-world.html#var-format-image-path">format-image-path</a> </li><li> <a href="mw-ui.render-world.html#var-format-mouseover">format-mouseover</a> </li><li> <a href="mw-ui.render-world.html#var-render-cell">render-cell</a> </li><li> <a href="mw-ui.render-world.html#var-render-inspector">render-inspector</a> </li><li> <a href="mw-ui.render-world.html#var-render-world-row">render-world-row</a> </li><li> <a href="mw-ui.render-world.html#var-render-world-table">render-world-table</a> </li></ul></div></div><div class="namespace"><h3><a href="mw-ui.repl.html">mw-ui.repl</a></h3><div class="doc"><div class="markdown"><p>In truth, boilerplate from Luminus.</p>
|
|
</div></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="mw-ui.repl.html#var--main">-main</a> </li><li> <a href="mw-ui.repl.html#var-get-handler">get-handler</a> </li><li> <a href="mw-ui.repl.html#var-server">server</a> </li><li> <a href="mw-ui.repl.html#var-start-server">start-server</a> </li><li> <a href="mw-ui.repl.html#var-stop-server">stop-server</a> </li></ul></div></div><div class="namespace"><h3><a href="mw-ui.routes.home.html">mw-ui.routes.home</a></h3><div class="doc"><div class="markdown"><p>Routes which serve the main pages of the application.</p>
|
|
</div></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="mw-ui.routes.home.html#var-about-page">about-page</a> </li><li> <a href="mw-ui.routes.home.html#var-docs-page">docs-page</a> </li><li> <a href="mw-ui.routes.home.html#var-home-page">home-page</a> </li><li> <a href="mw-ui.routes.home.html#var-home-routes">home-routes</a> </li><li> <a href="mw-ui.routes.home.html#var-inspect-page">inspect-page</a> </li><li> <a href="mw-ui.routes.home.html#var-list-states">list-states</a> </li><li> <a href="mw-ui.routes.home.html#var-md-page">md-page</a> </li><li> <a href="mw-ui.routes.home.html#var-world-page">world-page</a> </li></ul></div></div><div class="namespace"><h3><a href="mw-ui.routes.load.html">mw-ui.routes.load</a></h3><div class="doc"><div class="markdown"><p>Route which handles the upload of worlds/rules from the client.</p>
|
|
</div></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="mw-ui.routes.load.html#var-load-page">load-page</a> </li></ul></div></div><div class="namespace"><h3><a href="mw-ui.routes.params.html">mw-ui.routes.params</a></h3><div class="doc"><div class="markdown"><p>Route which serves and handles the parameters page.</p>
|
|
</div></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="mw-ui.routes.params.html#var-params-page">params-page</a> </li></ul></div></div><div class="namespace"><h3><a href="mw-ui.routes.rules.html">mw-ui.routes.rules</a></h3><div class="doc"><div class="markdown"><p>Route which serves and handles the rules page.</p>
|
|
</div></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="mw-ui.routes.rules.html#var-process-rules-request">process-rules-request</a> </li><li> <a href="mw-ui.routes.rules.html#var-rules-page">rules-page</a> </li></ul></div></div><div class="namespace"><h3><a href="mw-ui.routes.save.html">mw-ui.routes.save</a></h3><div class="doc"><div class="markdown"><p>Route which handles the saving of world state the client.</p>
|
|
</div></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="mw-ui.routes.save.html#var-save-page">save-page</a> </li></ul></div></div><div class="namespace"><h3><a href="mw-ui.util.html">mw-ui.util</a></h3><div class="doc"><div class="markdown"><p>Utility functions used by other namespaces in this package.</p>
|
|
</div></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="mw-ui.util.html#var-cache-seq-match">cache-seq-match</a> </li><li> <a href="mw-ui.util.html#var-compile-time-resources">compile-time-resources</a> </li><li> <a href="mw-ui.util.html#var-list-resources">list-resources</a> </li><li> <a href="mw-ui.util.html#var-md-.3Ehtml">md->html</a> </li><li> <a href="mw-ui.util.html#var-running-from-filesystem">running-from-filesystem</a> </li></ul></div></div></div></body></html> |