Debian Codegraph @

texmf-dist/doc/latex/maritime/maritime-doc.tex

raw
1 \documentclass{article}
2 \usepackage{maritime}
3 \usepackage{longtable} % For multi-page tables
4 \usepackage{hyperref} % For hyperlinks
5 \usepackage{xcolor} % For color in examples if needed
6
7 \title{International Maritime Signal Flags Documentation}
8 \author{N.\ E.\ Davis, \texttt{@sigilante}, \texttt{\textasciitilde lagrev-nocfep}}
9 \date{\today}
10
11 \begin{document}
12
13 \maketitle
14
15 \section{Introduction}
16
17 The \textbf{maritime} package provides LaTeX commands for drawing international maritime signal flags using TikZ. This documentation covers the basic usage of the package.
18
19 \section{Installation}
20 To use this package, ensure your \texttt{maritime.sty} file is in a directory where LaTeX can find it (like \texttt{texmf-local/tex/latex/maritime/}) or in the same directory as your document.
21
22 \section{Usage}
23
24 \subsection{Drawing Flags}
25 Flags are drawn using specific commands:
26
27 \begin{itemize}
28 \item \verb|\flagZ|: Draws flag Z.
29 \item \verb|\flagO|: Draws flag O.
30 \item \verb|\flagR|: Draws flag R.
31 \item \verb|\flagP|: Draws flag P.
32 \end{itemize}
33
34 Here's how to use them. We suggest using \verb|\quad| to separate the flags as otherwise they abut.
35
36 \begin{verbatim}
37 \flagZ
38 \flagO
39 \flagR
40 \flagP
41 \end{verbatim}
42
43 Example:
44
45 \flagZ \quad \flagO \quad \flagR \quad \flagP
46
47 Furthermore, we provide the standard name at \verb|\flagXname| and the blazon at \verb|\flagXblazon| for each flag \verb|X|.
48
49 Example:
50
51 \begin{verbatim}
52 \flagZname: \flagZblazon
53 \flagOname: \flagOblazon
54 \flagRname: \flagRblazon
55 \flagPname: \flagPblazon
56 \end{verbatim}
57
58 \noindent
59 \flagZname: \flagZblazon \\
60 \flagOname: \flagOblazon \\
61 \flagRname: \flagRblazon \\
62 \flagPname: \flagPblazon
63
64 \section{The Flags}
65
66 We supply the alphabetical International Code of Symbols maritime flags and the NATO number flags.
67
68 \begin{longtable}{lcl}
69 \caption{International Maritime Signal Flags, Letters} \\
70 A \flagAname & \flagA & \flagAblazon \\
71 B \flagBname & \flagB & \flagBblazon \\
72 C \flagCname & \flagC & \flagCblazon \\
73 D \flagDname & \flagD & \flagDblazon \\
74 E \flagEname & \flagE & \flagEblazon \\
75 F \flagFname & \flagF & \flagFblazon \\
76 G \flagGname & \flagG & \flagGblazon \\
77 H \flagHname & \flagH & \flagHblazon \\
78 I \flagIname & \flagI & \flagIblazon \\
79 J \flagJname & \flagJ & \flagJblazon \\
80 K \flagKname & \flagK & \flagKblazon \\
81 L \flagLname & \flagL & \flagLblazon \\
82 M \flagMname & \flagM & \flagMblazon \\
83 N \flagNname & \flagN & \flagNblazon \\
84 O \flagOname & \flagO & \flagOblazon \\
85 P \flagPname & \flagP & \flagPblazon \\
86 Q \flagQname & \flagQ & \flagQblazon \\
87 R \flagRname & \flagR & \flagRblazon \\
88 S \flagSname & \flagS & \flagSblazon \\
89 T \flagTname & \flagT & \flagTblazon \\
90 U \flagUname & \flagU & \flagUblazon \\
91 V \flagVname & \flagV & \flagVblazon \\
92 W \flagWname & \flagW & \flagWblazon \\
93 X \flagXname & \flagX & \flagXblazon \\
94 Y \flagYname & \flagY & \flagYblazon \\
95 Z \flagZname & \flagZ & \flagZblazon \\
96 \end{longtable}
97
98 \begin{longtable}{lcl}
99 \caption{International Maritime Signal Flags, Numbers} \\
100 0 \flagZeroName & \flagZero & \flagZeroBlazon \\
101 1 \flagOneName & \flagOne & \flagOneBlazon \\
102 2 \flagTwoName & \flagTwo & \flagTwoBlazon \\
103 3 \flagThreeName & \flagThree & \flagThreeBlazon \\
104 4 \flagFourName & \flagFour & \flagFourBlazon \\
105 5 \flagFiveName & \flagFive & \flagFiveBlazon \\
106 6 \flagSixName & \flagSix & \flagSixBlazon \\
107 7 \flagSevenName & \flagSeven & \flagSevenBlazon \\
108 8 \flagEightName & \flagEight & \flagEightBlazon \\
109 9 \flagNineName & \flagNine & \flagNineBlazon \\
110 \end{longtable}
111
112 \subsection{Customization}
113
114 \subsubsection{Size}
115
116 The standard flag size is \verb|15ex|, meaning the height of the flag is 15 times the height of the letter `x'.
117
118 \begin{verbatim}
119 \flagSix
120 \flagNine
121 \end{verbatim}
122
123 Example:
124
125 \flagSix \quad \flagNine
126
127 Flags can be scaled using standard LaTeX font size commands:
128
129 \begin{verbatim}
130 {\Large \flagU}
131 {\normalsize \flagR}
132 {\tiny \flagB}
133 \end{verbatim}
134
135 Example:
136
137 {\Large \flagU} \quad {\normalsize \flagR} \quad {\tiny \flagB}
138
139 They may also be explicitly scaled using the \verb|\resizebox| command:
140
141 \begin{verbatim}
142 \resizebox{!}{5cm}{\flagI}
143 \resizebox{!}{0.5cm}{\flagT}
144 \end{verbatim}
145
146 Example:
147
148 \resizebox{!}{5cm}{\flagI} \quad \resizebox{!}{0.5cm}{\flagT}
149
150 \section{Conclusion}
151
152 % enjoy yourself
153 \begin{center}
154 \flagE \space \flagN \space \flagJ \space \flagO \space \flagY \\
155
156 \flagY \quad \flagO \quad \flagU \quad \flagR \\
157 \quad \flagS \quad \flagE \quad \flagL \quad \flagF
158 \end{center}
159
160 \end{document}