summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/scsnowman/scsnowman.tex
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2017-08-08 20:38:40 +0000
committerKarl Berry <karl@freefriends.org>2017-08-08 20:38:40 +0000
commitbb5a582a3651ea6fe3c4fce9580cc248f5953f43 (patch)
tree2db9e292c86b09339265b097a9cddfdf3fe8ff89 /Master/texmf-dist/doc/latex/scsnowman/scsnowman.tex
parent3a8846b896e8f1b37294b5cd54016bf3b6f58490 (diff)
scsnowman (8aug17)
git-svn-id: svn://tug.org/texlive/trunk@44984 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/latex/scsnowman/scsnowman.tex')
-rw-r--r--Master/texmf-dist/doc/latex/scsnowman/scsnowman.tex58
1 files changed, 51 insertions, 7 deletions
diff --git a/Master/texmf-dist/doc/latex/scsnowman/scsnowman.tex b/Master/texmf-dist/doc/latex/scsnowman/scsnowman.tex
index 77688f561b1..431e2def470 100644
--- a/Master/texmf-dist/doc/latex/scsnowman/scsnowman.tex
+++ b/Master/texmf-dist/doc/latex/scsnowman/scsnowman.tex
@@ -205,29 +205,48 @@ This will be helpful when a snowman appears to be ``floating in the air.''\\[1ex
\subsection{Design Options}
Following \emph{key}s take a \emph{value} which specifies color. When the \emph{value} is omitted,
-the default color, black or white, will be used:
+it reacts to the surrounding text color:
\begin{quote}
\Lopt{body}, \Lopt{eyes}, \Lopt{mouth}, \Lopt{sweat},
\Lopt{hat}, \Lopt{arms}, \Lopt{muffler}, \Lopt{buttons}, \Lopt{snow}
\end{quote}
-The following \emph{key} require one specific \emph{value}:
+The following \emph{key}s require one specific \emph{value}:
\begin{quote}
- \Lopt{mouthshape}
+ \Lopt{shape}, \Lopt{mouthshape}
\end{quote}
+
+The key \Lopt{shape} specifies the outline shape of the snowman body.
+Currently, only \Lopt{shape=normal} is officially available, but you can define and use other shapes
+using \verb+\usescsnowmanlibrary+ command (described later, section \ref{usescsnowmanlibrary}).
+
The key \Lopt{mouthshape} takes one of the followings: \Lopt{smile}, \Lopt{tight} or \Lopt{frown}.
Here are some examples:\\[1ex]
\begin{minipage}{.7\textwidth}\begin{verbatim}
\scsnowman[scale=2,body,hat=red,muffler=blue]
\scsnowman[scale=3,hat,snow,arms,buttons]
- \scsnowman[scale=3,mouthshape=tight,muffler=red]
- \scsnowman[scale=3,mouthshape=frown,hat=green]
+ \scsnowman[scale=2,mouthshape=tight,muffler=red]
+ \scsnowman[scale=2,mouthshape=frown,hat=green]
\end{verbatim}\end{minipage}
\begin{minipage}{.25\textwidth}
\scsnowman[scale=2,body,hat=red,muffler=blue]
\scsnowman[scale=3,hat,snow,arms,buttons]
\scsnowman[scale=2,mouthshape=tight,muffler=red]
\scsnowman[scale=2,mouthshape=frown,hat=green]
+\end{minipage}\\[1ex]
+\begin{minipage}{.7\textwidth}\begin{verbatim}
+ {\color{blue}
+ \scsnowman[scale=2,body,hat=red,muffler=blue]
+ \scsnowman[scale=3,hat,snow,arms,buttons]
+ \scsnowman[scale=2,mouthshape=tight,muffler=red]
+ \scsnowman[scale=2,mouthshape=frown,hat=green]}
+\end{verbatim}\end{minipage}
+\begin{minipage}{.25\textwidth}
+ {\color{blue}
+ \scsnowman[scale=2,body,hat=red,muffler=blue]
+ \scsnowman[scale=3,hat,snow,arms,buttons]
+ \scsnowman[scale=2,mouthshape=tight,muffler=red]
+ \scsnowman[scale=2,mouthshape=frown,hat=green]}
\end{minipage}
\section{Changing the Default}
@@ -241,7 +260,7 @@ The available \emph{key}s are the same as those in \verb+\scsnowman+.
Here are some examples:\\[1ex]
\begin{minipage}{.6\textwidth}\begin{verbatim}
- \scsnowmandefault{scale=3,hat=red}
+ \scsnowmandefault{scale=5,hat=red}
\scsnowman
\scsnowman[body,muffler=blue]
\scsnowman[hat=green,snow]
@@ -253,6 +272,24 @@ Here are some examples:\\[1ex]
\scsnowman[hat=green,snow]
\end{minipage}
+\section{Adding User-defined Snowman Shapes}\label{usescsnowmanlibrary}
+
+Any users can define and use custom snowman shape definitions.
+Here is a description of adding a shape named \Lopt{myfavorite}.
+\begin{enumerate}
+ \item Prepare a snowman definition file \texttt{scsnowman-myfavorite.def}
+ and put it into \verb+$TEXMF+ tree (e.g. \verb+texmf-local/tex/latex/scsnowman/+).
+ For the format of snowman definition files, please refer to \texttt{scsnowman-normal.def}.
+ \item Use \verb+\usescsnowmanlibrary+ command (don't forget \emph{sc}!) to load it.
+\begin{verbatim}
+ \usepackage{scsnowman}
+ \usescsnowmanlibrary{myfavorite}
+\end{verbatim}
+ \item You can use the shape by \verb+\scsnowman[shape=myfavorite]+ command.
+\end{enumerate}
+If you have created a fancy snowman, please contact me, so that I can incorporate it
+into the official release!
+
\section{Changing Item Labels and QED Symbols}
For those who want more snowmen in the documents, currently \Lpack{scsnowman} provides
@@ -335,6 +372,8 @@ Here are some examples:\\[1ex]
The names of these commands are, of course, named after the \LaTeX\ \verb+\makeatletter+
and \verb+\makeatother+;-)
+\newpage
+
\section*{Version History}
This is the summary of changes. For more detail, see GitHub repository.
@@ -345,7 +384,12 @@ Version 0.1 & 2015-12-13 & First public version on GitHub \\
Version 0.8 & 2016-08-08 & Second public version on GitHub: \\
& & new variants \Lopt{buttons}, \Lopt{mouthshape}, \Lopt{sweat} are added \\
Version 1.0 & 2016-12-22 & First CTAN release \\
-Version 1.1 & 2017-01-22 & Add new key \Lopt{adjustbaseline}, documentation update
+Version 1.1 & 2017-01-22 & Add a new key \Lopt{adjustbaseline} \\
+ & & Update documentation \\
+Version 1.2 & 2017-08-08 & Default color reacts to surrounding text color \\
+ & & Support vertical writing on (u)p\TeX\ and Lua\TeX-ja \\
+ & & Add a new key \Lopt{shape} \\
+ & & Add a new command \verb+\usescsnowmanlibrary+
\end{tabular}
\end{table}