Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

When using table footnotes, label them using lowercase letters rather than numbers. This eliminates confusion between regular footnotes (which are normally numbered) and per-table footnotes. The first table footnote should be labeled a, the second b, and so on.

Footnotes

When starting a footnote on a new line after an opening brace, don't forget to squelch the unnecessary whitespace by inserting a comment character after the brace:

Code Block
titleFootnote
Some regular text\footnote{%
    The text of the footnote. Notice the comment character above.
} ends here.

Code formatting

The coding conventions for documentation are far less strict than those used for program source code, for obvious reasons of the different levels of complexity and maintenance requirements.

...

Allowed end-of-line character sequence is Unix-style (\n, LF). Windows or Mac line endings are not allowed.

All environments should be intended, excepting the outermost \begin{document} environment.

Working with graphics

JPEG images are not permitted except for photos.

Drawings, diagrams, plots, and other similar kinds of imagery must be in vector formats such as PDF, EPS, SVG, etc; PNG is explicitly prohibited because of image quality issues.

Avoid inclusion of complex graphics in the EPS format, because it tends to be rendered poorly by pdflatex. Prefer the PDF format instead.

...

Code Block
titleWrong
\begin{equation}
    last{\_}response{\_}latency + 1 / (1 + can{\_}bus{\_}bit{\_}rate / 65536)
\end{equation}

...

Code Block
titleCorrect
\begin{equation}
    \text{last{\_}response{\_}latency} + 1 / (1 + \text{can{\_}bus{\_}bit{\_}rate} / 65536)
\end{equation}

...