First draft of Version 5, incorporating numerous approved changes
[dwarf-doc.git] / dwarf5 / latexdoc / dwarf5.tex
index b7bea6e..47cec9d 100644 (file)
@@ -3,7 +3,12 @@
 % If draft is in the document class list, pix are just suggested
 % by an outline, the pic does not appear as a picture.
 %
-\newcommand{\docdate}{May 2, 2013 \hspace{1cm}(***\textbf{DRAFT}***)}
+\newcommand{\docdate}{June 22, 2013}
+%
+\usepackage{ifthen}
+\newboolean{isdraft}
+\setboolean{isdraft}{true}
+\newcommand{\draftmark}{\ifthenelse{\boolean{isdraft}}{*** DRAFT ***}{}}
 %
 \usepackage[T1]{fontenc}
 \usepackage{palatino}
@@ -54,10 +59,7 @@ escapeinside={\%*}{*)}     % if you want to add a comment within your code
 \usepackage{needspace}     % For assuring space remaining on a page
 \usepackage{ifthen}        % For conditional processing
 \usepackage{changepage}    % For odd/even page checks
-%\usepackage{epic}          % For eepic package 
-%\usepackage{eepic}         % For the diagram of section relationships
-%\usepackage{eepicemu}      % For the diagram of section relationships
-\usepackage{tikz}                      % graphics (Appendix B)
+\usepackage{tikz}                 % graphics (Appendix B)
 \usetikzlibrary{shapes.geometric}
 \usetikzlibrary{arrows}
 \usepackage{makeidx}       % For making an index
@@ -82,7 +84,7 @@ escapeinside={\%*}{*)}     % if you want to add a comment within your code
 \hypersetup{colorlinks=true,
   %bookmarks=true,
   pdfauthor={\dwf\ Committee},
-  pdftitle={\dwf\ Version 4.1}
+  pdftitle={\dwf\ Version 5}
 }
 
 % An environment to create a listing-like (boxed) presentation for DWARF examples
