todo-application.html - www.codemadness.org - www.codemadness.org saait content files
(HTM) git clone git://git.codemadness.org/www.codemadness.org
(DIR) Log
(DIR) Files
(DIR) Refs
(DIR) README
(DIR) LICENSE
---
todo-application.html (4751B)
---
1 <!DOCTYPE html>
2 <html dir="ltr" lang="en">
3 <head>
4 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
5 <meta http-equiv="Content-Language" content="en" />
6 <meta name="viewport" content="width=device-width" />
7 <meta name="keywords" content="todo, simple solutions(tm)" />
8 <meta name="description" content="A simple TODO application workflow" />
9 <meta name="author" content="Hiltjo" />
10 <meta name="generator" content="Static content generated using saait: https://codemadness.org/saait.html" />
11 <title>A simple TODO application - Codemadness</title>
12 <link rel="stylesheet" href="style.css" type="text/css" media="screen" />
13 <link rel="stylesheet" href="print.css" type="text/css" media="print" />
14 <link rel="alternate" href="atom.xml" type="application/atom+xml" title="Codemadness Atom Feed" />
15 <link rel="alternate" href="atom_content.xml" type="application/atom+xml" title="Codemadness Atom Feed with content" />
16 <link rel="icon" href="/favicon.png" type="image/png" />
17 </head>
18 <body>
19 <nav id="menuwrap">
20 <table id="menu" width="100%" border="0">
21 <tr>
22 <td id="links" align="left">
23 <a href="index.html">Blog</a> |
24 <a href="/git/" title="Git repository with some of my projects">Git</a> |
25 <a href="/releases/">Releases</a> |
26 <a href="gopher://codemadness.org">Gopherhole</a>
27 </td>
28 <td id="links-contact" align="right">
29 <span class="hidden"> | </span>
30 <a href="feeds.html">Feeds</a> |
31 <a href="pgp.asc">PGP</a> |
32 <a href="mailto:hiltjo@AT@codemadness.DOT.org">Mail</a>
33 </td>
34 </tr>
35 </table>
36 </nav>
37 <hr class="hidden" />
38 <main id="mainwrap">
39 <div id="main">
40 <article>
41 <header>
42 <h1>A simple TODO application</h1>
43 <p>
44 <strong>Last modification on </strong> <time>2022-07-01</time>
45 </p>
46 </header>
47
48 <p>This article describes a TODO application or workflow.</p>
49 <h2>Workflow</h2>
50 <p>It works like this:</p>
51 <ul>
52 <li>Open any text editor.</li>
53 <li>Edit the text.</li>
54 <li>Save it in a file (probably named "TODO").</li>
55 <li>Feel happy about it.</li>
56 </ul>
57 <h2>The text format</h2>
58 <p>The text format I use is this:</p>
59 <pre><code>[indendations]<symbol><SPACE><item text><NEWLINE>
60 </code></pre>
61 <p>Most of the time an item is just one line.
62 This format is just a general guideline to keep the items somewhat structured.</p>
63 <h2>Symbols</h2>
64 <p>Items are prefixed with a symbol.</p>
65 <ul>
66 <li>- is an item which is planned to be done at some point.</li>
67 <li>x is an item which is done.</li>
68 <li>? is an item which I'm not (yet) sure about. It can also be an idea.</li>
69 </ul>
70 <p>I use an indendation with a TAB before an item to indicate item dependencies.
71 The items can be nested.</p>
72 <p>For the prioritization I put the most important items and sections from the top
73 to the bottom. These can be reshuffled as you wish of course.</p>
74 <p>To delete an item you remove the line. To archive an item you keep the line.</p>
75 <h2>Sections</h2>
76 <p>A section is a line which has no symbol. This is like a header to group items.</p>
77 <h2>Example</h2>
78 <pre><code>Checklist for releasing project 0.1:
79 - Test project with different compilers and check for warnings.
80 - Documentation:
81 - Proofread and make sure it matches all program behaviour.
82 - Run mandoc -Tlint on the man pages.
83 ? Copy useful examples from the README file to the man page?
84 - Run testsuite and check for failures before release.
85
86
87 project 0.2:
88 ? Investigate if feature mentioned by some user is worth adding.
89 </code></pre>
90 <h1>Example: secure remote cloud-encrypted edit session(tm)</h1>
91 <pre><code>ssh -t host 'ed TODO'
92 </code></pre>
93 <h1>Example: multi-user secure remote cloud-encrypted edit session(tm)</h1>
94 <pre><code>ssh host
95 tmux or tmux a
96 ed TODO
97 </code></pre>
98 <h1>Example: version-controlled multi-user secure remote cloud-encrypted edit session(tm)</h1>
99 <pre><code>ssh host
100 tmux or tmux a
101 ed TODO
102 git add TODO
103 git commit -m 'TODO: update'
104 </code></pre>
105 <h2>Pros</h2>
106 <ul>
107 <li>When you open the TODO file the most important items are at the top.</li>
108 <li>The items are easy to read and modify with any text editor.</li>
109 <li>It is easy to extend the format and use with other text tools.</li>
110 <li>The format is portable: it works on sticky-notes on your CRT monitor too!</li>
111 <li>No monthly online subscription needed and full NO-money-back guarantee.</li>
112 </ul>
113 <h2>Cons</h2>
114 <ul>
115 <li>Complex lists with interconnected dependencies might not work, maybe.</li>
116 <li>It's assumed there is one person maintaining the TODO file. Merging items
117 from multiple people at the same time in this workflow is not recommended.</li>
118 <li>It is too simple: noone will be impressed by it.</li>
119 </ul>
120 <p>I hope this is inspirational or something,</p>
121
122 </article>
123 </div>
124 </main>
125 </body>
126 </html>