diff options
author | Karl Berry <karl@freefriends.org> | 2018-07-10 21:05:23 +0000 |
---|---|---|
committer | Karl Berry <karl@freefriends.org> | 2018-07-10 21:05:23 +0000 |
commit | a0465167a48139ce48ff14c95343b7afeaa88dee (patch) | |
tree | 371df5843c0c8b93dfa08a00529fd4e0dc05fa02 /Master/texmf-dist/doc/latex/tikzmarmots/tikzmarmots-doc.tex | |
parent | 4c32bf575783193243a14e77f1b8ecee929cb2fe (diff) |
tikzmarmots (10jul18)
git-svn-id: svn://tug.org/texlive/trunk@48177 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/latex/tikzmarmots/tikzmarmots-doc.tex')
-rw-r--r-- | Master/texmf-dist/doc/latex/tikzmarmots/tikzmarmots-doc.tex | 306 |
1 files changed, 306 insertions, 0 deletions
diff --git a/Master/texmf-dist/doc/latex/tikzmarmots/tikzmarmots-doc.tex b/Master/texmf-dist/doc/latex/tikzmarmots/tikzmarmots-doc.tex new file mode 100644 index 00000000000..56351729506 --- /dev/null +++ b/Master/texmf-dist/doc/latex/tikzmarmots/tikzmarmots-doc.tex @@ -0,0 +1,306 @@ +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +% +% Documentation for the tikzmarmots package +% A package to bring little marmots into tikz +% Maintained by samcarter +% +% Project repository and bug tracker: +% https://github.com/samcarter8/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 +% +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +\documentclass[parskip=half]{scrartcl} + +% packages %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +\usepackage[T1]{fontenc} +\usepackage[utf8]{inputenc} +\usepackage[english]{babel} +\usepackage[bitstream-charter]{mathdesign} +\usepackage{tikzducks} +\usetikzlibrary{ducks} +\usepackage{tikzmarmots} +\usetikzlibrary{marmots} +\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} + +% macros %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +\newcommand{\CTAN}{\textsc{CTAN}\xspace} +\newcommand{\TikZ}{Ti\emph{k}Z\xspace} +\newcommand{\tikzducks}{Ti\emph{k}Zducks\xspace} +\newcommand{\tikzmarmots}{Ti\emph{k}Zmarmots\xspace} +\newcommand{\miktex}{MiK\TeX\xspace} +\newcommand{\texlive}{\TeX{}Live\xspace} + +% customisation %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +\definecolor{duckblue}{RGB}{0,70,140} +\definecolor{marmotred}{RGB}{140,20,40} +\addtokomafont{sectioning}{\color{marmotred}} +\addtokomafont{date}{\normalsize} +\addtokomafont{author}{\normalsize} +\setlength{\footnotemargin}{0.7em} + +\lstdefinestyle{marmotstyle}{% + language={[latex]TeX}, + tabsize=2, + breaklines, + basicstyle=\footnotesize\ttfamily, + commentstyle={\color{green!50!black}\slshape}, + columns=fullflexible, + emphstyle=\color{orange!70!black}, + emph=[1]{body,blush,whiskers,invisible,cake,crown,teeth}, + texcsstyle=*\color{duckblue}\bfseries, + keywordstyle=\color{red!60!black}\bfseries, + morekeywords={tikzpicture,scope,patterns,calc,pgfinterruptboundingbox}, + moretexcs={marmot,path,definecolor,scalebox,foreach,node,draw,PassOptionsToPackage,usetikzlibrary,selectcolormodel,colorlet,includegraphics,tikzset,shade,duck}, + delim ={[s][\ttfamily\color{green!50!black}]{$}{$}}, + moredelim=[is][\footnotesize\ttfamily\color{orange!70!black}]{|}{|}, + index=[1][emph] +} + +\tcbset{% + colframe=marmotred, + arc=2mm, + fonttitle=\bfseries, + sidebyside, + listing options={style=marmotstyle}, + center lower, + righthand width=6.5cm, + bottom=0pt, + top=0pt, + before lower={% + \setlength{\parskip}{0.5cm}% + \spaceskip=5\fontdimen2\font% + }, +} + +\lstset{style=marmotstyle} + +\setlength{\footheight}{45pt} + +\cfoot{% + \begin{tikzpicture}[scale=0.5] + \marmot + \duck[invisible,signpost=\scalebox{0.6}{\thepage}] + \end{tikzpicture} +} +\pagestyle{scrheadings} +%\indexsetup{firstpagestyle=scrheadings} +%\makeindex + +% meta %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +\title{The \texorpdfstring{\tikzmarmots}{tikzmarmots} package} +\subtitle{using marmots in \TikZ} +\author{% + \texorpdfstring{\texttt{samcarter} (alias + \begin{tikzpicture}[scale=0.3,baseline=3pt] + \duck[body=yellow!50!brown!50!white, + 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} + }{samcarter}} +\date{Version 0.1 -- \today} + +\begin{document} +\maketitle +\thispagestyle{scrheadings} + +\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. + +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. +If you seek any other assistance (not bug reports/feature requests), I suggest asking on \href{https://tex.stackexchange.com}{TeX.Stackexchange}. + +%\subsection{Acknowledgements} +% +%Without the friendly and helpful community of \href{https://tex.stackexchange.com/}{TeX.Stackexchange} this package would not exist. +% +%%I would like to thank a few fellow users in particular: +%%TODO marmot +%%TODO ulrike + +\subsection{License} + +Copyright \raisebox{0.2em}{\tiny\fontfamily{cmr}\selectfont\textcopyright} +\texttt{samcarter}. Permission is granted to copy, distribute and\slash or modify this software under the terms of the LaTeX project public licence, version 1.3c or later \url{http://www.latex-project.org/lppl.txt}. + +The shown example marmots are purely fictional characters, any resemblance to real marmots or persons is purely coincidental and no copyright infringement is intended. + +\subsection{Dependencies} + +The \tikzmarmots package loads \TikZ, which in turn loads the \lstinline|xcolor| package (amongst others). If you require one of these packages to be loaded with some option, please consider loading it yourself before the \tikzmarmots package or use, e.g. + +\begin{lstlisting}[aboveskip=1.2em,morekeywords={xcolor,svgnames}] + \PassOptionsToPackage{svgnames}{xcolor} +\end{lstlisting} + + + +\section{Usage} + +The basic usage is fairly simple, to draw a marmot: +\begin{tcblisting}{title={Basic marmot}} +\begin{tikzpicture} + \marmot +\end{tikzpicture} +\end{tcblisting} + +To customise this basic marmot, the package uses \lstinline|pgf| keys. + +These keys can for example be used to change the marmot's colour via \lstinline|body=<colour name>|. + +\begin{tcblisting}{title={Blue marmot}} +\begin{tikzpicture} + \marmot[body=blue] +\end{tikzpicture} +\end{tcblisting} + +They can also be used to add whiskers to the marmot: + +\begin{tcblisting}{title={Whiskers}} +\begin{tikzpicture} + \marmot[whiskers] +\end{tikzpicture} +\begin{tikzpicture} + \marmot[whiskers=blue] +\end{tikzpicture} +\end{tcblisting} + +Or to make it blush: + +\begin{tcblisting}{title={Blushing marmot}} +\begin{tikzpicture} + \marmot[blush] +\end{tikzpicture} +\end{tcblisting} + +Some marmots even show their chisel teeth: + +\begin{tcblisting}{title={Chisel teeth}} +\begin{tikzpicture} + \marmot[teeth] +\end{tikzpicture} +\end{tcblisting} + +\newpage +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} +\end{tikzpicture} +\end{tcblisting} + +To make the usage easier for the \TikZ-savvy users, the marmots can also be used as \TikZ library. It can be loaded with \lstinline|\usetikzlibrary{marmots}|. In addition to the normal functionality of the \tikzmarmots package, the marmots are now also available as \lstinline|pic|. A short example: + +\begin{tcolorbox}[title={\TikZ library ``marmots''}] +\begin{lstlisting}[morekeywords={marmots,duck,standalone,tikz,document}] +\documentclass{standalone} + +\usepackage{tikz} +\usetikzlibrary{marmots} + +\begin{document} + +\begin{tikzpicture} +\draw (0,0) pic[ + marmot/body=blue, + marmot/blush, + ] {marmot}; +\draw (2,0) pic[ + scale=1.4, + ] {marmot}; +\end{tikzpicture} + +\end{document} +\end{lstlisting} + +\tcblower +\begin{tikzpicture} +\draw (0,0) pic[ + marmot/body=blue, + marmot/blush, + ] {marmot}; +\draw (2,0) pic[ + scale=1.4, + ] {marmot}; +\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. + +\begin{tcblisting}{title={Adding things to the marmot}} +\begin{tikzpicture} + \marmot + \fill[blue] (2,0) rectangle (1,1); +\end{tikzpicture} +\end{tcblisting} + +%\begin{tcblisting}{title={Monochrome marmot}} +%\begin{tikzpicture} +% \selectcolormodel{gray} +% \marmot +%\end{tikzpicture} +%\end{tcblisting} + +\section{Re-using accessories from the \tikzducks package} + +As already said in the introduction, this package focuses on the marmots themselves and does not provide additional accessories. +However there is no need to despair! Many of the accessories from the \tikzducks package (\url{https://www.ctan.org/pkg/tikzducks}) can be re-used using the \lstinline|invisible| key which will only produce the desired item without a duck. + +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}} +%\usepackage{tikzducks} +\begin{tikzpicture} + \marmot + \duck[invisible,crown] +\end{tikzpicture} +\end{tcblisting} + +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: + +\begin{tcblisting}{title={Happy Birthday!}} +%\usepackage{tikzducks} +\begin{tikzpicture} + \marmot + \begin{scope}[scale=0.7,xshift=9,yshift=18] + \duck[invisible,cake=red!50!violet] + \end{scope} +\end{tikzpicture} +\end{tcblisting} + +For a complete list of available accessories, please see the documentation of the \tikzducks package (\url{http://mirrors.ctan.org/graphics/pgf/contrib/tikzducks/tikzducks-doc.pdf}) + +\end{document}
\ No newline at end of file |