|
| 1 | +\section{Introduction} |
| 2 | + |
| 3 | +Structure the introduction along the same lines as the abstract. |
| 4 | +Expand on the problem, contribution, result, and meaning in one or two |
| 5 | +paragraphs on each. |
| 6 | + |
| 7 | +% problem |
| 8 | + |
| 9 | +% contribution |
| 10 | + |
| 11 | +% result |
| 12 | + |
| 13 | +% meaning |
| 14 | + |
| 15 | +A few grammatical notes. Elminate passive voice. Passivity |
| 16 | +introduces ambiguity (Who is the actor?). Ambiguity is occasionally a |
| 17 | +useful device, but as a rule it is the antithesis of effective |
| 18 | +scientific communication, so should be avoided. Do not use a citation |
| 19 | +as a noun, always use it as a footnote. For example, instead of |
| 20 | +``\cite{BH:04} measure barrier overheads.'' say ``\citeauthor{BH:04} |
| 21 | +measure barrier overheads~\cite{BH:04}.'' Do not use an unqualified |
| 22 | +``this'' as the noun of your sentence. For example, instead of ``This |
| 23 | +makes caches rock.'' say ``This locality of reference makes caches |
| 24 | +rock.'' |
| 25 | + |
| 26 | +Some other points of style. When writing numbers with units, you |
| 27 | +should insert a small space (\textjava{\\,}) between the number and |
| 28 | +the units. For example, use `\textjava{2.8\\,GHz}', which renders as |
| 29 | +2.8\,GHz. The space is there for correctness (see NIST standards on |
| 30 | +units), and the small space both typesets it nicely and ensures the |
| 31 | +unit does not wrap onto a different line from the number. |
| 32 | + |
| 33 | +The \textjava{todonotes} package provides nice |
| 34 | +\todo[fancyline,color=green,size=\footnotesize]{This is a test of |
| 35 | + todonotes} tricks for adding todo items (\textjava{\\todo}) and |
| 36 | +notes to your draft document. You can make macros with \kathryn{This |
| 37 | + is a note from Kathryn.} color-coded notes from each of the authors. |
| 38 | +When you are ready to submit, you should silence them all with the |
| 39 | +\textjava{disable} package option. Figure~\ref{fig:todo} |
| 40 | +shows\steve{Here's one from Steve.} the package's |
| 41 | +\textjava{\\missingfigure} macro, which is a nice way to make |
| 42 | +place-holders. |
| 43 | + |
| 44 | +When there are numbers for checking before submit, you can use \pending{12456} |
| 45 | +to highlight the number. After you check the number, switch it to |
| 46 | +\checked{12456}. When you submit the paper, change the these two macros to submit |
| 47 | +version, then the color will disappear. |
| 48 | + |
| 49 | +\begin{figure} |
| 50 | + \centering |
| 51 | + \missingfigure{There's a figure missing here} |
| 52 | + \caption{An example of a missing figure, using \textjava{todonotes}' |
| 53 | + \textjava{\\missingfigure} macro.} |
| 54 | + \label{fig:todo} |
| 55 | +\end{figure} |
| 56 | + |
| 57 | +There are good tools for automating the process of running latex. I |
| 58 | +discourage you from using a Makefile. If your editor does not do the |
| 59 | +job for you, you should probably use \textjava{latexmk}, which is |
| 60 | +bundled as part of the standard texlive distribution. There is an |
| 61 | +example configuration file provided in this directory. Copy it into |
| 62 | +your home director with the name \textjava{.latexmkrc} (notice the |
| 63 | +dot). |
| 64 | + |
| 65 | +Gratuitous citation to generate a few bib entries \cite{BH:04,SBF:12,YBFH:12}. |
| 66 | + |
| 67 | +%%% Local Variables: |
| 68 | +%%% mode: latex |
| 69 | +%%% TeX-master: "paper" |
| 70 | +%%% End: |
0 commit comments