Update logbook doc to 5187718.

5 files changed, 50 insertions, 23 deletions

diff --git a/doc/Log.html b/doc/Log.html
index 58619ba..7cc10c3 100644
--- a/doc/Log.html
+++ b/doc/Log.html
@@ -12,6 +12,7 @@
 <link title="Log" rel="Chapter" href="Log.html"><link title="Log" rel="Section" href="#1_Log">
 <link title="Log Representation" rel="Subsection" href="#2_LogRepresentation">
 <link title="Log Parsing" rel="Subsection" href="#2_LogParsing">
+<link title="Log processing" rel="Subsection" href="#2_Logprocessing">
 <link title="Log Building" rel="Subsection" href="#2_LogBuilding">
 <title>Log</title>
 </head>
@@ -25,7 +26,7 @@ OCaml representation and parsing of the
     <a href="https://gist.github.com/Profpatsch/092ff68fa267b9fa0ccbe13e98149b21">log format</a>.
 <p>
 
-    <em>84a3c76 — <a href="https://github.com/sternenseemann/logbook ">homepage</a></em><br>
+    <em>5187718 — <a href="https://github.com/sternenseemann/logbook ">homepage</a></em><br>
 </div>
 <hr width="100%">
 <br>
@@ -57,41 +58,43 @@ OCaml representation and parsing of the
 </tr></table>
 
 <div class="info ">
-Describes, how private a log item is. Semi-private means “visible to trusted persons”<br>
+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”.<br>
 </div>
 
 
-<pre><code><span id="TYPEitem"><span class="keyword">type</span> <code class="type"></code>item</span> = </code></pre><table class="typetable">
+<pre><code><span id="TYPEitem"><span class="keyword">type</span> <code class="type">'a</code> item</span> = </code></pre><table class="typetable">
 <tr>
 <td align="left" valign="top" >
 <code><span class="keyword">|</span></code></td>
 <td align="left" valign="top" >
-<code><span id="TYPEELTitem.Item"><span class="constructor">Item</span></span> <span class="keyword">of</span> <code class="type"><a href="Log.html#TYPEprivacy_level">privacy_level</a> * string * string</code></code></td>
+<code><span id="TYPEELTitem.Item"><span class="constructor">Item</span></span> <span class="keyword">of</span> <code class="type"><a href="Log.html#TYPEprivacy_level">privacy_level</a> * 'a * 'a</code></code></td>
 
 </tr></table>
 
 <div class="info ">
-A log item consisting of a title, a text (formatting/markup unknown) and its privacy level.<br>
+A log item consisting of its privacy level, a title and a text, both in markup <code class="code"><span class="keywordsign">'</span>a</code>.<br>
 </div>
 
 
-<pre><code><span id="TYPElog_entry"><span class="keyword">type</span> <code class="type"></code>log_entry</span> = </code></pre><table class="typetable">
+<pre><code><span id="TYPElog_entry"><span class="keyword">type</span> <code class="type">'a</code> log_entry</span> = </code></pre><table class="typetable">
 <tr>
 <td align="left" valign="top" >
 <code><span class="keyword">|</span></code></td>
 <td align="left" valign="top" >
-<code><span id="TYPEELTlog_entry.Log_entry"><span class="constructor">Log_entry</span></span> <span class="keyword">of</span> <code class="type">Ptime.date * string * <a href="Log.html#TYPEitem">item</a> list</code></code></td>
+<code><span id="TYPEELTlog_entry.Log_entry"><span class="constructor">Log_entry</span></span> <span class="keyword">of</span> <code class="type">Ptime.date * 'a * 'a <a href="Log.html#TYPEitem">item</a> list</code></code></td>
 
 </tr></table>
 
 <div class="info ">
-A log entry consisting of a date (point in time is sufficient, so Ptime is used), a summary and items<br>
+A log entry consisting of a date, a summary and items, both in markup <code class="code"><span class="keywordsign">'</span>a</code>.<br>
 </div>
 
 
-<pre><span id="TYPElog"><span class="keyword">type</span> <code class="type"></code>log</span> = <code class="type"><a href="Log.html#TYPElog_entry">log_entry</a> list</code> </pre>
+<pre><span id="TYPElog"><span class="keyword">type</span> <code class="type">'a</code> log</span> = <code class="type">'a <a href="Log.html#TYPElog_entry">log_entry</a> list</code> </pre>
 <div class="info ">
-A log file consisting of multiple log entries for multiple days<br>
+A log file consisting of multiple log entries for multiple days using markup <code class="code"><span class="keywordsign">'</span>a</code>.<br>
 </div>
 
 
@@ -104,15 +107,26 @@ A test to check wether a privacy level of e. g. an item is
 Get the corresponding privacy level for a char<br>
 </div>
 
