Mainly code tidyup, also documentation.
This commit is contained in:
parent
04ce4d7f83
commit
357f4f53d4
31 changed files with 3732 additions and 17 deletions
551
docs/codox/css/default.css
Normal file
551
docs/codox/css/default.css
Normal file
|
|
@ -0,0 +1,551 @@
|
|||
body {
|
||||
font-family: Helvetica, Arial, sans-serif;
|
||||
font-size: 15px;
|
||||
}
|
||||
|
||||
pre, code {
|
||||
font-family: Monaco, DejaVu Sans Mono, Consolas, monospace;
|
||||
font-size: 9pt;
|
||||
margin: 15px 0;
|
||||
}
|
||||
|
||||
h1 {
|
||||
font-weight: normal;
|
||||
font-size: 29px;
|
||||
margin: 10px 0 2px 0;
|
||||
padding: 0;
|
||||
}
|
||||
|
||||
h2 {
|
||||
font-weight: normal;
|
||||
font-size: 25px;
|
||||
}
|
||||
|
||||
h5.license {
|
||||
margin: 9px 0 22px 0;
|
||||
color: #555;
|
||||
font-weight: normal;
|
||||
font-size: 12px;
|
||||
font-style: italic;
|
||||
}
|
||||
|
||||
.document h1, .namespace-index h1 {
|
||||
font-size: 32px;
|
||||
margin-top: 12px;
|
||||
}
|
||||
|
||||
#header, #content, .sidebar {
|
||||
position: fixed;
|
||||
}
|
||||
|
||||
#header {
|
||||
top: 0;
|
||||
left: 0;
|
||||
right: 0;
|
||||
height: 22px;
|
||||
color: #f5f5f5;
|
||||
padding: 5px 7px;
|
||||
}
|
||||
|
||||
#content {
|
||||
top: 32px;
|
||||
right: 0;
|
||||
bottom: 0;
|
||||
overflow: auto;
|
||||
background: #fff;
|
||||
color: #333;
|
||||
padding: 0 18px;
|
||||
}
|
||||
|
||||
.sidebar {
|
||||
position: fixed;
|
||||
top: 32px;
|
||||
bottom: 0;
|
||||
overflow: auto;
|
||||
}
|
||||
|
||||
.sidebar.primary {
|
||||
background: #e2e2e2;
|
||||
border-right: solid 1px #cccccc;
|
||||
left: 0;
|
||||
width: 250px;
|
||||
}
|
||||
|
||||
.sidebar.secondary {
|
||||
background: #f2f2f2;
|
||||
border-right: solid 1px #d7d7d7;
|
||||
left: 251px;
|
||||
width: 200px;
|
||||
}
|
||||
|
||||
#content.namespace-index, #content.document {
|
||||
left: 251px;
|
||||
}
|
||||
|
||||
#content.namespace-docs {
|
||||
left: 452px;
|
||||
}
|
||||
|
||||
#content.document {
|
||||
padding-bottom: 10%;
|
||||
}
|
||||
|
||||
#header {
|
||||
background: #3f3f3f;
|
||||
box-shadow: 0 0 8px rgba(0, 0, 0, 0.4);
|
||||
z-index: 100;
|
||||
}
|
||||
|
||||
#header h1 {
|
||||
margin: 0;
|
||||
padding: 0;
|
||||
font-size: 18px;
|
||||
font-weight: lighter;
|
||||
text-shadow: -1px -1px 0px #333;
|
||||
}
|
||||
|
||||
#header h1 .project-version {
|
||||
font-weight: normal;
|
||||
}
|
||||
|
||||
.project-version {
|
||||
padding-left: 0.15em;
|
||||
}
|
||||
|
||||
#header a, .sidebar a {
|
||||
display: block;
|
||||
text-decoration: none;
|
||||
}
|
||||
|
||||
#header a {
|
||||
color: #f5f5f5;
|
||||
}
|
||||
|
||||
.sidebar a {
|
||||
color: #333;
|
||||
}
|
||||
|
||||
#header h2 {
|
||||
float: right;
|
||||
font-size: 9pt;
|
||||
font-weight: normal;
|
||||
margin: 4px 3px;
|
||||
padding: 0;
|
||||
color: #bbb;
|
||||
}
|
||||
|
||||
#header h2 a {
|
||||
display: inline;
|
||||
}
|
||||
|
||||
.sidebar h3 {
|
||||
margin: 0;
|
||||
padding: 10px 13px 0 13px;
|
||||
font-size: 19px;
|
||||
font-weight: lighter;
|
||||
}
|
||||
|
||||
.sidebar h3 a {
|
||||
color: #444;
|
||||
}
|
||||
|
||||
.sidebar h3.no-link {
|
||||
color: #636363;
|
||||
}
|
||||
|
||||
.sidebar ul {
|
||||
padding: 7px 0 6px 0;
|
||||
margin: 0;
|
||||
}
|
||||
|
||||
.sidebar ul.index-link {
|
||||
padding-bottom: 4px;
|
||||
}
|
||||
|
||||
.sidebar li {
|
||||
display: block;
|
||||
vertical-align: middle;
|
||||
}
|
||||
|
||||
.sidebar li a, .sidebar li .no-link {
|
||||
border-left: 3px solid transparent;
|
||||
padding: 0 10px;
|
||||
white-space: nowrap;
|
||||
}
|
||||
|
||||
.sidebar li .no-link {
|
||||
display: block;
|
||||
color: #777;
|
||||
font-style: italic;
|
||||
}
|
||||
|
||||
.sidebar li .inner {
|
||||
display: inline-block;
|
||||
padding-top: 7px;
|
||||
height: 24px;
|
||||
}
|
||||
|
||||
.sidebar li a, .sidebar li .tree {
|
||||
height: 31px;
|
||||
}
|
||||
|
||||
.depth-1 .inner { padding-left: 2px; }
|
||||
.depth-2 .inner { padding-left: 6px; }
|
||||
.depth-3 .inner { padding-left: 20px; }
|
||||
.depth-4 .inner { padding-left: 34px; }
|
||||
.depth-5 .inner { padding-left: 48px; }
|
||||
.depth-6 .inner { padding-left: 62px; }
|
||||
|
||||
.sidebar li .tree {
|
||||
display: block;
|
||||
float: left;
|
||||
position: relative;
|
||||
top: -10px;
|
||||
margin: 0 4px 0 0;
|
||||
padding: 0;
|
||||
}
|
||||
|
||||
.sidebar li.depth-1 .tree {
|
||||
display: none;
|
||||
}
|
||||
|
||||
.sidebar li .tree .top, .sidebar li .tree .bottom {
|
||||
display: block;
|
||||
margin: 0;
|
||||
padding: 0;
|
||||
width: 7px;
|
||||
}
|
||||
|
||||
.sidebar li .tree .top {
|
||||
border-left: 1px solid #aaa;
|
||||
border-bottom: 1px solid #aaa;
|
||||
height: 19px;
|
||||
}
|
||||
|
||||
.sidebar li .tree .bottom {
|
||||
height: 22px;
|
||||
}
|
||||
|
||||
.sidebar li.branch .tree .bottom {
|
||||
border-left: 1px solid #aaa;
|
||||
}
|
||||
|
||||
.sidebar.primary li.current a {
|
||||
border-left: 3px solid #a33;
|
||||
color: #a33;
|
||||
}
|
||||
|
||||
.sidebar.secondary li.current a {
|
||||
border-left: 3px solid #33a;
|
||||
color: #33a;
|
||||
}
|
||||
|
||||
.namespace-index h2 {
|
||||
margin: 30px 0 0 0;
|
||||
}
|
||||
|
||||
.namespace-index h3 {
|
||||
font-size: 16px;
|
||||
font-weight: bold;
|
||||
margin-bottom: 0;
|
||||
}
|
||||
|
||||
.namespace-index .topics {
|
||||
padding-left: 30px;
|
||||
margin: 11px 0 0 0;
|
||||
}
|
||||
|
||||
.namespace-index .topics li {
|
||||
padding: 5px 0;
|
||||
}
|
||||
|
||||
.namespace-docs h3 {
|
||||
font-size: 18px;
|
||||
font-weight: bold;
|
||||
}
|
||||
|
||||
.public h3 {
|
||||
margin: 0;
|
||||
float: left;
|
||||
}
|
||||
|
||||
.usage {
|
||||
clear: both;
|
||||
}
|
||||
|
||||
.public {
|
||||
margin: 0;
|
||||
border-top: 1px solid #e0e0e0;
|
||||
padding-top: 14px;
|
||||
padding-bottom: 6px;
|
||||
}
|
||||
|
||||
.public:last-child {
|
||||
margin-bottom: 20%;
|
||||
}
|
||||
|
||||
.members .public:last-child {
|
||||
margin-bottom: 0;
|
||||
}
|
||||
|
||||
.members {
|
||||
margin: 15px 0;
|
||||
}
|
||||
|
||||
.members h4 {
|
||||
color: #555;
|
||||
font-weight: normal;
|
||||
font-variant: small-caps;
|
||||
margin: 0 0 5px 0;
|
||||
}
|
||||
|
||||
.members .inner {
|
||||
padding-top: 5px;
|
||||
padding-left: 12px;
|
||||
margin-top: 2px;
|
||||
margin-left: 7px;
|
||||
border-left: 1px solid #bbb;
|
||||
}
|
||||
|
||||
#content .members .inner h3 {
|
||||
font-size: 12pt;
|
||||
}
|
||||
|
||||
.members .public {
|
||||
border-top: none;
|
||||
margin-top: 0;
|
||||
padding-top: 6px;
|
||||
padding-bottom: 0;
|
||||
}
|
||||
|
||||
.members .public:first-child {
|
||||
padding-top: 0;
|
||||
}
|
||||
|
||||
h4.type,
|
||||
h4.dynamic,
|
||||
h4.added,
|
||||
h4.deprecated {
|
||||
float: left;
|
||||
margin: 3px 10px 15px 0;
|
||||
font-size: 15px;
|
||||
font-weight: bold;
|
||||
font-variant: small-caps;
|
||||
}
|
||||
|
||||
.public h4.type,
|
||||
.public h4.dynamic,
|
||||
.public h4.added,
|
||||
.public h4.deprecated {
|
||||
font-size: 13px;
|
||||
font-weight: bold;
|
||||
margin: 3px 0 0 10px;
|
||||
}
|
||||
|
||||
.members h4.type,
|
||||
.members h4.added,
|
||||
.members h4.deprecated {
|
||||
margin-top: 1px;
|
||||
}
|
||||
|
||||
h4.type {
|
||||
color: #717171;
|
||||
}
|
||||
|
||||
h4.dynamic {
|
||||
color: #9933aa;
|
||||
}
|
||||
|
||||
h4.added {
|
||||
color: #508820;
|
||||
}
|
||||
|
||||
h4.deprecated {
|
||||
color: #880000;
|
||||
}
|
||||
|
||||
.namespace {
|
||||
margin-bottom: 30px;
|
||||
}
|
||||
|
||||
.namespace:last-child {
|
||||
margin-bottom: 10%;
|
||||
}
|
||||
|
||||
.index {
|
||||
padding: 0;
|
||||
font-size: 80%;
|
||||
margin: 15px 0;
|
||||
line-height: 16px;
|
||||
}
|
||||
|
||||
.index * {
|
||||
display: inline;
|
||||
}
|
||||
|
||||
.index p {
|
||||
padding-right: 3px;
|
||||
}
|
||||
|
||||
.index li {
|
||||
padding-right: 5px;
|
||||
}
|
||||
|
||||
.index ul {
|
||||
padding-left: 0;
|
||||
}
|
||||
|
||||
.type-sig {
|
||||
clear: both;
|
||||
color: #088;
|
||||
}
|
||||
|
||||
.type-sig pre {
|
||||
padding-top: 10px;
|
||||
margin: 0;
|
||||
}
|
||||
|
||||
.usage code {
|
||||
display: block;
|
||||
color: #008;
|
||||
margin: 2px 0;
|
||||
}
|
||||
|
||||
.usage code:first-child {
|
||||
padding-top: 10px;
|
||||
}
|
||||
|
||||
p {
|
||||
margin: 15px 0;
|
||||
}
|
||||
|
||||
.public p:first-child, .public pre.plaintext {
|
||||
margin-top: 12px;
|
||||
}
|
||||
|
||||
.doc {
|
||||
margin: 0 0 26px 0;
|
||||
clear: both;
|
||||
}
|
||||
|
||||
.public .doc {
|
||||
margin: 0;
|
||||
}
|
||||
|
||||
.namespace-index .doc {
|
||||
margin-bottom: 20px;
|
||||
}
|
||||
|
||||
.namespace-index .namespace .doc {
|
||||
margin-bottom: 10px;
|
||||
}
|
||||
|
||||
.markdown p, .markdown li, .markdown dt, .markdown dd, .markdown td {
|
||||
line-height: 22px;
|
||||
}
|
||||
|
||||
.markdown li {
|
||||
padding: 2px 0;
|
||||
}
|
||||
|
||||
.markdown h2 {
|
||||
font-weight: normal;
|
||||
font-size: 25px;
|
||||
margin: 30px 0 10px 0;
|
||||
}
|
||||
|
||||
.markdown h3 {
|
||||
font-weight: normal;
|
||||
font-size: 20px;
|
||||
margin: 30px 0 0 0;
|
||||
}
|
||||
|
||||
.markdown h4 {
|
||||
font-size: 15px;
|
||||
margin: 22px 0 -4px 0;
|
||||
}
|
||||
|
||||
.doc, .public, .namespace .index {
|
||||
max-width: 680px;
|
||||
overflow-x: visible;
|
||||
}
|
||||
|
||||
.markdown pre > code {
|
||||
display: block;
|
||||
padding: 10px;
|
||||
}
|
||||
|
||||
.markdown pre > code, .src-link a {
|
||||
border: 1px solid #e4e4e4;
|
||||
border-radius: 2px;
|
||||
}
|
||||
|
||||
.markdown code:not(.hljs), .src-link a {
|
||||
background: #f6f6f6;
|
||||
}
|
||||
|
||||
pre.deps {
|
||||
display: inline-block;
|
||||
margin: 0 10px;
|
||||
border: 1px solid #e4e4e4;
|
||||
border-radius: 2px;
|
||||
padding: 10px;
|
||||
background-color: #f6f6f6;
|
||||
}
|
||||
|
||||
.markdown hr {
|
||||
border-style: solid;
|
||||
border-top: none;
|
||||
color: #ccc;
|
||||
}
|
||||
|
||||
.doc ul, .doc ol {
|
||||
padding-left: 30px;
|
||||
}
|
||||
|
||||
.doc table {
|
||||
border-collapse: collapse;
|
||||
margin: 0 10px;
|
||||
}
|
||||
|
||||
.doc table td, .doc table th {
|
||||
border: 1px solid #dddddd;
|
||||
padding: 4px 6px;
|
||||
}
|
||||
|
||||
.doc table th {
|
||||
background: #f2f2f2;
|
||||
}
|
||||
|
||||
.doc dl {
|
||||
margin: 0 10px 20px 10px;
|
||||
}
|
||||
|
||||
.doc dl dt {
|
||||
font-weight: bold;
|
||||
margin: 0;
|
||||
padding: 3px 0;
|
||||
border-bottom: 1px solid #ddd;
|
||||
}
|
||||
|
||||
.doc dl dd {
|
||||
padding: 5px 0;
|
||||
margin: 0 0 5px 10px;
|
||||
}
|
||||
|
||||
.doc abbr {
|
||||
border-bottom: 1px dotted #333;
|
||||
font-variant: none;
|
||||
cursor: help;
|
||||
}
|
||||
|
||||
.src-link {
|
||||
margin-bottom: 15px;
|
||||
}
|
||||
|
||||
.src-link a {
|
||||
font-size: 70%;
|
||||
padding: 1px 4px;
|
||||
text-decoration: none;
|
||||
color: #5555bb;
|
||||
}
|
||||
97
docs/codox/css/highlight.css
Normal file
97
docs/codox/css/highlight.css
Normal file
|
|
@ -0,0 +1,97 @@
|
|||
/*
|
||||
github.com style (c) Vasily Polovnyov <vast@whiteants.net>
|
||||
*/
|
||||
|
||||
.hljs {
|
||||
display: block;
|
||||
overflow-x: auto;
|
||||
padding: 0.5em;
|
||||
color: #333;
|
||||
background: #f8f8f8;
|
||||
}
|
||||
|
||||
.hljs-comment,
|
||||
.hljs-quote {
|
||||
color: #998;
|
||||
font-style: italic;
|
||||
}
|
||||
|
||||
.hljs-keyword,
|
||||
.hljs-selector-tag,
|
||||
.hljs-subst {
|
||||
color: #333;
|
||||
font-weight: bold;
|
||||
}
|
||||
|
||||
.hljs-number,
|
||||
.hljs-literal,
|
||||
.hljs-variable,
|
||||
.hljs-template-variable,
|
||||
.hljs-tag .hljs-attr {
|
||||
color: #008080;
|
||||
}
|
||||
|
||||
.hljs-string,
|
||||
.hljs-doctag {
|
||||
color: #d14;
|
||||
}
|
||||
|
||||
.hljs-title,
|
||||
.hljs-section,
|
||||
.hljs-selector-id {
|
||||
color: #900;
|
||||
font-weight: bold;
|
||||
}
|
||||
|
||||
.hljs-subst {
|
||||
font-weight: normal;
|
||||
}
|
||||
|
||||
.hljs-type,
|
||||
.hljs-class .hljs-title {
|
||||
color: #458;
|
||||
font-weight: bold;
|
||||
}
|
||||
|
||||
.hljs-tag,
|
||||
.hljs-name,
|
||||
.hljs-attribute {
|
||||
color: #000080;
|
||||
font-weight: normal;
|
||||
}
|
||||
|
||||
.hljs-regexp,
|
||||
.hljs-link {
|
||||
color: #009926;
|
||||
}
|
||||
|
||||
.hljs-symbol,
|
||||
.hljs-bullet {
|
||||
color: #990073;
|
||||
}
|
||||
|
||||
.hljs-built_in,
|
||||
.hljs-builtin-name {
|
||||
color: #0086b3;
|
||||
}
|
||||
|
||||
.hljs-meta {
|
||||
color: #999;
|
||||
font-weight: bold;
|
||||
}
|
||||
|
||||
.hljs-deletion {
|
||||
background: #fdd;
|
||||
}
|
||||
|
||||
.hljs-addition {
|
||||
background: #dfd;
|
||||
}
|
||||
|
||||
.hljs-emphasis {
|
||||
font-style: italic;
|
||||
}
|
||||
|
||||
.hljs-strong {
|
||||
font-weight: bold;
|
||||
}
|
||||
14
docs/codox/index.html
Normal file
14
docs/codox/index.html
Normal file
|
|
@ -0,0 +1,14 @@
|
|||
<!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>
|
||||
2
docs/codox/js/highlight.min.js
vendored
Normal file
2
docs/codox/js/highlight.min.js
vendored
Normal file
File diff suppressed because one or more lines are too long
4
docs/codox/js/jquery.min.js
vendored
Normal file
4
docs/codox/js/jquery.min.js
vendored
Normal file
File diff suppressed because one or more lines are too long
112
docs/codox/js/page_effects.js
Normal file
112
docs/codox/js/page_effects.js
Normal file
|
|
@ -0,0 +1,112 @@
|
|||
function visibleInParent(element) {
|
||||
var position = $(element).position().top
|
||||
return position > -50 && position < ($(element).offsetParent().height() - 50)
|
||||
}
|
||||
|
||||
function hasFragment(link, fragment) {
|
||||
return $(link).attr("href").indexOf("#" + fragment) != -1
|
||||
}
|
||||
|
||||
function findLinkByFragment(elements, fragment) {
|
||||
return $(elements).filter(function(i, e) { return hasFragment(e, fragment)}).first()
|
||||
}
|
||||
|
||||
function scrollToCurrentVarLink(elements) {
|
||||
var elements = $(elements);
|
||||
var parent = elements.offsetParent();
|
||||
|
||||
if (elements.length == 0) return;
|
||||
|
||||
var top = elements.first().position().top;
|
||||
var bottom = elements.last().position().top + elements.last().height();
|
||||
|
||||
if (top >= 0 && bottom <= parent.height()) return;
|
||||
|
||||
if (top < 0) {
|
||||
parent.scrollTop(parent.scrollTop() + top);
|
||||
}
|
||||
else if (bottom > parent.height()) {
|
||||
parent.scrollTop(parent.scrollTop() + bottom - parent.height());
|
||||
}
|
||||
}
|
||||
|
||||
function setCurrentVarLink() {
|
||||
$('.secondary a').parent().removeClass('current')
|
||||
$('.anchor').
|
||||
filter(function(index) { return visibleInParent(this) }).
|
||||
each(function(index, element) {
|
||||
findLinkByFragment(".secondary a", element.id).
|
||||
parent().
|
||||
addClass('current')
|
||||
});
|
||||
scrollToCurrentVarLink('.secondary .current');
|
||||
}
|
||||
|
||||
var hasStorage = (function() { try { return localStorage.getItem } catch(e) {} }())
|
||||
|
||||
function scrollPositionId(element) {
|
||||
var directory = window.location.href.replace(/[^\/]+\.html$/, '')
|
||||
return 'scroll::' + $(element).attr('id') + '::' + directory
|
||||
}
|
||||
|
||||
function storeScrollPosition(element) {
|
||||
if (!hasStorage) return;
|
||||
localStorage.setItem(scrollPositionId(element) + "::x", $(element).scrollLeft())
|
||||
localStorage.setItem(scrollPositionId(element) + "::y", $(element).scrollTop())
|
||||
}
|
||||
|
||||
function recallScrollPosition(element) {
|
||||
if (!hasStorage) return;
|
||||
$(element).scrollLeft(localStorage.getItem(scrollPositionId(element) + "::x"))
|
||||
$(element).scrollTop(localStorage.getItem(scrollPositionId(element) + "::y"))
|
||||
}
|
||||
|
||||
function persistScrollPosition(element) {
|
||||
recallScrollPosition(element)
|
||||
$(element).scroll(function() { storeScrollPosition(element) })
|
||||
}
|
||||
|
||||
function sidebarContentWidth(element) {
|
||||
var widths = $(element).find('.inner').map(function() { return $(this).innerWidth() })
|
||||
return Math.max.apply(Math, widths)
|
||||
}
|
||||
|
||||
function calculateSize(width, snap, margin, minimum) {
|
||||
if (width == 0) {
|
||||
return 0
|
||||
}
|
||||
else {
|
||||
return Math.max(minimum, (Math.ceil(width / snap) * snap) + (margin * 2))
|
||||
}
|
||||
}
|
||||
|
||||
function resizeSidebars() {
|
||||
var primaryWidth = sidebarContentWidth('.primary')
|
||||
var secondaryWidth = 0
|
||||
|
||||
if ($('.secondary').length != 0) {
|
||||
secondaryWidth = sidebarContentWidth('.secondary')
|
||||
}
|
||||
|
||||
// snap to grid
|
||||
primaryWidth = calculateSize(primaryWidth, 32, 13, 160)
|
||||
secondaryWidth = calculateSize(secondaryWidth, 32, 13, 160)
|
||||
|
||||
$('.primary').css('width', primaryWidth)
|
||||
$('.secondary').css('width', secondaryWidth).css('left', primaryWidth + 1)
|
||||
|
||||
if (secondaryWidth > 0) {
|
||||
$('#content').css('left', primaryWidth + secondaryWidth + 2)
|
||||
}
|
||||
else {
|
||||
$('#content').css('left', primaryWidth + 1)
|
||||
}
|
||||
}
|
||||
|
||||
$(window).ready(resizeSidebars)
|
||||
$(window).ready(setCurrentVarLink)
|
||||
$(window).ready(function() { persistScrollPosition('.primary')})
|
||||
$(window).ready(function() {
|
||||
$('#content').scroll(setCurrentVarLink)
|
||||
$(window).resize(setCurrentVarLink)
|
||||
})
|
||||
8
docs/codox/mw-ui.handler.html
Normal file
8
docs/codox/mw-ui.handler.html
Normal file
|
|
@ -0,0 +1,8 @@
|
|||
<!DOCTYPE html PUBLIC ""
|
||||
"">
|
||||
<html><head><meta charset="UTF-8" /><title>mw-ui.handler 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 current"><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="sidebar secondary"><h3><a href="#top"><span class="inner">Public Vars</span></a></h3><ul><li class="depth-1"><a href="mw-ui.handler.html#var-app"><div class="inner"><span>app</span></div></a></li><li class="depth-1"><a href="mw-ui.handler.html#var-app-routes"><div class="inner"><span>app-routes</span></div></a></li><li class="depth-1"><a href="mw-ui.handler.html#var-destroy"><div class="inner"><span>destroy</span></div></a></li><li class="depth-1"><a href="mw-ui.handler.html#var-init"><div class="inner"><span>init</span></div></a></li></ul></div><div class="namespace-docs" id="content"><h1 class="anchor" id="top">mw-ui.handler</h1><div class="doc"><div class="markdown"><p>Set up and tear down the request handler.</p>
|
||||
</div></div><div class="public anchor" id="var-app"><h3>app</h3><div class="usage"></div><div class="doc"><div class="markdown"><p><strong>TODO</strong>: write docs</p>
|
||||
</div></div><div class="src-link"><a href="https://github.com/simon-brooke/mw-ui/blob/master/src/mw_ui/handler.clj#L73">view source</a></div></div><div class="public anchor" id="var-app-routes"><h3>app-routes</h3><div class="usage"></div><div class="doc"><div class="markdown"><p><strong>TODO</strong>: write docs</p>
|
||||
</div></div><div class="src-link"><a href="https://github.com/simon-brooke/mw-ui/blob/master/src/mw_ui/handler.clj#L38">view source</a></div></div><div class="public anchor" id="var-destroy"><h3>destroy</h3><div class="usage"><code>(destroy)</code></div><div class="doc"><div class="markdown"><p>destroy will be called when your application shuts down, put any clean up code here</p>
|
||||
</div></div><div class="src-link"><a href="https://github.com/simon-brooke/mw-ui/blob/master/src/mw_ui/handler.clj#L66">view source</a></div></div><div class="public anchor" id="var-init"><h3>init</h3><div class="usage"><code>(init)</code></div><div class="doc"><div class="markdown"><p>init will be called once when app is deployed as a servlet on an app server such as Tomcat put any initialization code here</p>
|
||||
</div></div><div class="src-link"><a href="https://github.com/simon-brooke/mw-ui/blob/master/src/mw_ui/handler.clj#L43">view source</a></div></div></div></body></html>
|
||||
6
docs/codox/mw-ui.layout.html
Normal file
6
docs/codox/mw-ui.layout.html
Normal file
|
|
@ -0,0 +1,6 @@
|
|||
<!DOCTYPE html PUBLIC ""
|
||||
"">
|
||||
<html><head><meta charset="UTF-8" /><title>mw-ui.layout 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 current"><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="sidebar secondary"><h3><a href="#top"><span class="inner">Public Vars</span></a></h3><ul><li class="depth-1"><a href="mw-ui.layout.html#var-render"><div class="inner"><span>render</span></div></a></li><li class="depth-1"><a href="mw-ui.layout.html#var-template-path"><div class="inner"><span>template-path</span></div></a></li></ul></div><div class="namespace-docs" id="content"><h1 class="anchor" id="top">mw-ui.layout</h1><div class="doc"><div class="markdown"><p>Layout content as HTML.</p>
|
||||
</div></div><div class="public anchor" id="var-render"><h3>render</h3><div class="usage"><code>(render template & [params])</code></div><div class="doc"><div class="markdown"><p><strong>TODO</strong>: write docs</p>
|
||||
</div></div><div class="src-link"><a href="https://github.com/simon-brooke/mw-ui/blob/master/src/mw_ui/layout.clj#L49">view source</a></div></div><div class="public anchor" id="var-template-path"><h3>template-path</h3><div class="usage"></div><div class="doc"><div class="markdown"><p><strong>TODO</strong>: write docs</p>
|
||||
</div></div><div class="src-link"><a href="https://github.com/simon-brooke/mw-ui/blob/master/src/mw_ui/layout.clj#L33">view source</a></div></div></div></body></html>
|
||||
8
docs/codox/mw-ui.middleware.html
Normal file
8
docs/codox/mw-ui.middleware.html
Normal file
|
|
@ -0,0 +1,8 @@
|
|||
<!DOCTYPE html PUBLIC ""
|
||||
"">
|
||||
<html><head><meta charset="UTF-8" /><title>mw-ui.middleware 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 current"><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="sidebar secondary"><h3><a href="#top"><span class="inner">Public Vars</span></a></h3><ul><li class="depth-1"><a href="mw-ui.middleware.html#var-development-middleware"><div class="inner"><span>development-middleware</span></div></a></li><li class="depth-1"><a href="mw-ui.middleware.html#var-load-middleware"><div class="inner"><span>load-middleware</span></div></a></li><li class="depth-1"><a href="mw-ui.middleware.html#var-log-request"><div class="inner"><span>log-request</span></div></a></li><li class="depth-1"><a href="mw-ui.middleware.html#var-production-middleware"><div class="inner"><span>production-middleware</span></div></a></li></ul></div><div class="namespace-docs" id="content"><h1 class="anchor" id="top">mw-ui.middleware</h1><div class="doc"><div class="markdown"><p>In truth, boilerplate from Luminus.</p>
|
||||
</div></div><div class="public anchor" id="var-development-middleware"><h3>development-middleware</h3><div class="usage"></div><div class="doc"><div class="markdown"><p><strong>TODO</strong>: write docs</p>
|
||||
</div></div><div class="src-link"><a href="https://github.com/simon-brooke/mw-ui/blob/master/src/mw_ui/middleware.clj#L40">view source</a></div></div><div class="public anchor" id="var-load-middleware"><h3>load-middleware</h3><div class="usage"><code>(load-middleware)</code></div><div class="doc"><div class="markdown"><p><strong>TODO</strong>: write docs</p>
|
||||
</div></div><div class="src-link"><a href="https://github.com/simon-brooke/mw-ui/blob/master/src/mw_ui/middleware.clj#L50">view source</a></div></div><div class="public anchor" id="var-log-request"><h3>log-request</h3><div class="usage"><code>(log-request handler)</code></div><div class="doc"><div class="markdown"><p><strong>TODO</strong>: write docs</p>
|
||||
</div></div><div class="src-link"><a href="https://github.com/simon-brooke/mw-ui/blob/master/src/mw_ui/middleware.clj#L34">view source</a></div></div><div class="public anchor" id="var-production-middleware"><h3>production-middleware</h3><div class="usage"></div><div class="doc"><div class="markdown"><p><strong>TODO</strong>: write docs</p>
|
||||
</div></div><div class="src-link"><a href="https://github.com/simon-brooke/mw-ui/blob/master/src/mw_ui/middleware.clj#L46">view source</a></div></div></div></body></html>
|
||||
11
docs/codox/mw-ui.render-world.html
Normal file
11
docs/codox/mw-ui.render-world.html
Normal file
|
|
@ -0,0 +1,11 @@
|
|||
<!DOCTYPE html PUBLIC ""
|
||||
"">
|
||||
<html><head><meta charset="UTF-8" /><title>mw-ui.render-world 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 current"><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="sidebar secondary"><h3><a href="#top"><span class="inner">Public Vars</span></a></h3><ul><li class="depth-1"><a href="mw-ui.render-world.html#var-format-css-class"><div class="inner"><span>format-css-class</span></div></a></li><li class="depth-1"><a href="mw-ui.render-world.html#var-format-image-path"><div class="inner"><span>format-image-path</span></div></a></li><li class="depth-1"><a href="mw-ui.render-world.html#var-format-mouseover"><div class="inner"><span>format-mouseover</span></div></a></li><li class="depth-1"><a href="mw-ui.render-world.html#var-render-cell"><div class="inner"><span>render-cell</span></div></a></li><li class="depth-1"><a href="mw-ui.render-world.html#var-render-inspector"><div class="inner"><span>render-inspector</span></div></a></li><li class="depth-1"><a href="mw-ui.render-world.html#var-render-world-row"><div class="inner"><span>render-world-row</span></div></a></li><li class="depth-1"><a href="mw-ui.render-world.html#var-render-world-table"><div class="inner"><span>render-world-table</span></div></a></li></ul></div><div class="namespace-docs" id="content"><h1 class="anchor" id="top">mw-ui.render-world</h1><div class="doc"><div class="markdown"><p>Render the state of the world as an HTML table.</p>
|
||||
</div></div><div class="public anchor" id="var-format-css-class"><h3>format-css-class</h3><div class="usage"><code>(format-css-class statekey)</code></div><div class="doc"><div class="markdown"><p>Format this statekey, assumed to be a keyword indicating a state in the world, into a CSS class</p>
|
||||
</div></div><div class="src-link"><a href="https://github.com/simon-brooke/mw-ui/blob/master/src/mw_ui/render_world.clj#L34">view source</a></div></div><div class="public anchor" id="var-format-image-path"><h3>format-image-path</h3><div class="usage"><code>(format-image-path statekey)</code></div><div class="doc"><div class="markdown"><p>Render this statekey, assumed to be a keyword indicating a state in the world, into a path which should recover the corresponding image file.</p>
|
||||
</div></div><div class="src-link"><a href="https://github.com/simon-brooke/mw-ui/blob/master/src/mw_ui/render_world.clj#L41">view source</a></div></div><div class="public anchor" id="var-format-mouseover"><h3>format-mouseover</h3><div class="usage"><code>(format-mouseover cell)</code></div><div class="doc"><div class="markdown"><p><strong>TODO</strong>: write docs</p>
|
||||
</div></div><div class="src-link"><a href="https://github.com/simon-brooke/mw-ui/blob/master/src/mw_ui/render_world.clj#L48">view source</a></div></div><div class="public anchor" id="var-render-cell"><h3>render-cell</h3><div class="usage"><code>(render-cell cell)</code></div><div class="doc"><div class="markdown"><p>Render this world cell as a Hiccup table cell.</p>
|
||||
</div></div><div class="src-link"><a href="https://github.com/simon-brooke/mw-ui/blob/master/src/mw_ui/render_world.clj#L52">view source</a></div></div><div class="public anchor" id="var-render-inspector"><h3>render-inspector</h3><div class="usage"><code>(render-inspector cell _)</code><code>(render-inspector cell)</code></div><div class="doc"><div class="markdown"><p>Render in Hiccup format the HTML content of an inspector on this cell.</p>
|
||||
</div></div><div class="src-link"><a href="https://github.com/simon-brooke/mw-ui/blob/master/src/mw_ui/render_world.clj#L91">view source</a></div></div><div class="public anchor" id="var-render-world-row"><h3>render-world-row</h3><div class="usage"><code>(render-world-row row)</code></div><div class="doc"><div class="markdown"><p>Render this world row as a Hiccup table row.</p>
|
||||
</div></div><div class="src-link"><a href="https://github.com/simon-brooke/mw-ui/blob/master/src/mw_ui/render_world.clj#L61">view source</a></div></div><div class="public anchor" id="var-render-world-table"><h3>render-world-table</h3><div class="usage"><code>(render-world-table)</code></div><div class="doc"><div class="markdown"><p>Render the world implied by the current session as a complete HTML table in a DIV.</p>
|
||||
</div></div><div class="src-link"><a href="https://github.com/simon-brooke/mw-ui/blob/master/src/mw_ui/render_world.clj#L67">view source</a></div></div></div></body></html>
|
||||
9
docs/codox/mw-ui.repl.html
Normal file
9
docs/codox/mw-ui.repl.html
Normal file
|
|
@ -0,0 +1,9 @@
|
|||
<!DOCTYPE html PUBLIC ""
|
||||
"">
|
||||
<html><head><meta charset="UTF-8" /><title>mw-ui.repl 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 current"><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="sidebar secondary"><h3><a href="#top"><span class="inner">Public Vars</span></a></h3><ul><li class="depth-1"><a href="mw-ui.repl.html#var--main"><div class="inner"><span>-main</span></div></a></li><li class="depth-1"><a href="mw-ui.repl.html#var-get-handler"><div class="inner"><span>get-handler</span></div></a></li><li class="depth-1"><a href="mw-ui.repl.html#var-server"><div class="inner"><span>server</span></div></a></li><li class="depth-1"><a href="mw-ui.repl.html#var-start-server"><div class="inner"><span>start-server</span></div></a></li><li class="depth-1"><a href="mw-ui.repl.html#var-stop-server"><div class="inner"><span>stop-server</span></div></a></li></ul></div><div class="namespace-docs" id="content"><h1 class="anchor" id="top">mw-ui.repl</h1><div class="doc"><div class="markdown"><p>In truth, boilerplate from Luminus.</p>
|
||||
</div></div><div class="public anchor" id="var--main"><h3>-main</h3><div class="usage"><code>(-main)</code></div><div class="doc"><div class="markdown"><p><strong>TODO</strong>: write docs</p>
|
||||
</div></div><div class="src-link"><a href="https://github.com/simon-brooke/mw-ui/blob/master/src/mw_ui/repl.clj#L64">view source</a></div></div><div class="public anchor" id="var-get-handler"><h3>get-handler</h3><div class="usage"><code>(get-handler)</code></div><div class="doc"><div class="markdown"><p><strong>TODO</strong>: write docs</p>
|
||||
</div></div><div class="src-link"><a href="https://github.com/simon-brooke/mw-ui/blob/master/src/mw_ui/repl.clj#L36">view source</a></div></div><div class="public anchor" id="var-server"><h3>server</h3><div class="usage"></div><div class="doc"><div class="markdown"><p><strong>TODO</strong>: write docs</p>
|
||||
</div></div><div class="src-link"><a href="https://github.com/simon-brooke/mw-ui/blob/master/src/mw_ui/repl.clj#L34">view source</a></div></div><div class="public anchor" id="var-start-server"><h3>start-server</h3><div class="usage"><code>(start-server & [port])</code></div><div class="doc"><div class="markdown"><p>used for starting the server in development mode from REPL</p>
|
||||
</div></div><div class="src-link"><a href="https://github.com/simon-brooke/mw-ui/blob/master/src/mw_ui/repl.clj#L47">view source</a></div></div><div class="public anchor" id="var-stop-server"><h3>stop-server</h3><div class="usage"><code>(stop-server)</code></div><div class="doc"><div class="markdown"><p><strong>TODO</strong>: write docs</p>
|
||||
</div></div><div class="src-link"><a href="https://github.com/simon-brooke/mw-ui/blob/master/src/mw_ui/repl.clj#L60">view source</a></div></div></div></body></html>
|
||||
12
docs/codox/mw-ui.routes.home.html
Normal file
12
docs/codox/mw-ui.routes.home.html
Normal file
|
|
@ -0,0 +1,12 @@
|
|||
<!DOCTYPE html PUBLIC ""
|
||||
"">
|
||||
<html><head><meta charset="UTF-8" /><title>mw-ui.routes.home 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 current"><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="sidebar secondary"><h3><a href="#top"><span class="inner">Public Vars</span></a></h3><ul><li class="depth-1"><a href="mw-ui.routes.home.html#var-about-page"><div class="inner"><span>about-page</span></div></a></li><li class="depth-1"><a href="mw-ui.routes.home.html#var-docs-page"><div class="inner"><span>docs-page</span></div></a></li><li class="depth-1"><a href="mw-ui.routes.home.html#var-home-page"><div class="inner"><span>home-page</span></div></a></li><li class="depth-1"><a href="mw-ui.routes.home.html#var-home-routes"><div class="inner"><span>home-routes</span></div></a></li><li class="depth-1"><a href="mw-ui.routes.home.html#var-inspect-page"><div class="inner"><span>inspect-page</span></div></a></li><li class="depth-1"><a href="mw-ui.routes.home.html#var-list-states"><div class="inner"><span>list-states</span></div></a></li><li class="depth-1"><a href="mw-ui.routes.home.html#var-md-page"><div class="inner"><span>md-page</span></div></a></li><li class="depth-1"><a href="mw-ui.routes.home.html#var-world-page"><div class="inner"><span>world-page</span></div></a></li></ul></div><div class="namespace-docs" id="content"><h1 class="anchor" id="top">mw-ui.routes.home</h1><div class="doc"><div class="markdown"><p>Routes which serve the main pages of the application.</p>
|
||||
</div></div><div class="public anchor" id="var-about-page"><h3>about-page</h3><div class="usage"><code>(about-page)</code></div><div class="doc"><div class="markdown"><p><strong>TODO</strong>: write docs</p>
|
||||
</div></div><div class="src-link"><a href="https://github.com/simon-brooke/mw-ui/blob/master/src/mw_ui/routes/home.clj#L51">view source</a></div></div><div class="public anchor" id="var-docs-page"><h3>docs-page</h3><div class="usage"><code>(docs-page)</code></div><div class="doc"><div class="markdown"><p><strong>TODO</strong>: write docs</p>
|
||||
</div></div><div class="src-link"><a href="https://github.com/simon-brooke/mw-ui/blob/master/src/mw_ui/routes/home.clj#L58">view source</a></div></div><div class="public anchor" id="var-home-page"><h3>home-page</h3><div class="usage"><code>(home-page)</code></div><div class="doc"><div class="markdown"><p>Render the home page.</p>
|
||||
</div></div><div class="src-link"><a href="https://github.com/simon-brooke/mw-ui/blob/master/src/mw_ui/routes/home.clj#L66">view source</a></div></div><div class="public anchor" id="var-home-routes"><h3>home-routes</h3><div class="usage"></div><div class="doc"><div class="markdown"><p><strong>TODO</strong>: write docs</p>
|
||||
</div></div><div class="src-link"><a href="https://github.com/simon-brooke/mw-ui/blob/master/src/mw_ui/routes/home.clj#L118">view source</a></div></div><div class="public anchor" id="var-inspect-page"><h3>inspect-page</h3><div class="usage"><code>(inspect-page request)</code></div><div class="doc"><div class="markdown"><p>Open an inspector on the cell at the co-ordinates specified in this request</p>
|
||||
</div></div><div class="src-link"><a href="https://github.com/simon-brooke/mw-ui/blob/master/src/mw_ui/routes/home.clj#L73">view source</a></div></div><div class="public anchor" id="var-list-states"><h3>list-states</h3><div class="usage"><code>(list-states)</code></div><div class="doc"><div class="markdown"><p><strong>TODO</strong>: write docs</p>
|
||||
</div></div><div class="src-link"><a href="https://github.com/simon-brooke/mw-ui/blob/master/src/mw_ui/routes/home.clj#L43">view source</a></div></div><div class="public anchor" id="var-md-page"><h3>md-page</h3><div class="usage"><code>(md-page request)</code></div><div class="doc"><div class="markdown"><p>Render the markdown page specified in this request, if any. Probably undesirable, should be removed.</p>
|
||||
</div></div><div class="src-link"><a href="https://github.com/simon-brooke/mw-ui/blob/master/src/mw_ui/routes/home.clj#L98">view source</a></div></div><div class="public anchor" id="var-world-page"><h3>world-page</h3><div class="usage"><code>(world-page)</code></div><div class="doc"><div class="markdown"><p><strong>TODO</strong>: write docs</p>
|
||||
</div></div><div class="src-link"><a href="https://github.com/simon-brooke/mw-ui/blob/master/src/mw_ui/routes/home.clj#L108">view source</a></div></div></div></body></html>
|
||||
7
docs/codox/mw-ui.routes.load.html
Normal file
7
docs/codox/mw-ui.routes.load.html
Normal file
|
|
@ -0,0 +1,7 @@
|
|||
<!DOCTYPE html PUBLIC ""
|
||||
"">
|
||||
<html><head><meta charset="UTF-8" /><title>mw-ui.routes.load 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 current"><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="sidebar secondary"><h3><a href="#top"><span class="inner">Public Vars</span></a></h3><ul><li class="depth-1"><a href="mw-ui.routes.load.html#var-load-page"><div class="inner"><span>load-page</span></div></a></li></ul></div><div class="namespace-docs" id="content"><h1 class="anchor" id="top">mw-ui.routes.load</h1><div class="doc"><div class="markdown"><p>Route which handles the upload of worlds/rules from the client.</p>
|
||||
</div></div><div class="public anchor" id="var-load-page"><h3>load-page</h3><div class="usage"><code>(load-page)</code><code>(load-page request)</code></div><div class="doc"><div class="markdown"><p>If no args, show the load form; with args, load a world file from the client.</p>
|
||||
<p><em>NOTE</em> that this reads a Clojure form from an untrusted client and should almost certainly NOT be enabled on a public-facing site, especially not on the Internet.</p>
|
||||
<p><em>TODO</em> doesn’t work yet.</p>
|
||||
</div></div><div class="src-link"><a href="https://github.com/simon-brooke/mw-ui/blob/master/src/mw_ui/routes/load.clj#L41">view source</a></div></div></div></body></html>
|
||||
5
docs/codox/mw-ui.routes.params.html
Normal file
5
docs/codox/mw-ui.routes.params.html
Normal file
|
|
@ -0,0 +1,5 @@
|
|||
<!DOCTYPE html PUBLIC ""
|
||||
"">
|
||||
<html><head><meta charset="UTF-8" /><title>mw-ui.routes.params 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 current"><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="sidebar secondary"><h3><a href="#top"><span class="inner">Public Vars</span></a></h3><ul><li class="depth-1"><a href="mw-ui.routes.params.html#var-params-page"><div class="inner"><span>params-page</span></div></a></li></ul></div><div class="namespace-docs" id="content"><h1 class="anchor" id="top">mw-ui.routes.params</h1><div class="doc"><div class="markdown"><p>Route which serves and handles the parameters page.</p>
|
||||
</div></div><div class="public anchor" id="var-params-page"><h3>params-page</h3><div class="usage"><code>(params-page)</code><code>(params-page request)</code></div><div class="doc"><div class="markdown"><p>Handler for params request. If no <code>request</code> passed, show empty params form. If <code>request</code> is passed, put parameters from request into session and show the world page.</p>
|
||||
</div></div><div class="src-link"><a href="https://github.com/simon-brooke/mw-ui/blob/master/src/mw_ui/routes/params.clj#L44">view source</a></div></div></div></body></html>
|
||||
7
docs/codox/mw-ui.routes.rules.html
Normal file
7
docs/codox/mw-ui.routes.rules.html
Normal file
|
|
@ -0,0 +1,7 @@
|
|||
<!DOCTYPE html PUBLIC ""
|
||||
"">
|
||||
<html><head><meta charset="UTF-8" /><title>mw-ui.routes.rules 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 current"><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="sidebar secondary"><h3><a href="#top"><span class="inner">Public Vars</span></a></h3><ul><li class="depth-1"><a href="mw-ui.routes.rules.html#var-process-rules-request"><div class="inner"><span>process-rules-request</span></div></a></li><li class="depth-1"><a href="mw-ui.routes.rules.html#var-rules-page"><div class="inner"><span>rules-page</span></div></a></li></ul></div><div class="namespace-docs" id="content"><h1 class="anchor" id="top">mw-ui.routes.rules</h1><div class="doc"><div class="markdown"><p>Route which serves and handles the rules page.</p>
|
||||
</div></div><div class="public anchor" id="var-process-rules-request"><h3>process-rules-request</h3><div class="usage"><code>(process-rules-request request)</code></div><div class="doc"><div class="markdown"><p><strong>TODO</strong>: write docs</p>
|
||||
</div></div><div class="src-link"><a href="https://github.com/simon-brooke/mw-ui/blob/master/src/mw_ui/routes/rules.clj#L34">view source</a></div></div><div class="public anchor" id="var-rules-page"><h3>rules-page</h3><div class="usage"><code>(rules-page request)</code><code>(rules-page)</code></div><div class="doc"><div class="markdown"><p>Request handler for the <code>rules</code> request. If the <code>request</code> contains a value for <code>:src</code>, treat that as rule source and try to compile it. If compilation succeeds, stash the compiled rules and the rule text on the session, and provide feedback; if not, provide feedback.</p>
|
||||
<p>If <code>request</code> doesn’t contain a value for <code>:src</code>, load basic rule source from the session or from <code>resources/rulesets/basic.txt</code> and pass that back.</p>
|
||||
</div></div><div class="src-link"><a href="https://github.com/simon-brooke/mw-ui/blob/master/src/mw_ui/routes/rules.clj#L55">view source</a></div></div></div></body></html>
|
||||
5
docs/codox/mw-ui.routes.save.html
Normal file
5
docs/codox/mw-ui.routes.save.html
Normal file
|
|
@ -0,0 +1,5 @@
|
|||
<!DOCTYPE html PUBLIC ""
|
||||
"">
|
||||
<html><head><meta charset="UTF-8" /><title>mw-ui.routes.save 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 current"><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="sidebar secondary"><h3><a href="#top"><span class="inner">Public Vars</span></a></h3><ul><li class="depth-1"><a href="mw-ui.routes.save.html#var-save-page"><div class="inner"><span>save-page</span></div></a></li></ul></div><div class="namespace-docs" id="content"><h1 class="anchor" id="top">mw-ui.routes.save</h1><div class="doc"><div class="markdown"><p>Route which handles the saving of world state the client.</p>
|
||||
</div></div><div class="public anchor" id="var-save-page"><h3>save-page</h3><div class="usage"><code>(save-page)</code></div><div class="doc"><div class="markdown"><p>Save the current world to the browser, using our own custom mime-type in an attempt to prevent the browser trying to do anything clever with it. Note that it is saved as a raw Clojure data structure, not as XML or any proprietary format.</p>
|
||||
</div></div><div class="src-link"><a href="https://github.com/simon-brooke/mw-ui/blob/master/src/mw_ui/routes/save.clj#L32">view source</a></div></div></div></body></html>
|
||||
9
docs/codox/mw-ui.util.html
Normal file
9
docs/codox/mw-ui.util.html
Normal file
|
|
@ -0,0 +1,9 @@
|
|||
<!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->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->html</h3><div class="usage"><code>(md->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 we’re running from the filesystem unless we find we’re 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>
|
||||
Loading…
Add table
Add a link
Reference in a new issue