build based on 0979c41

dev/datatoml/index.html

@@ -39,4 +39,4 @@
 type=["a QualifiedType", ...] # probably optional
 type="a QualifiedType" # single-value alternative form
 priority=1 # (optional)
-# other properties...</code></pre><p>A data set is a top-level instance of an <a href="https://toml.io/en/v1.0.0#array-of-tables">array of tables</a>, with any name other than <code>config</code>. Data set names need not be unique, but should be able to be uniquely identified by the combination of their name and parameters.</p><p>Apart from data transformers, there is one recognised data property: <code>uuid</code>, a UUIDv4 string. Any number of additional properties may be given (so long as they do not conflict with the transformer names), they may have special behaviour based on plugins or extensions loaded, but will not be treated specially by DataToolkitBase.</p><p>A data set can have any number of data transformers, but at least two are needed for a functional data set. Data transformers are instances of an array of tables (like data sets), but directly under the data set table.</p><h2 id="Structure-of-a-data-transformer"><a class="docs-heading-anchor" href="#Structure-of-a-data-transformer">Structure of a data transformer</a><a id="Structure-of-a-data-transformer-1"></a><a class="docs-heading-anchor-permalink" href="#Structure-of-a-data-transformer" title="Permalink"></a></h2><p>There are three data transformers types, with the following names:</p><ul><li><code>storage</code></li><li><code>loader</code></li><li><code>writer</code></li></ul><p>All transformers recognise three properties:</p><ul><li><code>driver</code>, the transformer driver name, as a string</li><li><code>type</code>, a single <code>QualifiedType</code> string, or an array of them</li><li><code>priority</code>, an integer which sets the order in which multiple transformers should be considered</li></ul><p>The <code>driver</code> property is mandatory. <code>type</code> and <code>priority</code> can be omitted, in which case they will adopt the default values. The default <code>type</code> value is either determined dynamically from the available methods, or set for that particular transformer.</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../usage/">« Usage</a><a class="docs-footer-nextpage" href="../repl/">REPL »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 0.27.25 on <span class="colophon-date" title="Sunday 3 September 2023 16:41">Sunday 3 September 2023</span>. Using Julia version 1.9.3.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+# other properties...</code></pre><p>A data set is a top-level instance of an <a href="https://toml.io/en/v1.0.0#array-of-tables">array of tables</a>, with any name other than <code>config</code>. Data set names need not be unique, but should be able to be uniquely identified by the combination of their name and parameters.</p><p>Apart from data transformers, there is one recognised data property: <code>uuid</code>, a UUIDv4 string. Any number of additional properties may be given (so long as they do not conflict with the transformer names), they may have special behaviour based on plugins or extensions loaded, but will not be treated specially by DataToolkitBase.</p><p>A data set can have any number of data transformers, but at least two are needed for a functional data set. Data transformers are instances of an array of tables (like data sets), but directly under the data set table.</p><h2 id="Structure-of-a-data-transformer"><a class="docs-heading-anchor" href="#Structure-of-a-data-transformer">Structure of a data transformer</a><a id="Structure-of-a-data-transformer-1"></a><a class="docs-heading-anchor-permalink" href="#Structure-of-a-data-transformer" title="Permalink"></a></h2><p>There are three data transformers types, with the following names:</p><ul><li><code>storage</code></li><li><code>loader</code></li><li><code>writer</code></li></ul><p>All transformers recognise three properties:</p><ul><li><code>driver</code>, the transformer driver name, as a string</li><li><code>type</code>, a single <code>QualifiedType</code> string, or an array of them</li><li><code>priority</code>, an integer which sets the order in which multiple transformers should be considered</li></ul><p>The <code>driver</code> property is mandatory. <code>type</code> and <code>priority</code> can be omitted, in which case they will adopt the default values. The default <code>type</code> value is either determined dynamically from the available methods, or set for that particular transformer.</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../usage/">« Usage</a><a class="docs-footer-nextpage" href="../repl/">REPL »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 0.27.25 on <span class="colophon-date" title="Monday 4 September 2023 14:46">Monday 4 September 2023</span>. Using Julia version 1.9.3.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>