This is a summary of coding style rules which is intended to be a guideline for writing portable and readable VHDL code. Following these rules should result in better code quality or, at least, should make finding errors easier.
This version was printed on \today.
\end{abstract}
\newpage
\tableofcontents
\clearpage
\section*{Changelog for rev. \svnrev}
\footnotesize
2009-04-21
\begin{itemize}
\item changed postfix for pulsed signals
\end{itemize}
2009-03-03
\begin{itemize}
\item Author info added
\item\emph{Doxygen} chapter modified
\end{itemize}
2003-02-19
\begin{itemize}
\item SVN revision number / date
\item\emph{Doxygen} and Changelog chapters added
\item Variables usage and placing component instantiation determined
\item Naming conventions extended
\item Combinational blocks template added
\end{itemize}
2009-02-08
\begin{itemize}
\item Minor text corrections
\item Upper case naming convention changed
\end{itemize}
2008-12-19
\begin{itemize}
\item Initial release
\end{itemize}
\normalsize
\clearpage
\include{conventions}
\clearpage
\include{rules}
\clearpage
\begin{appendix}
\begin{flushleft}
\begin{thebibliography}{VHDL01}
\bibitem[ESA94]{ESA94}\emph{R. Creasey, R. Coirault, P. Sinander}: VHDL Modelling Guidelines,
\url{ftp://ftp.estec.esa.nl/pub/vhdl/doc/ModelGuide.pdf}, September 1994
\bibitem[Cad00]{Cad00}\emph{Gerhard R. Cadek}: HDL Coding Style Rules,
\url{http://agcad.ict.tuwien.ac.at/info/hdl_gesamt/hdlcoding/hdlcoding.htm}, 10 September 2000
A lot of cross references are used because they make it easier to find other corresponding parts within the document. A link looks like ``($\rightarrow$\ref{fonts})'' and always belongs to the word(s) right before it.
Further, this document distinguishes between different types of rules. An explanation of these types and the appropriate symbol is shown in table \ref{tab:ruleTypes}.\\
\begin{table}[htb]
\begin{center}
\begin{tabular}{lll}
\toprule
symbol & type & description\\
\midrule
(*) & important & This rule should be followed in any case.\\
(x) & recommended & Coding and reading is a lot easier with this rule.\\
(o) & practical & Your code quality will improve using the rule.\\
none & hints & Just giving you an idea of how it could be.\\