adl-support/docs/index.html
2019-05-02 16:01:57 +01:00

3 lines
13 KiB
HTML

<!DOCTYPE html PUBLIC ""
"">
<html><head><meta charset="UTF-8" /><title>Adl-support 0.1.6</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">Adl-support</span> <span class="project-version">0.1.6</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">Topics</span></h3><ul><li class="depth-1 "><a href="intro.html"><div class="inner"><span>Introduction to adl-support</span></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>adl-support</span></div></div></li><li class="depth-2 branch"><a href="adl-support.core.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>core</span></div></a></li><li class="depth-2 branch"><a href="adl-support.filters.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>filters</span></div></a></li><li class="depth-2 branch"><a href="adl-support.forms-support.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>forms-support</span></div></a></li><li class="depth-2 branch"><a href="adl-support.print-usage.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>print-usage</span></div></a></li><li class="depth-2 branch"><a href="adl-support.rest-support.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>rest-support</span></div></a></li><li class="depth-2 branch"><a href="adl-support.tags.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>tags</span></div></a></li><li class="depth-2"><a href="adl-support.utils.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>utils</span></div></a></li></ul></div><div class="namespace-index" id="content"><h1><span class="project-title"><span class="project-name">Adl-support</span> <span class="project-version">0.1.6</span></span></h1><h5 class="license">Released under the <a href="https://opensource.org/licenses/MIT">MIT License</a></h5><div class="doc"><p>A small library of functions called by generated ADL code.</p></div><h2>Installation</h2><p>To install, add the following dependency to your project or build file:</p><pre class="deps">[adl-support "0.1.6"]</pre><h2>Topics</h2><ul class="topics"><li><a href="intro.html">Introduction to adl-support</a></li></ul><h2>Namespaces</h2><div class="namespace"><h3><a href="adl-support.core.html">adl-support.core</a></h3><div class="doc"><div class="markdown"><p>Application Description Language support - utility functions likely to be useful in user-written code.</p></div></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="adl-support.core.html#var-*warn*">*warn*</a> </li><li> <a href="adl-support.core.html#var-compose-exception-reason">compose-exception-reason</a> </li><li> <a href="adl-support.core.html#var-compose-reason-and-log">compose-reason-and-log</a> </li><li> <a href="adl-support.core.html#var-do-or-log-and-return-reason">do-or-log-and-return-reason</a> </li><li> <a href="adl-support.core.html#var-do-or-log-error">do-or-log-error</a> </li><li> <a href="adl-support.core.html#var-do-or-return-reason">do-or-return-reason</a> </li><li> <a href="adl-support.core.html#var-do-or-warn">do-or-warn</a> </li><li> <a href="adl-support.core.html#var-do-or-warn-and-log">do-or-warn-and-log</a> </li><li> <a href="adl-support.core.html#var-massage-params">massage-params</a> </li><li> <a href="adl-support.core.html#var-massage-value">massage-value</a> </li><li> <a href="adl-support.core.html#var-raw-massage-params">raw-massage-params</a> </li><li> <a href="adl-support.core.html#var-raw-resolve-template">raw-resolve-template</a> </li><li> <a href="adl-support.core.html#var-resolve-template">resolve-template</a> </li></ul></div></div><div class="namespace"><h3><a href="adl-support.filters.html">adl-support.filters</a></h3><div class="doc"><div class="markdown"><p>Application Description Language support - custom Selmer filters used in generated templates.</p></div></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="adl-support.filters.html#var-*default-international-dialing-prefix*">*default-international-dialing-prefix*</a> </li><li> <a href="adl-support.filters.html#var-contains">contains</a> </li><li> <a href="adl-support.filters.html#var-email">email</a> </li><li> <a href="adl-support.filters.html#var-telephone">telephone</a> </li></ul></div></div><div class="namespace"><h3><a href="adl-support.forms-support.html">adl-support.forms-support</a></h3><div class="doc"><div class="markdown"><p>Application Description Language support - functions useful in generating forms.</p></div></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="adl-support.forms-support.html#var-all-keys-present.3F">all-keys-present?</a> </li><li> <a href="adl-support.forms-support.html#var-auxlist-data-name">auxlist-data-name</a> </li><li> <a href="adl-support.forms-support.html#var-form-title">form-title</a> </li><li> <a href="adl-support.forms-support.html#var-get-current-value">get-current-value</a> </li><li> <a href="adl-support.forms-support.html#var-get-menu-options">get-menu-options</a> </li><li> <a href="adl-support.forms-support.html#var-prepare-insertion-params">prepare-insertion-params</a> </li><li> <a href="adl-support.forms-support.html#var-property-defaults">property-defaults</a> </li><li> <a href="adl-support.forms-support.html#var-query-name">query-name</a> </li></ul></div></div><div class="namespace"><h3><a href="adl-support.print-usage.html">adl-support.print-usage</a></h3><div class="doc"><div class="markdown"><p>Application Description Language support - print a usage message.</p></div></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="adl-support.print-usage.html#var-print-usage">print-usage</a> </li></ul></div></div><div class="namespace"><h3><a href="adl-support.rest-support.html">adl-support.rest-support</a></h3><div class="doc"><div class="markdown"><p>Application Description Language support - functions useful in generating JSON route handlers.</p></div></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="adl-support.rest-support.html#var-do-or-server-fail">do-or-server-fail</a> </li><li> <a href="adl-support.rest-support.html#var-if-valid-user">if-valid-user</a> </li><li> <a href="adl-support.rest-support.html#var-valid-user-or-forbid">valid-user-or-forbid</a> </li><li> <a href="adl-support.rest-support.html#var-with-params-or-error">with-params-or-error</a> </li></ul></div></div><div class="namespace"><h3><a href="adl-support.tags.html">adl-support.tags</a></h3><div class="doc"><div class="markdown"><p>Application Description Language support - custom Selmer tags used in generated templates.</p></div></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="adl-support.tags.html#var-add-tags">add-tags</a> </li><li> <a href="adl-support.tags.html#var-if-member-of-permitted">if-member-of-permitted</a> </li><li> <a href="adl-support.tags.html#var-parse-arg">parse-arg</a> </li></ul></div></div><div class="namespace"><h3><a href="adl-support.utils.html">adl-support.utils</a></h3><div class="doc"><div class="markdown"><p>Application Description Language support - utility functions.</p></div></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="adl-support.utils.html#var-*locale*">*locale*</a> </li><li> <a href="adl-support.utils.html#var-*output-path*">*output-path*</a> </li><li> <a href="adl-support.utils.html#var-*verbosity*">*verbosity*</a> </li><li> <a href="adl-support.utils.html#var-all-properties">all-properties</a> </li><li> <a href="adl-support.utils.html#var-attributes">attributes</a> </li><li> <a href="adl-support.utils.html#var-base-type">base-type</a> </li><li> <a href="adl-support.utils.html#var-capitalise">capitalise</a> </li><li> <a href="adl-support.utils.html#var-child">child</a> </li><li> <a href="adl-support.utils.html#var-child-with-tag">child-with-tag</a> </li><li> <a href="adl-support.utils.html#var-children">children</a> </li><li> <a href="adl-support.utils.html#var-children-with-tag">children-with-tag</a> </li><li> <a href="adl-support.utils.html#var-column-name">column-name</a> </li><li> <a href="adl-support.utils.html#var-descendant-with-tag">descendant-with-tag</a> </li><li> <a href="adl-support.utils.html#var-descendants-with-tag">descendants-with-tag</a> </li><li> <a href="adl-support.utils.html#var-distinct-properties">distinct-properties</a> </li><li> <a href="adl-support.utils.html#var-editor-name">editor-name</a> </li><li> <a href="adl-support.utils.html#var-element.3F">element?</a> </li><li> <a href="adl-support.utils.html#var-emit-header">emit-header</a> </li><li> <a href="adl-support.utils.html#var-entity-by-name">entity-by-name</a> </li><li> <a href="adl-support.utils.html#var-entity-for-property">entity-for-property</a> </li><li> <a href="adl-support.utils.html#var-entity.3F">entity?</a> </li><li> <a href="adl-support.utils.html#var-find-permissions">find-permissions</a> </li><li> <a href="adl-support.utils.html#var-formal-primary-key.3F">formal-primary-key?</a> </li><li> <a href="adl-support.utils.html#var-has-non-key-properties.3F">has-non-key-properties?</a> </li><li> <a href="adl-support.utils.html#var-has-primary-key.3F">has-primary-key?</a> </li><li> <a href="adl-support.utils.html#var-insertable-key-properties">insertable-key-properties</a> </li><li> <a href="adl-support.utils.html#var-insertable-properties">insertable-properties</a> </li><li> <a href="adl-support.utils.html#var-insertable.3F">insertable?</a> </li><li> <a href="adl-support.utils.html#var-is-quotable-type.3F">is-quotable-type?</a> </li><li> <a href="adl-support.utils.html#var-key-names">key-names</a> </li><li> <a href="adl-support.utils.html#var-key-properties">key-properties</a> </li><li> <a href="adl-support.utils.html#var-link-table-name">link-table-name</a> </li><li> <a href="adl-support.utils.html#var-link-table.3F">link-table?</a> </li><li> <a href="adl-support.utils.html#var-list-related-query-name">list-related-query-name</a> </li><li> <a href="adl-support.utils.html#var-order-preserving-set">order-preserving-set</a> </li><li> <a href="adl-support.utils.html#var-path-part">path-part</a> </li><li> <a href="adl-support.utils.html#var-permission-groups">permission-groups</a> </li><li> <a href="adl-support.utils.html#var-pretty-name">pretty-name</a> </li><li> <a href="adl-support.utils.html#var-prompt">prompt</a> </li><li> <a href="adl-support.utils.html#var-properties">properties</a> </li><li> <a href="adl-support.utils.html#var-property-for-field">property-for-field</a> </li><li> <a href="adl-support.utils.html#var-property.3F">property?</a> </li><li> <a href="adl-support.utils.html#var-required-properties">required-properties</a> </li><li> <a href="adl-support.utils.html#var-safe-name">safe-name</a> </li><li> <a href="adl-support.utils.html#var-singularise">singularise</a> </li><li> <a href="adl-support.utils.html#var-sort-by-name">sort-by-name</a> </li><li> <a href="adl-support.utils.html#var-system-generated.3F">system-generated?</a> </li><li> <a href="adl-support.utils.html#var-type-for-defined">type-for-defined</a> </li><li> <a href="adl-support.utils.html#var-typedef">typedef</a> </li><li> <a href="adl-support.utils.html#var-unique-link.3F">unique-link?</a> </li><li> <a href="adl-support.utils.html#var-user-distinct-properties">user-distinct-properties</a> </li><li> <a href="adl-support.utils.html#var-user-distinct-property-names">user-distinct-property-names</a> </li><li> <a href="adl-support.utils.html#var-visible-to">visible-to</a> </li><li> <a href="adl-support.utils.html#var-volatility">volatility</a> </li><li> <a href="adl-support.utils.html#var-wrap-lines">wrap-lines</a> </li><li> <a href="adl-support.utils.html#var-writeable-by">writeable-by</a> </li></ul></div></div></div></body></html>