The examples of internal live links now work, and
[dwarf-doc.git] / dwarf5 / latexdoc / dwarf5.tex
1 \documentclass[12pt,letterpaper,oneside]{memoir} 
2 % for debugging, add 'draft' (without quotes) to the [] document class list.
3 % If draft is in the document class list, pix are just suggested
4 % by an outline, the pic does not appear as a picture.
5 %
6 \usepackage{url} % For color in letters. Links instead?
7 \usepackage{color} % For color in letters. Links instead?
8 \usepackage{ellipsis} % Provides ... as \dots
9 \usepackage{color}
10 \usepackage{listings}
11 \usepackage{alltt}
12 \lstset{ %
13 language=C++,              % choose the language of the code
14 basicstyle=\footnotesize,  % the size of the fonts that are used for the code
15 numbers=left,              % where to put the line-numbers
16 numberstyle=\footnotesize, % the size of the fonts that are used for the line-numbers
17 stepnumber=1,              % the step between two line-numbers. If it is 1 each line will be numbered
18 numbersep=5pt,             % how far the line-numbers are from the code
19 backgroundcolor=\color{white}, % choose the background color. You must add \usepackage{color}
20 showspaces=false,          % show spaces adding particular underscores
21 showstringspaces=false,    % underline spaces within strings
22 showtabs=false,            % show tabs within strings adding particular underscores
23 frame=single,           % adds a frame around the code
24 tabsize=2,              % sets default tabsize to 2 spaces
25 captionpos=b,           % sets the caption-position to bottom
26 breaklines=true,        % sets automatic line breaking
27 breakatwhitespace=false,% sets if automatic breaks should only happen at whitespace
28 escapeinside={\%*}{*)}  % if you want to add a comment within your code
29 }
30
31 \usepackage{amsmath} % Provides \nobreakdash
32 \usepackage{graphicx} % For pictures
33 \usepackage{longtable}
34 % \textregistered is the trademark symbol
35 \usepackage[headheight=16pt,paper=letterpaper]{geometry}
36 \setlength{\headheight}{15pt}  % avoids warning from latex
37 \usepackage{epic} % For eepic package 
38 \usepackage{eepic} % For the diagram of section relationships
39 \usepackage{makeidx}
40 % hyperref must be the last package listed.
41 % The hyperref settings helps hypertext get right links in the 
42 % pdf of the index.
43 \usepackage[plainpages=false,pdfpagelabels,pagebackref]{hyperref}  % Lets us generate colored active links inside a pdf.
44 \makeindex  % This and the makeidx package allow \index to create index entries.
45
46 \newcommand{\docdate}{13 May 2012}
47
48 \newcommand{\dwf}{DWARF Debugging Information Format}
49 \newenvironment{myindentpara}[1]%
50  {\begin{list}{}%
51    {\setlength{\leftmargin}{#1}}%
52    \item[]%
53  }
54  {\end{list}}
55
56 % broken somehow.
57 %\newcommand{\myindent1}[1]{\begin{myindentpara}{1cm}#1\end{myindentpara}}
58
59 \hypersetup{colorlinks=true,
60   %bookmarks=true,
61   pdfauthor={\dwf\ Committee},
62   pdftitle={\dwf\ Version 4.1}
63 }
64
65 % Generate a page ref.
66 % use like   \refersec{chap:registerbasedaddressing}
67 \newcommand{\refersec}[1]{ \ref{#1} Page \pageref{#1} }
68
69 % Generate a live link in the document
70 % use like \livelink{chap:DWOPdup}{DW\_OP\_dup}
71 \newcommand{\livelink}[2]{ \hyperref[#1]{#2}\index{#2} }
72 % livetarg is the declaration this is the target of livelinks.
73 \newcommand{\livetarg}[2]{ \label{#1} #2\index{#2}  }
74
75 \newcommand{\dash}{\nobreakdash-\hspace{0pt}}  % So we handle dashes ok.
76
77 %Fors simple index entries, this saves typing.
78 \newcommand{\addtoindex}[1]{#1\index{#1}}
79
80
81 \begin{document}
82 \pagestyle{empty}
83 \nonzeroparskip
84 \setlength{\parindent}{0pt} 
85 \setlength{\headheight}{6cm}
86 \setlength{\uppermargin}{6cm}
87
88
89
90 \begin{centering}
91 \LARGE
92 \textbf{\dwf}
93
94 \textbf{Version 4.1}
95
96 \centering
97 \includegraphics[keepaspectratio=true,scale=0.5]{DWlogo}
98
99 \centering
100 \href{http://www.dwarfstd.org}{\dwf\ Committee} 
101
102 \url{http://www.dwarfstd.org}
103
104 \textbf{\docdate}
105
106 \end{centering}
107 \openany
108 \clearpage
109 \openany
110
111 \frontmatter
112 \textmd
113 \normalsize
114 \setlength{\headheight}{15pt}  
115
116 \pagestyle{plain}
117 \makeevenhead{plain}{}{}{}
118 \makeoddhead{plain}{}{}{}
119 \makeevenfoot{plain}{}{}{}
120 \makeoddfoot{plain}{}{}{}
121
122 \nonzeroparskip
123 \setlength{\parindent}{0pt} 
124 \settrims{0.5in}{0.5in}
125 \settypeblocksize{8.2in}{6.0in}
126 %\setlrmarginsandblock{0.6in}{0.6in}{*}
127 %\setheadfoot{15pt}{15pt}
128 %\setheaderspaces {*}{2\onelineskip}{*}
129 \nouppercaseheads
130 \makeevenhead{plain}{}{\rightmark}{}
131 \makeoddhead{plain}{}{\rightmark}{}
132 \makeevenfoot{plain}{\docdate}{}{Page \thepage}
133 \makeoddfoot{plain}{\docdate}{}{Page \thepage}
134
135 \openany
136 \pagenumbering{roman}
137 \nonzeroparskip
138 \setlength{\parindent}{0pt} 
139
140 \include{copyright}
141 \include{foreword}
142
143 \tableofcontents
144 \listoffigures
145 \listoftables
146
147 \mainmatter
148
149 % Define the levels of sectionality that are numbered.
150 \setcounter{secnumdepth}{5}
151
152 \nonzeroparskip
153 \setlength{\parindent}{0pt} 
154
155 \makepagestyle{fragFirstChPage}
156
157 \makeevenhead{fragFirstChPage}{}{}{}
158 \makeoddhead{fragFirstChPage}{}{}{}
159 \makeoddfoot{fragFirstChPage}{\docdate}{}{Page \thepage}
160 \makeevenfoot{fragFirstChPage}{\docdate}{}{Page \thepage}
161
162 \aliaspagestyle{chapter}{fragFirstChPage}
163
164
165
166 \chapterstyle{section}
167 \pagenumbering{arabic}
168
169 \aliaspagestyle{chapter}{fragFirstChPage}
170
171
172 \include{introduction}
173 \include{generaldescription}
174 \include{programscope}
175 \include{dataobject}
176 \include{typeentries}
177 \include{otherdebugginginformation}
178 \include{datarepresentation}
179 %  The \appendix toggles us into appendix chapters
180 \appendix
181 \include{attributesbytag}
182 \include{debugsectionrelationships}
183 \include{encodingdecoding}
184 \include{examples}
185 \include{compression}
186 \include{sectionversionnumbers}
187 \include{gnulicense}
188 \printindex
189 \end{document}