Debian Codegraph @

texmf-dist/doc/latex/harveyballs/harveyballs-Manual.tex

raw
1 \documentclass{article}%
2
3 \title{The \texttt{harveyballs} Package}
4 \author{Sascha Roth\\Technische Universit\"at M\"unchen\\[email protected]}
5
6 \usepackage{booktabs}%
7 \usepackage{xspace}%
8 \usepackage{HarveyBalls}%
9 %
10 \begin{document}%
11 \maketitle
12
13
14 %\@harveyBallsSize and \@harveyBallsLineWidth
15
16 \newcommand{\pkgName}{\texttt{harveyballs}\xspace}
17
18 \begin{abstract}
19 This document exemplifies the \pkgName package for \LaTeXe in a nutshell. Harvey balls can be used in arbitrary contexts such as to present survey results in a visual manner or express parameter values of certain characteristics. They provide a visual means to easily compare these values best facilitated by the sophisticated pattern recognition techniques of build in visual human cognition by mother nature.
20 \end{abstract}
21
22 \section{Package Dependencies}
23
24 The \pkgName package requires the \texttt{tikz} package.
25
26
27 \section{Examples and Options}
28
29 \subsection{In text}
30
31 This is a normal text with Harvey Balls included.
32 Here is a value commonly indicating a property is not fulfilled \harveyBallNone.
33 For partially fulfilled properties you could use a Harvey Ball filled by a quarter, e.g.\,\harveyBallQuarter.
34 If it is half fulfilled, you could use \harveyBallHalf.
35 Almost fulfilled properties could be illustrated with \harveyBallThreeQuarter.
36 Finally, if a certain property is fullfilled entirely you should use \harveyBallFull.
37
38 \subsection{In table}
39 Harvey Balls can also be integrated in tables (cf.\,Table \ref{tab:ExampleForATableIncludingHarveyBalls}).
40
41
42 \begin{table}[h]
43 \centering
44 \begin{tabular}{lccc}
45 \hline
46 & Approach 1 & Approach 2 & Approach 3\\
47 \hline
48 Property 1 & \harveyBallNone & \harveyBallQuarter & \harveyBallHalf \\
49 Property 2 & \harveyBallHalf & \harveyBallThreeQuarter & \harveyBallFull \\
50 Property 3 & \harveyBallFull & \harveyBallThreeQuarter & \harveyBallQuarter\\
51 \hline
52 \end{tabular}
53 \caption{Example for a table including Harvey Balls}
54 \label{tab:ExampleForATableIncludingHarveyBalls}
55 \end{table}
56
57 \subsection{Custom size}
58
59 There are two variables available to the user to override the size of the Harvey Balls globally.
60 \begin{itemize}
61 \item \verb|\harveyBallsSize|, i.e. the size of the Harvey Balls and
62 \item \verb|\harveyBallsLineWidth|, i.e. the line width used to draw the Harvey Balls.
63 \end{itemize}
64 Threse values can be changed using the following commands:
65 \begin{itemize}
66 \item \verb|\def\harveyBallsSize{0.85ex}|
67 \item \verb|\def\harveyBallsLineWidth{0.2pt}|
68 \end{itemize}
69 Whereas 0.85ex and 0.2pt would be parameters, i.e. your custom sizes. Note that these are also the default values.
70 \verb|\def\harveyBallsLineWidth{1pt}| and \verb|\def\harveyBallsSize{3ex}| produces:\\
71 \def\harveyBallsLineWidth{1pt}\def\harveyBallsSize{3ex}
72 \harveyBallNone, \harveyBallNone, \harveyBallQuarter, \harveyBallHalf, \harveyBallThreeQuarter, \harveyBallFull. \\
73
74 %reset to defaults
75 %\def\harveyBallsSize{0.85ex}
76 %\def\harveyBallsLineWidth{0.2pt}
77
78
79 You can also use custom sized using an optional parameter for each Harvey Ball\\
80 %
81 \begin{table}[h]
82 \centering
83 \begin{tabular}{lc}
84 \hline
85 Command & {Produced Harvey Ball}\\
86 \hline
87 \verb|\harveyBallNone[14pt]| & \harveyBallNone[14pt] \\
88 \verb|\harveyBallQuarter[14pt]|& \harveyBallQuarter[14pt]\\
89 \verb|\harveyBallHalf[14pt]|& \harveyBallHalf[14pt]\\
90 \verb|\harveyBallThreeQuarter[14pt]|& \harveyBallThreeQuarter[14pt]\\
91 \verb|\harveyBallFull[14pt]|& \harveyBallFull[14pt]\\
92 \hline
93 \end{tabular}
94 \caption{Example for custom-sized Harvey Balls}
95 \end{table}
96
97 \subsection{Custom Colors}
98 The colors of the Havey Balls can be overridden utilizing the user variables
99 \begin{itemize}
100 \item \verb|\harveyBallsColor|, i.e. the fill color of the Harvey Ball and
101 \item \verb|\harveyBallsLineColor|, i.e. the border color of the Harvey Ball.
102 \end{itemize}
103 For instance with \verb|\def\harveyBallsColor{red}| and \verb|\def\harveyBallsLineColor{blue}| you Harvey Balls will apear like this:\\
104 \def\harveyBallsColor{red}
105 \def\harveyBallsLineColor{blue}
106 \harveyBallNone, \harveyBallQuarter, \harveyBallHalf, \harveyBallThreeQuarter, \harveyBallFull. \\
107
108 \def\harveyBallsColor{blue}
109
110 \section{Changelog}
111 \begin{tabular}{llp{8cm}}
112 Date & Version & Changes\\
113 \hline
114 2013/10/26 & Version 1.1 & Added user variables for fill and border colors, custom sizes and improved visual appreareance. Thanks to Daniel H. Luecking from University of Arkansas for the valuable feedback to the initial version and suggestions for improvements \\
115 2013/10/22 & Version 1.0 & Initial release.\\
116 \end{tabular}
117
118
119 \section{License}
120 \begin{verbatim}
121 Harvey Balls for LaTeX
122 Copyright (C) 2013 Sascha Roth, Technical University Munich
123
124 This program is free software: you can redistribute it and/or modify
125 it under the terms of the GNU General Public License as published by
126 the Free Software Foundation, either version 3 of the License, or
127 (at your option) any later version.
128
129 This program is distributed in the hope that it will be useful,
130 but WITHOUT ANY WARRANTY; without even the implied warranty of
131 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
132 GNU General Public License for more details.
133
134 You should have received a copy of the GNU General Public License
135 along with this program. If not, see <http://www.gnu.org/licenses/>.
136 \end{verbatim}
137
138 %This work consists of the files README, svg.dtx (with derived files svg.sty, svg.pdf, Fig.1a.pdf, Fig.1b.eps, Fig.2.pdf, Fig.2.png, sample.tex), preamble.tex, example.svg (with derived files example.pdf and example.pdf).
139
140 % The following files constitute the svg package and should be distributed as a whole: README, svg.dtx, svg.sty, svg.pdf, Fig.1a.pdf, Fig.1b.eps, Fig.2.pdf, Fig.2.png, preamble.tex example.svg, example.pdf, example.pdf_tex, root.C, root.svg, root.pdf, and root.pdf_tex.
141
142 \end{document}