-
Notifications
You must be signed in to change notification settings - Fork 15
Home
Welcome to the rulebook wiki! Please notice there is a second page about technology.
- Port the old 2012-Rulebook to the branch 2012 on GitHub
- Make all the changes by the passed proposals from the Rulebook commitee
- Use some keywords to describe the change, like in which part you did something or which bug you fixed
- Include the name of the chapter or part changed
- Write your commit message in present tense. Why?
- Make sure you commit with the same email address as your Github account. This links the commit with your account. How to set it up
- Use one sentence per line, as git is a line-based version control system
- Add a new line in the code before every new section or subsection to make the code easier to read
- Use a blank line for a new paragraph within a section. Do not use
\\
When referencing a section, it should be labeled as follows:
\part{Racing \label{chap:racing}}
\section{Age Groups \label{sec:racing_age-groups}}
There are age groups. See \ref{subsec:racing_age-groups_little-kids} if you are a little kid.
\subsection{Little Kids \label{subsec:racing_age-groups_little-kids}}
If you are a little kid you should still race unicycles.
Make sure that the label is contained within the section title and brackets.
\begin{itemize} and \end{itemize} should be on their own line.
When using nested lists, tab the second level in.
For example:
\begin{itemize}
\item Item 1
\item Item 2
\begin{itemize}
\item Subitem 1
\item Subitem 2
\end{itemize}
\item Item 3
\end{itemize}
For quoting text, LaTeX automatically makes smart quotes (“ ”) around quoted text if you do the following (for general quoting text):
``This is a quote'' (notice that ones at the end of the sentence are two single apostrophe marks)
For single quotes:
`This is a singled quoted phrase'
For inch markings (like for wheel sizes) you must use math mode ($) in order for LaTeX to not make the smart quotes. For example
Use only a 24$''$ inch wheel for this race.