6 lines
20 KiB
HTML
6 lines
20 KiB
HTML
<!DOCTYPE html PUBLIC ""
|
|
"">
|
|
<html><head><meta charset="UTF-8" /><title>Adl 1.4.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</span> <span class="project-version">1.4.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">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</span></div></div></li><li class="depth-2 branch"><a href="adl.main.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>main</span></div></a></li><li class="depth-2 branch"><a href="adl.to-cache.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>to-cache</span></div></a></li><li class="depth-2 branch"><a href="adl.to-hugsql-queries.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>to-hugsql-queries</span></div></a></li><li class="depth-2 branch"><a href="adl.to-json-routes.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>to-json-routes</span></div></a></li><li class="depth-2 branch"><a href="adl.to-psql.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>to-psql</span></div></a></li><li class="depth-2 branch"><a href="adl.to-reframe.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>to-reframe</span></div></a></li><li class="depth-2 branch"><a href="adl.to-selmer-routes.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>to-selmer-routes</span></div></a></li><li class="depth-2 branch"><a href="adl.to-selmer-templates.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>to-selmer-templates</span></div></a></li><li class="depth-2 branch"><a href="adl.to-swagger.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>to-swagger</span></div></a></li><li class="depth-2"><a href="adl.validator.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>validator</span></div></a></li></ul></div><div class="namespace-index" id="content"><h1><span class="project-title"><span class="project-name">Adl</span> <span class="project-version">1.4.6</span></span></h1><h5 class="license">Released under the <a href="https://www.gnu.org/licenses/lgpl-3.0.en.html">GNU Lesser General Public License, version 3.0 or (at your option) any later version</a></h5><div class="doc"><p>An application to transform an ADL application specification
|
|
document into skeleton code for a Clojure web-app.</p></div><h2>Installation</h2><p>To install, add the following dependency to your project or build file:</p><pre class="deps">[adl "1.4.6"]</pre><h2>Namespaces</h2><div class="namespace"><h3><a href="adl.main.html">adl.main</a></h3><div class="doc"><pre class="plaintext">Application Description Language - command line invocation.</pre></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="adl.main.html#var--main">-main</a> </li><li> <a href="adl.main.html#var-adl-.3Ecanonical">adl->canonical</a> </li><li> <a href="adl.main.html#var-canonicalise">canonicalise</a> </li><li> <a href="adl.main.html#var-cli-options">cli-options</a> </li><li> <a href="adl.main.html#var-process">process</a> </li><li> <a href="adl.main.html#var-usage">usage</a> </li></ul></div></div><div class="namespace"><h3><a href="adl.to-cache.html">adl.to-cache</a></h3><div class="doc"><pre class="plaintext">Application Description Language: generate caching layer for database requests.</pre></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="adl.to-cache.html#var-file-header">file-header</a> </li><li> <a href="adl.to-cache.html#var-handler">handler</a> </li><li> <a href="adl.to-cache.html#var-to-cache">to-cache</a> </li></ul></div></div><div class="namespace"><h3><a href="adl.to-hugsql-queries.html">adl.to-hugsql-queries</a></h3><div class="doc"><pre class="plaintext">Application Description Language - generate HUGSQL queries file.</pre></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="adl.to-hugsql-queries.html#var-delete-query">delete-query</a> </li><li> <a href="adl.to-hugsql-queries.html#var-expanded-token">expanded-token</a> </li><li> <a href="adl.to-hugsql-queries.html#var-foreign-queries">foreign-queries</a> </li><li> <a href="adl.to-hugsql-queries.html#var-generate-documentation">generate-documentation</a> </li><li> <a href="adl.to-hugsql-queries.html#var-insert-query">insert-query</a> </li><li> <a href="adl.to-hugsql-queries.html#var-list-query">list-query</a> </li><li> <a href="adl.to-hugsql-queries.html#var-order-by-clause">order-by-clause</a> </li><li> <a href="adl.to-hugsql-queries.html#var-queries">queries</a> </li><li> <a href="adl.to-hugsql-queries.html#var-search-query">search-query</a> </li><li> <a href="adl.to-hugsql-queries.html#var-select-query">select-query</a> </li><li> <a href="adl.to-hugsql-queries.html#var-to-hugsql-queries">to-hugsql-queries</a> </li><li> <a href="adl.to-hugsql-queries.html#var-update-query">update-query</a> </li><li> <a href="adl.to-hugsql-queries.html#var-where-clause">where-clause</a> </li></ul></div></div><div class="namespace"><h3><a href="adl.to-json-routes.html">adl.to-json-routes</a></h3><div class="doc"><pre class="plaintext">Application Description Language: generate RING routes for REST requests.</pre></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="adl.to-json-routes.html#var-declarations">declarations</a> </li><li> <a href="adl.to-json-routes.html#var-defroutes">defroutes</a> </li><li> <a href="adl.to-json-routes.html#var-file-header">file-header</a> </li><li> <a href="adl.to-json-routes.html#var-generate-handler-body">generate-handler-body</a> </li><li> <a href="adl.to-json-routes.html#var-generate-handler-src">generate-handler-src</a> </li><li> <a href="adl.to-json-routes.html#var-handler">handler</a> </li><li> <a href="adl.to-json-routes.html#var-make-handlers-map">make-handlers-map</a> </li><li> <a href="adl.to-json-routes.html#var-to-json-routes">to-json-routes</a> </li></ul></div></div><div class="namespace"><h3><a href="adl.to-psql.html">adl.to-psql</a></h3><div class="doc"><pre class="plaintext">Application Description Language: generate Postgres database definition.</pre></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="adl.to-psql.html#var-compose-convenience-entity-field">compose-convenience-entity-field</a> </li><li> <a href="adl.to-psql.html#var-compose-convenience-view-select-list">compose-convenience-view-select-list</a> </li><li> <a href="adl.to-psql.html#var-compose-convenience-where-clause">compose-convenience-where-clause</a> </li><li> <a href="adl.to-psql.html#var-construct-link-property">construct-link-property</a> </li><li> <a href="adl.to-psql.html#var-emit-application">emit-application</a> </li><li> <a href="adl.to-psql.html#var-emit-convenience-entity-field">emit-convenience-entity-field</a> </li><li> <a href="adl.to-psql.html#var-emit-convenience-view">emit-convenience-view</a> </li><li> <a href="adl.to-psql.html#var-emit-defined-field-type">emit-defined-field-type</a> </li><li> <a href="adl.to-psql.html#var-emit-entity-field-type">emit-entity-field-type</a> </li><li> <a href="adl.to-psql.html#var-emit-field-type">emit-field-type</a> </li><li> <a href="adl.to-psql.html#var-emit-file-header">emit-file-header</a> </li><li> <a href="adl.to-psql.html#var-emit-group-declaration">emit-group-declaration</a> </li><li> <a href="adl.to-psql.html#var-emit-link-field">emit-link-field</a> </li><li> <a href="adl.to-psql.html#var-emit-link-table">emit-link-table</a> </li><li> <a href="adl.to-psql.html#var-emit-link-tables">emit-link-tables</a> </li><li> <a href="adl.to-psql.html#var-emit-permissions-grant">emit-permissions-grant</a> </li><li> <a href="adl.to-psql.html#var-emit-property">emit-property</a> </li><li> <a href="adl.to-psql.html#var-emit-referential-integrity-link">emit-referential-integrity-link</a> </li><li> <a href="adl.to-psql.html#var-emit-referential-integrity-links">emit-referential-integrity-links</a> </li><li> <a href="adl.to-psql.html#var-emit-table">emit-table</a> </li><li> <a href="adl.to-psql.html#var-field-name">field-name</a> </li><li> <a href="adl.to-psql.html#var-to-psql">to-psql</a> </li></ul></div></div><div class="namespace"><h3><a href="adl.to-reframe.html">adl.to-reframe</a></h3><div class="doc"><pre class="plaintext">Application Description Language: generate re-frame UI. TODO: doesn't even nearly work yet.</pre></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="adl.to-reframe.html#var-file-header">file-header</a> </li><li> <a href="adl.to-reframe.html#var-generate-form">generate-form</a> </li></ul></div></div><div class="namespace"><h3><a href="adl.to-selmer-routes.html">adl.to-selmer-routes</a></h3><div class="doc"><pre class="plaintext">Application Description Language: generate routes for user interface requests.</pre></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="adl.to-selmer-routes.html#var-compose-fetch-auxlist-data">compose-fetch-auxlist-data</a> </li><li> <a href="adl.to-selmer-routes.html#var-compose-fetch-record">compose-fetch-record</a> </li><li> <a href="adl.to-selmer-routes.html#var-compose-get-menu-options">compose-get-menu-options</a> </li><li> <a href="adl.to-selmer-routes.html#var-file-header">file-header</a> </li><li> <a href="adl.to-selmer-routes.html#var-generate-handler-resolver">generate-handler-resolver</a> </li><li> <a href="adl.to-selmer-routes.html#var-handler-name">handler-name</a> </li><li> <a href="adl.to-selmer-routes.html#var-make-defroutes">make-defroutes</a> </li><li> <a href="adl.to-selmer-routes.html#var-make-form-get-handler-content">make-form-get-handler-content</a> </li><li> <a href="adl.to-selmer-routes.html#var-make-form-post-handler-content">make-form-post-handler-content</a> </li><li> <a href="adl.to-selmer-routes.html#var-make-get-handler">make-get-handler</a> </li><li> <a href="adl.to-selmer-routes.html#var-make-handlers">make-handlers</a> </li><li> <a href="adl.to-selmer-routes.html#var-make-list-get-handler-content">make-list-get-handler-content</a> </li><li> <a href="adl.to-selmer-routes.html#var-make-page-get-handler-content">make-page-get-handler-content</a> </li><li> <a href="adl.to-selmer-routes.html#var-make-post-handler">make-post-handler</a> </li><li> <a href="adl.to-selmer-routes.html#var-make-route">make-route</a> </li><li> <a href="adl.to-selmer-routes.html#var-to-selmer-routes">to-selmer-routes</a> </li></ul></div></div><div class="namespace"><h3><a href="adl.to-selmer-templates.html">adl.to-selmer-templates</a></h3><div class="doc"><pre class="plaintext">Application Description Language - generate Selmer templates for
|
|
the HTML pages implied by an ADL file.</pre></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="adl.to-selmer-templates.html#var-application-to-template">application-to-template</a> </li><li> <a href="adl.to-selmer-templates.html#var-back-link">back-link</a> </li><li> <a href="adl.to-selmer-templates.html#var-big-link">big-link</a> </li><li> <a href="adl.to-selmer-templates.html#var-compose-form-auxlist">compose-form-auxlist</a> </li><li> <a href="adl.to-selmer-templates.html#var-compose-form-auxlists">compose-form-auxlists</a> </li><li> <a href="adl.to-selmer-templates.html#var-compose-form-content">compose-form-content</a> </li><li> <a href="adl.to-selmer-templates.html#var-compose-form-extra-head">compose-form-extra-head</a> </li><li> <a href="adl.to-selmer-templates.html#var-compose-form-extra-tail">compose-form-extra-tail</a> </li><li> <a href="adl.to-selmer-templates.html#var-compose-if-member-of-tag">compose-if-member-of-tag</a> </li><li> <a href="adl.to-selmer-templates.html#var-compose-input-widget-para">compose-input-widget-para</a> </li><li> <a href="adl.to-selmer-templates.html#var-compose-list-search-widget">compose-list-search-widget</a> </li><li> <a href="adl.to-selmer-templates.html#var-compose-readable-or-not-authorised">compose-readable-or-not-authorised</a> </li><li> <a href="adl.to-selmer-templates.html#var-compose-widget-para">compose-widget-para</a> </li><li> <a href="adl.to-selmer-templates.html#var-csrf-widget">csrf-widget</a> </li><li> <a href="adl.to-selmer-templates.html#var-delete-widget">delete-widget</a> </li><li> <a href="adl.to-selmer-templates.html#var-edit-link">edit-link</a> </li><li> <a href="adl.to-selmer-templates.html#var-embed-script-fragment">embed-script-fragment</a> </li><li> <a href="adl.to-selmer-templates.html#var-emit-content">emit-content</a> </li><li> <a href="adl.to-selmer-templates.html#var-emit-entity-dd">emit-entity-dd</a> </li><li> <a href="adl.to-selmer-templates.html#var-emit-entity-dt">emit-entity-dt</a> </li><li> <a href="adl.to-selmer-templates.html#var-entity-to-templates">entity-to-templates</a> </li><li> <a href="adl.to-selmer-templates.html#var-file-footer">file-footer</a> </li><li> <a href="adl.to-selmer-templates.html#var-file-header">file-header</a> </li><li> <a href="adl.to-selmer-templates.html#var-form-to-template">form-to-template</a> </li><li> <a href="adl.to-selmer-templates.html#var-get-options">get-options</a> </li><li> <a href="adl.to-selmer-templates.html#var-get-size-for-widget">get-size-for-widget</a> </li><li> <a href="adl.to-selmer-templates.html#var-list-tbody">list-tbody</a> </li><li> <a href="adl.to-selmer-templates.html#var-list-to-template">list-to-template</a> </li><li> <a href="adl.to-selmer-templates.html#var-page-to-template">page-to-template</a> </li><li> <a href="adl.to-selmer-templates.html#var-save-widget">save-widget</a> </li><li> <a href="adl.to-selmer-templates.html#var-select-field-name">select-field-name</a> </li><li> <a href="adl.to-selmer-templates.html#var-select-property">select-property</a> </li><li> <a href="adl.to-selmer-templates.html#var-select-widget">select-widget</a> </li><li> <a href="adl.to-selmer-templates.html#var-to-selmer-templates">to-selmer-templates</a> </li><li> <a href="adl.to-selmer-templates.html#var-widget">widget</a> </li><li> <a href="adl.to-selmer-templates.html#var-widget-type">widget-type</a> </li><li> <a href="adl.to-selmer-templates.html#var-wrap-in-if-member-of">wrap-in-if-member-of</a> </li><li> <a href="adl.to-selmer-templates.html#var-write-template-file">write-template-file</a> </li></ul></div></div><div class="namespace"><h3><a href="adl.to-swagger.html">adl.to-swagger</a></h3><div class="doc"><pre class="plaintext">Application Description Language: generate swagger routes.</pre></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="adl.to-swagger.html#var-file-header">file-header</a> </li></ul></div></div><div class="namespace"><h3><a href="adl.validator.html">adl.validator</a></h3><div class="doc"><pre class="plaintext">Application Description Language: validator for ADL structure.
|
|
TODO: this is at present largely a failed experiment.</pre></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="adl.validator.html#var-all-data-types">all-data-types</a> </li><li> <a href="adl.validator.html#var-application-validations">application-validations</a> </li><li> <a href="adl.validator.html#var-auxlist-validations">auxlist-validations</a> </li><li> <a href="adl.validator.html#var-cascade-actions">cascade-actions</a> </li><li> <a href="adl.validator.html#var-complex-data-types">complex-data-types</a> </li><li> <a href="adl.validator.html#var-content">content</a> </li><li> <a href="adl.validator.html#var-content-validations">content-validations</a> </li><li> <a href="adl.validator.html#var-defineable-data-types">defineable-data-types</a> </li><li> <a href="adl.validator.html#var-disjunct-valid.3F">disjunct-valid?</a> </li><li> <a href="adl.validator.html#var-documentation-validations">documentation-validations</a> </li><li> <a href="adl.validator.html#var-entity-validations">entity-validations</a> </li><li> <a href="adl.validator.html#var-field-stuff">field-stuff</a> </li><li> <a href="adl.validator.html#var-field-validations">field-validations</a> </li><li> <a href="adl.validator.html#var-fieldgroup-validations">fieldgroup-validations</a> </li><li> <a href="adl.validator.html#var-foot-validations">foot-validations</a> </li><li> <a href="adl.validator.html#var-form-validations">form-validations</a> </li><li> <a href="adl.validator.html#var-generator-actions">generator-actions</a> </li><li> <a href="adl.validator.html#var-generator-validations">generator-validations</a> </li><li> <a href="adl.validator.html#var-group-validations">group-validations</a> </li><li> <a href="adl.validator.html#var-head-validations">head-validations</a> </li><li> <a href="adl.validator.html#var-help-validations">help-validations</a> </li><li> <a href="adl.validator.html#var-ifmissing-validations">ifmissing-validations</a> </li><li> <a href="adl.validator.html#var-in-implementation-validations">in-implementation-validations</a> </li><li> <a href="adl.validator.html#var-key-validations">key-validations</a> </li><li> <a href="adl.validator.html#var-list-validations">list-validations</a> </li><li> <a href="adl.validator.html#var-option-validations">option-validations</a> </li><li> <a href="adl.validator.html#var-order-validations">order-validations</a> </li><li> <a href="adl.validator.html#var-page-content">page-content</a> </li><li> <a href="adl.validator.html#var-page-stuff">page-stuff</a> </li><li> <a href="adl.validator.html#var-page-validations">page-validations</a> </li><li> <a href="adl.validator.html#var-param-validations">param-validations</a> </li><li> <a href="adl.validator.html#var-permission-validations">permission-validations</a> </li><li> <a href="adl.validator.html#var-permissions">permissions</a> </li><li> <a href="adl.validator.html#var-pragma-validations">pragma-validations</a> </li><li> <a href="adl.validator.html#var-prompt-validations">prompt-validations</a> </li><li> <a href="adl.validator.html#var-property-validations">property-validations</a> </li><li> <a href="adl.validator.html#var-reference-validations">reference-validations</a> </li><li> <a href="adl.validator.html#var-sequences">sequences</a> </li><li> <a href="adl.validator.html#var-simple-data-types">simple-data-types</a> </li><li> <a href="adl.validator.html#var-special-data-types">special-data-types</a> </li><li> <a href="adl.validator.html#var-specification-validations">specification-validations</a> </li><li> <a href="adl.validator.html#var-top-validations">top-validations</a> </li><li> <a href="adl.validator.html#var-try-validate">try-validate</a> </li><li> <a href="adl.validator.html#var-typedef-validations">typedef-validations</a> </li><li> <a href="adl.validator.html#var-valid-adl.3F">valid-adl?</a> </li><li> <a href="adl.validator.html#var-validate-adl">validate-adl</a> </li><li> <a href="adl.validator.html#var-validate-adl-file">validate-adl-file</a> </li><li> <a href="adl.validator.html#var-verb-validations">verb-validations</a> </li></ul></div></div></div></body></html> |