70ac908729685fdb5726ed77c2bba17da8410b32
[dwarf-doc.git] / dwarf5 / latexdoc / hint.txt
1 %DWARF5 local or useful Latex macros
2
3 \dwf DWARF Debugging Information Format
4 \docdate  % document date, like 1 April 1492
5
6 \begin{myindentpara}{1cm}
7 jtext indented 1 cm or whatever distance in arg
8 \end{myindentpara}
9
10 \copyright  % shows copyright symbol.
11
12 \begin{itemize} % A bullet list
13 \item x
14 \end {itemize}
15
16 \begin{tabular}{ll}
17 % another example: \begin{tabular}{l|p{10cm}} \hline
18 a&b\\
19 d&e\\
20 \end{tabular}
21
22 \dash  % Use as in   x\dash y  to print x-y
23 % but don't do this inside chapter or paragraph headings!
24
25 % Underbar is special to latex, so use \_ not plain _  .
26 % In rare cases we must hyphenate a DW\_OP\_call4 or the like to
27 % avoid an overfull hbox. So use  DW\-\_OP\-\_call4 (for example) and
28 % latex will hyphenate (otherwise it will not with these underbar words).
29
30 % By default x<n>y prints strangely because of
31 % the default code page of T1 involved,  so one can use
32     x\textless~n~\textgreater~y  
33 % instead.
34
35 \begin{verbatim}
36 Text here is not formatted or examined except to look for \end{verbatim}
37 \end{verbatim}
38
39 \begin{alltt}  % \usepackage{alltt} to make this accessible
40 Here the contents are not reformatted, but various
41 commands are allowed.
42 \end{alltt}
43 % see https://en.wikibooks.org/wiki/LaTeX/Paragraph_Formatting#Verbatim_Text
44
45 % Generate a page ref.
46 % use like \refersec{chap:registerbasedaddressing}
47
48 %Generate a live link into the doc
49 % use like \livelink{DW\_OP\_dup}{chap:DWOPdup}
50
51 % To print < use \textless and for > use \textgreater
52 % which is awkward.
53
54 \begin{lstlisting}
55 % C or other example code goes here.
56 \end{lstlisting}
57
58 % The nesting order (showing via indent here) is:
59 \chapter{title}
60  \section{title} 
61   \subsection{title} 
62    \subsubsection{title} 
63     \paragraph{title}
64
65 \label{fig:classesofattributevalue}
66
67 \textit{this text shows in italics}
68
69 \begin{enumerate}[1]  % or [a] for lowercase alpha item id
70 \item xtitle \\    % The  backslash pair gets indented content
71 x content
72 \item ytitle \\
73 y content
74 \end{enumerate}
75