-<pre><span id="VALfilter_privacy_level"><span class="keyword">val</span> filter_privacy_level</span> : <code class="type"><a href="Log.html#TYPEprivacy_level">privacy_level</a> -> <a href="Log.html#TYPEitem">item</a> list -> <a href="Log.html#TYPEitem">item</a> list</code></pre><br>
+<pre><span id="VALfilter_privacy_level"><span class="keyword">val</span> filter_privacy_level</span> : <code class="type"><a href="Log.html#TYPEprivacy_level">privacy_level</a> -> 'a <a href="Log.html#TYPEitem">item</a> list -> 'a <a href="Log.html#TYPEitem">item</a> list</code></pre><div class="info ">
+Remove all items incompatible with the given privacy level
+    from the list of items.<br>
+</div>
+<br>
 <h2 id="2_LogParsing">Log Parsing</h2> 
 <p>
 
     log files are parsed using <a href="https://github.com/inhabitedtype/angstrom">angstrom</a>.<br>
 
-<pre><span id="VALlog_parser"><span class="keyword">val</span> log_parser</span> : <code class="type"><a href="Log.html#TYPElog">log</a> Angstrom.t</code></pre><div class="info ">
+<pre><span id="VALlog_parser"><span class="keyword">val</span> log_parser</span> : <code class="type">string <a href="Log.html#TYPElog">log</a> Angstrom.t</code></pre><div class="info ">
 An angstrom parser for log files<br>
 </div>
 <br>
+<h2 id="2_Logprocessing">Log processing</h2><br>
+
+<pre><span id="VALapply_markup"><span class="keyword">val</span> apply_markup</span> : <code class="type">('a -> 'b) -> 'a <a href="Log.html#TYPElog">log</a> -> 'b <a href="Log.html#TYPElog">log</a></code></pre><div class="info ">
+Convert a log's markup. This is especially useful
+    to apply a specific markup to a freshly parsed log file.<br>
+</div>
+<br>
 <h2 id="2_LogBuilding">Log Building</h2><br>
 </body></html>
\ No newline at end of file
diff --git a/doc/html.stamp b/doc/html.stamp
index b9087d0..45bd9a2 100644
--- a/doc/html.stamp
+++ b/doc/html.stamp
@@ -1 +1 @@
-14b4fda0d39bbbc30f75a24e2252a457
\ No newline at end of file
+9db98fff676c9f7671cd36dc52af4cd7
\ No newline at end of file
diff --git a/doc/index_types.html b/doc/index_types.html
index c91a6cc..adea31e 100644
--- a/doc/index_types.html
+++ b/doc/index_types.html
@@ -17,24 +17,26 @@
 <tr><td align="left"><br>I</td></tr>
 <tr><td><a href="Log.html#TYPEitem">item</a> [<a href="Log.html">Log</a>]</td>
 <td><div class="info">
-A log item consisting of a title, a text (formatting/markup unknown) and its privacy level.
+A log item consisting of its privacy level, a title and a text, both in markup <code class="code"><span class="keywordsign">'</span>a</code>.
 </div>
 </td></tr>
 <tr><td align="left"><br>L</td></tr>
 <tr><td><a href="Log.html#TYPElog">log</a> [<a href="Log.html">Log</a>]</td>
 <td><div class="info">
-A log file consisting of multiple log entries for multiple days
+A log file consisting of multiple log entries for multiple days using markup <code class="code"><span class="keywordsign">'</span>a</code>.
 </div>
 </td></tr>
 <tr><td><a href="Log.html#TYPElog_entry">log_entry</a> [<a href="Log.html">Log</a>]</td>
 <td><div class="info">
-A log entry consisting of a date (point in time is sufficient, so Ptime is used), a summary and items
+A log entry consisting of a date, a summary and items, both in markup <code class="code"><span class="keywordsign">'</span>a</code>.
 </div>
 </td></tr>
 <tr><td align="left"><br>P</td></tr>
 <tr><td><a href="Log.html#TYPEprivacy_level">privacy_level</a> [<a href="Log.html">Log</a>]</td>
 <td><div class="info">
-Describes, how private a log item is.
+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”.
 </div>
 </td></tr>
 </table>
diff --git a/doc/index_values.html b/doc/index_values.html
index 17e7130..78034cb 100644
--- a/doc/index_values.html
+++ b/doc/index_values.html
@@ -14,6 +14,12 @@
 &nbsp;</div>
 <h1>Index of values</h1>
 <table>
+<tr><td align="left"><br>A</td></tr>
+<tr><td><a href="Log.html#VALapply_markup">apply_markup</a> [<a href="Log.html">Log</a>]</td>
+<td><div class="info">
+Convert a log's markup.
+</div>
+</td></tr>
 <tr><td align="left"><br>C</td></tr>
 <tr><td><a href="Log.html#VALcompatible_privacy">compatible_privacy</a> [<a href="Log.html">Log</a>]</td>
 <td><div class="info">
@@ -22,7 +28,11 @@ A test to check wether a privacy level of e.
 </td></tr>
 <tr><td align="left"><br>F</td></tr>
 <tr><td><a href="Log.html#VALfilter_privacy_level">filter_privacy_level</a> [<a href="Log.html">Log</a>]</td>
-<td></td></tr>
+<td><div class="info">
+Remove all items incompatible with the given privacy level
+    from the list of items.
+</div>
+</td></tr>
 <tr><td align="left"><br>L</td></tr>
 <tr><td><a href="Log.html#VALlog_parser">log_parser</a> [<a href="Log.html">Log</a>]</td>
 <td><div class="info">
