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