summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2024-05-15 19:14:27 +0000
committerKarl Berry <karl@freefriends.org>2024-05-15 19:14:27 +0000
commitb293bb424a0d8b9fbff26f8dd008a64a190e5ef6 (patch)
treeaf5e8a86a8b42767d07720b02744d00df7ace084 /Master/texmf-dist/doc/latex
parent8d697d19e71082982168b486e77423d1b2db21f6 (diff)
rpgicons (15may24)
git-svn-id: svn://tug.org/texlive/trunk@71269 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/latex')
-rw-r--r--Master/texmf-dist/doc/latex/rpgicons/README.md2
-rw-r--r--Master/texmf-dist/doc/latex/rpgicons/rpgicons-doc.pdfbin490866 -> 500755 bytes
-rw-r--r--Master/texmf-dist/doc/latex/rpgicons/rpgicons-doc.tex53
3 files changed, 46 insertions, 9 deletions
diff --git a/Master/texmf-dist/doc/latex/rpgicons/README.md b/Master/texmf-dist/doc/latex/rpgicons/README.md
index febd9902539..e889b70b03d 100644
--- a/Master/texmf-dist/doc/latex/rpgicons/README.md
+++ b/Master/texmf-dist/doc/latex/rpgicons/README.md
@@ -1,4 +1,4 @@
-![Version 1.8.2](https://img.shields.io/badge/version-1.8.2-blue)
+![Version 1.8.3](https://img.shields.io/badge/version-1.8.3-blue)
<img width="200" alt="rpgicons-example" src="https://github.com/jasperhabicht/rpgicons/assets/6378801/81a1d0aa-7a4f-4f83-bbdc-3bc3332023b2" />
diff --git a/Master/texmf-dist/doc/latex/rpgicons/rpgicons-doc.pdf b/Master/texmf-dist/doc/latex/rpgicons/rpgicons-doc.pdf
index 7eab4162449..7fa0c036d70 100644
--- a/Master/texmf-dist/doc/latex/rpgicons/rpgicons-doc.pdf
+++ b/Master/texmf-dist/doc/latex/rpgicons/rpgicons-doc.pdf
Binary files differ
diff --git a/Master/texmf-dist/doc/latex/rpgicons/rpgicons-doc.tex b/Master/texmf-dist/doc/latex/rpgicons/rpgicons-doc.tex
index 72aad456a78..7eef59a1a40 100644
--- a/Master/texmf-dist/doc/latex/rpgicons/rpgicons-doc.tex
+++ b/Master/texmf-dist/doc/latex/rpgicons/rpgicons-doc.tex
@@ -11,8 +11,8 @@
% This work has the LPPL maintenance status `maintained'.
%
\documentclass[a4paper]{article}
-\def\rpgiconsfileversion{1.8.2}
-\def\rpgiconsfiledate{28 April 2024}
+\def\rpgiconsfileversion{1.8.3}
+\def\rpgiconsfiledate{15 May 2024}
\usepackage[T1]{fontenc}
\usepackage{Alegreya}
@@ -232,7 +232,7 @@
[The rpgicons package]
{The \titlemacro{rpgicons} package}
{A set of high-quality icons for use in notes for tabletop role-playing games}
- {Jasper Habicht}[E-mail: \href{mailto:mail@jasperhabicht.de}{mail@jasperhabicht.de}]
+ {Jasper Habicht}[E-mail: \href{mailto:mail@jasperhabicht.de}{mail@jasperhabicht.de}. I am grateful to Joseph Wright who fixes bugs at an astonishing speed and to all other contributors to this package.]
{Version \rpgiconsfileversion, released on \rpgiconsfiledate}
\changes{v1.1.0}{2023/08/15}{First public release.}
@@ -261,6 +261,7 @@
\changes{v1.7.0}{2024/03/16}{Macro for easy typesetting using roll dice syntax added in L3 variant, compatibility mode updated.}
\changes{v1.8.0}{2024/03/24}{Unified wrapper to load either package variant.}
\changes{v1.8.2}{2024/04/28}{Roll dice syntax for PGF variant.}
+\changes{v1.8.3}{2024/05/15}{Minor compatibility fix. Example of how to use pics added to ducumentation.}
\begin{document}
@@ -277,11 +278,11 @@
The \macro{rpgicons} package provides a set of high-quality icons for use in notes for tabletop role-playing games. The icons are meant to be used in the body text, but they can also be used in other contexts such as graphics or diagrams.
-The package comes in two variants, a L3 variant based on the \macro{l3draw} package which is loaded per default and a PGF veriant based on PGF/Ti\emph{k}Z.
+The package comes in two variants, a L3 variant based on the \macro{l3draw} package which is loaded per default and a PGF variant based on PGF/Ti\emph{k}Z.
\section{Loading the package}
-To install the package, copy the relevant package files \macro{rpgicons.sty}, \macro{rpgicons-l3.sty} and \macro{rpgicons-pgf.sty} into the working directory or into the \macro{texmf} directory. After the package has been installted, the \macro{rpgicons} package is loaded by calling \macro{\usepackage{rpgicons}} in the preamble of the document.
+To install the package, copy the relevant package files \macro{rpgicons.sty}, \macro{rpgicons-l3.sty} and \macro{rpgicons-pgf.sty} into the working directory or into the \macro{texmf} directory. After the package has been installed, the \macro{rpgicons} package is loaded by calling \macro{\usepackage{rpgicons}} in the preamble of the document.
\begin{macrodef}l3\end{macrodef}
The L3 variant of the package is loaded by default. To load it explicitly, the package can be loaded using the option \macro{l3}. Alternatively, \macro{\usepackage{rpgicons-l3}} can be called instead.
@@ -297,7 +298,7 @@ The PGF variant of the package loads the \macro{tikz} package which in turn load
\section{Main user commands}
-Regardless of the variant of the package, a set of user commands is always available. These are described in the following. Depending on the use of the L3 or the PGF veriant, certain specific commands or options are available that are explained in the following sections in further detail.
+Regardless of the variant of the package, a set of user commands is always available. These are described in the following. Depending on the use of the L3 or the PGF variant, certain specific commands or options are available that are explained in the following sections in further detail.
Because of the way the package defines the icons, every of the below described user commands can actually be used together with every shape. However, the combinations of shapes and commands as described in the following subsections are preferable.
@@ -498,7 +499,7 @@ The command \macro{\condition} prints icons depicting a condition of a character
The L3 variant of the package that uses the \macro{l3draw} package is loaded by default or explicitly by either calling \macro{\usepackage[l3]{rpgicons}} or \macro{\usepackage{rpgicons-l3}} in the preamble of the document after having installed the files \macro{rpgicons.sty} and \macro{rpgicons-l3.sty}. The \macro{l3draw} package is an experimental package that provides only basic drawing functionality. The L3 variant thus only supports a certain set of option for styling the icons.
-The L3 variant of the package does not load the \macro{xcolor} package, but makes use of the \macro{l3color} module which uses a similar syntax like the \macro{xcolor} package, but color defintions made using the \macro{l3color} module are not directly usable via commands provided by the \macro{xcolor} package. Therefore, setting a color using the \macro{\color} macro provided by the \macro{xcolor} package won't affect the color of the icons.
+The L3 variant of the package does not load the \macro{xcolor} package, but makes use of the \macro{l3color} module which uses a similar syntax like the \macro{xcolor} package, but color definitions made using the \macro{l3color} module are not directly usable via commands provided by the \macro{xcolor} package. Therefore, setting a color using the \macro{\color} macro provided by the \macro{xcolor} package won't affect the color of the icons.
\begin{macrodef}compat\end{macrodef}
The \macro{l3draw} package is experimental and subject to ongoing updates. Loading the L3 variant of the package with the option \macro{compat} will use macro definitions that have been available since the last major TeX Live release as replacement for certain functions that only became available in the most recent versions of the \macro{l3draw} and related packages.
@@ -581,7 +582,7 @@ every attack
every condition
every <shape>
\end{macrodef}
-Styles following the pattern \macro{rpg icons/every} followed by a space and the name of the command or the shape can be used to apply styles to every instance of this command or shape. For example, \macro{\rpgiconsset{every die={color={red}}}} can be used to draw in red all icons created using the \macro{\die} command. Calling \macro{\rpgiconsset{every charisma={color={red}}}} will draw every instace of the \macro{charisma} shape in red.
+Styles following the pattern \macro{rpg icons/every} followed by a space and the name of the command or the shape can be used to apply styles to every instance of this command or shape. For example, \macro{\rpgiconsset{every die={color={red}}}} can be used to draw in red all icons created using the \macro{\die} command. Calling \macro{\rpgiconsset{every charisma={color={red}}}} will draw every instance of the \macro{charisma} shape in red.
\subsection{Setting options globally}
@@ -801,6 +802,42 @@ The icon is embedded as a node in the pic which has the name \macro{-node}. Thus
\end{macrodef}
The PGF variant of the package defines five Ti\emph{k}Z keys that are used to create pics using the relevant node shapes. Another key is defined to create keys that can be used to style all instances of a command or shape. In normal circumstances, it is not necessary to use these keys. They are mentioned here only for reference.
+The following example shows how to create the drawing on the first page of this documentation using Ti\emph{k}Z pics. We need to call \macro{rpg icons/create pic from ability shape} for the shapes \macro{twentyside}, \macro{buff} and \macro{ranged}, because per default no pics are defined for these shapes in combination with ability. Note the use of \macro{\space} to ensure correct use of spaces in the pic name as spaces are gobbled after commands in TeX.
+
+\begin{codeexample}
+\tikzset{
+ rpg icons/%
+ create pic from ability shape/%
+ .list={
+ twentyside,
+ buff,
+ ranged
+ },
+ rpg icons/every ability/.style={
+ ultra thick,
+ draw=white,
+ line join=round,
+ line cap=round
+ }
+}
+
+\begin{tikzpicture}[scale=4]
+ \foreach \x/\c [count=\i] in {
+ twentyside/264653,
+ charisma/287271,
+ armor/2a9d8f,
+ buff/e9c46a,
+ ranged/f4a261,
+ proficiency/e76f51
+ } {
+ \definecolor{color}{HTML}{\c}
+ \pic[fill=color, transform shape]
+ at ({60*\i+10}:{0.33cm})
+ {rpg icons \x\space ability};
+ }
+\end{tikzpicture}
+\end{codeexample}
+
\subsection{Roll dice syntax}
\begin{macrodef}