diff --git a/doc/type_Log.html b/doc/type_Log.html
index cfa97de..d0b6980 100644
--- a/doc/type_Log.html
+++ b/doc/type_Log.html
@@ -11,12 +11,13 @@
 <body>
 <code class="code"><span class="keyword">sig</span><br>
 &nbsp;&nbsp;<span class="keyword">type</span>&nbsp;privacy_level&nbsp;=&nbsp;<span class="constructor">Private</span>&nbsp;<span class="keywordsign">|</span>&nbsp;<span class="constructor">Semi_private</span>&nbsp;<span class="keywordsign">|</span>&nbsp;<span class="constructor">Public</span><br>
-&nbsp;&nbsp;<span class="keyword">type</span>&nbsp;item&nbsp;=&nbsp;<span class="constructor">Item</span>&nbsp;<span class="keyword">of</span>&nbsp;<span class="constructor">Log</span>.privacy_level&nbsp;*&nbsp;string&nbsp;*&nbsp;string<br>
-&nbsp;&nbsp;<span class="keyword">type</span>&nbsp;log_entry&nbsp;=&nbsp;<span class="constructor">Log_entry</span>&nbsp;<span class="keyword">of</span>&nbsp;<span class="constructor">Ptime</span>.date&nbsp;*&nbsp;string&nbsp;*&nbsp;<span class="constructor">Log</span>.item&nbsp;list<br>
-&nbsp;&nbsp;<span class="keyword">type</span>&nbsp;log&nbsp;=&nbsp;<span class="constructor">Log</span>.log_entry&nbsp;list<br>
+&nbsp;&nbsp;<span class="keyword">type</span>&nbsp;<span class="keywordsign">'</span>a&nbsp;item&nbsp;=&nbsp;<span class="constructor">Item</span>&nbsp;<span class="keyword">of</span>&nbsp;<span class="constructor">Log</span>.privacy_level&nbsp;*&nbsp;<span class="keywordsign">'</span>a&nbsp;*&nbsp;<span class="keywordsign">'</span>a<br>
+&nbsp;&nbsp;<span class="keyword">type</span>&nbsp;<span class="keywordsign">'</span>a&nbsp;log_entry&nbsp;=&nbsp;<span class="constructor">Log_entry</span>&nbsp;<span class="keyword">of</span>&nbsp;<span class="constructor">Ptime</span>.date&nbsp;*&nbsp;<span class="keywordsign">'</span>a&nbsp;*&nbsp;<span class="keywordsign">'</span>a&nbsp;<span class="constructor">Log</span>.item&nbsp;list<br>
+&nbsp;&nbsp;<span class="keyword">type</span>&nbsp;<span class="keywordsign">'</span>a&nbsp;log&nbsp;=&nbsp;<span class="keywordsign">'</span>a&nbsp;<span class="constructor">Log</span>.log_entry&nbsp;list<br>
 &nbsp;&nbsp;<span class="keyword">val</span>&nbsp;compatible_privacy&nbsp;:&nbsp;<span class="constructor">Log</span>.privacy_level&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;<span class="constructor">Log</span>.privacy_level&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;bool<br>
 &nbsp;&nbsp;<span class="keyword">val</span>&nbsp;privacy_level_of_char&nbsp;:&nbsp;char&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;<span class="constructor">Log</span>.privacy_level&nbsp;option<br>
 &nbsp;&nbsp;<span class="keyword">val</span>&nbsp;filter_privacy_level&nbsp;:<br>
-&nbsp;&nbsp;&nbsp;&nbsp;<span class="constructor">Log</span>.privacy_level&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;<span class="constructor">Log</span>.item&nbsp;list&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;<span class="constructor">Log</span>.item&nbsp;list<br>
-&nbsp;&nbsp;<span class="keyword">val</span>&nbsp;log_parser&nbsp;:&nbsp;<span class="constructor">Log</span>.log&nbsp;<span class="constructor">Angstrom</span>.t<br>
+&nbsp;&nbsp;&nbsp;&nbsp;<span class="constructor">Log</span>.privacy_level&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;<span class="keywordsign">'</span>a&nbsp;<span class="constructor">Log</span>.item&nbsp;list&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;<span class="keywordsign">'</span>a&nbsp;<span class="constructor">Log</span>.item&nbsp;list<br>
+&nbsp;&nbsp;<span class="keyword">val</span>&nbsp;log_parser&nbsp;:&nbsp;string&nbsp;<span class="constructor">Log</span>.log&nbsp;<span class="constructor">Angstrom</span>.t<br>
+&nbsp;&nbsp;<span class="keyword">val</span>&nbsp;apply_markup&nbsp;:&nbsp;(<span class="keywordsign">'</span>a&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;<span class="keywordsign">'</span>b)&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;<span class="keywordsign">'</span>a&nbsp;<span class="constructor">Log</span>.log&nbsp;<span class="keywordsign">-&gt;</span>&nbsp;<span class="keywordsign">'</span>b&nbsp;<span class="constructor">Log</span>.log<br>
 <span class="keyword">end</span></code></body></html>
\ No newline at end of file