summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/tikzmarmots
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2018-11-09 21:54:24 +0000
committerKarl Berry <karl@freefriends.org>2018-11-09 21:54:24 +0000
commit621d4074c3976631f81047dec629532809f8488a (patch)
treea702e4da411ef5baf887a54ec5fc5ed50f4e00fb /Master/texmf-dist/doc/latex/tikzmarmots
parent05a427a48fbea0f9183ca423dd19d4cbd5feb7a2 (diff)
tikzmarmots (9nov18)
git-svn-id: svn://tug.org/texlive/trunk@49114 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/latex/tikzmarmots')
-rw-r--r--Master/texmf-dist/doc/latex/tikzmarmots/README.md2
-rw-r--r--Master/texmf-dist/doc/latex/tikzmarmots/tikzmarmots-doc.pdfbin212998 -> 226107 bytes
-rw-r--r--Master/texmf-dist/doc/latex/tikzmarmots/tikzmarmots-doc.tex80
3 files changed, 52 insertions, 30 deletions
diff --git a/Master/texmf-dist/doc/latex/tikzmarmots/README.md b/Master/texmf-dist/doc/latex/tikzmarmots/README.md
index cf7b04491f5..dcc8ed647c6 100644
--- a/Master/texmf-dist/doc/latex/tikzmarmots/README.md
+++ b/Master/texmf-dist/doc/latex/tikzmarmots/README.md
@@ -4,7 +4,7 @@ This is a little LaTeX package for marmots to be used in TikZ pictures.
This project is licensed under the LaTeX Project Public License v1.3c or later, see http://www.latex-project.org/lppl.txt
-The project repository, including a bug tracker, can be found at https://github.com/samcarter8/tikzmarmots/issues
+The project repository, including a bug tracker, can be found at https://github.com/samcarter/tikzmarmots/issues
### A few examples:
diff --git a/Master/texmf-dist/doc/latex/tikzmarmots/tikzmarmots-doc.pdf b/Master/texmf-dist/doc/latex/tikzmarmots/tikzmarmots-doc.pdf
index d9bcccafd4d..a05c4313842 100644
--- a/Master/texmf-dist/doc/latex/tikzmarmots/tikzmarmots-doc.pdf
+++ b/Master/texmf-dist/doc/latex/tikzmarmots/tikzmarmots-doc.pdf
Binary files differ
diff --git a/Master/texmf-dist/doc/latex/tikzmarmots/tikzmarmots-doc.tex b/Master/texmf-dist/doc/latex/tikzmarmots/tikzmarmots-doc.tex
index 56351729506..20569b0aba7 100644
--- a/Master/texmf-dist/doc/latex/tikzmarmots/tikzmarmots-doc.tex
+++ b/Master/texmf-dist/doc/latex/tikzmarmots/tikzmarmots-doc.tex
@@ -5,13 +5,13 @@
% Maintained by samcarter
%
% Project repository and bug tracker:
-% https://github.com/samcarter8/tikzmarmots
+% https://github.com/samcarter/tikzmarmots
%
% Released under the LaTeX Project Public License v1.3c or later
% See http://www.latex-project.org/lppl.txt
%
-% Version 0.1
-% July 10, 2018
+% Version 1.0
+% Nov 8, 2018
%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\documentclass[parskip=half]{scrartcl}
@@ -28,13 +28,13 @@
\usepackage[most]{tcolorbox}
\usepackage[paper=a4paper,margin=3cm]{geometry}
\usepackage{url}
-\usepackage[colorlinks=true,breaklinks=true,urlcolor=duckblue,linkcolor=duckblue,citecolor=duckblue,filecolor=duckblue]{hyperref}
\usepackage{xspace}
\usepackage{scrlayer-scrpage}
\usepackage{marvosym}
\usepackage{fontawesome}
\usepackage[hang,flushmargin,bottom]{footmisc}
\usepackage{imakeidx}
+\usepackage[colorlinks=true,breaklinks=true,urlcolor=duckblue,linkcolor=duckblue,citecolor=duckblue,filecolor=duckblue]{hyperref}
% macros %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\newcommand{\CTAN}{\textsc{CTAN}\xspace}
@@ -60,7 +60,7 @@
commentstyle={\color{green!50!black}\slshape},
columns=fullflexible,
emphstyle=\color{orange!70!black},
- emph=[1]{body,blush,whiskers,invisible,cake,crown,teeth},
+ emph=[1]{body,blush,whiskers,invisible,cake,crown,teeth,3D,shadow,askphil,scale,xshift,yshift},
texcsstyle=*\color{duckblue}\bfseries,
keywordstyle=\color{red!60!black}\bfseries,
morekeywords={tikzpicture,scope,patterns,calc,pgfinterruptboundingbox},
@@ -110,24 +110,29 @@
longhair=red!50!brown,
jacket=blue!50!black]
\end{tikzpicture})\\[0.8em]
- \url{https://github.com/samcarter8/tikzmarmots}\\
-% \url{https://www.ctan.org/pkg/tikzmarmots}
+ \url{https://github.com/samcarter/tikzmarmots}\\
+ \url{https://www.ctan.org/pkg/tikzmarmots}
}{samcarter}}
-\date{Version 0.1 -- \today}
+\date{Version 1.0 -- \today}
\begin{document}
\maketitle
\thispagestyle{scrheadings}
+\begin{tcolorbox}[coltext=marmotred,width=.8\textwidth,center, sidebyside=false, bottom=10pt,top=10pt]
+The \tikzmarmots package was merged into the Ti\emph{k}Zlings package. To get an up-to-date version, please load the {\color{duckblue}\lstinline|tikzlings-marmots|} or the more general {\color{duckblue}\lstinline|tikzlings|} package instead.
+\end{tcolorbox}
+
+
\section{Introduction}
\label{intro}
-Inspired by the enthusiasms of the TeX.Stackexchange user \href{https://tex.stackexchange.com/users/121799/marmot}{@marmot} for animals of the same species, this little package can draw marmots using \TikZ.
+Inspired by the enthusiasms of the TeX.Stackexchange user \href{https://tex.stackexchange.com/users/121799/marmot}{@marmot} for beings of the same species, this little package can draw marmots using \TikZ.
Unlike its older sibling, the \tikzducks package, this packages focuses on drawing the marmot itself. Additional accessories are not part of the package, but can be taken from other sources.
-This package is work in progress, therefore I would be happy to hear your feedback and ideas how to improve the package. The head version of the source code can be found on \url{github.com/samcarter8/tikzmarmots}, including a bug tracker -- please make constructive use of it!
-%A more stable package version can be found on \CTAN (\url{www.ctan.org/pkg/tikzmarmots}) and is included in both \miktex and \texlive as \tikzmarmots.
+This package is work in progress, therefore I would be happy to hear your feedback and ideas how to improve the package. The head version of the source code can be found on \url{github.com/samcarter/tikzmarmots}, including a bug tracker -- please make constructive use of it!
+A more stable package version can be found on \CTAN (\url{www.ctan.org/pkg/tikzmarmots}) and is included in both \miktex and \texlive as \tikzmarmots.
If you seek any other assistance (not bug reports/feature requests), I suggest asking on \href{https://tex.stackexchange.com}{TeX.Stackexchange}.
%\subsection{Acknowledgements}
@@ -153,8 +158,6 @@ The \tikzmarmots package loads \TikZ, which in turn loads the \lstinline|xcolor|
\PassOptionsToPackage{svgnames}{xcolor}
\end{lstlisting}
-
-
\section{Usage}
The basic usage is fairly simple, to draw a marmot:
@@ -174,7 +177,17 @@ These keys can for example be used to change the marmot's colour via \lstinline|
\end{tikzpicture}
\end{tcblisting}
-They can also be used to add whiskers to the marmot:
+The colour of the belly and muzzle will use a lighter shade of the selected colour, while a darker shade is chosen for paws, nose and eyes.
+
+The key \lstinline|3D| will make the marmot 3-dimensional:
+
+\begin{tcblisting}{title={3D marmot}}
+\begin{tikzpicture}
+ \marmot[3D]
+\end{tikzpicture}
+\end{tcblisting}
+
+Keys can also be used to add whiskers to the marmot:
\begin{tcblisting}{title={Whiskers}}
\begin{tikzpicture}
@@ -201,21 +214,31 @@ Some marmots even show their chisel teeth:
\end{tikzpicture}
\end{tcblisting}
-\newpage
+The marmots also can cast a shadow:
+
+\begin{tcblisting}{title={Shadow}}
+\begin{tikzpicture}
+ \marmot[shadow]
+\end{tikzpicture}
+\end{tcblisting}
+
+This ability is important if you want to ask Punxsutawney Phil\footnote{\url{https://en.wikipedia.org/wiki/Punxsutawney_Phil}} on Groundhog Day how the weather is going to be. With a probability derived from the statistics of 120 Groundhog Days\footnote{\url{https://www.livescience.com/32974-punxsutawney-phil-weather-prediction-accuracy.html}} the option \lstinline|askphil| might or might not result in a shadow.
+
+\begin{tcblisting}{title={Ask Phil}}
+\begin{tikzpicture}
+ \marmot[askphil]
+\end{tikzpicture}
+\end{tcblisting}
+
+
If the size of the marmots should be changed or shifted:
\begin{tcblisting}{title={Scaled and shifted marmots}, righthand width=3cm}
\begin{tikzpicture}[scale=0.6]
\marmot
- \begin{scope}[xshift=90pt, scale=.5, yshift=150pt]
- \marmot[body=brown!80!gray]
- \end{scope}
- \begin{scope}[xshift=60pt, scale=.5, yshift=100pt]
- \marmot[body=brown!80!yellow]
- \end{scope}
- \begin{scope}[xshift=80pt, scale=.5, yshift=50pt]
- \marmot[body=brown!80!red]
- \end{scope}
+ \marmot[xshift=90pt, scale=.5, yshift=150pt,body=brown!80!gray]
+ \marmot[xshift=60pt, scale=.5, yshift=100pt,body=brown!80!yellow]
+ \marmot[xshift=80pt, scale=.5, yshift=50pt,body=brown!80!red]
\end{tikzpicture}
\end{tcblisting}
@@ -255,7 +278,6 @@ To make the usage easier for the \TikZ-savvy users, the marmots can also be used
\end{tikzpicture}
\end{tcolorbox}
-\clearpage
\section{Further customisation}
The above list of available customisations does not sound very exhaustive, but there are basically infinite possibilities for further customisation, as the marmots are just shapes in a \TikZ picture -- all the heavy weapons of the \TikZ package are thus available for further customisation.
@@ -281,13 +303,15 @@ However there is no need to despair! Many of the accessories from the \tikzducks
The marmots are designed to have the same height as the ducks, so many items can be adopted without any modifications. One example:
-\begin{tcblisting}{title={Marmot King}}
+\addtocounter{footnote}{1}
+\begin{tcblisting}{title={Marmot Queen$^{\thefootnote}$}}
%\usepackage{tikzducks}
\begin{tikzpicture}
\marmot
\duck[invisible,crown]
\end{tikzpicture}
\end{tcblisting}
+\footnotetext[\thefootnote]{The Marmot Queen is inspired by \href{http://www.ilregnodeifanes.it/inglese/summary.htm}{The Fanes' saga}}
Unfortunately not all accessories will work. Some are entirely unsuitable (e.g. clothing which shape was specially designed for the ducks), others can be modified to fit:
@@ -295,9 +319,7 @@ Unfortunately not all accessories will work. Some are entirely unsuitable (e.g.
%\usepackage{tikzducks}
\begin{tikzpicture}
\marmot
- \begin{scope}[scale=0.7,xshift=9,yshift=18]
- \duck[invisible,cake=red!50!violet]
- \end{scope}
+ \duck[invisible, cake=red!50!violet, scale=0.7, xshift=9, yshift=18]
\end{tikzpicture}
\end{tcblisting}