simon/dog-and-duck
1
0
Fork 0
Code Issues Pull requests Actions Packages Projects Releases Wiki Activity
dog-and-duck/docs/codox/dog-and-duck.quack.picky.constants.html

14 lines
12 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

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

<!DOCTYPE html PUBLIC ""
"">
<html><head><meta charset="UTF-8" /><title>dog-and-duck.quack.picky.constants 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">Dog-and-duck</span> <span class="project-version">0.1.0</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">Topics</span></h3><ul><li class="depth-1 "><a href="Desiderata.html"><div class="inner"><span>Desiderata</span></div></a></li><li class="depth-1 "><a href="Using_ActivityPub.html"><div class="inner"><span>Using ActivityPub</span></div></a></li><li class="depth-1 "><a href="Validation_Faults.html"><div class="inner"><span>Validation Faults in ActivityPub documents</span></div></a></li><li class="depth-1 "><a href="intro.html"><div class="inner"><span>The Old Dog and Duck</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>dog-and-duck</span></div></div></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>quack</span></div></div></li><li class="depth-3 branch"><a href="dog-and-duck.quack.cli.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>cli</span></div></a></li><li class="depth-3"><a href="dog-and-duck.quack.picky.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>picky</span></div></a></li><li class="depth-4 branch"><a href="dog-and-duck.quack.picky.collections.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>collections</span></div></a></li><li class="depth-4 branch current"><a href="dog-and-duck.quack.picky.constants.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>constants</span></div></a></li><li class="depth-4 branch"><a href="dog-and-duck.quack.picky.control-variables.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>control-variables</span></div></a></li><li class="depth-4 branch"><a href="dog-and-duck.quack.picky.distribution.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>distribution</span></div></a></li><li class="depth-4 branch"><a href="dog-and-duck.quack.picky.objects.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>objects</span></div></a></li><li class="depth-4 branch"><a href="dog-and-duck.quack.picky.scratch.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>scratch</span></div></a></li><li class="depth-4 branch"><a href="dog-and-duck.quack.picky.time.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>time</span></div></a></li><li class="depth-4"><a href="dog-and-duck.quack.picky.utils.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>utils</span></div></a></li><li class="depth-3"><a href="dog-and-duck.quack.quack.html"><div class="inner"><span class="tree" style="top: -269px;"><span class="top" style="height: 278px;"></span><span class="bottom"></span></span><span>quack</span></div></a></li><li class="depth-2"><div class="no-link"><div class="inner"><span class="tree" style="top: -362px;"><span class="top" style="height: 371px;"></span><span class="bottom"></span></span><span>scratch</span></div></div></li><li class="depth-3 branch"><a href="dog-and-duck.scratch.parser.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>parser</span></div></a></li><li class="depth-3"><a href="dog-and-duck.scratch.scratch.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>scratch</span></div></a></li><li class="depth-2"><div class="no-link"><div class="inner"><span class="tree" style="top: -83px;"><span class="top" style="height: 92px;"></span><span class="bottom"></span></span><span>utils</span></div></div></li><li class="depth-3"><a href="dog-and-duck.utils.process.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>process</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="dog-and-duck.quack.picky.constants.html#var-activity-types"><div class="inner"><span>activity-types</span></div></a></li><li class="depth-1"><a href="dog-and-duck.quack.picky.constants.html#var-activitystreams-context-uri"><div class="inner"><span>activitystreams-context-uri</span></div></a></li><li class="depth-1"><a href="dog-and-duck.quack.picky.constants.html#var-actor-types"><div class="inner"><span>actor-types</span></div></a></li><li class="depth-1"><a href="dog-and-duck.quack.picky.constants.html#var-context-key"><div class="inner"><span>context-key</span></div></a></li><li class="depth-1"><a href="dog-and-duck.quack.picky.constants.html#var-implicit-noun-types"><div class="inner"><span>implicit-noun-types</span></div></a></li><li class="depth-1"><a href="dog-and-duck.quack.picky.constants.html#var-noun-types"><div class="inner"><span>noun-types</span></div></a></li><li class="depth-1"><a href="dog-and-duck.quack.picky.constants.html#var-re-rfc5646"><div class="inner"><span>re-rfc5646</span></div></a></li><li class="depth-1"><a href="dog-and-duck.quack.picky.constants.html#var-severity"><div class="inner"><span>severity</span></div></a></li><li class="depth-1"><a href="dog-and-duck.quack.picky.constants.html#var-severity-filters"><div class="inner"><span>severity-filters</span></div></a></li><li class="depth-1"><a href="dog-and-duck.quack.picky.constants.html#var-validation-fault-context-uri"><div class="inner"><span>validation-fault-context-uri</span></div></a></li></ul></div><div class="namespace-docs" id="content"><h1 class="anchor" id="top">dog-and-duck.quack.picky.constants</h1><div class="doc"><div class="markdown"><p>Constants supporting the picky validator.</p></div></div><div class="public anchor" id="var-activity-types"><h3>activity-types</h3><div class="usage"></div><div class="doc"><div class="markdown"><p>The set of types we will accept as activities.</p>
<p>There’s an <a href="https://www.w3.org/TR/activitystreams-vocabulary/#activity-types">explicit set of allowed activity types</a>.</p></div></div><div class="src-link"><a href="https://github.com/simon-brooke/dog-and-duck/blob/master/src/dog_and_duck/quack/picky/constants.clj#L79">view source</a></div></div><div class="public anchor" id="var-activitystreams-context-uri"><h3>activitystreams-context-uri</h3><div class="usage"></div><div class="doc"><div class="markdown"><p>The URI of the context of an ActivityStreams object is expected to be this literal string.</p>
<p><strong>NOTE THAT</strong> the URI actually used in the published suite of activitystreams-test-documents use this URI with ‘http’ rather than ‘https’ as the property part, but the spec itself specifies ‘https’.</p></div></div><div class="src-link"><a href="https://github.com/simon-brooke/dog-and-duck/blob/master/src/dog_and_duck/quack/picky/constants.clj#L20">view source</a></div></div><div class="public anchor" id="var-actor-types"><h3>actor-types</h3><div class="usage"></div><div class="doc"><div class="markdown"><p>The set of types we will accept as actors.</p>
<p>There’s an <a href="https://www.w3.org/TR/activitystreams-vocabulary/#actor-types">explicit set of allowed actor types</a>.</p></div></div><div class="src-link"><a href="https://github.com/simon-brooke/dog-and-duck/blob/master/src/dog_and_duck/quack/picky/constants.clj#L29">view source</a></div></div><div class="public anchor" id="var-context-key"><h3>context-key</h3><div class="usage"></div><div class="doc"><div class="markdown"><p>The Clojure reader barfs on <code>:@context</code>, although it is in principle a valid keyword. So we’ll make it once, here, to make the code more performant and easier to read.</p></div></div><div class="src-link"><a href="https://github.com/simon-brooke/dog-and-duck/blob/master/src/dog_and_duck/quack/picky/constants.clj#L40">view source</a></div></div><div class="public anchor" id="var-implicit-noun-types"><h3>implicit-noun-types</h3><div class="usage"></div><div class="doc"><div class="markdown"><p>These types are not explicitly listed in <a href="https://www.w3.org/TR/activitystreams-vocabulary/#object-types">Section 3.3 of the spec</a>, but are mentioned in narrative</p></div></div><div class="src-link"><a href="https://github.com/simon-brooke/dog-and-duck/blob/master/src/dog_and_duck/quack/picky/constants.clj#L111">view source</a></div></div><div class="public anchor" id="var-noun-types"><h3>noun-types</h3><div class="usage"></div><div class="doc"><div class="markdown"><p>The set of object types we will accept as nouns.</p>
<p>There’s an <a href="https://www.w3.org/TR/activitystreams-vocabulary/#object-types">explicit set of allowed ‘object types’</a>, but by implication it is not exhaustive.</p></div></div><div class="src-link"><a href="https://github.com/simon-brooke/dog-and-duck/blob/master/src/dog_and_duck/quack/picky/constants.clj#L89">view source</a></div></div><div class="public anchor" id="var-re-rfc5646"><h3>re-rfc5646</h3><div class="usage"></div><div class="doc"><div class="markdown"><p>A regex which tests conformity to RFC 5646. Cribbed from <a href="https://newbedev.com/regex-to-detect-locales">https://newbedev.com/regex-to-detect-locales</a></p></div></div><div class="src-link"><a href="https://github.com/simon-brooke/dog-and-duck/blob/master/src/dog_and_duck/quack/picky/constants.clj#L46">view source</a></div></div><div class="public anchor" id="var-severity"><h3>severity</h3><div class="usage"></div><div class="doc"><div class="markdown"><p>Severity of faults found, as follows:</p>
<ol>
<li><code>:info</code> not actually a fault, but an issue noted during validation;</li>
<li><code>:minor</code> things which I consider to be faults, but which don’t actually breach the spec;</li>
<li><code>:should</code> instances where the spec says something SHOULD be done, which isn’t;</li>
<li><code>:must</code> instances where the spec says something MUST be done, which isn’t;</li>
<li><code>:critical</code> instances where I believe the fault means that the object cannot be meaningfully processed.</li>
</ol></div></div><div class="src-link"><a href="https://github.com/simon-brooke/dog-and-duck/blob/master/src/dog_and_duck/quack/picky/constants.clj#L51">view source</a></div></div><div class="public anchor" id="var-severity-filters"><h3>severity-filters</h3><div class="usage"></div><div class="doc"><div class="markdown"><p>Hack for implementing a severity hierarchy</p></div></div><div class="src-link"><a href="https://github.com/simon-brooke/dog-and-duck/blob/master/src/dog_and_duck/quack/picky/constants.clj#L65">view source</a></div></div><div class="public anchor" id="var-validation-fault-context-uri"><h3>validation-fault-context-uri</h3><div class="usage"></div><div class="doc"><div class="markdown"><p>The URI of the context of a validation fault report object shall be this literal string.</p></div></div><div class="src-link"><a href="https://github.com/simon-brooke/dog-and-duck/blob/master/src/dog_and_duck/quack/picky/constants.clj#L74">view source</a></div></div></div></body></html>
Reference in a new issue View git blame Copy permalink