summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/harveyballs
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2013-10-23 22:36:26 +0000
committerKarl Berry <karl@freefriends.org>2013-10-23 22:36:26 +0000
commitf2774ca5d48f5ad0f49343181ea3a9677d99d90c (patch)
tree4068e056646b78bdb9b3709da47503f6816c54b9 /Master/texmf-dist/doc/latex/harveyballs
parentbe557c9e5b206f9bb931da8bd1ea4fd4fe2e1311 (diff)
harveyballs (23oct13)
git-svn-id: svn://tug.org/texlive/trunk@31980 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/latex/harveyballs')
-rw-r--r--Master/texmf-dist/doc/latex/harveyballs/README25
-rw-r--r--Master/texmf-dist/doc/latex/harveyballs/harveyballs-Manual.pdfbin0 -> 130233 bytes
-rw-r--r--Master/texmf-dist/doc/latex/harveyballs/harveyballs-Manual.tex96
3 files changed, 121 insertions, 0 deletions
diff --git a/Master/texmf-dist/doc/latex/harveyballs/README b/Master/texmf-dist/doc/latex/harveyballs/README
new file mode 100644
index 00000000000..16082328c1a
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/harveyballs/README
@@ -0,0 +1,25 @@
+Harvey Balls for LaTeX
+Copyright (C) 2013 Sascha Roth, Technical University Munich, sascha.roth@mytum.de
+
+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/>.
+
+This package provides the commands to create Harvey Balls using tikz.
+
+ \harveyBallNone
+ \harveyBallQuarter
+ \harveyBallHalf
+ \harveyBallThreeQuarter
+ \harveyBallFull
+
+All commands take an optional parameter to set the size. Default is \normalsize to be used in inline text and tables. \ No newline at end of file
diff --git a/Master/texmf-dist/doc/latex/harveyballs/harveyballs-Manual.pdf b/Master/texmf-dist/doc/latex/harveyballs/harveyballs-Manual.pdf
new file mode 100644
index 00000000000..b9274513707
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/harveyballs/harveyballs-Manual.pdf
Binary files differ
diff --git a/Master/texmf-dist/doc/latex/harveyballs/harveyballs-Manual.tex b/Master/texmf-dist/doc/latex/harveyballs/harveyballs-Manual.tex
new file mode 100644
index 00000000000..f025e150f5d
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/harveyballs/harveyballs-Manual.tex
@@ -0,0 +1,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}