1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52
|
[comment {-*- tcl -*- doctools manpage}]
[manpage_begin soundex n 1.0]
[copyright {????, Algorithm: Donald E. Knuth}]
[copyright {2003, Documentation: Andreas Kupries <andreas_kupries@users.sourceforge.net>}]
[copyright {1998, Tcl port: Evan Rempel <erempel@uvic.ca>}]
[moddesc {Soundex}]
[titledesc {Soundex}]
[require Tcl 8.2]
[require soundex [opt 1.0]]
[description]
[para]
This package provides soundex algorithms which allow the
comparison of words based on their phonetic likeness.
[para]
Currently only an algorithm by Knuth is provided, which
is tuned to english names and words.
[list_begin definitions]
[call [cmd ::soundex::knuth] [arg string]]
Computes the soundex code of the input [arg string] using
Knuth's algorithm and returns it as the result of the
command.
[list_end]
[section EXAMPLES]
[example {
% ::soundex::knuth Knuth
K530
}]
[section {BUGS, IDEAS, FEEDBACK}]
This document, and the package it describes, will undoubtedly contain
bugs and other problems.
Please report such in the category [emph soundex] of the
[uri {http://sourceforge.net/tracker/?group_id=12883} {Tcllib SF Trackers}].
Please also report any ideas for enhancements you may have for either
package and/or documentation.
[keywords soundex knuth {text comparison} {text likeness}]
[manpage_end]
|