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 | |
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')
-rw-r--r-- | Master/texmf-dist/doc/latex/tikzmarmots/LICENSE.txt | 415 | ||||
-rw-r--r-- | Master/texmf-dist/doc/latex/tikzmarmots/README.md | 12 | ||||
-rw-r--r-- | Master/texmf-dist/doc/latex/tikzmarmots/tikzmarmots-doc.pdf | bin | 0 -> 212998 bytes | |||
-rw-r--r-- | Master/texmf-dist/doc/latex/tikzmarmots/tikzmarmots-doc.tex | 306 |
4 files changed, 733 insertions, 0 deletions
diff --git a/Master/texmf-dist/doc/latex/tikzmarmots/LICENSE.txt b/Master/texmf-dist/doc/latex/tikzmarmots/LICENSE.txt new file mode 100644 index 00000000000..f8b699e6eb5 --- /dev/null +++ b/Master/texmf-dist/doc/latex/tikzmarmots/LICENSE.txt @@ -0,0 +1,415 @@ +The LaTeX Project Public License +=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=- + +LPPL Version 1.3c 2008-05-04 + +Copyright 1999 2002-2008 LaTeX3 Project + Everyone is allowed to distribute verbatim copies of this + license document, but modification of it is not allowed. + + +PREAMBLE +======== + +The LaTeX Project Public License (LPPL) is the primary license under +which the LaTeX kernel and the base LaTeX packages are distributed. + +You may use this license for any work of which you hold the copyright +and which you wish to distribute. This license may be particularly +suitable if your work is TeX-related (such as a LaTeX package), but +it is written in such a way that you can use it even if your work is +unrelated to TeX. + +The section `WHETHER AND HOW TO DISTRIBUTE WORKS UNDER THIS LICENSE', +below, gives instructions, examples, and recommendations for authors +who are considering distributing their works under this license. + +This license gives conditions under which a work may be distributed +and modified, as well as conditions under which modified versions of +that work may be distributed. + +We, the LaTeX3 Project, believe that the conditions below give you +the freedom to make and distribute modified versions of your work +that conform with whatever technical specifications you wish while +maintaining the availability, integrity, and reliability of +that work. If you do not see how to achieve your goal while +meeting these conditions, then read the document `cfgguide.tex' +and `modguide.tex' in the base LaTeX distribution for suggestions. + + +DEFINITIONS +=========== + +In this license document the following terms are used: + + `Work' + Any work being distributed under this License. + + `Derived Work' + Any work that under any applicable law is derived from the Work. + + `Modification' + Any procedure that produces a Derived Work under any applicable + law -- for example, the production of a file containing an + original file associated with the Work or a significant portion of + such a file, either verbatim or with modifications and/or + translated into another language. + + `Modify' + To apply any procedure that produces a Derived Work under any + applicable law. + + `Distribution' + Making copies of the Work available from one person to another, in + whole or in part. Distribution includes (but is not limited to) + making any electronic components of the Work accessible by + file transfer protocols such as FTP or HTTP or by shared file + systems such as Sun's Network File System (NFS). + + `Compiled Work' + A version of the Work that has been processed into a form where it + is directly usable on a computer system. This processing may + include using installation facilities provided by the Work, + transformations of the Work, copying of components of the Work, or + other activities. Note that modification of any installation + facilities provided by the Work constitutes modification of the Work. + + `Current Maintainer' + A person or persons nominated as such within the Work. If there is + no such explicit nomination then it is the `Copyright Holder' under + any applicable law. + + `Base Interpreter' + A program or process that is normally needed for running or + interpreting a part or the whole of the Work. + + A Base Interpreter may depend on external components but these + are not considered part of the Base Interpreter provided that each + external component clearly identifies itself whenever it is used + interactively. Unless explicitly specified when applying the + license to the Work, the only applicable Base Interpreter is a + `LaTeX-Format' or in the case of files belonging to the + `LaTeX-format' a program implementing the `TeX language'. + + + +CONDITIONS ON DISTRIBUTION AND MODIFICATION +=========================================== + +1. Activities other than distribution and/or modification of the Work +are not covered by this license; they are outside its scope. In +particular, the act of running the Work is not restricted and no +requirements are made concerning any offers of support for the Work. + +2. You may distribute a complete, unmodified copy of the Work as you +received it. Distribution of only part of the Work is considered +modification of the Work, and no right to distribute such a Derived +Work may be assumed under the terms of this clause. + +3. You may distribute a Compiled Work that has been generated from a +complete, unmodified copy of the Work as distributed under Clause 2 +above, as long as that Compiled Work is distributed in such a way that +the recipients may install the Compiled Work on their system exactly +as it would have been installed if they generated a Compiled Work +directly from the Work. + +4. If you are the Current Maintainer of the Work, you may, without +restriction, modify the Work, thus creating a Derived Work. You may +also distribute the Derived Work without restriction, including +Compiled Works generated from the Derived Work. Derived Works +distributed in this manner by the Current Maintainer are considered to +be updated versions of the Work. + +5. If you are not the Current Maintainer of the Work, you may modify +your copy of the Work, thus creating a Derived Work based on the Work, +and compile this Derived Work, thus creating a Compiled Work based on +the Derived Work. + +6. If you are not the Current Maintainer of the Work, you may +distribute a Derived Work provided the following conditions are met +for every component of the Work unless that component clearly states +in the copyright notice that it is exempt from that condition. Only +the Current Maintainer is allowed to add such statements of exemption +to a component of the Work. + + a. If a component of this Derived Work can be a direct replacement + for a component of the Work when that component is used with the + Base Interpreter, then, wherever this component of the Work + identifies itself to the user when used interactively with that + Base Interpreter, the replacement component of this Derived Work + clearly and unambiguously identifies itself as a modified version + of this component to the user when used interactively with that + Base Interpreter. + + b. Every component of the Derived Work contains prominent notices + detailing the nature of the changes to that component, or a + prominent reference to another file that is distributed as part + of the Derived Work and that contains a complete and accurate log + of the changes. + + c. No information in the Derived Work implies that any persons, + including (but not limited to) the authors of the original version + of the Work, provide any support, including (but not limited to) + the reporting and handling of errors, to recipients of the + Derived Work unless those persons have stated explicitly that + they do provide such support for the Derived Work. + + d. You distribute at least one of the following with the Derived Work: + + 1. A complete, unmodified copy of the Work; + if your distribution of a modified component is made by + offering access to copy the modified component from a + designated place, then offering equivalent access to copy + the Work from the same or some similar place meets this + condition, even though third parties are not compelled to + copy the Work along with the modified component; + + 2. Information that is sufficient to obtain a complete, + unmodified copy of the Work. + +7. If you are not the Current Maintainer of the Work, you may +distribute a Compiled Work generated from a Derived Work, as long as +the Derived Work is distributed to all recipients of the Compiled +Work, and as long as the conditions of Clause 6, above, are met with +regard to the Derived Work. + +8. The conditions above are not intended to prohibit, and hence do not +apply to, the modification, by any method, of any component so that it +becomes identical to an updated version of that component of the Work as +it is distributed by the Current Maintainer under Clause 4, above. + +9. Distribution of the Work or any Derived Work in an alternative +format, where the Work or that Derived Work (in whole or in part) is +then produced by applying some process to that format, does not relax or +nullify any sections of this license as they pertain to the results of +applying that process. + +10. a. A Derived Work may be distributed under a different license + provided that license itself honors the conditions listed in + Clause 6 above, in regard to the Work, though it does not have + to honor the rest of the conditions in this license. + + b. If a Derived Work is distributed under a different license, that + Derived Work must provide sufficient documentation as part of + itself to allow each recipient of that Derived Work to honor the + restrictions in Clause 6 above, concerning changes from the Work. + +11. This license places no restrictions on works that are unrelated to +the Work, nor does this license place any restrictions on aggregating +such works with the Work by any means. + +12. Nothing in this license is intended to, or may be used to, prevent +complete compliance by all parties with all applicable laws. + + +NO WARRANTY +=========== + +There is no warranty for the Work. Except when otherwise stated in +writing, the Copyright Holder provides the Work `as is', without +warranty of any kind, either expressed or implied, including, but not +limited to, the implied warranties of merchantability and fitness for a +particular purpose. The entire risk as to the quality and performance +of the Work is with you. Should the Work prove defective, you assume +the cost of all necessary servicing, repair, or correction. + +In no event unless required by applicable law or agreed to in writing +will The Copyright Holder, or any author named in the components of the +Work, or any other party who may distribute and/or modify the Work as +permitted above, be liable to you for damages, including any general, +special, incidental or consequential damages arising out of any use of +the Work or out of inability to use the Work (including, but not limited +to, loss of data, data being rendered inaccurate, or losses sustained by +anyone as a result of any failure of the Work to operate with any other +programs), even if the Copyright Holder or said author or said other +party has been advised of the possibility of such damages. + + +MAINTENANCE OF THE WORK +======================= + +The Work has the status `author-maintained' if the Copyright Holder +explicitly and prominently states near the primary copyright notice in +the Work that the Work can only be maintained by the Copyright Holder +or simply that it is `author-maintained'. + +The Work has the status `maintained' if there is a Current Maintainer +who has indicated in the Work that they are willing to receive error +reports for the Work (for example, by supplying a valid e-mail +address). It is not required for the Current Maintainer to acknowledge +or act upon these error reports. + +The Work changes from status `maintained' to `unmaintained' if there +is no Current Maintainer, or the person stated to be Current +Maintainer of the work cannot be reached through the indicated means +of communication for a period of six months, and there are no other +significant signs of active maintenance. + +You can become the Current Maintainer of the Work by agreement with +any existing Current Maintainer to take over this role. + +If the Work is unmaintained, you can become the Current Maintainer of +the Work through the following steps: + + 1. Make a reasonable attempt to trace the Current Maintainer (and + the Copyright Holder, if the two differ) through the means of + an Internet or similar search. + + 2. If this search is successful, then enquire whether the Work + is still maintained. + + a. If it is being maintained, then ask the Current Maintainer + to update their communication data within one month. + + b. If the search is unsuccessful or no action to resume active + maintenance is taken by the Current Maintainer, then announce + within the pertinent community your intention to take over + maintenance. (If the Work is a LaTeX work, this could be + done, for example, by posting to comp.text.tex.) + + 3a. If the Current Maintainer is reachable and agrees to pass + maintenance of the Work to you, then this takes effect + immediately upon announcement. + + b. If the Current Maintainer is not reachable and the Copyright + Holder agrees that maintenance of the Work be passed to you, + then this takes effect immediately upon announcement. + + 4. If you make an `intention announcement' as described in 2b. above + and after three months your intention is challenged neither by + the Current Maintainer nor by the Copyright Holder nor by other + people, then you may arrange for the Work to be changed so as + to name you as the (new) Current Maintainer. + + 5. If the previously unreachable Current Maintainer becomes + reachable once more within three months of a change completed + under the terms of 3b) or 4), then that Current Maintainer must + become or remain the Current Maintainer upon request provided + they then update their communication data within one month. + +A change in the Current Maintainer does not, of itself, alter the fact +that the Work is distributed under the LPPL license. + +If you become the Current Maintainer of the Work, you should +immediately provide, within the Work, a prominent and unambiguous +statement of your status as Current Maintainer. You should also +announce your new status to the same pertinent community as +in 2b) above. + + +WHETHER AND HOW TO DISTRIBUTE WORKS UNDER THIS LICENSE +====================================================== + +This section contains important instructions, examples, and +recommendations for authors who are considering distributing their +works under this license. These authors are addressed as `you' in +this section. + +Choosing This License or Another License +---------------------------------------- + +If for any part of your work you want or need to use *distribution* +conditions that differ significantly from those in this license, then +do not refer to this license anywhere in your work but, instead, +distribute your work under a different license. You may use the text +of this license as a model for your own license, but your license +should not refer to the LPPL or otherwise give the impression that +your work is distributed under the LPPL. + +The document `modguide.tex' in the base LaTeX distribution explains +the motivation behind the conditions of this license. It explains, +for example, why distributing LaTeX under the GNU General Public +License (GPL) was considered inappropriate. Even if your work is +unrelated to LaTeX, the discussion in `modguide.tex' may still be +relevant, and authors intending to distribute their works under any +license are encouraged to read it. + +A Recommendation on Modification Without Distribution +----------------------------------------------------- + +It is wise never to modify a component of the Work, even for your own +personal use, without also meeting the above conditions for +distributing the modified component. While you might intend that such +modifications will never be distributed, often this will happen by +accident -- you may forget that you have modified that component; or +it may not occur to you when allowing others to access the modified +version that you are thus distributing it and violating the conditions +of this license in ways that could have legal implications and, worse, +cause problems for the community. It is therefore usually in your +best interest to keep your copy of the Work identical with the public +one. Many works provide ways to control the behavior of that work +without altering any of its licensed components. + +How to Use This License +----------------------- + +To use this license, place in each of the components of your work both +an explicit copyright notice including your name and the year the work +was authored and/or last substantially modified. Include also a +statement that the distribution and/or modification of that +component is constrained by the conditions in this license. + +Here is an example of such a notice and statement: + + %% pig.dtx + %% Copyright 2005 M. Y. Name + % + % This work may be distributed and/or modified under the + % conditions of the LaTeX Project Public License, either version 1.3 + % of this license or (at your option) any later version. + % The latest version of this license is in + % http://www.latex-project.org/lppl.txt + % and version 1.3 or later is part of all distributions of LaTeX + % version 2005/12/01 or later. + % + % This work has the LPPL maintenance status `maintained'. + % + % The Current Maintainer of this work is M. Y. Name. + % + % This work consists of the files pig.dtx and pig.ins + % and the derived file pig.sty. + +Given such a notice and statement in a file, the conditions +given in this license document would apply, with the `Work' referring +to the three files `pig.dtx', `pig.ins', and `pig.sty' (the last being +generated from `pig.dtx' using `pig.ins'), the `Base Interpreter' +referring to any `LaTeX-Format', and both `Copyright Holder' and +`Current Maintainer' referring to the person `M. Y. Name'. + +If you do not want the Maintenance section of LPPL to apply to your +Work, change `maintained' above into `author-maintained'. +However, we recommend that you use `maintained', as the Maintenance +section was added in order to ensure that your Work remains useful to +the community even when you can no longer maintain and support it +yourself. + +Derived Works That Are Not Replacements +--------------------------------------- + +Several clauses of the LPPL specify means to provide reliability and +stability for the user community. They therefore concern themselves +with the case that a Derived Work is intended to be used as a +(compatible or incompatible) replacement of the original Work. If +this is not the case (e.g., if a few lines of code are reused for a +completely different task), then clauses 6b and 6d shall not apply. + + +Important Recommendations +------------------------- + + Defining What Constitutes the Work + + The LPPL requires that distributions of the Work contain all the + files of the Work. It is therefore important that you provide a + way for the licensee to determine which files constitute the Work. + This could, for example, be achieved by explicitly listing all the + files of the Work near the copyright notice of each file or by + using a line such as: + + % This work consists of all files listed in manifest.txt. + + in that place. In the absence of an unequivocal list it might be + impossible for the licensee to determine what is considered by you + to comprise the Work and, in such a case, the licensee would be + entitled to make reasonable conjectures as to which files comprise + the Work. diff --git a/Master/texmf-dist/doc/latex/tikzmarmots/README.md b/Master/texmf-dist/doc/latex/tikzmarmots/README.md new file mode 100644 index 00000000000..cf7b04491f5 --- /dev/null +++ b/Master/texmf-dist/doc/latex/tikzmarmots/README.md @@ -0,0 +1,12 @@ +# Tikzmarmots + +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 + + +### A few examples: + +![tikz marmots](https://user-images.githubusercontent.com/8226363/42419778-ba1cf506-82bb-11e8-8e44-15f9837188e4.png) diff --git a/Master/texmf-dist/doc/latex/tikzmarmots/tikzmarmots-doc.pdf b/Master/texmf-dist/doc/latex/tikzmarmots/tikzmarmots-doc.pdf Binary files differnew file mode 100644 index 00000000000..d9bcccafd4d --- /dev/null +++ b/Master/texmf-dist/doc/latex/tikzmarmots/tikzmarmots-doc.pdf 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 |