From b4fc5f639874db951177ec539299d20908adb654 Mon Sep 17 00:00:00 2001 From: Karl Berry Date: Mon, 9 Jan 2006 00:44:40 +0000 Subject: doc 4 git-svn-id: svn://tug.org/texlive/trunk@80 c570f23f-e606-0410-a88d-b1316a301751 --- .../texmf-dist/doc/latex/tokenizer/tokenizer.pdf | Bin 0 -> 85772 bytes .../texmf-dist/doc/latex/tokenizer/tokenizer.tex | 109 +++++++++++++++++++++ 2 files changed, 109 insertions(+) create mode 100644 Master/texmf-dist/doc/latex/tokenizer/tokenizer.pdf create mode 100644 Master/texmf-dist/doc/latex/tokenizer/tokenizer.tex (limited to 'Master/texmf-dist/doc/latex/tokenizer') diff --git a/Master/texmf-dist/doc/latex/tokenizer/tokenizer.pdf b/Master/texmf-dist/doc/latex/tokenizer/tokenizer.pdf new file mode 100644 index 00000000000..f0da3f6c469 Binary files /dev/null and b/Master/texmf-dist/doc/latex/tokenizer/tokenizer.pdf differ diff --git a/Master/texmf-dist/doc/latex/tokenizer/tokenizer.tex b/Master/texmf-dist/doc/latex/tokenizer/tokenizer.tex new file mode 100644 index 00000000000..4f5715412fc --- /dev/null +++ b/Master/texmf-dist/doc/latex/tokenizer/tokenizer.tex @@ -0,0 +1,109 @@ +% Copyright 2003 Sascha Herpers +% +% This file can be redistributed and/or modified under the terms +% of the LaTeX Project Public License Distributed from CTAN +% archives in directory macros/latex/base/lppl.txt; either +% version 1 of the License, or any later version. +% +% +% 2003-05-22 +% Sascha Herpers +% herpers@wiso.uni-koeln.de +\documentclass[draft]{article} +\usepackage{tokenizer} +\usepackage{verbatim} +\usepackage{tabularx} + +\setlength{\parindent}{0pt} + +\begin{document} +\title{\texttt{tokenizer.sty}} +\author{Sascha Herpers\thanks{Herpers@wiso.uni-koeln.de}} +\date{\today} \maketitle +\begin{abstract} +\noindent This package provides a command \verb+\GetTokens+, which +splits a comma separated list of strings into +tokens.\footnote{Thanks to Harald Harders for his support.}\\ + +\noindent Version: 1.1.0 (May 26, 2003) +\end{abstract} + +\section{Usage} +This package defines the following command: +\begin{center} +\verb+\GetTokens{}{}{}+. +\end{center} + +\verb+\GetTokens+ can be used to split a comma separated list of +strings passed as \verb++ into two tokens at the first +encounter of a comma. While doing so, two commands with the name +\verb++ and \verb++ are defined. The string up to +the first comma of \verb++ is assigned as value for +\verb+\+ and the rest is assigned to \verb+\+.\\ + +By default the tokens are left as is, i.\,e. leading and trailing +spaces are not removed. However, if this behavior is not +desirable, you can use the package option \textbf{trim}. +Specifying this option causes each token to be stripped off +leading and trailing spaces.\footnote{Omitting the trim options +has the same result as using the \textbf{notrim} option.}\\ + +As a byproduct to the trim option the tokenizer package defines +the following command: +\begin{center} +\verb+\TrimSpaces{}+ +\end{center} +\verb+\TrimSpaces+ can be used remove spaces from the text passed +as first parameters. + +\section{Example} +The example shown in listing 1 illustrates the use of +\verb+\GetTokens+. Firstly, a source string \verb+\Source+ is +created, which contains the strings to be separated. The following +while statement loops until there are no more tokens to process. +\verb+\GetTokens+ is called and the separated tokens are stored in +two commands \verb+\TokenOne+ and \verb+\TokenTwo+, which are +created by \verb+\GetTokens+. Lastly, \verb+\Source+ is replaced +by the remainder string contained in \verb+\TokenTwo+.\\ + + +\hrule +\begin{verbatim} + \def\Source{ this , is , a , short , test } + The string \emph{\Source} contains the following tokens:\\ + \whiledo{\not\equal{\Source}{}} + { + \GetTokens{TokenOne}{TokenTwo}{\Source} + \hspace*{.3cm}$\bullet$ [\TokenOne]\\ + \let\Source\TokenTwo + } +\end{verbatim} +\hrule +\begin{center} +Listing 1: example usage of \verb+\GetTokens+ +\end{center} + +This is the output produced by the above example:\\ +\begin{center} + \begin{minipage}{9cm} + \def\Source{ this , is , a , short , test } + The string \emph{\Source} contains the following tokens:\\ + \whiledo{\not\equal{\Source}{}} + { + \GetTokens{TokenOne}{TokenTwo}{\Source} + \hspace*{.3cm}$\bullet$ [\TokenOne]\\ + \let\Source\TokenTwo + } + \end{minipage} +\end{center} + +\newpage +\section{History} +\begin{tabularx}{\textwidth}{lX} + \hline + date & change\\ + \hline + 05/26/03 & added packages options \textbf{trim} and \textbf{notrim}\\ +\end{tabularx} + +\end{document} -- cgit v1.2.3