diff options
| author | mms <git@sapka.me> | 2024-11-12 23:39:40 +0100 |
|---|---|---|
| committer | mms <git@sapka.me> | 2024-11-12 23:39:40 +0100 |
| commit | 7b0046756dccabac0346e637515d4939a3de3da6 (patch) | |
| tree | 997ef820082bb74d75b6a59d167c6a40e73eb8f3 | |
| parent | 6d3ab5f655c83f78905dccede27e5b1da22cc97c (diff) | |
doc: fix snippet style
| -rw-r--r-- | README.html | 49 | ||||
| -rw-r--r-- | README.org | 2 |
2 files changed, 27 insertions, 24 deletions
diff --git a/README.html b/README.html index f037bc6..57eb60b 100644 --- a/README.html +++ b/README.html @@ -3,7 +3,7 @@ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"> <head> -<!-- 2024-11-12 Tue 23:15 --> +<!-- 2024-11-12 Tue 23:39 --> <meta http-equiv="Content-Type" content="text/html;charset=utf-8" /> <meta name="viewport" content="width=device-width, initial-scale=1" /> <title>Chotto</title> @@ -201,12 +201,12 @@ <h2>Table of Contents</h2> <div id="text-table-of-contents" role="doc-toc"> <ul> -<li><a href="#orgdea3aac">1. Naming & Afew</a></li> -<li><a href="#org94b9395">2. Prerequisites</a></li> -<li><a href="#org0e2ddf0">3. Configuration</a></li> -<li><a href="#org46389b5">4. Config</a></li> -<li><a href="#orgf4ff526">5. Rule sets</a></li> -<li><a href="#org8263f11">6. Filter language</a></li> +<li><a href="#orgdd2ec1d">1. Naming & Afew</a></li> +<li><a href="#orgb9e39e9">2. Prerequisites</a></li> +<li><a href="#org6363f6d">3. Configuration</a></li> +<li><a href="#org60dbc75">4. Config</a></li> +<li><a href="#org31ef853">5. Rule sets</a></li> +<li><a href="#org50fb573">6. Filter language</a></li> </ul> </div> </div> @@ -222,8 +222,8 @@ Chotto is an initial tagging script for Notmuch Chotto is written in Ruby and had a (quite) nice DSL for configuration. </p> -<div id="outline-container-orgdea3aac" class="outline-2"> -<h2 id="orgdea3aac"><span class="section-number-2">1.</span> Naming & Afew</h2> +<div id="outline-container-orgdd2ec1d" class="outline-2"> +<h2 id="orgdd2ec1d"><span class="section-number-2">1.</span> Naming & Afew</h2> <div class="outline-text-2" id="text-1"> <p> Notmuch ecosystem already has a great script for initial tagging - afew. @@ -238,8 +238,8 @@ And because I love Ruby! </div> </div> -<div id="outline-container-org94b9395" class="outline-2"> -<h2 id="org94b9395"><span class="section-number-2">2.</span> Prerequisites</h2> +<div id="outline-container-orgb9e39e9" class="outline-2"> +<h2 id="orgb9e39e9"><span class="section-number-2">2.</span> Prerequisites</h2> <div class="outline-text-2" id="text-2"> <p> Chotto expects: @@ -273,8 +273,8 @@ If you use <b>Windows</b>, you have my sympathy. </div> </div> -<div id="outline-container-org0e2ddf0" class="outline-2"> -<h2 id="org0e2ddf0"><span class="section-number-2">3.</span> Configuration</h2> +<div id="outline-container-org6363f6d" class="outline-2"> +<h2 id="org6363f6d"><span class="section-number-2">3.</span> Configuration</h2> <div class="outline-text-2" id="text-3"> <p> Chotto expects the configuration file to be present in @@ -290,18 +290,19 @@ The user needs to add (at least) two blocks to the file: config & rule sets </div> </div> -<div id="outline-container-org46389b5" class="outline-2"> -<h2 id="org46389b5"><span class="section-number-2">4.</span> Config</h2> +<div id="outline-container-org60dbc75" class="outline-2"> +<h2 id="org60dbc75"><span class="section-number-2">4.</span> Config</h2> <div class="outline-text-2" id="text-4"> <p> Presently, the only option Config expects is the absolute path to the Notmuch database: </p> -<p> -Chotto.configure do - config.database<sub>path</sub> = <code>/home/<user>/mail</code> +<div class="org-src-container"> +<pre class="src src-ruby">Chotto.configure do + config.database_path = =/home/<user>/mail= end -</p> +</pre> +</div> <p> Please, adjust the path to the valid location @@ -309,8 +310,8 @@ Please, adjust the path to the valid location </div> </div> -<div id="outline-container-orgf4ff526" class="outline-2"> -<h2 id="orgf4ff526"><span class="section-number-2">5.</span> Rule sets</h2> +<div id="outline-container-org31ef853" class="outline-2"> +<h2 id="org31ef853"><span class="section-number-2">5.</span> Rule sets</h2> <div class="outline-text-2" id="text-5"> <p> The actual magic happens in <code>Rule Sets</code> which are sets of filters & tag modifications. @@ -356,8 +357,8 @@ Lastly, we save! the message in the database. </div> </div> -<div id="outline-container-org8263f11" class="outline-2"> -<h2 id="org8263f11"><span class="section-number-2">6.</span> Filter language</h2> +<div id="outline-container-org50fb573" class="outline-2"> +<h2 id="org50fb573"><span class="section-number-2">6.</span> Filter language</h2> <div class="outline-text-2" id="text-6"> <p> We can quite easily filter messages based. Chotto accepts filters as: @@ -413,7 +414,7 @@ You can test what is produced by calling <code>#to_query_string</code> on messag </div> <div id="postamble" class="status"> <p class="author">Author: User Mms</p> -<p class="date">Created: 2024-11-12 Tue 23:15</p> +<p class="date">Created: 2024-11-12 Tue 23:39</p> <p class="validation"><a href="https://validator.w3.org/check?uri=referer">Validate</a></p> </div> </body> @@ -42,9 +42,11 @@ The user needs to add (at least) two blocks to the file: config & rule sets * Config Presently, the only option Config expects is the absolute path to the Notmuch database: +#+begin_src ruby Chotto.configure do config.database_path = =/home/<user>/mail= end +#+end_src Please, adjust the path to the valid location |