doc/index.html

   1 <html> <head>
   2 <title>howm: note-taking tool on Emacs</title>
   3 </head>
   4
   5 <body>
   6
   7 <a href="index-j.html">Japanese</a>
   8 <hr>
   9
  10 <h1><a href="https://howm.osdn.jp/">howm: Write fragmentarily and read collectively.</a></h1>
  11
  12 <ul>
  13 <li> Download
  14      <a href="https://howm.osdn.jp/a/howm-1.5.0.tar.gz">howm-1.5.0.tar.gz</a>
  15      (snapshot:
  16      <a href="https://melpa.org/#/howm"><img alt="MELPA" src="https://melpa.org/packages/howm-badge.svg"/></a>
  17      /
  18      <a href="https://osdn.net/projects/howm/scm/git/howm/">git</a>
  19      )
  20 <li> <a href="https://leahneukirchen.org/blog/archive/2022/03/note-taking-in-emacs-with-howm.html">Introduction by Leah Neukirchen</a> (thx!)
  21 <li> <a href="README.html">Tutorial</a>
  22 <li> <a href="https://howm.osdn.jp/cgi-bin/hiki/hiki.cgi?e.FrontPage">Wiki, BBS, mailing list</a>
  23 </ul>
  24
  25 <hr>
  26
  27 Howm is a note-taking tool on Emacs.
  28 It is similar to emacs-wiki.el;
  29 you can enjoy hyperlinks and full-text search easily.
  30 It is not similar to emacs-wiki.el;
  31 it can be combined with any format.
  32
  33 <p>
  34 <a href="screen-shot.png"><img alt="screen shot" src="s-screen-shot.png"></a>
  35 <a href="search.png"><img alt="screen shot" src="s-search.png"></a>
  36 <a href="cat.png"><img alt="screen shot" src="s-cat.png"></a>
  37 <a href="menu.png"><img alt="screen shot" src="s-menu.png"></a>
  38 <br>
  39 (<a href="https://howm.osdn.jp/a/rich-title/">Title bar? See rich-title.</a>)
  40 </p>
  41
  42 <hr>
  43
  44 <h2>Hyperlinks</h2>
  45
  46 <ul>
  47 <li>goto link: file name or keyword
  48 <pre>
  49       &gt;&gt;&gt; ~/BabyloniaWave.txt
  50       &gt;&gt;&gt; highway planet
  51 </pre>
  52 <li> come-from link:
  53     If you write
  54 <pre>
  55       &lt;&lt;&lt; crystal star cluster
  56 </pre>
  57     in file A,
  58     all strings 'crystal star cluster' in other files are automatically linked to A.
  59 </ul>
  60 <img src="go.png" alt="goto link">
  61 <img src="come.png" alt="come-from link">
  62
  63 <h2>Full-text search</h2>
  64
  65 <ul>
  66 <li>Everything is based on full-text search (grep);
  67     the above 'links' are shortcuts to grep.
  68 <li>Write fragmentarily and read collectively;
  69     you can concatenate all matched notes into a single buffer.
  70 </ul>
  71
  72 <h2>No conversion</h2>
  73 You can keep your favorite style. :-)
  74 <ul>
  75 <li>text file and free format
  76 <li>implemented as a minor mode; can be combined with other modes.
  77 </ul>
  78
  79 <h2>Todo list with magic sorting</h2>
  80 <ul>
  81 <li>Reminder: sinks slowly.
  82 <li>Todo: floats slowly.
  83 <li>Deadline: floats rapidly when the date is approaching.
  84 </ul>
  85
  86 <hr>
  87
  88 <h2>Install</h2>
  89
  90 <ul>
  91  <li> './configure', 'make', and 'make install'.
  92       Files are installed to /usr/share/emacs/site-lisp/howm/
  93       and /usr/local/share/howm/.
  94  <li> Write below in your .emacs.
  95       <pre>
  96         (require 'howm)
  97       </pre>
  98  <li> If you see 'cannot open load file' error, put this before
  99       the above description.
 100       <pre>
 101         (add-to-list 'load-path "/usr/share/emacs/site-lisp/howm/")
 102       </pre>
 103  <li> (Optional)
 104       When howm runs too slow, try
 105       'M-x customize-group RET howm-efficiency RET'.
 106       In particular, the below settings will be necessary for heavy users.
 107       <pre>
 108         (setq howm-view-use-grep t)  ;; use external grep
 109         (setq howm-menu-refresh-after-save nil)
 110         (setq howm-menu-expiry-hours 6)  ;; cache menu N hours
 111         (setq howm-menu-file "0000-00-00-000000.txt")  ;; don't *search*
 112       </pre>
 113 </ul>
 114
 115 <h2>Customization</h2>
 116
 117 For customization, try 'M-x customize-group RET howm RET'.
 118
 119 <h2>Update from old version</h2>
 120
 121 <h3>1.4.8 to 1.5.0</h3>
 122
 123 <p>
 124 <ul>
 125  <li>"u" key (uniq) in summary buffer is now togglable. You can hit "u" again to cancel "uniq".</li>
 126  <li>If you are interested in the incremental search, try M-x customize-group RET howm-iigrep RET and set howm-iigrep-show-what. It will be turned on by default in the next release.</li>
 127 </ul>
 128 </p>
 129
 130 <h3>1.4.7 to 1.4.8</h3>
 131
 132 <p>
 133 fix for Emacs 28.1
 134 </p>
 135
 136 <h3>1.4.6 to 1.4.7</h3>
 137
 138 <p>
 139 fix a warning in byte compilation, etc. (`font-lock-fontify-buffer' is for interactive use only; use `font-lock-ensure' or `font-lock-flush' instead.)
 140 </p>
 141
 142 <h3>1.4.5 to 1.4.6</h3>
 143
 144 <p>
 145 fix C-c , : (howm-find-yesterday) for newer Emacs.
 146 </p>
 147
 148 <h3>1.4.4 to 1.4.5</h3>
 149
 150 <p>
 151 add French menu
 152 <a href="https://osdn.net/projects/howm/lists/archive/eng/2018/000136.html">thx</a>
 153 <a href="https://osdn.net/projects/howm/lists/archive/eng/2018/000139.html">thx</a>
 154 <ol>
 155  <li>Delete the old menu file 0000-00-00-000000.txt in your howm-directory.
 156  <li>Add (setq howm-menu-lang 'fr) into your .emacs.
 157  <li>Start Emacs and howm.
 158 </ol>
 159 </p>
 160
 161 <h3>1.4.3 to 1.4.4</h3>
 162
 163 <p>
 164 fix for warnings in byte-compilation, etc.
 165 </p>
 166
 167 <h3>1.4.2 to 1.4.3</h3>
 168
 169 <p>
 170 fix for emacs-25, etc.
 171 </p>
 172
 173 <h3>1.4.1 to 1.4.2</h3>
 174
 175 <p>
 176 fix for emacs-24.3, etc.
 177 </p>
 178
 179 <h3>1.4.0 to 1.4.1</h3>
 180
 181 <p>
 182 small bug fix, etc.
 183 </p>
 184
 185 <h3>1.3.9.2 to 1.4.0</h3>
 186
 187 <p>
 188 INCOMPATIBLE update.
 189 If you need compatibility with 1.3.*,
 190 put (setq howm-compatible-to-ver1dot3 t) before (require 'howm) in your .emacs.
 191 See M-x customize-group RET howm-compatibility RET for details.
 192 </p>
 193
 194 <p>
 195 Though howm-1.4.0 has a new menu file,
 196 your old menu file is not updated automatically.
 197 Copy en/0000-00-00-000000.txt into howm/ directory if you like.
 198 Alternatively, you can cut and paste some parts of it to your
 199 howm/0000-00-00-000000.txt by hand.
 200 </p>
 201
 202 <h3>1.3.9.1 to 1.3.9.2</h3>
 203
 204 <p>
 205 small bug fix.
 206 </p>
 207
 208 <h3>1.3.9 to 1.3.9.1</h3>
 209
 210 <p>
 211 bug fix for emacs-24.0.50.
 212 </p>
 213
 214 <h3>1.3.8 to 1.3.9</h3>
 215
 216 <p>
 217 small bug fix, etc.
 218 </p>
 219
 220 <h3>1.3.7 to 1.3.8</h3>
 221
 222 <p>
 223 highlight late deadlines.
 224 small bug fix, etc.
 225 </p>
 226
 227 <h3>1.3.6 to 1.3.7</h3>
 228
 229 <p>
 230 Maintenance release (internal cleaning).
 231 The variable howm-list-normalizer is obsolete now.
 232 Use howm-normalizer instead:
 233 <ul>
 234  <li>(Case 0) What is howm-list-normalizer? I don't know it at all.
 235       --- You need to do nothing. :-)
 236  <li>(Case 1) I've set it in M-x customize-variable.
 237       --- M-x customize-variable howm-list-normalizer RET and select Off.
 238       Then M-x customize-variable howm-normalizer RET and select
 239       the corresponding item again.
 240  <li>(Case 2) I've written (setq howm-list-normalizer 'howm-view-sort-by-XXX)
 241       in my .emacs.
 242       --- Rewrite it to
 243       (setq howm-normalizer 'howm-sort-items-by-XXX).
 244  <li>(Case 3) I've written (setq howm-list-normalizer ...my_original_elisp...).
 245       --- Modify it correspondingly with the below change.
 246       <ul>
 247        <li>Old (howm-list-normalizer):
 248             Specify a function that sorts and REDISPLAYS CURRENT items.
 249        <li>New (howm-normalizer):
 250             Specify a function that RETURNS the sorted list of items
 251             for the GIVEN items.
 252       </ul>
 253       Or, Ask me in
 254       <a href="http://lists.sourceforge.jp/mailman/archives/howm-eng/">
 255       howm-eng ML</a>.
 256 </ul>
 257 </p>
 258
 259 <h3>1.3.5 to 1.3.6</h3>
 260
 261 <p>
 262 Maintenance release.
 263 Font-lock problem was fixed for CVS-head emacs.
 264 </p>
 265
 266 <h3>1.3.4 to 1.3.5</h3>
 267
 268 <p>
 269 Maintenance release.
 270 Today's schedule didn't appear on menu on the last day of DST.
 271 (cf. <a href="https://howm.osdn.jp/a/howm-1.3.4_DST.patch">patch for 1.3.4</a>)
 272 </p>
 273
 274 <h3>1.3.3 to 1.3.4</h3>
 275
 276 <p>
 277 Maintenance release (security fix).
 278 All symbols are marked as risky-local-variable.
 279 </p>
 280
 281 <h3>1.3.2 to 1.3.3</h3>
 282
 283 <p>
 284 Maintenance release.
 285 Several bugs are fixed (for CVS-head emacs, etc).
 286 From this version, sleeping reminders can appear in todo list
 287 in menu buffer.
 288 If you don't like this behavior, please try
 289 M-x customize-variable howm-menu-todo-priority.
 290 </p>
 291
 292 <h3>1.3.1 to 1.3.2</h3>
 293
 294 <p>
 295 Maintenance release.
 296 A few bugs are fixed (mainly for xemacs).
 297 Default value of an option is changed so that
 298 [Today] function will show titles instead of matched lines themselves.
 299 If you don't like this change, try below steps.
 300 <ul>
 301  <li> M-x customize-variable RET howm-list-title RET
 302  <li> Remove check mark on howm-action-lock-date-search.
 303  <li> [Save for Future Sessions]
 304 </ul>
 305 </p>
 306
 307 <h3>1.3.0 to 1.3.1</h3>
 308
 309 <p>
 310 Maintenance release.
 311 A few bugs (locale, xemacs) are fixed.
 312 </p>
 313
 314 <h3>1.2.* to 1.3.0</h3>
 315
 316 <!--
 317 If you have already used howm-1.2.*, you may want to add these codes
 318 into .emacs for backward compatibility.
 319 <pre>
 320 ;; no title in summary buffer
 321 (setq howm-list-title nil)
 322 ;; no search history
 323 (setq howm-history-limit 0)
 324 (setq howm-history-unique nil)
 325 ;; not 'grep -E/-F' but 'egrep/fgrep'
 326 (setq howm-view-grep-command "egrep")
 327 (setq howm-view-fgrep-command "fgrep")
 328 (setq howm-view-grep-extended-option nil)
 329 (setq howm-view-grep-fixed-option nil)
 330 (setq howm-view-grep-file-stdin-option nil)
 331 ;; misc.
 332 (setq howm-template-receive-buffer nil)
 333 (setq howm-view-summary-keep-cursor nil)
 334 </pre>
 335 -->
 336
 337 <p>
 338 Though howm-1.3.0 has a new menu file,
 339 your old menu file is not updated automatically.
 340 Copy en/0000-00-00-000000.txt into howm/ directory if you like.
 341 Alternatively, you can cut and paste some parts of it to your
 342 howm/0000-00-00-000000.txt by hand.
 343 </p>
 344
 345 <p>
 346 Among several new features in howm-1.3.0,
 347 the most useful one will be 'aliases'.
 348 See <a href="README.rd">README</a> for details.
 349 </p>
 350
 351 <hr>
 352
 353 <h2>Contact</h2>
 354
 355 My email address is written at the beginning of source files.
 356
 357 <hr>
 358 <a href="https://osdn.net/"><img src="http://osdn.net/sflogo.php?group_id=913" width="96" height="31" border="0" alt="OSDN"></a>
 359 </body> </html>