Annotation of charlint/Overview.html, revision 1.43
1.1 duerst 1: <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"
1.34 duerst 2: "http://www.w3.org/TR/REC-html40/loose.dtd">
3: <html>
4: <head>
5: <meta http-equiv="Content-Type" content="text/html">
6: <meta http-equiv="Content-Style-Type" content="text/css">
1.1 duerst 7: <!--BASE href="http://www.w3.org/Consortium/Translation/"-->
8: <!--LINK rel="stylesheet" href="../i18n.css"-->
1.34 duerst 9: <style type="text/css"> <!--
10: H1.title {text-align: center }
11: P.toolbar { text-align: center }
12: DIV.deliverable { margin-left: 2em;
13: margin-right: 2em }
14: P.note { margin-left: 10%;
15: margin-right: 10%;
16: color: green }
17: TH { text-align: left }
18: TH, TD { padding: 2px }
19: .external { font-style: italic }
20: -->
21:
22: </style>
23: <title>Charlint - A Character Normalization Tool</title>
24: <link rel="stylesheet" type="text/css" href="../../StyleSheets/base.css">
25: </head>
26:
27: <body bgcolor="#FFFFFF" text="#000000">
28: <p><a href="/"><img border="0" src="/Icons/WWW/w3c_home" alt="W3C" width="72"
29: height="48"></a> <a href="/International"><img src="/Icons/WWW/i18n-alt"
30: alt="International" width="72" height="48" border="0"></a></p>
31:
32: <h1>Charlint - A Character Normalization Tool</h1>
33:
34: <p><a href="#Perl">Perl source</a> | <a href="#Recommended">Recommended Data
35: Files</a> | <a href="#How">How to use</a> | <a href="#Future">Future Plans</a>
36: | <a href="#Background">Background </a>| <a href="#Version">Version
37: History</a></p>
38:
1.39 duerst 39: <p><strong>IMPORTANT</strong>: New version 0.35, fixes serious bugs (24 July
1.37 duerst 40: 2000)</p>
1.36 duerst 41:
1.34 duerst 42: <p>Charlint is a character normalization/checking tool written in Perl. Among
43: else, it implements Normalization Form C of <a
44: href="http://www.unicode.org/unicode/reports/tr15/">Unicode TR 15</a>.</p>
45:
46: <h3><a name="Perl">Perl Source</a> and Installation</h3>
47:
48: <p>Charlint , aka 'Charlie', is written in <a
49: href="http://www.perl.com/pace/pub/perldocs/latest.html">Perl 5</a>. You can
50: get the source from <a
51: href="http://www.w3.org/International/charlint/charlint.pl">http://www.w3.org/International/charlint/charlint.pl</a>.
52: Charlint is covered by the <a
53: href="http://www.w3.org/Consortium/Legal/copyright-software.html">W3C software
54: licence</a>. To install charlint, please make sure you have installed <a
55: href="http://www.perl.com/pace/pub/perldocs/latest.html">Perl 5</a>, you have
56: downloaded an appropriate character data file, and you have downloaded the <a
57: href="http://www.w3.org/International/charlint/charlint.pl">Perl source</a>.
58: Please send error reports or comments to <a
59: href="mailto:duerst@w3.org">duerst@w3.org</a>; for anouncements and public
60: discussion please see the Winter mailing list (www-international@w3.org).</p>
61:
62: <h3><a name="Recommended">Recommended Character Data Files</a></h3>
63:
64: <p>Charlint needs information on characters in order to work correctly. To
65: indicate the file you want to use, please use the -f option. The currently
66: recommended character data file is available from <a
1.40 duerst 67: href="fftp://ftp.unicode.org/Public/UNIDATA/UnicodeData-Latest.txt">ftp://ftp.unicode.org/Public/UNIDATA/UnicodeData-Latest.txt</a>.
1.34 duerst 68: Composition exclusions are currently hard-coded and are based on <a
1.41 duerst 69: href="ftp://ftp.unicode.org/Public/UNIDATA/CompositionExclusions.txt">ftp://ftp.unicode.org/Public/UNIDATA/CompositionExclusions.txt</a>
1.42 duerst 70: [Final 3.0.0 version of 10 Sept 1999 for both files; identical with the
71: versions available on the CD-ROM provided with <a
72: href="http://www.unicode.org/unicode/uni2book/u2.html">The Unicode Standard,
73: Version 3.0</a>]. Additional information on these and other files can be found
74: at <a
75: href="http://www.unicode.org/unicode/onlinedat/online.html">http://www.unicode.org/unicode/onlinedat/online.html</a>.</p>
1.34 duerst 76:
77: <h3><a name="How">How to use charlint</a></h3>
78:
79: <p>Charlint is a perl script that works as a simple filter. It uses UTF-8 both
80: for input and for output. Behaviour can be fine-tuned with various options. A
81: list of options such as the one below can be optained by using <kbd>charlint
82: -h</kbd>.</p>
83: <pre>(options prefixed by # are currently not available)
1.14 duerst 84: -b: Remove initial 'Byte Order Mark'
85: -B: Supress warning about initial 'Byte Order Mark'
86: -d: Debug: Thoroughly check character data table input
87: -D: Leave after reading in character data
88: -e: # remove undefined codepoints
89: -E: Do not warn about undefined codepoints
90: -f file: Read data from file
91: (please use newest V3.0 beta datafiles)
1.38 duerst 92: -C: Do not normalize
1.14 duerst 93: -h: Prints out this short description
94: -n: Accept &#ddddd; and &#xhhhh; on input
1.34 duerst 95: (beware of <![CDATA[, <SCRIPT>, <STYLE>)
1.14 duerst 96: -N: Produce &#xhh; on output
97: -o: Print out 'unprintable' bytes as octal
98: -p: # Remove stuff in private zone
99: -P: Supress checking private zone
100: -u: # Fix UTF-8 (convert or remove)
101: -U: Supress checking correctness of UTF-8
1.34 duerst 102: -v: Print version</pre>
103:
104: <h3><a name="Version">Version History</a></h3>
1.39 duerst 105: <pre># History:
106: # 2000/07/24: 0.35, adapted exclusions to 3.0.0 final (+Tibetan) MJD
107: # 2000/07/24: 0.34, $chClass = $CombClass{ch}; should read $chClass = $CombClass{$ch};
108: # implemented -C MJD
109: # 1999/08/16: 0.33, updated for second version of 3.0.0.beta MJD
110: # 1999/07/01: 0.32, adapted surrogates/exclusions to 3.0.0.beta MJD
1.23 duerst 111: # 1999/06/25: 0.31, fixed reordering bug, going public MJD
1.39 duerst 112: # 1999/06/23: 0.30, preparation for W3C member test, without Hangul MJD</pre>
1.34 duerst 113:
114: <h3><a name="Background">Background</a></h3>
115: <ul>
116: <li><a href="http://www.w3.org/TR/WD-charmod">Character Model for the World
117: Wide Web</a> (W3C Working Draft)</li>
118: <li><a href="http://www.unicode.org/unicode/reports/tr15/">Unicode Technical
1.43 ! duerst 119: Report #15</a> (Version 18 part of Unicode V 3.0)</li>
1.34 duerst 120: <li><a href="http://www.w3.org/Status">W3C Open Source Releases</a></li>
121: </ul>
122:
123: <h3><a name="Future">Future Plans</a></h3>
124:
125: <p>We have just released the first version of charlint. There are many things
126: we plan to add in the future:</p>
127: <ul>
128: <li>Hangul syllable normalization</li>
129: <li>Removal of undefined codepoints and codepoints in the private zone</li>
130: <li>Removal/fix of incorrect UTF-8</li>
131: <li>Compatibility character detection or removal.</li>
132: <li>Detection or removal of characters not suitable for markup.</li>
133: </ul>
134:
135: <p>Your help (bug reports, patches, ideas, test cases) is welcome.</p>
136: <hr>
137:
138: <address>
139: <a href="mailto:duerst@w3.org">Martin Dürst</a> <br>
140: <a href="/Help/Webmaster.html">Webmaster</a> <br>
141: last revised $Date: 1999/09/29 09:03:18 $ by $Author: duerst $
142: </address>
143:
144: <p class="policyfooter"><small><a
145: href="/Consortium/Legal/ipr-notice.html#Copyright">Copyright</a> © 1997 <a
146: href="http://www.w3.org">W3C</a> (<a href="http://www.lcs.mit.edu">MIT</a>, <a
147: href="http://www.inria.fr/">INRIA</a>, <a
148: href="http://www.keio.ac.jp/">Keio</a> ), All Rights Reserved. W3C <a
149: href="/Consortium/Legal/ipr-notice.html#Legal Disclaimer">liability,</a> <a
150: href="/Consortium/Legal/ipr-notice.html#W3C Trademarks">trademark</a>, <a
151: href="/Consortium/Legal/copyright-documents.html">document use </a>and <a
152: href="/Consortium/Legal/copyright-software.html">software licensing </a>rules
153: apply. Your interactions with this site are in accordance with our <a
154: href="/Consortium/Legal/privacy-statement.html#Public">public</a> and <a
155: href="/Consortium/Legal/privacy-statement.html#Members">Member</a> privacy
156: statements.</small></p>
157: </body>
158: </html>
Webmaster