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