summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/harveyballs/harveyballs-Manual.tex
blob: f025e150f5d96ec820012d0bef44d7391be8b6c6 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
\documentclass{article}%

\title{The \texttt{harveyballs} Package}
\author{Sascha Roth\\Technische Universit\"at M\"unchen\\sascha.roth@mytum.de}

\usepackage{booktabs}%
\usepackage{xspace}%
\usepackage{HarveyBalls}%
%
\begin{document}%
\maketitle

\newcommand{\pkgName}{\texttt{harveyballs}\xspace}

\begin{abstract}
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.
\end{abstract}

\section{Package Dependencies}

The \pkgName package requires the \texttt{tikz} package.


\section{Examples}

\subsection{In text}

This is a normal text with Harvey Balls included.
Here is a value commonly indicating a property is not fulfilled \harveyBallNone.
For partially fulfilled properties you could use a Harvey Ball filled by a quarter, e.g.\,\harveyBallQuarter.
If it is half fulfilled, you could use \harveyBallHalf.
Almost fulfilled properties could be illustrated with \harveyBallThreeQuarter.
Finally, if a certain property is fullfilled entirely you should use \harveyBallFull.

\subsection{In table}
Harvey Balls can also be integrated in tables (cf.\,Table \ref{tab:ExampleForATableIncludingHarveyBalls}).


\begin{table}[h]
	\centering
		\begin{tabular}{lccc}
\hline
									& Approach 1 & Approach 2 & Approach 3\\
\hline
			Property 1	& \harveyBallNone & \harveyBallQuarter & \harveyBallHalf \\
			Property 2	& \harveyBallHalf & \harveyBallThreeQuarter & \harveyBallFull \\
			Property 3	& \harveyBallFull & \harveyBallThreeQuarter & \harveyBallQuarter\\
\hline			
		\end{tabular}
	\caption{Example for a table including Harvey Balls}
	\label{tab:ExampleForATableIncludingHarveyBalls}
\end{table}

\subsection{Custom size}
You can also use custom sized Harvey Balls:\\
%
\begin{table}[h]
	\centering
\begin{tabular}{lc}
\hline
Command & {Produced Harvey Ball}\\
\hline
\verb|\harveyBallNone[14pt]| & \harveyBallNone[14pt] \\
\verb|\harveyBallQuarter[14pt]|& \harveyBallQuarter[14pt]\\
\verb|\harveyBallHalf[14pt]|& \harveyBallHalf[14pt]\\
\verb|\harveyBallThreeQuarter[14pt]|& \harveyBallThreeQuarter[14pt]\\
\verb|\harveyBallFull[14pt]|& \harveyBallFull[14pt]\\
\hline
\end{tabular}
	\caption{Example for custom-sized Harvey Balls}
\end{table}

\section{License}
\begin{verbatim}
Harvey Balls for LaTeX
Copyright (C) 2013 Sascha Roth, Technical University Munich

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program.  If not, see <http://www.gnu.org/licenses/>.
\end{verbatim}

%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).

% 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.

\end{document}