summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2010-06-12 23:30:04 +0000
committerKarl Berry <karl@freefriends.org>2010-06-12 23:30:04 +0000
commitf8b2509b17bd7177dc511cbaa7ecd21edea407b1 (patch)
treead822a0b43c421585765ecd0b93b71e2793e14ae /Master/texmf-dist/doc/latex
parent5d4c8dc9b9eedf00ef981be81f2ac073102fb67f (diff)
truncate own pkg (12jun10)
git-svn-id: svn://tug.org/texlive/trunk@18921 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/latex')
-rw-r--r--Master/texmf-dist/doc/latex/truncate/miscdoc.sty115
-rw-r--r--Master/texmf-dist/doc/latex/truncate/truncate.pdfbin0 -> 161089 bytes
-rw-r--r--Master/texmf-dist/doc/latex/truncate/truncate.tex57
3 files changed, 172 insertions, 0 deletions
diff --git a/Master/texmf-dist/doc/latex/truncate/miscdoc.sty b/Master/texmf-dist/doc/latex/truncate/miscdoc.sty
new file mode 100644
index 00000000000..da1f2a5fdba
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/truncate/miscdoc.sty
@@ -0,0 +1,115 @@
+\ProvidesPackage{miscdoc}[2010/01/20 v1.2 documentation macros misc latex pkgs]
+
+% miscdoc.sty
+% Copyright 2010 Robin Fairbairns
+%
+% 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 Robin Fairbairns.
+%
+% This work consists of the file miscdoc.sty (only)
+
+\setcounter{errorcontextlines}{1274}
+
+% The package arose from a small exercise to document packages whose
+% previous documentation consisted solely of comments in the package files.
+% The macros here defined are lifted from the author's faq.sty
+% (written for the UK TeX FAQ, CTAN:help/uk-tex-faq) or are inspired
+% by others' work (credited where the author is known) ... except
+% where they came as a flash of inspiration while actually writing the
+% documentation.
+
+% this option suggested by Heiko Oberdiek, 2010-01-29
+\DeclareOption{hyper}{%
+ \AtEndOfPackage{%
+ \RequirePackage[pdfusetitle]{hyperref}
+ \RequirePackage{bookmark}
+ \bookmarksetup{numbered,open,openlevel=1}
+ }
+}
+\ProcessOptions\relax
+
+% note: T1 encoding assumed
+\usepackage{lmodern}
+\usepackage[T1]{fontenc}
+\usepackage{booktabs}
+
+% from faq.sty
+\newcommand\cs[1]{\texttt{\char`\\#1}}
+\let\csx\cs
+\def\bsbs{\cs{\char`\\}}
+
+% \cmdinvoke\cs<argument sequence>
+% \cs typeset as above
+% <argument sequence> may consist of optional or mandatory arguments;
+%
+% the `arguments' are simply typesett \texttt, as yet -- if something
+% fancier is needed, there's a bunch of code needs rewriting here...
+\DeclareRobustCommand\cmdinvoke{\@ifstar
+ {\let\@tempa\emph\@scmdinvoke}%
+ {\let\@tempa\relax\@scmdinvoke}%
+}
+\def\@scmdinvoke#1{\texttt{\symbol{92}#1}%
+ \futurelet\@let@token\@cmdinvoke
+}
+\def\@cmdinvoke{\ifx\@let@token\bgroup
+ \let\@tempb\@cmdinvoke@lbrace
+ \else
+ \ifx\@let@token[% ]
+ \let\@tempb\@cmdinvoke@lbrack
+ \else
+ \ifx\@let@token(% )
+ \let\@tempb\@cmdinvoke@lparen
+ \else
+ \let\@tempb\@empty
+ \fi
+ \fi
+ \fi
+ \@tempb
+}
+\def\@cmdinvoke@lbrace#1{\penalty0\hskip0pt\relax
+ \texttt{\symbol{123}\@tempa{#1}\symbol{125}}%
+ \futurelet\@let@token\@cmdinvoke
+}
+\def\@cmdinvoke@lbrack[#1]{\penalty-150\hskip0pt\relax
+ \texttt{[\@tempa{#1}]}%
+ \futurelet\@let@token\@cmdinvoke
+}
+\def\@cmdinvoke@lparen(#1){\penalty-150\hskip0pt\relax
+ \texttt{(\@tempa{#1})}%
+ \futurelet\@let@token\@cmdinvoke
+}
+% and extension -- versions that take a single extra (delimiter)
+% argument, such as \delcmdinvoke{lscrunge}( ... awful syntax, but...
+\DeclareRobustCommand\delcmdinvoke{\@ifstar
+ {\let\@tempa\emph\@sdelcmdinvoke}%
+ {\let\@tempa\relax\@sdelcmdinvoke}%
+}
+\def\@sdelcmdinvoke#1#2{\texttt{\symbol{92}#1#2}%
+ \futurelet\@let@token\@cmdinvoke
+}
+
+% sui generis
+\newcommand\newitem{\par\addvspace{1ex}\noindent}
+
+% inspired by doc.sty in latex distribution
+\newcommand\meta[1]{\ensuremath{\langle}\emph{#1}\ensuremath{\rangle}}
+
+% meaningful names, as in faq.sty
+\newcommand\environment[1]{\texttt{#1}}
+\newcommand\pkgoption[1]{\texttt{#1}}
+\newcommand\extension[1]{\texttt{.#1}}
+\newcommand\Package[1]{\textsf{#1}}
+\def\option{\@ifnextchar[\@optionb\@option}% ]
+\def\@optionb[#1]{{\normalfont\ttfamily[#1]}}
+\def\@option#1{\texttt{#1}}
+
+\let\FontName\textsf \ No newline at end of file
diff --git a/Master/texmf-dist/doc/latex/truncate/truncate.pdf b/Master/texmf-dist/doc/latex/truncate/truncate.pdf
new file mode 100644
index 00000000000..f27ecf8690a
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/truncate/truncate.pdf
Binary files differ
diff --git a/Master/texmf-dist/doc/latex/truncate/truncate.tex b/Master/texmf-dist/doc/latex/truncate/truncate.tex
new file mode 100644
index 00000000000..412d183553c
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/truncate/truncate.tex
@@ -0,0 +1,57 @@
+\documentclass[a4paper]{article}
+\usepackage[a4paper]{geometry}
+\usepackage{miscdoc}
+\usepackage[scaled=0.85]{luximono}
+\begin{document}
+\title{The \Package{truncate} package}
+\author{Donald Arseneau\thanks{Documentation file assembled by Robin
+ Fairbairns}}
+\date{August 2001, version 3.6}
+\maketitle
+
+\section*{Truncating text to a given width}
+
+The package defines a command
+\cmdinvoke{truncate}[\meta{marker}]{\meta{width}}{\meta{text}}
+
+If the text is too wide to fit in the specified width, then it is
+truncated, and a continuation marker is shown at the end. The default
+marker, used when the optional \texttt{[marker]} parameter is omitted,
+is \cs{,}\cs{dots}. You can change this default by redefining
+\cs{TruncateMarker}
+(\cmdinvoke{renewcommand}{\cs{TruncateMarker}}{\dots}).
+
+Normally, the text (whether truncated or not) is printed flush-left
+in a box with exactly the width specified. The package option
+\option[fit] causes the output text to have its natural width, up to a
+maximum of the specified width.
+
+The text will not normally be truncated in the middle of a word,
+nor at a space specified by the tie (\verb|~|). For example:
+\begin{quote}
+ \cmdinvoke{truncate}{122pt}{This text has been\string~truncated}
+\end{quote}
+gives
+\begin{quote}
+ ``This text has\dots~~~~~~''
+\end{quote}
+
+You can give one of the package options \option[hyphenate],
+\option[breakwords], or \option[breakall] to allow breaking in the
+middle of words. The first two only truncate at hyphenation points;
+with the difference being that \option[breakwords] suppresses the
+hyphen character. On the other hand, \option{breakall} allows
+truncation at any character. For example:
+\begin{quote}
+ \cmdinvoke{truncate}{122pt}{This text has been\string~truncated}
+\end{quote}
+gives
+\begin{quote}
+ \begin{tabular}{l@{\quad}l}
+ ``This text has been trun-...'' & (option hyphenate) \\
+ ``This text has been trun...~'' & (option breakwords) \\
+ ``This text has been trunc...'' & (option breakall)
+ \end{tabular}
+\end{quote}
+(All of these options work through \TeX{}'s hyphenation mechanism.)
+\end{document}