1 |
\chapter {A Chapter} |
\chapter {A Chapter} |
2 |
|
|
3 |
This a section called ''1 A Chapter''. In this section we mentioned a \id{new |
This a chapter called ''A Chapter''. In this chapter we mention a \id{new |
4 |
concept} . Using the id command will highlight the word and place a reference |
concept} . Using the id command will highlight the word and place a reference |
5 |
in the index. |
in the index. Use a separate file for each chapter. |
6 |
|
|
7 |
\section{A section} |
\section{A section} |
8 |
|
|
9 |
This is a section called ''1.1 A section'' |
This is a section called ''A section''. Use sections to divide and categorise functions. |
10 |
|
|
11 |
\noindent This is a mtable |
\noindent This is a mtable |
12 |
|
|
16 |
the second is 10cm wide. Very handy \\ |
the second is 10cm wide. Very handy \\ |
17 |
} |
} |
18 |
|
|
19 |
|
|
20 |
|
|
21 |
\noindent This is a mtable |
\noindent This is a mtable |
22 |
|
|
23 |
\mtablex{lX}{ |
\mtablex{lX}{ |
36 |
Put the function prototype here |
Put the function prototype here |
37 |
\end{verbatim} |
\end{verbatim} |
38 |
|
|
39 |
This is the description of a function. It is classed as a subsubsection |
This is the description of a function. It is classed as a subsection. |
40 |
|
|
41 |
\begin{verbatim} |
\begin{verbatim} |
42 |
This is the function code. Verbatim mode allows you to copy |
This is the function code. Verbatim mode allows you to copy |
43 |
and paste in without worrying that LaTeX will mangle it in |
and paste in without worrying that LaTeX will mangle it in |
44 |
some way |
some way. ex: |
45 |
|
|
46 |
|
if (num_physpages >= (128 * 1024)) |
47 |
|
goal = num_physpages >> (21 - PAGE_SHIFT); |
48 |
|
else |
49 |
|
goal = num_physpages >> (23 - PAGE_SHIFT); |
50 |
\end{verbatim} |
\end{verbatim} |
51 |
|
|
52 |
|
use 4 spaces to indent each level. DO NOT use TABS. In vi the easiest way to indent is,\\ |
53 |
|
\begin{enumerate} |
54 |
|
\item :set sw=4 |
55 |
|
\item in visual mode (v), select the code to indent |
56 |
|
\item press '=' |
57 |
|
\end{enumerate} |
58 |
|
|
59 |
|
|
60 |
|
|
61 |
\begin{description} |
\begin{description} |
62 |
|
|
63 |
\idx{some field} This is the description environment that should be used when |
\idx{some field} This is the description environment that should be used when |
64 |
describiing structs or whatever. Using \texttt{idx} wil |
describiing structs or whatever. Using \texttt{idx} will |
65 |
place the entry ''some field'' into the Index and cite this |
place the entry ''some field'' into the Index and cite this |
66 |
page reference |
page reference |
67 |
|
|
69 |
field'' but it will not be added to the index. |
field'' but it will not be added to the index. |
70 |
|
|
71 |
\end{description} |
\end{description} |
72 |
|
|
73 |
|
Use the above description environment to describe structure fields and function parameters. |