Update documentation for 1bf0b9198ef53aa5e22842a7e0a8cabe1054f14d

author: sternenseemann <git@lukasepple.de> 2020-05-19 13:44:15 +0200
committer: sternenseemann <git@lukasepple.de> 2020-05-19 13:44:15 +0200
commit: 946f1209ab44ef3b09ae1cfce97b30082fae41b9 (patch)
tree: a869a40f81e02e1f4d96b90dff9503376bdd2a3f
parent: ead94115faf4ea87e1ae526c4ce4dc56c3eb8786 (diff)
2 files changed, 2 insertions, 2 deletions
diff --git a/doc/logbook/Log/index.html b/doc/logbook/Log/index.html
index c97e521..0c0bdd9 100644
--- a/doc/logbook/Log/index.html
+++ b/doc/logbook/Log/index.html
@@ -1,2 +1,2 @@
 <!DOCTYPE html>
-<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Log (logbook.Log)</title><link rel="stylesheet" href="../../odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc %%VERSION%%"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body><div class="content"><header><nav><a href="../index.html">Up</a> – <a href="../index.html">logbook</a> &#x00BB; Log</nav><h1>Module <code>Log</code></h1><p>OCaml representation and parsing of the <a href="https://gist.github.com/Profpatsch/092ff68fa267b9fa0ccbe13e98149b21">log format</a>.</p><p><em>%%VERSION%% — <a href="%%PKG_HOMEPAGE%%">homepage</a></em></p><nav class="toc"><ul><li><a href="#log">Log</a><ul><li><a href="#log-representation">Log Representation</a></li><li><a href="#log-parsing">Log Parsing</a></li><li><a href="#log-processing">Log processing</a></li><li><a href="#log-building">Log Building</a></li></ul></li></ul></nav></header><section><header><h2 id="log"><a href="#log" class="anchor"></a>Log</h2></header><section><header><h3 id="log-representation"><a href="#log-representation" class="anchor"></a>Log Representation</h3></header><dl><dt class="spec type" id="type-privacy_level"><a href="#type-privacy_level" class="anchor"></a><code><span class="keyword">type</span> privacy_level</code><code> = </code><table class="variant"><tr id="type-privacy_level.Private" class="anchored"><td class="def constructor"><a href="#type-privacy_level.Private" class="anchor"></a><code>| </code><code><span class="constructor">Private</span></code></td></tr><tr id="type-privacy_level.Semi_private" class="anchored"><td class="def constructor"><a href="#type-privacy_level.Semi_private" class="anchor"></a><code>| </code><code><span class="constructor">Semi_private</span></code></td></tr><tr id="type-privacy_level.Public" class="anchored"><td class="def constructor"><a href="#type-privacy_level.Public" class="anchor"></a><code>| </code><code><span class="constructor">Public</span></code></td></tr></table></dt><dd><p>Describes, how private a log item is, where private means “item only visible to oneself, semi-private “item visible to trusted persons” and public “item visible to everyone”.</p></dd></dl><dl><dt class="spec type" id="type-item"><a href="#type-item" class="anchor"></a><code><span class="keyword">type</span> <span>'a item</span></code><code> = </code><table class="variant"><tr id="type-item.Item" class="anchored"><td class="def constructor"><a href="#type-item.Item" class="anchor"></a><code>| </code><code><span class="constructor">Item</span> <span class="keyword">of</span> <a href="index.html#type-privacy_level">privacy_level</a> * <span class="type-var">'a</span> * <span class="type-var">'a</span></code></td></tr></table></dt><dd><p>A log item consisting of its privacy level, a title and a text, both in markup <code>'a</code>.</p></dd></dl><dl><dt class="spec type" id="type-log_entry"><a href="#type-log_entry" class="anchor"></a><code><span class="keyword">type</span> <span>'a log_entry</span></code><code> = </code><table class="variant"><tr id="type-log_entry.Log_entry" class="anchored"><td class="def constructor"><a href="#type-log_entry.Log_entry" class="anchor"></a><code>| </code><code><span class="constructor">Log_entry</span> <span class="keyword">of</span> Ptime.date * <span class="type-var">'a</span> * <span><span><span class="type-var">'a</span> <a href="index.html#type-item">item</a></span> list</span></code></td></tr></table></dt><dd><p>A log entry consisting of a date, a summary and items, both in markup <code>'a</code>.</p></dd></dl><dl><dt class="spec type" id="type-log"><a href="#type-log" class="anchor"></a><code><span class="keyword">type</span> <span>'a log</span></code><code> = <span><span><span class="type-var">'a</span> <a href="index.html#type-log_entry">log_entry</a></span> list</span></code></dt><dd><p>A log file consisting of multiple log entries for multiple days using markup <code>'a</code>.</p></dd></dl><dl><dt class="spec value" id="val-compatible_privacy"><a href="#val-compatible_privacy" class="anchor"></a><code><span class="keyword">val</span> compatible_privacy : <a href="index.html#type-privacy_level">privacy_level</a> <span>&#45;&gt;</span> <a href="index.html#type-privacy_level">privacy_level</a> <span>&#45;&gt;</span> bool</code></dt><dd><p>A test to check wether a privacy level of e. g. an item is compatible with the (maximum) privacy level available.</p></dd></dl><dl><dt class="spec value" id="val-privacy_level_of_char"><a href="#val-privacy_level_of_char" class="anchor"></a><code><span class="keyword">val</span> privacy_level_of_char : char <span>&#45;&gt;</span> <span><a href="index.html#type-privacy_level">privacy_level</a> option</span></code></dt><dd><p>Get the corresponding privacy level for a char</p></dd></dl><dl><dt class="spec value" id="val-filter_privacy_level"><a href="#val-filter_privacy_level" class="anchor"></a><code><span class="keyword">val</span> filter_privacy_level : <a href="index.html#type-privacy_level">privacy_level</a> <span>&#45;&gt;</span> <span><span><span class="type-var">'a</span> <a href="index.html#type-item">item</a></span> list</span> <span>&#45;&gt;</span> <span><span><span class="type-var">'a</span> <a href="index.html#type-item">item</a></span> list</span></code></dt><dd><p>Remove all items incompatible with the given privacy level from the list of items.</p></dd></dl></section><section><header><h3 id="log-parsing"><a href="#log-parsing" class="anchor"></a>Log Parsing</h3><p>log files are parsed using <a href="https://github.com/inhabitedtype/angstrom">angstrom</a>.</p></header><dl><dt class="spec value" id="val-log_parser"><a href="#val-log_parser" class="anchor"></a><code><span class="keyword">val</span> log_parser : <span><span>string <a href="index.html#type-log">log</a></span> Angstrom.t</span></code></dt><dd><p>An angstrom parser for log files</p></dd></dl></section><section><header><h3 id="log-processing"><a href="#log-processing" class="anchor"></a>Log processing</h3></header><dl><dt class="spec value" id="val-apply_markup"><a href="#val-apply_markup" class="anchor"></a><code><span class="keyword">val</span> apply_markup : <span>(<span class="type-var">'a</span> <span>&#45;&gt;</span> <span class="type-var">'b</span>)</span> <span>&#45;&gt;</span> <span><span class="type-var">'a</span> <a href="index.html#type-log">log</a></span> <span>&#45;&gt;</span> <span><span class="type-var">'b</span> <a href="index.html#type-log">log</a></span></code></dt><dd><p>Convert a log's markup. This is especially useful to apply a specific markup to a freshly parsed log file.</p></dd></dl></section><section><header><h3 id="log-building"><a href="#log-building" class="anchor"></a>Log Building</h3></header></section></section></div></body></html>
\ No newline at end of file
+<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Log (logbook.Log)</title><link rel="stylesheet" href="../../odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc %%VERSION%%"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body><div class="content"><header><nav><a href="../index.html">Up</a> – <a href="../index.html">logbook</a> &#x00BB; Log</nav><h1>Module <code>Log</code></h1><p>OCaml representation and parsing of the <a href="https://gist.github.com/Profpatsch/092ff68fa267b9fa0ccbe13e98149b21">log format</a>.</p><p><em>%%VERSION%% — <a href="%%PKG_HOMEPAGE%%">homepage</a></em></p><nav class="toc"><ul><li><a href="#log">Log</a><ul><li><a href="#log-representation">Log Representation</a></li><li><a href="#log-parsing">Log Parsing</a></li><li><a href="#log-processing">Log processing</a></li></ul></li></ul></nav></header><section><header><h2 id="log"><a href="#log" class="anchor"></a>Log</h2></header><section><header><h3 id="log-representation"><a href="#log-representation" class="anchor"></a>Log Representation</h3></header><dl><dt class="spec type" id="type-privacy_level"><a href="#type-privacy_level" class="anchor"></a><code><span class="keyword">type</span> privacy_level</code><code> = </code><table class="variant"><tr id="type-privacy_level.Private" class="anchored"><td class="def constructor"><a href="#type-privacy_level.Private" class="anchor"></a><code>| </code><code><span class="constructor">Private</span></code></td></tr><tr id="type-privacy_level.Semi_private" class="anchored"><td class="def constructor"><a href="#type-privacy_level.Semi_private" class="anchor"></a><code>| </code><code><span class="constructor">Semi_private</span></code></td></tr><tr id="type-privacy_level.Public" class="anchored"><td class="def constructor"><a href="#type-privacy_level.Public" class="anchor"></a><code>| </code><code><span class="constructor">Public</span></code></td></tr></table></dt><dd><p>Describes, how private a log item is, where private means “item only visible to oneself, semi-private “item visible to trusted persons” and public “item visible to everyone”.</p></dd></dl><dl><dt class="spec type" id="type-item"><a href="#type-item" class="anchor"></a><code><span class="keyword">type</span> <span>'a item</span></code><code> = </code><table class="variant"><tr id="type-item.Item" class="anchored"><td class="def constructor"><a href="#type-item.Item" class="anchor"></a><code>| </code><code><span class="constructor">Item</span> <span class="keyword">of</span> <a href="index.html#type-privacy_level">privacy_level</a> * <span class="type-var">'a</span> * <span class="type-var">'a</span></code></td></tr></table></dt><dd><p>A log item consisting of its privacy level, a title and a text, both in markup <code>'a</code>.</p></dd></dl><dl><dt class="spec type" id="type-log_entry"><a href="#type-log_entry" class="anchor"></a><code><span class="keyword">type</span> <span>'a log_entry</span></code><code> = </code><table class="variant"><tr id="type-log_entry.Log_entry" class="anchored"><td class="def constructor"><a href="#type-log_entry.Log_entry" class="anchor"></a><code>| </code><code><span class="constructor">Log_entry</span> <span class="keyword">of</span> Ptime.date * <span class="type-var">'a</span> * <span><span><span class="type-var">'a</span> <a href="index.html#type-item">item</a></span> list</span></code></td></tr></table></dt><dd><p>A log entry consisting of a date, a summary and items, both in markup <code>'a</code>.</p></dd></dl><dl><dt class="spec type" id="type-log"><a href="#type-log" class="anchor"></a><code><span class="keyword">type</span> <span>'a log</span></code><code> = <span><span><span class="type-var">'a</span> <a href="index.html#type-log_entry">log_entry</a></span> list</span></code></dt><dd><p>A log file consisting of multiple log entries for multiple days using markup <code>'a</code>.</p></dd></dl><dl><dt class="spec value" id="val-compatible_privacy"><a href="#val-compatible_privacy" class="anchor"></a><code><span class="keyword">val</span> compatible_privacy : <a href="index.html#type-privacy_level">privacy_level</a> <span>&#45;&gt;</span> <a href="index.html#type-privacy_level">privacy_level</a> <span>&#45;&gt;</span> bool</code></dt><dd><p>A test to check wether a privacy level of e. g. an item is compatible with the (maximum) privacy level available.</p></dd></dl><dl><dt class="spec value" id="val-privacy_level_of_char"><a href="#val-privacy_level_of_char" class="anchor"></a><code><span class="keyword">val</span> privacy_level_of_char : char <span>&#45;&gt;</span> <span><a href="index.html#type-privacy_level">privacy_level</a> option</span></code></dt><dd><p>Get the corresponding privacy level for a char</p></dd></dl><dl><dt class="spec value" id="val-filter_privacy_level"><a href="#val-filter_privacy_level" class="anchor"></a><code><span class="keyword">val</span> filter_privacy_level : <a href="index.html#type-privacy_level">privacy_level</a> <span>&#45;&gt;</span> <span><span><span class="type-var">'a</span> <a href="index.html#type-item">item</a></span> list</span> <span>&#45;&gt;</span> <span><span><span class="type-var">'a</span> <a href="index.html#type-item">item</a></span> list</span></code></dt><dd><p>Remove all items incompatible with the given privacy level from the list of items.</p></dd></dl></section><section><header><h3 id="log-parsing"><a href="#log-parsing" class="anchor"></a>Log Parsing</h3><p>log files are parsed using <a href="https://github.com/inhabitedtype/angstrom">angstrom</a>.</p></header><dl><dt class="spec value" id="val-log_parser"><a href="#val-log_parser" class="anchor"></a><code><span class="keyword">val</span> log_parser : <span><span>string <a href="index.html#type-log">log</a></span> Angstrom.t</span></code></dt><dd><p>An angstrom parser for log files</p></dd></dl></section><section><header><h3 id="log-processing"><a href="#log-processing" class="anchor"></a>Log processing</h3></header><dl><dt class="spec value" id="val-apply_markup"><a href="#val-apply_markup" class="anchor"></a><code><span class="keyword">val</span> apply_markup : <span>(<span class="type-var">'a</span> <span>&#45;&gt;</span> <span class="type-var">'b</span>)</span> <span>&#45;&gt;</span> <span><span class="type-var">'a</span> <a href="index.html#type-log">log</a></span> <span>&#45;&gt;</span> <span><span class="type-var">'b</span> <a href="index.html#type-log">log</a></span></code></dt><dd><p>Convert a log's markup. This is especially useful to apply a specific markup to a freshly parsed log file.</p></dd></dl></section></section></div></body></html>
\ No newline at end of file
diff --git a/doc/logbook/index.html b/doc/logbook/index.html
index bd86251..377da9b 100644
--- a/doc/logbook/index.html
+++ b/doc/logbook/index.html
@@ -1,2 +1,2 @@
 <!DOCTYPE html>