@@ -112,6 +114,9 @@ escapeinside={\%*}{*)}     % if you want to add a comment within your code
 % When we want the index entry to look different from the name.
 \newcommand{\livetargi}[3]{\hypertarget{#1}{#2}\index{#3}}
 
+\newcommand{\thirtytwobitdwarfformat}[1][]{\livelink{datarep:xxbitdwffmt}{32-bit DWARF format}}
+\newcommand{\sixtyfourbitdwarfformat}[1][]{\livelink{datarep:xxbitdwffmt}{64-bit DWARF format}}
+
 \newcommand{\dash}{\nobreakdash-\hspace{0pt}}  % So we handle dashes ok.
 
 % The following two let us mark a word as 'do not link' or
@@ -123,10 +128,16 @@ escapeinside={\%*}{*)}     % if you want to add a comment within your code
 \newcommand{\nolink}[1]{#1}
 \newcommand{\noindex}[1]{#1}
 
-% For index entries.
+% For index entries. The tt-variant of each pair is designed to
+% allow a word to appear in tt font in the main test and the index
+% but to collate in the index in its non-tt order. (LaTex normally
+% sorts all tt words before all non-tt words.)
 \newcommand{\addtoindex}[1]{#1\index{#1}}
+\newcommand{\addttindex}[1]{\texttt{#1}\index{#1@\texttt{#1}}}
 \newcommand{\addtoindexi}[2]{#1\index{#2}}
+\newcommand{\addttindexi}[2]{\texttt{#1}\index{#2@\texttt{#2}}}
 \newcommand{\addtoindexx}[1]{\index{#1}}
+\newcommand{\addttindexx}[1]{\index{#1@\texttt{#1}}}
 
 % Quote commands that avoid need for inline UTF-8 in these sources
 \newcommand{\doublequote}[1]{\textquotedblleft #1\textquotedblright}
@@ -146,9 +157,6 @@ escapeinside={\%*}{*)}     % if you want to add a comment within your code
 \renewcommand{\descriptionlabel}[1]{\hspace{\labelsep}\textnormal{#1}}
 \newcommand{\descriptionlabelnl}[1]{\item[#1] \mbox{}\\}
 
-% Reduce vertical space at beginning of a list
-\setlength{\topsep}{0in}
-
 \newcommand{\emptypage}{
     \clearpage
     \vspace*{4in}
@@ -204,43 +212,42 @@ escapeinside={\%*}{*)}     % if you want to add a comment within your code
 \setlength{\parindent}{0pt} 
 \setlength{\headheight}{6cm}
 \setlength{\uppermargin}{6cm}
+\setlength{\topsep}{0pt}
+\tightlists                                    % less spacing before/after lists
 
-\begin{centering}
+\begin{center}
 \LARGE
 \textbf{\dwf}
-
-\textbf{Version 4.1}
-
-\centering
+\\
+\textbf{Version 5}
+\\
 \vspace{1cm}
 \includegraphics[keepaspectratio=true,scale=1.0]{dwarf-logo}
-
-%\centering
-\vspace{2cm}
-\href{http://www.dwarfstd.org}{\dwf\ Committee}
-
-\vspace{1cm} 
+\\
+\vspace{1cm}
+\href{http://www.dwarfstd.org}{\dwf}
+\href{http://www.dwarfstd.org}{Committee}
+\\
+\vspace{0.3cm} 
 \url{http://www.dwarfstd.org}
-
-\large
-\vspace{2cm}
+\\
+\vspace{3cm}
 \textbf{\docdate}
-
-\end{centering}
-
-%\clearpage
-%\openany
+\\
+\ifthenelse{\boolean{isdraft}}{
+       \vspace{1cm}
+       \draftmark}
+       {}
+\end{center}
 
 \textmd
 \normalsize
 \setlength{\headheight}{15pt}  
-
 \pagestyle{plain}
 %\makeevenhead{plain}{}{}{}
 %\makeoddhead{plain}{}{}{}
 %\makeevenfoot{plain}{}{}{}
 %\makeoddfoot{plain}{}{}{}
-
 \nonzeroparskip
 \setlength{\parindent}{0pt} 
 \settrims{0.5in}{0.5in}
@@ -251,19 +258,16 @@ escapeinside={\%*}{*)}     % if you want to add a comment within your code
 \nouppercaseheads
 \makeevenhead{plain}{}{\rightmark}{}
 \makeoddhead{plain}{}{\rightmark}{}
-\makeevenfoot{plain}{\docdate}{}{Page \thepage}
-\makeoddfoot{plain}{\docdate}{}{Page \thepage}
+\makeevenfoot{plain}{\docdate}{\draftmark}{Page \thepage}
+\makeoddfoot{plain}{\docdate}{\draftmark}{Page \thepage}
 
 %\openany
 
 \nonzeroparskip
 \setlength{\parindent}{0pt} 
-
 \flushleft
 \include{copyright}
 \include{foreword}
-\include{foreword4.1}
-\emptypage
 
 \newpage
 \tableofcontents
@@ -274,6 +278,15 @@ escapeinside={\%*}{*)}     % if you want to add a comment within your code
 \cleardoublepage
 \listoftables
 
+\ifthenelse{\boolean{isdraft}}
+       {       {% Environment to keep the following header change local
+               \cleardoublepage
+               \makeevenhead{plain}{}{Change Summary}{}
+               \makeoddhead{plain}{}{Change Summary}{}
+               \include{changesummary}
+               \cleardoublepage}
+       }{}
+
 \flushleft
 \raggedbottom
 \chapterstyle{default}
@@ -283,8 +296,8 @@ escapeinside={\%*}{*)}     % if you want to add a comment within your code
 \makepagestyle{fragFirstChPage}
     \makeevenhead{fragFirstChPage}{}{}{}
     \makeoddhead{fragFirstChPage}{}{}{}
-    \makeoddfoot{fragFirstChPage}{\docdate}{}{Page \thepage}
-    \makeevenfoot{fragFirstChPage}{\docdate}{}{Page \thepage}
+    \makeoddfoot{fragFirstChPage}{\docdate}{\draftmark}{Page \thepage}
+    \makeevenfoot{fragFirstChPage}{\docdate}{\draftmark}{Page \thepage}
 \nouppercaseheads
 \aliaspagestyle{chapter}{fragFirstChPage}
 
@@ -292,21 +305,22 @@ escapeinside={\%*}{*)}     % if you want to add a comment within your code
 \mainmatter
 % Define the levels of sectionality that are numbered.
 \setcounter{secnumdepth}{5}
+
 \include{introduction}
-\include{generaldescription}            \emptypage
+\include{generaldescription}            %\emptypage
 \include{programscope}                  \emptypage
 \include{dataobject}                    \emptypage
-\include{typeentries}                   \emptypage
+\include{typeentries}                   %\emptypage
 \include{otherdebugginginformation}    \emptypage
 \include{datarepresentation}            \emptypage
 
 %  The \appendix toggles us into appendix chapters
 \appendix
 
-\include{attributesbytag}
+\include{attributesbytag}                              %\emptypage
 \include{debugsectionrelationships}     \emptypage
 \include{encodingdecoding}              \emptypage
-\include{examples}                      %\emptypage
+\include{examples}                      \emptypage
 \include{compression}                   %\emptypage
 \include{sectionversionnumbers}
 \include{gnulicense}