diff options
Diffstat (limited to 'Doc/doc/doc.tex')
| -rw-r--r-- | Doc/doc/doc.tex | 22 |
1 files changed, 18 insertions, 4 deletions
diff --git a/Doc/doc/doc.tex b/Doc/doc/doc.tex index e4b91ac..1d0f279 100644 --- a/Doc/doc/doc.tex +++ b/Doc/doc/doc.tex @@ -187,6 +187,20 @@ text contributions are more than welcome as well. Topics which are not covered in the Apple's style guide will be discussed in this document if necessary. + Footnotes are generally discouraged due to the pain of using + footnotes in the HTML conversion of documents. Footnotes may be + used when they are the best way to present specific information. + When a footnote reference is added at the end of the sentence, it + should follow the sentence-ending punctuation. The \LaTeX{} markup + should appear something like this: + +\begin{verbatim} +This sentence has a footnote reference.% + \footnote{This is the footnote text.} +\end{verbatim} + + Footnotes may appear in the middle of sentences where appropriate. + Many special names are used in the Python documentation, including the names of operating systems, programming languages, standards bodies, and the like. Many of these were assigned \LaTeX{} macros @@ -281,10 +295,10 @@ text contributions are more than welcome as well. to know about \LaTeX{} syntax. A \dfn{comment} is started by the ``percent'' character - (\character{\%}) and continues through the end of the line and all - leading whitespace on the following line. This is a little - different from any programming language I know of, so an example - is in order: + (\character{\%}) and continues through the end of the line + \emph{and all leading whitespace on the following line}. This is + a little different from any programming language I know of, so an + example is in order: \begin{verbatim} This is text.% comment |