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