From 007f67a693e4d031fd3d792df8e4d5f43e2cb2e7 Mon Sep 17 00:00:00 2001 From: Karl Berry Date: Mon, 9 Jan 2006 00:49:07 +0000 Subject: doc/latex git-svn-id: svn://tug.org/texlive/trunk@84 c570f23f-e606-0410-a88d-b1316a301751 --- Master/texmf-dist/doc/latex/titlesec/README | 52 + Master/texmf-dist/doc/latex/titlesec/titlesec.new | 16 + Master/texmf-dist/doc/latex/titlesec/titlesec.pdf | Bin 0 -> 230525 bytes Master/texmf-dist/doc/latex/titlesec/titlesec.tex | 2320 +++++++++++++++++++++ Master/texmf-dist/doc/latex/titlesec/titletoc.new | 67 + 5 files changed, 2455 insertions(+) create mode 100644 Master/texmf-dist/doc/latex/titlesec/README create mode 100644 Master/texmf-dist/doc/latex/titlesec/titlesec.new create mode 100644 Master/texmf-dist/doc/latex/titlesec/titlesec.pdf create mode 100644 Master/texmf-dist/doc/latex/titlesec/titlesec.tex create mode 100644 Master/texmf-dist/doc/latex/titlesec/titletoc.new (limited to 'Master/texmf-dist/doc/latex/titlesec') diff --git a/Master/texmf-dist/doc/latex/titlesec/README b/Master/texmf-dist/doc/latex/titlesec/README new file mode 100644 index 00000000000..117ac5fe87c --- /dev/null +++ b/Master/texmf-dist/doc/latex/titlesec/README @@ -0,0 +1,52 @@ +Titlesec package +~~~~~~~~~~~~~~~~ +This package allows to change the sectioning titles. Amongst its many +features it provides margin titles, different format in left and right +pages, rules above and below the title, etc. + +Titletoc package +~~~~~~~~~~~~~~~~ +For toc entries formatting, providing the possibility of changing +the format in the middle of a document, grouping the entries +in a single paragraph, pretty free-forms entries, partial tocs, etc. + +The titletoc.sty file is not part of the titlesec package; it's +an independent package, but it's described in titlesec.tex. + +Installation +~~~~~~~~~~~~ +No .ins/.dtx preinstalation is required. Move the files to a place +where LaTeX can find them and typeset titlesec.tex. All of files in +this directory are necessary for titlesec.sty to work, except the +manual titlesec.tex (and this 'readme' file). The manual requires +titlesec.sty and titletoc.sty, and hence all the .tss, .def +and .new files as well. + +Files with extension .new (titlesec.new and titletoc.new) +are patch files, ie, files with bug fixes, which are loaded +automatically. + +Web site, manual in PDF format and info +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +More details are available on + + http://texytipografia.com/titlesec.html + +Known problems +~~~~~~~~~~ +Some language styles (for babel) add the indentation +after a section in a so radical way that titlesec (which uses +the internal LaTeX macros) cannot supress it again. +For example, spanish (by myself) and frenchb. + +Changes +~~~~~~~~ +2005/05/19. Patch for titletoc (titletoc.new, level 1) to +fix a bug when partial tocs are used with \include'd +files (a partial toc could appear in the wrong context). + +2005/05/19 + +______________________________________________________________ +Javier Bezos | http://texytipografia.com +.............................................................. \ No newline at end of file diff --git a/Master/texmf-dist/doc/latex/titlesec/titlesec.new b/Master/texmf-dist/doc/latex/titlesec/titlesec.new new file mode 100644 index 00000000000..3e6180f6524 --- /dev/null +++ b/Master/texmf-dist/doc/latex/titlesec/titlesec.new @@ -0,0 +1,16 @@ +% titlesec 2.6, patch +% (c) Javier Bezos 2005, as stated in titlesec.sty +% +% Level 0 +% +%\def\ttl@a{2005/01/22 v2.6 Sectioning titles} +%\expandafter\ifx\csname ver@titlesec.sty\endcsname\ttl@a +% \message{*** titlesec 2.6, loading patch level 1 ***} +%\else +% \PackageError{titlesec}{Wrong patch version} +% {This patch is intended for titlesec v2.6\MessageBreak +% and you are using a different version. If you have +% installed a later release, please remove titlesec.new} +%\fi + +\endinput \ No newline at end of file diff --git a/Master/texmf-dist/doc/latex/titlesec/titlesec.pdf b/Master/texmf-dist/doc/latex/titlesec/titlesec.pdf new file mode 100644 index 00000000000..1b7de55f85d Binary files /dev/null and b/Master/texmf-dist/doc/latex/titlesec/titlesec.pdf differ diff --git a/Master/texmf-dist/doc/latex/titlesec/titlesec.tex b/Master/texmf-dist/doc/latex/titlesec/titlesec.tex new file mode 100644 index 00000000000..4f73ae70182 --- /dev/null +++ b/Master/texmf-dist/doc/latex/titlesec/titlesec.tex @@ -0,0 +1,2320 @@ +% +--------------------------------------------------+ +% | Typeset this file to get the documentation. | +% +--------------------------------------------------+ +% +% Copyright (c) 1998-2005 by Javier Bezos. +% All Rights Reserved. +% +% This file is part of the titlesec distribution release 2.6 +% ----------------------------------------------------------- +% +% This program 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. + +\def\fileversion{2.6} +\def\docdate{January 22, 2005} + +\documentclass[a4paper]{ltxguide} +\usepackage[sf,bf,compact,topmarks,calcwidth,pagestyles]{titlesec} +\usepackage{titletoc} +\def\gobble#1{} +\def\cs#1{\expandafter\gobble\string\\#1} +\makeatletter +\newenvironment{desc} + {\if@nobreak + \vskip-\lastskip + \vspace*{-2.5ex}% + \fi + \decl} + {\enddecl} +\makeatother + +\usepackage{textcomp,pslatex} +\usepackage[linktocpage]{hyperref} + +\title{The \textsf{titlesec} and \textsf{titletoc} +Packages\footnote{The \textsf{titlesec} package is currently at +version 2.6. \copyright{} 1998--2005 Javier Bezos. +The \textsf{titletoc} package is currently at +version 1.5. \copyright{} 1999--2005 Javier Bezos. All Rights +Reserved.}} + +\author{Javier Bezos\footnote{For bug reports, comments and +suggestions go to \href{http://www.texytipografia.com/contact.php}% +{http://www.texytipografia.com/contact.php}, +or to my postal address: Apartado 116.035, E-28080 Madrid, Spain. +English is not my strong point, so contact me when you find mistakes +in the manual. Other packages by the same author: \textsf{gloss} +(with Jos\'e Luis D\'{\i}az), \textsf{accents, tensind, esindex, +dotlessi}.}} + +\date{\docdate} + +\widenhead{2.1pc}{0pc} +\titlelabel{\thetitle.\quad} + +\renewpagestyle{plain}[\small\sffamily\slshape]{ + \footrule + \setfoot{}{\usepage}{}} + +\newpagestyle{myps}[\small\sffamily\slshape]{ + \headrule + \sethead{Titlesec}{\sectiontitle}{\usepage}} + +\pagestyle{myps} + +\newcommand{\examplesep}{% + \begin{center}% + \rule{4pt}{4pt}% + \end{center}} + +\contentsmargin{0pt} +\titlecontents{section}[1.8pc] + {\addvspace{3pt}\bfseries} + {\contentslabel[\thecontentslabel.]{1.8pc}} + {} + {\quad\thecontentspage} + +\titlecontents*{subsection}[1.8pc] + {\small} + {\thecontentslabel. } + {} + {, \thecontentspage} + [.---][.] + +\addtolength{\topmargin}{-3pc} +\addtolength{\textwidth}{6pc} +\addtolength{\oddsidemargin}{-2pc} +\addtolength{\textheight}{7pc} + +\raggedright +\parindent1em +\parskip0pt + +\begin{document} + +\maketitle +\tableofcontents +\section{Introduction} + +This package is essentially a replacement---partial or total---for the +\LaTeX{} macros related with sections---namely titles, headers and +contents. The goal is to provide new features unavailable in current +\LaTeX{}; if you just want a more friendly interface than that of +standard \LaTeX{} but without changing the way \LaTeX{} works you may +consider using \textsf{fancyhdr}, by Piet van Oostrum, \textsf{sectsty}, +by Rowland McDonnell, and \textsf{tocloft}, by Peter Wilson, which you +can make pretty things with. + +Some of the new features provided are: +\begin{itemize} +\item Different classes and ``shapes'' of titles, with tools for very +fancy formats. You can define different formats for left and right +pages, or numbered and unnumbered titles, measure the width of the +title, add a new section level, use graphics, and many more. The +Appendix shows a good deal of examples, so jump forward right now! + +\item Headers and footers defined with no |\...mark| intermediates, +and perhaps containing top, first \emph{and} bot marks at the same time. +Top marks correctly synchronized with titles, and without +incompatibilities with the float mechanism. Decorative elements easily +added, including picture environments. + +\item Pretty free form contents, with the possibility of grouping +entries of different levels in a paragraph or changing the format +of entries in the middle of a document. +\end{itemize} +\textsf{Titlesec} works with the standard classes and with many +others, including the AMS ones, and it runs smoothly with +\textsf{hyperref}.\footnote{However, be aware that the AMS classes +reimplement the original internal commands. These changes will be +lost here. The compatibility with \textsf{hyperref} has been tested +with \textsf{dvips}, \textsf{dvipdfm} and \textsf{pdftex} but it's an +unsupported feature. Please, check that your version of +\textsf{hyperref} is compatible with \textsf{titlesec}.} + +As usual, load the package in the standard way with +|\usepackage|. Then, redefine the sectioning commands with the +simple, predefined settings (see section ``Quick Reference'') or with +the provided commands if you want more elaborate formats (see section +``Advanced Interface.'') In the latter case, you only need to +redefine the commands you'll use. Both methods are available at the +same time, but because |\part| is usually implemented in a +non-standard way, it remains untouched by the simple settings and +should be changed with the help of the ``Advanced Interface.'' + + +\section{Quick Reference} +%~~~~~~~~~~~~~~~~~~~~~~ + +The easiest way to change the format is by means of a set of package +options and a couple of commands. If you feel happy with the +functionality provided by this set of tools, you needn't go +further in this manual. Just read this section and ignore the +subsequent ones. + +\subsection{Format} + +There are three option groups controlling font, size and align. You +need not set all of these groups, since a default is provided for each +one; however, you must use at least an option from them if you want +this ``easy setup.'' +\begin{desc} +|rm sf tt md bf up it sl sc| +\end{desc} +Select the corresponding family/series/shape. Default is |bf|. + +\begin{desc} +|big medium small tiny| +\end{desc} +Set the size of titles. +Default is |big|, which gives the size of standard classes. +With |tiny|, sections (except chapters) are typed in the text +size. |medium| and |small| are intermediate layouts. + +\begin{desc} +|raggedleft center raggedright| +\end{desc} + +Control the alignment. + +\subsection{Spacing} + +\begin{desc} +|compact| +\end{desc} +This option is independent from those above and reduces the spacing +above and below the titles. + +\subsection{Tools} + +\begin{desc} +|\titlelabel{}| +\end{desc} +Changes the label format in sections, subsections, etc. A +|\thetitle| command is provided which is respectively |\thesection|, +|\thesubsection|, etc. The default value in standard classes is +\begin{verbatim} +\titlelabel{\thetitle\quad} +\end{verbatim} +and you may add a dot after the counter simply with +\begin{verbatim} +\titlelabel{\thetitle.\quad} +\end{verbatim} +That was done in this document. + +\begin{desc} +|\titleformat*{}{}| +\end{desc} + +This command allows to change the || of a sectioning +command, as for example: +\begin{verbatim} +\titleformat*{\section}{\itshape} +\end{verbatim} + +\section{Advanced Interface} +%~~~~~~~~~~~~~~~~~~~~~~~~ + +Two commands are provided to change the title format. The first one +is used for the ``internal'' format, i.~e., shape, font, label\dots, +the second one defines the ``external'' format, i.~e., spacing before +and after, indentation, etc. This scheme is intended to easy +definitions, since in most of cases you will want to modify either +spacing or format.\footnote{Information is ``extracted'' from the +class sectioning commands, except for chapter and part. Standard +definitions with |\cs{@startsection}| are presumed, and if an +special procedure was followed an arbitrary value is provided, which +you may change later. (Sadly, there is no way to catch the chapter or +part formats, and one similar to that of standard classes will be +used.)} That redefines existing sectioning commands, but +does not create \emph{new} ones. New sectioning levels can be +added with |\titleclass|, as described below, and then their format +can be set with the commands described here. + +\subsection{Format} + +A set of shapes is provided, which controls the basic distribution of +elements in a title. The available shapes are: +\begin{description} +\item[hang] is the default value, with a hanging label. (Like the +standard |\section|.) + +\item[block] typesets the whole title in a block (a paragraph) without +additional formatting. Useful in centered titles\,\footnote{The label +will be slightly displaced to the left if the title is two or more +lines long and the \texttt{hang} shape is used, except with explicit +|\string\\|.} and special formatting (including graphic tools such as +|picture|, |pspicture|, etc.) + +\item[display] puts the label in a separate paragraph. (Like the +standard |\chapter|.) + +\item[runin] A run-in title. (Like the standard |\paragraph|.) + +\item[leftmargin] puts the title at the left margin. Titles at the +very end of a page will be moved to the next one and will not stick +out in the bottom margin, which means that large titles can lead to +underfull pages.\footnote{However, floats following the title a couple +of lines after will interfere with the page breaking used here and +sometimes the title may stick out.} In this case you may increase the +stretchability of the page elements, use |\raggedbottom| or use the +package option |nobottomtitles| described below. Since the mechanism +used is independent from that of the margin pars, they can overlap. +A synonymous is |margin|. + +\item[rightmargin] is like |leftmargin| but at the right margin. + +\item[drop] wraps the text around the title, provided that the +first paragraph is longer than the title (if not, they overlap). +The comments in |leftmargin| also applies here. + +\item[wrap] is quite similar to drop. The only difference is that +while the space reserved in drop for the title is fixed, in wrap is +automatically readjusted to the longest line. The limitations +explained below related to |calcwidth| also applies here. + +\item[frame] similar to display, but the title will be framed. +\end{description} + +Note, however, that some shapes don't make sense in chapters and +parts. + +\begin{desc} +|\titleformat{}[]{}{