Skip to content

Commit 362e1fc

Browse files
author
Vladimir Kotal
committed
add spellchecking README
1 parent 26800a4 commit 362e1fc

File tree

1 file changed

+27
-0
lines changed

1 file changed

+27
-0
lines changed

README.spellcheck

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
2+
In the Makefile there is the 'spellcheck' target. This is meant pretty much for
3+
non-interactive runs (e.g. via Travis). For spell checking, aspell is used.
4+
5+
The spell checking works by transforming the file via m4 (using macros.m4)
6+
and sed (using spellfilter.sed).
7+
8+
The sed filters are not very smart, especially they cannot deal with multi line
9+
LateX commands. For those, wrap the lines inside the ifdef, like so:
10+
11+
ifdef([[[NOSPELLCHECK]]], [[[
12+
\texttt{void \funnm{err}(int \emph{status},
13+
const char *\emph{fmt}, ...);}
14+
]]])
15+
16+
The [[[ and ]]] character sequences are left and right quotation marks,
17+
respectively (see macros.m4) not to interfere with LateX quotation.
18+
19+
There is a personal dictionary in unix_dict.txt. Try not to add too much stuff
20+
there, especially names of functions, headers, varibles, constants etc. as these
21+
should be eradicated using either m4 or sed.
22+
23+
Sometimes it is not obvious from the output from the 'spellcheck' makefile
24+
target where particular problem is. To do that it is necessary to enter
25+
interactive mode on file processed by m4/sed and then run aspell with the
26+
'check' command (that requires file name as argument) in one terminal window and
27+
edit the original .tex file in another window.

0 commit comments

Comments
 (0)