diff options
author | Karl Berry <karl@freefriends.org> | 2012-01-23 23:09:45 +0000 |
---|---|---|
committer | Karl Berry <karl@freefriends.org> | 2012-01-23 23:09:45 +0000 |
commit | 5410446ef33746820096ec2eca0d536287d606f6 (patch) | |
tree | ddd6a117a1b3f651bae2f0d2f8e0186c63055077 | |
parent | fde9f1341f8b60d9193c41e45d1a5a43868f1757 (diff) |
new latex package outlines (23jan12)
git-svn-id: svn://tug.org/texlive/trunk@25184 c570f23f-e606-0410-a88d-b1316a301751
-rw-r--r-- | Master/texmf-dist/doc/latex/outlines/README | 16 | ||||
-rw-r--r-- | Master/texmf-dist/doc/latex/outlines/outlines.pdf | bin | 0 -> 134476 bytes | |||
-rw-r--r-- | Master/texmf-dist/doc/latex/outlines/outlines.tex | 257 | ||||
-rw-r--r-- | Master/texmf-dist/tex/latex/outlines/outlines.sty | 139 | ||||
-rwxr-xr-x | Master/tlpkg/bin/tlpkg-ctan-check | 2 | ||||
-rw-r--r-- | Master/tlpkg/tlpsrc/collection-latexextra.tlpsrc | 1 | ||||
-rw-r--r-- | Master/tlpkg/tlpsrc/outlines.tlpsrc | 0 |
7 files changed, 414 insertions, 1 deletions
diff --git a/Master/texmf-dist/doc/latex/outlines/README b/Master/texmf-dist/doc/latex/outlines/README new file mode 100644 index 00000000000..98e6f4b7a93 --- /dev/null +++ b/Master/texmf-dist/doc/latex/outlines/README @@ -0,0 +1,16 @@ + +The "outlines" package +---------------------- +v 1.1, Charles Pecheur, January 23, 2012 + + +The "outlines" package defines the "outline" environment, +that allows outline-style indented lists with freely mixed levels up +to four levels deep. It replaces the nested "begin"/"end" pairs by +different item tags "\1" to "\4" for each nesting level. This is very +convenient in cases where nested lists are used a lot, such as for to-do +lists or presentation slides. + +This package is built on top of the standard list environments and has +no specific pre-requisite. + diff --git a/Master/texmf-dist/doc/latex/outlines/outlines.pdf b/Master/texmf-dist/doc/latex/outlines/outlines.pdf Binary files differnew file mode 100644 index 00000000000..5b0c3ba92b1 --- /dev/null +++ b/Master/texmf-dist/doc/latex/outlines/outlines.pdf diff --git a/Master/texmf-dist/doc/latex/outlines/outlines.tex b/Master/texmf-dist/doc/latex/outlines/outlines.tex new file mode 100644 index 00000000000..5e160ecc498 --- /dev/null +++ b/Master/texmf-dist/doc/latex/outlines/outlines.tex @@ -0,0 +1,257 @@ +\documentclass[11pt]{article} + +\usepackage{outlines} +\usepackage{fancyvrb} +\DefineShortVerb{\"} + +\title{The \texttt{outlines} package} +\author{Charles Pecheur} +\date{Version 1.1 -- January 23, 2012} + +\begin{document} + +\maketitle + +\begin{abstract} +The \texttt{outlines} package defines the \texttt{outline} environment, +that allows outline-style indented lists with freely mixed levels up +to four levels deep. It replaces the nested "begin"/"end" pairs by +different item tags "\1" to "\4" for each nesting level. This is very +convenient in cases where nested lists are used a lot, such as for to-do +lists or presentation slides. +\end{abstract} + + +\section{Examples} + +\subsection{Basics} + +{\small\begin{verbatim} +\begin{outline} + \1 This is a first item. + \1[!!!] This is a second, with a custom label. + \2 A level-2 item. + \3 A level 3. + \4 Deepest is level 4. + \2 Back to level 2. +\0 A normal paragraph in the middle. + \1 A couple more + \2 items. +\end{outline} +\end{verbatim}} + +\noindent Produces: + +{\small +\begin{outline} + \1 This is a first item. + \1[!!!] This is a second, with a custom label. + \2 A level-2 item. + \3 A level 3. + \4 Deepest is level 4. + \2 Back to level 2. +\0 A normal paragraph in the middle. + \1 A couple more + \2 items. +\end{outline} +} + +\subsection{Changing List Styles at Each Level} + +{\small\begin{verbatim} +\renewcommand{\outlineii}{enumerate} +\begin{outline} + \1 This is a first item. + \2 A level-2 item in enumerate style. + \2 And another. +\0 A normal paragraph in the middle. +\renewcommand{\outlineii}{description} + \1 More level-1. + \2[Descr] Level-2 in description style. +\end{outline} +\end{verbatim}} + +\noindent Produces: + +{\small +\renewcommand{\outlineii}{enumerate} +\begin{outline} + \1 This is a first item. + \2 A level-2 item in enumerate style. + \2 And another. +\0 A normal paragraph in the middle. +\renewcommand{\outlineii}{description} + \1 More level-1. + \2[Descr] Level-2 in description style. +\end{outline} +} + +\subsection{Changing List Styles for the Whole Outline} + +{\small\begin{verbatim} +\begin{outline}[enumerate] +\0 All in enumerate style. + \1 A level-1 enum. + \2 A level-2 enum. + \3 A level-3 enum. + \4 A level-4 enum. +\end{outline} +\end{verbatim}} + +\noindent Produces: + +{\small +\begin{outline}[enumerate] +\0 All in enumerate style. + \1 A level-1 enum. + \2 A level-2 enum. + \3 A level-3 enum. + \4 A level-4 enum. +\end{outline} +} + +\subsection{With Custom List Styles} + +\noindent For example, the following list environment provides a variant of "enumerate" that keeps increasing item numbers across different enumerations: + +{\small\begin{verbatim} +\newcounter{cenum} +\newcounter{cenumsaved} +\setcounter{cenumsaved}{0} +\newcommand{\labelcenum}{\arabic{cenum}.} +\newenvironment{cenumerate}% + {\begin{list}{\labelcenum}{\usecounter{cenum}}% + \setcounter{cenum}{\value{cenumsaved}}}% + {\setcounter{cenumsaved}{\value{cenum}}% + \end{list}} +\end{verbatim}} + +\newcounter{cenum} +\newcounter{cenumsaved} +\setcounter{cenumsaved}{0} +\newcommand{\labelcenum}{\arabic{cenum}.} +\newenvironment{cenumerate}% + {\begin{list}{\labelcenum}{\usecounter{cenum}}% + \setcounter{cenum}{\value{cenumsaved}}}% + {\setcounter{cenumsaved}{\value{cenum}}% + \end{list}} + +\noindent This can be used as a list style in an outline as follows: + +{\small\begin{verbatim} +\renewcommand{\outlineii}{cenumerate} +\begin{outline} + \1 This is a first item. + \2 A level-2 item in cenumerate style. + \2 And another. +\0 A normal paragraph in the middle. + \1 More level-1. + \2 Level-2 with continued numbering. +\end{outline} +\end{verbatim}} + +\noindent Which produces: + +{\small +\renewcommand{\outlineii}{cenumerate} +\begin{outline} + \1 This is a first item. + \2 A level-2 item in cenumerate style. + \2 And another. +\0 A normal paragraph in the middle. + \1 More level-1. + \2 Level-2 with continued numbering. +\end{outline} +} + +\section{Usage} + +\begin{outline} + +\0 In the preamble: + +\1 "\usepackage{outlines}" + +loads this package (no options supported). + +\0 In the document: + +\1 "\begin{outline}["\emph{style}"]" \emph{body} "\end{outline}" + +produces an \emph{outline} region, with a hierarchy of items up to four levels deep. The outline is formatted according to \emph{style}, which must be the name of a \LaTeX\ list environment. The default is "itemize". All levels use the same style. + +\1 "\renewcommand{\outlinei}{"\emph{style}"}" \\ + "\renewcommand{\outlineii}{"\emph{style}"}" \\ + "\renewcommand{\outlineiii}{"\emph{style}"}" \\ + "\renewcommand{\outlineiiii}{"\emph{style}"}" + +change the list style to \emph{style} for levels 1, 2, 3 and 4. + +\0 Inside \emph{body}: + +\1 "\1["\emph{lbl}"]", "\2["\emph{lbl}"]", "\3["\emph{lbl}"]", +"\4["\emph{lbl}"]" + +introduce outline items at the four nesting levels. They are +used the same way as "\item["\emph{lbl}"]" in list environments, where +\emph{lbl} is an optional custom item label. + +\1 "\0" + +introduces a normal, non-itemized paragraph. + +\end{outline} + +\section{Remarks} + +\LaTeX\ list environments cannot begin with a nested list. +In outlines, that means that a level-$n$ item may only follow an item +of level $n-1$ or higher. For example, the following produces two +``"missing \item"'' errors: + +\begin{verbatim} +\begin{outline} + \2 Missing level 1, + \4 missing level 3. +\end{outline} +\end{verbatim} + +Do not use outlines inside other outlines or other list environments. +Nested lists in outlines should work and be consistent with the current +level of the outline (e.g. a nested list following a level-2 outline +item will look as a level-3 list). The four-level limit applies overall. + +Outside an outline, re-defining outline styles (by changing "\outlinei" etc.) will apply to all posterior outlines; inside an outline, it will apply only according to usual \LaTeX\ list scoping rules: for example, re-defining "\outlineii" at level 1 will apply to posterior level-2 sub-lists within this level-1 sublist only; re-defining "\outlineii" inside a level-2 sub-list will have no effect. Note that the \emph{style} parameter of the "outline" environment applies to non-redefined styles only. + +\section{Implementation Notes} + +The package is implemented in \LaTeX\ (no plain \TeX); it should be +easy to understand and customize even to a non-\TeX-pert. The main +programming trick is a set of commands "\ol@toz", \dots, "\ol@toiiii" +which are dynamically modified to contain the necessary list openings or closings to reach outline levels 0 to 4 from the current level. + +Outlines expand to the corresponding hierarchy of nested lists of the +selected style. All custom list formatting and user-provided list styles +should be compatible with "outline" environments, as long as they keep +the "\item" syntax. + +\paragraph{History} + +\begin{description} + + \item[v 1.1 (Jan 2012)] Added re-definition of individual list styles. + + \item[(no version) (Mar 2005)] Initial release. + +\end{description} + +\section{Credits} + +This package was developed by Charles Pecheur at Universit\'e catholique de +Louvain, Belgium. It is free for anyone to use, modify and re-distribute +as long as credit to the original author is preserved. Charles Pecheur +can be contacted at "charles.pecheur@uclouvain.be". + +This package is independent from similar packages "outline.sty" and "outliner.sty", available on the CTAN archive. + +\end{document}
\ No newline at end of file diff --git a/Master/texmf-dist/tex/latex/outlines/outlines.sty b/Master/texmf-dist/tex/latex/outlines/outlines.sty new file mode 100644 index 00000000000..ad56a226244 --- /dev/null +++ b/Master/texmf-dist/tex/latex/outlines/outlines.sty @@ -0,0 +1,139 @@ +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +% outlines.sty - Provides an "outline" environment for mixed-level +% outline lists +% +% Charles Pecheur, UCL, 2005 -- 2012 +% charles.pecheur@uclouvain.be +% +% Note: this package has no connection with outline.sty or outliner.sty, +% that are available on CTAN +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +% Usage: +% +% \usepackage{outlines} +% +% \begin{outline}[<list-style>] +% \1 <level 1 text> +% \1[<label>] <level 1 text> +% \2 <level 2 text> +% \3 <level 3 text> +% \4 <level 4 text> +% \0 <normal paragraph> +% ... +% \end{outline} +% +% where: +% + <list-style> is an optional list environment name +% (e.g. itemize, enumerate, ...). The default is itemize. +% The same style is used for all levels that have not been overridden. +% + <label> is an optional label, as in \item[<label>]. +% + Levels may be mixed freely, except that a \1 must come before +% the first \2, a \2 before the first \3, etc. +% (this restriction is inherited from list environments). +% + \0 gives a normal, non-list paragraph. +% + List styles for each level can be overridden by re-defining +% \outlinei, ..., \outlineiiii, either globally or inside an outline block. +% +% Do not nest outlines inside outlines or other lists. Lists inside outlines +% should work fine. +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% + +\ProvidesPackage{outlines}[2012/1/23 1.1 Ch. Pecheur] +\RequirePackage{ifthen} + +\makeatletter +% \ol@type stores the default list style +\newcommand{\ol@type}{itemize} +% \ol@typei ... store the (list) environment names used in outlines +\newcommand{\outlinei}{\ol@type} +\newcommand{\outlineii}{\ol@type} +\newcommand{\outlineiii}{\ol@type} +\newcommand{\outlineiiii}{\ol@type} +% \ol@inci ..., \ol@deci ... increase/decrease the indentation level +\newcommand{\ol@inci}{\begin{\outlinei}} +\newcommand{\ol@deci}{\end{\outlinei}} +\newcommand{\ol@incii}{\begin{\outlineii}} +\newcommand{\ol@decii}{\end{\outlineii}} +\newcommand{\ol@inciii}{\begin{\outlineiii}} +\newcommand{\ol@deciii}{\end{\outlineiii}} +\newcommand{\ol@inciiii}{\begin{\outlineiiii}} +\newcommand{\ol@deciiii}{\end{\outlineiiii}} + +% \ol@toz, \ol@toi ... "transition" to indentation level 0..4 by opening or +% closing nested list levels as needed. +% They are dynamically modified according to the current level. +\newcommand{\ol@toz}{} +\newcommand{\ol@toi}{} +\newcommand{\ol@toii}{} +\newcommand{\ol@toiii}{} +\newcommand{\ol@toiiii}{} + +% \ol@commands{C0}{C1}{C2}{C3}{C4} set the level transition commands +% above to C0..C4 +\newcommand{\ol@commands}[5]{% + \renewcommand{\ol@toz}{#1}% + \renewcommand{\ol@toi}{#2}% + \renewcommand{\ol@toii}{#3}% + \renewcommand{\ol@toiii}{#4}% + \renewcommand{\ol@toiiii}{#5}% +} + +% \ol@exit resets transition commands. This is not mandatory, just cleaner. +\newcommand{\ol@exit}{% + \ol@commands{}{}{}{}{}} +% \ol@z, \ol@i ... update all transitions for level 0..4 +\newcommand{\ol@z}{% + \ol@commands% + {}% + {\ol@inci}% + {\ol@inci\ol@incii}% + {\ol@inci\ol@incii\ol@inciii}% + {\ol@inci\ol@incii\ol@inciii\ol@inciiii}} +\newcommand{\ol@i}{% + \ol@commands% + {\ol@deci}% + {}% + {\ol@incii}% + {\ol@incii\ol@inciii}% + {\ol@incii\ol@inciii\ol@inciiii}} +\newcommand{\ol@ii}{% + \ol@commands% + {\ol@decii\ol@deci}% + {\ol@decii}% + {}% + {\ol@inciii}% + {\ol@inciii\ol@inciiii}} +\newcommand{\ol@iii}{% + \ol@commands% + {\ol@deciii\ol@decii\ol@deci}% + {\ol@deciii\ol@decii}% + {\ol@deciii}% + {}% + {\ol@inciiii}} +\newcommand{\ol@iiii}{% + \ol@commands% + {\ol@deciiii\ol@deciii\ol@decii\ol@deci}% + {\ol@deciiii\ol@deciii\ol@decii}% + {\ol@deciiii\ol@deciii}% + {\ol@deciiii}% + {}} + + +% the outline environment provides commands \1..\4 for +% introducing items at level 1..4, and \0 for normal paragraphs +% within the outline section. +\newenvironment{outline}[1][]{% + \ifthenelse{\equal{#1}{}}{}{\renewcommand{\ol@type}{#1}}% + \ol@z% + \newcommand{\0}{\ol@toz\ol@z}% + \newcommand{\1}{\ol@toi\ol@i\item}% + \newcommand{\2}{\ol@toii\ol@ii\item}% + \newcommand{\3}{\ol@toiii\ol@iii\item}% + \newcommand{\4}{\ol@toiiii\ol@iiii\item}% +}{% + \ol@toz\ol@exit% +} + +\makeatother + + diff --git a/Master/tlpkg/bin/tlpkg-ctan-check b/Master/tlpkg/bin/tlpkg-ctan-check index 9aee7895256..89559ec7841 100755 --- a/Master/tlpkg/bin/tlpkg-ctan-check +++ b/Master/tlpkg/bin/tlpkg-ctan-check @@ -284,7 +284,7 @@ my @TLP_working = qw( ogham oldlatin oldstandard oldstyle onlyamsmath onrannual opcit opensans optional ordinalpt orkhun ot-tableau othello othelloboard - oubraces outline outliner overpic + oubraces outline outliner outlines overpic pacioli pagecolor pagecont pagenote pagerange pageslts paper papercdcase papermas papertex paracol paralist parallel paratype diff --git a/Master/tlpkg/tlpsrc/collection-latexextra.tlpsrc b/Master/tlpkg/tlpsrc/collection-latexextra.tlpsrc index 9f6c06480f6..3a505f7bc49 100644 --- a/Master/tlpkg/tlpsrc/collection-latexextra.tlpsrc +++ b/Master/tlpkg/tlpsrc/collection-latexextra.tlpsrc @@ -499,6 +499,7 @@ depend opcit depend optional depend outline depend outliner +depend outlines depend overpic depend pagecolor depend pagecont diff --git a/Master/tlpkg/tlpsrc/outlines.tlpsrc b/Master/tlpkg/tlpsrc/outlines.tlpsrc new file mode 100644 index 00000000000..e69de29bb2d --- /dev/null +++ b/Master/tlpkg/tlpsrc/outlines.tlpsrc |