-<html xmlns="http://www.w3.org/1999/xhtml"><head><title>index (logbook.index)</title><link rel="stylesheet" href="../odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc %%VERSION%%"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body><div class="content"><header><nav><a href="../index.html">Up</a> – logbook</nav><h1 id="logbook-index"><a href="#logbook-index" class="anchor"></a>logbook index</h1><nav class="toc"><ul><li><a href="#library-logbook">Library logbook</a></li></ul></nav></header><h2 id="library-logbook"><a href="#library-logbook" class="anchor"></a>Library logbook</h2><p>The entry point of this library is the module: <a href="Log/index.html"><code>Log</code></a>.</p></div></body></html>
\ No newline at end of file
+<html xmlns="http://www.w3.org/1999/xhtml"><head><title>index (logbook.index)</title><link rel="stylesheet" href="../odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc %%VERSION%%"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body><div class="content"><header><nav><a href="../index.html">Up</a> – logbook</nav><h1 id="logbook"><a href="#logbook" class="anchor"></a>logbook</h1><p>The <code>logbook</code> package includes a command line utility and a OCaml library for dealing with <code>log</code> files.</p><nav class="toc"><ul><li><a href="#log-files">log files</a></li><li><a href="#log">Log</a></li><li><a href="#logbook">logbook</a></li></ul></nav></header><h2 id="log-files"><a href="#log-files" class="anchor"></a>log files</h2><p><code>log</code> is a file format for personal diary or log keeping. For detailed information on the <code>log</code> file format see <code>man 7 logbook-log</code> or the <code>README.md</code> distributed with this package.</p><h2 id="log"><a href="#log" class="anchor"></a>Log</h2><p>The <a href="Log/index.html"><code>Log</code></a> module allows for parsing and manipulation of an OCaml representation of <code>log</code> files.</p><h2 id="logbook"><a href="#logbook" class="anchor"></a>logbook</h2><p>For usage information for the <code>logbook</code> utility that can generate HTML from <code>log</code> files see <code>man logbook</code> or the <code>README.md</code> distributed with this package.</p></div></body></html>
\ No newline at end of file
author	sternenseemann <git@lukasepple.de>	2020-05-19 13:44:15 +0200
committer	sternenseemann <git@lukasepple.de>	2020-05-19 13:44:15 +0200
commit	946f1209ab44ef3b09ae1cfce97b30082fae41b9 (patch)
tree	a869a40f81e02e1f4d96b90dff9503376bdd2a3f
parent	ead94115faf4ea87e1ae526c4ce4dc56c3eb8786 (diff)