diff options
author | Karl Berry <karl@freefriends.org> | 2010-09-22 00:09:53 +0000 |
---|---|---|
committer | Karl Berry <karl@freefriends.org> | 2010-09-22 00:09:53 +0000 |
commit | fadc35429e479153067f694a93f8cd10f6c934e5 (patch) | |
tree | a05f872d1ba32da629880facb56bb10c78f25da0 /Master/texmf-dist/doc | |
parent | 03799d65499299079bb659eb8897228076096ce6 (diff) |
csquotes 5.0c (21sep10)
git-svn-id: svn://tug.org/texlive/trunk@19835 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc')
-rw-r--r-- | Master/texmf-dist/doc/latex/csquotes/README | 11 | ||||
-rw-r--r-- | Master/texmf-dist/doc/latex/csquotes/RELEASE | 2 | ||||
-rw-r--r-- | Master/texmf-dist/doc/latex/csquotes/csquotes.pdf | bin | 359795 -> 241840 bytes | |||
-rw-r--r-- | Master/texmf-dist/doc/latex/csquotes/csquotes.tex | 167 |
4 files changed, 92 insertions, 88 deletions
diff --git a/Master/texmf-dist/doc/latex/csquotes/README b/Master/texmf-dist/doc/latex/csquotes/README index 644e35ca36d..3d9726318dd 100644 --- a/Master/texmf-dist/doc/latex/csquotes/README +++ b/Master/texmf-dist/doc/latex/csquotes/README @@ -1,4 +1,4 @@ -$Id: README,v 5.0b 2010/08/06 18:16:03 lehman stable $ +$Id: README,v 5.0c 2010/09/21 18:17:28 lehman stable $ ABOUT @@ -28,12 +28,9 @@ purpose. REQUIREMENTS -This package requires e-TeX and the 'etoolbox' package. etoolbox is -available from: - -http://www.ctan.org/tex-archive/macros/latex/contrib/etoolbox/ - -or any CTAN mirror. +- e-TeX +- etoolbox 1.7 or later +- keyval AUTOMATIC INSTALLATION diff --git a/Master/texmf-dist/doc/latex/csquotes/RELEASE b/Master/texmf-dist/doc/latex/csquotes/RELEASE index bb4b4ff5dab..779843535e0 100644 --- a/Master/texmf-dist/doc/latex/csquotes/RELEASE +++ b/Master/texmf-dist/doc/latex/csquotes/RELEASE @@ -1,4 +1,4 @@ -$Id: RELEASE,v 5.0b 2010/08/06 18:16:03 lehman stable $ +$Id: RELEASE,v 5.0c 2010/09/21 18:17:28 lehman stable $ RELEASE NOTES FOR VERSION 5.0 diff --git a/Master/texmf-dist/doc/latex/csquotes/csquotes.pdf b/Master/texmf-dist/doc/latex/csquotes/csquotes.pdf Binary files differindex 83eace5f658..bfe84058075 100644 --- a/Master/texmf-dist/doc/latex/csquotes/csquotes.pdf +++ b/Master/texmf-dist/doc/latex/csquotes/csquotes.pdf diff --git a/Master/texmf-dist/doc/latex/csquotes/csquotes.tex b/Master/texmf-dist/doc/latex/csquotes/csquotes.tex index 8b2c0886e40..ef7bd4690f2 100644 --- a/Master/texmf-dist/doc/latex/csquotes/csquotes.tex +++ b/Master/texmf-dist/doc/latex/csquotes/csquotes.tex @@ -1,4 +1,4 @@ -% $Id: csquotes.tex,v 5.0b 2010/08/06 18:16:03 lehman stable $ +% $Id: csquotes.tex,v 5.0c 2010/09/21 18:17:28 lehman stable $ \documentclass{ltxdockit}[2009/05/24] \usepackage[latin9]{inputenc} \usepackage[american]{babel} @@ -7,16 +7,17 @@ \usepackage{booktabs} \usepackage{graphicx} \usepackage{shortvrb} +\usepackage{needspace} \usepackage{pifont} \MakeAutoQuote{«}{»} \MakeAutoQuote*{<}{>} \MakeShortVerb{\|} -\rcsid{$Id: csquotes.tex,v 5.0b 2010/08/06 18:16:03 lehman stable $} +\rcsid{$Id: csquotes.tex,v 5.0c 2010/09/21 18:17:28 lehman stable $} \titlepage{% - title={The \sty{csquotes} package}, - subtitle={Context sensitive quotation facilities}, + title={The \sty{csquotes} Package}, + subtitle={Context Sensitive Quotation Facilities}, url={http://www.ctan.org/tex-archive/macros/latex/contrib/csquotes/}, author={Philipp Lehman}, email={plehman@gmx.net}, @@ -24,8 +25,8 @@ date={\rcstoday}} \hypersetup{% - pdftitle={The csquotes package}, - pdfsubject={Context sensitive quotation facilities}, + pdftitle={The csquotes Package}, + pdfsubject={Context Sensitive Quotation Facilities}, pdfauthor={Philipp Lehman}, pdfkeywords={tex, e-tex, latex, quote, quotation, smart quotes, babel, polyglossia, multilingual typesetting}} @@ -112,7 +113,7 @@ \section{Introduction} \label{int} -\subsection{About} +\subsection[About]{About \sty{csquotes}} This package provides advanced facilities for inline and display quotations. It is designed for a wide range of tasks ranging from the most simple applications to the more complex demands of formal quotations. The facilities include commands, environments, and user"=definable <smart quotes> which dynamically adjust to their context. Quotation marks are switched automatically if quotations are nested and can adjust to the current language. There are additional facilities designed to cope with the more specific demands of academic writing, especially in the humanities and the social sciences. All quote styles as well as the optional active quotes are freely configurable. @@ -124,17 +125,12 @@ Copyright © 2003--2010 Philipp Lehman. Permission is granted to copy, distribute The multilingual support of this package depends on user contributions. If you want to contribute a quote style, please refer to \secref{cfg:sty} for an overview of the components a quote style is composed of and to \tabref{tab:out} for a list of commands which should be used in the definition of quote styles. -\subsection{Requirements} -\label{int:req} - -This package requires \etex and the \sty{etoolbox} package which is readily available from \acr{CTAN}.\fnurl{http://www.ctan.org/tex-archive/macros/latex/contrib/etoolbox/} \tex distributions have been shipping \etex binaries for quite some time, most distributions even use them by default these days. The \sty{csquotes} package checks if it is running under \etex. Simply try compiling your documents as you usually do, the chances are that it just works. If you get an error message, try compiling the document with \path{elatex} instead of \path{latex} or \path{pdfelatex} instead of \path{pdflatex}, respectively. - -\section{Package options} +\section{Package Options} \label{opt} All package options are given in \keyval syntax. -\subsection{Main options} +\subsection{Main Options} \label{opt:opt} \begin{optionlist} @@ -173,7 +169,7 @@ This option controls multilingual support. It requires either the \sty{babel} pa swedish & quotes, guillemets, guillemets\*\\ \bottomrule \end{tabularx} -\caption[Language options]{Language options defined by default} +\caption[Language Options]{Language Options Defined by Default} \label{tab:lng} \end{table} @@ -192,9 +188,13 @@ Note that \sty{babel}'s language name is \opt{ngerman} here whereas \sty{csquote This option controls whether quotation commands scan ahead for trailing punctuation marks. See \secref{bas:txt:reg,bas:blk:reg,int:txt:reg,int:blk:reg} for details. Also see \cmd{DeclareAutoPunct} in \secref{cfg:dap} and \secref{cfg:aux} on how to configure and use the punctuation look-ahead feature. +\boolitem[false]{csdisplay} + +By default, the block quotation facilities discussed in \secref{bas:blk:reg, bas:blk:bbl, int:blk:reg, int:blk:bbl} will automatically force inline quotations in footnotes, parboxes, minipages, and floats. Set this option to \texttt{true} to permit context sensitive display quotations in these contexts. This option may also be set locally with \cmd{csdisplaytrue} and \cmd{csdisplayfalse}, respectively. + \end{optionlist} -\subsection{Compatibility options} +\subsection{Compatibility Options} \label{opt:leg} \begin{optionlist} @@ -209,12 +209,12 @@ A legacy alias for the \opt{autostyle} option. This option is depreciated. \end{optionlist} -\section{Basic interface} +\section{Basic Interface} \label{bas} This package supports two ways to tag quotations: built-in commands and active quotes defined in the document preamble or the configuration file. This section will introduce the basic commands, active quotes are discussed in \secref{act}. When working with automated citations, you might also want to learn about the integrated quotation facilities presented in \secref{cit}. -\subsection{Quoting regular text} +\subsection{Quoting Regular Text} \label{bas:reg} The most basic command will simply enclose its argument in quotation marks: @@ -228,7 +228,7 @@ Like all quotation facilities, this command is context sensitive. Depending on t \end{ltxsyntax} -\subsection{Quoting text in a foreign language} +\subsection{Quoting Text in a Foreign Language} \label{bas:bbl} To facilitate typesetting quotations in a foreign language, \sty{csquotes} provides two commands which combine \cmd{enquote} with the language switches of the \sty{babel} or the \sty{polyglossia} package: @@ -247,7 +247,8 @@ This command combines \cmd{enquote} with the \env{hyphenrules} environment, that \end{ltxsyntax} -\subsection{Formal quoting of regular text} +\needspace{4\baselineskip} +\subsection{Formal Quoting of Regular Text} \label{bas:txt:reg} Formal quotations are typically accompanied by a citation indicating the source of the quoted text. The following command is an extended version of \cmd{enquote} which encloses the quoted piece of text in quotation marks and adds a citation after the quotation: @@ -270,7 +271,7 @@ Note the use of the optional arguments in the examples above. As seen in the sec \end{ltxsyntax} -\subsection{Formal quoting of text in a foreign language} +\subsection{Formal Quoting of Text in a Foreign Language} \label{bas:txt:bbl} There are two additional commands which combine \cmd{textquote} with the language switches of the \sty{babel} or the \sty{polyglossia} package: @@ -289,7 +290,7 @@ This command combines \cmd{textquote} with the \env{hyphenrules} environment. Ap \end{ltxsyntax} -\subsection{Block quoting of regular text} +\subsection{Block Quoting of Regular Text} \label{bas:blk:reg} A common requirement in academic writing demands that quotations be embedded in the text if they are short but set off as an indented paragraph if they are longer than a certain number of lines. In the latter case no quotation marks are inserted. The following command deals with this requirement automatically: @@ -298,11 +299,11 @@ A common requirement in academic writing demands that quotations be embedded in \cmditem{blockquote}[cite][punct]{text}<tpunct> -This command determines the number of lines required to typeset \prm{text}. If \prm{text} is longer than a given number of lines or if it spans more than one paragraph, it is wrapped in a block quotation environment. Otherwise \cmd{blockquote} behaves like \cmd{textquote}. Quotations in footnotes, parboxes, minipages, and floats are always set inline. By default, the threshold is three lines and the environment used for long quotations is the \env{quote} environment. See \secref{cfg:blk} on how to change these parameters. The optional arguments \prm{cite} and \prm{punct} specify the citation and any terminal punctuation of \prm{text}. \prm{tpunct} denotes trailing punctuation after the command. If the \opt{autopunct} option is enabled, the quotation commands will scan ahead for punctuation marks immediately following their last argument and can move them around if required. See \secref{cfg:aux} on how to change the way these arguments are handled and \secref{use:hok} for reasons why you may want to specify the punctuation as a separate argument. +This command determines the number of lines required to typeset \prm{text}. If \prm{text} is longer than a given number of lines or if it spans more than one paragraph, it is wrapped in a block quotation environment. Otherwise \cmd{blockquote} behaves like \cmd{textquote}. The default threshold is three lines and the environment used for long quotations is the \env{quote} environment. See \secref{cfg:blk} on how to change these parameters. Note that \sty{csquotes} will force inline quotations in footnotes, parboxes, minipages, and floats by default. Use the \opt{csdisplay} option from \secref{opt:opt} to change this behavior. The optional arguments \prm{cite} and \prm{punct} specify the citation and any terminal punctuation of \prm{text}. \prm{tpunct} denotes trailing punctuation after the command. If the \opt{autopunct} option is enabled, the quotation commands will scan ahead for punctuation marks immediately following their last argument and can move them around if required. See \secref{cfg:aux} on how to change the way these arguments are handled and \secref{use:hok} for reasons why you may want to specify the punctuation as a separate argument. \end{ltxsyntax} -\subsection{Block quoting of text in a foreign language} +\subsection{Block Quoting of Text in a Foreign Language} \label{bas:blk:bbl} The following commands combine \cmd{blockquote} with the language switches of the \sty{babel} or the \sty{polyglossia} package: @@ -323,7 +324,8 @@ This command behaves like \cmd{hyphenquote} if the quotation is short. If it exc \end{ltxsyntax} -\subsection{Selecting quote styles} +\needspace{6\baselineskip} +\subsection{Selecting Quote Styles} \label{bas:set} Quote styles may be selected manually at any point in the document body by way of the following command: @@ -338,12 +340,12 @@ The regular form of this command selects a quote style and disables multilingual \end{ltxsyntax} -\section{Active quotes} +\section{Active Quotes} \label{act} This package also supports active characters corresponding to the commands presented in \secref{bas}. Roughly speaking, an active character is a single character which functions as a command. Like the corresponding control sequences, active quotes are fully"=fledged markup elements which verify the nesting level and issue an error if quotations are nested in an invalid way. If multilingual support is enabled, the style of all quotation marks will be adapted to the current language. The commands presented in the following allocate such active quotes. They may be used in the configuration file, the preamble, or the document body. Note that all characters are automatically checked for validity as they are allocated. This package will reject characters which are unsuitable as active quotes. See \secref{hnt:val} for details on the characters which may be used as active quotes. -\subsection{Quoting regular text} +\subsection{Quoting Regular Text} \label{act:reg} \cmd{MakeOuterQuote} and \cmd{MakeInnerQuote} define active quotes which print outer and inner quotation marks. Both take one mandatory argument, the character serving as both opening and closing mark: @@ -362,7 +364,7 @@ All active quotes defined with \cmd{MakeAutoQuote} work like \cmd{enquote}. Thos \end{ltxsyntax} -\subsection{Quoting text in a foreign language} +\subsection{Quoting Text in a Foreign Language} \label{act:bbl} These commands combine \cmd{MakeAutoQuote} with the language switches of the \sty{babel} or the \sty{polyglossia} package: @@ -381,7 +383,7 @@ The active quotes defined with the above commands are similar in concept and fun \end{ltxsyntax} -\subsection{Block quoting of regular text} +\subsection{Block Quoting of Regular Text} \label{act:blk:reg} \cmd{MakeBlockQuote} defines active quotes which will set quotations inline or as a separate paragraph, depending on their length. This command takes three mandatory arguments which must be distinct: @@ -402,7 +404,7 @@ If the delimiter is omitted, the entire text between the opening and the closing \end{ltxsyntax} -\subsection{Block quoting of text in a foreign language} +\subsection{Block Quoting of Text in a Foreign Language} \label{act:blk:bbl} These commands combine \cmd{MakeBlockQuote} with the language switches of the \sty{babel} or the \sty{polyglossia} package: @@ -423,7 +425,7 @@ The active quotes defined with this command are similar in concept and function \end{ltxsyntax} -\subsection{Controlling active quotes} +\subsection{Controlling Active Quotes} \label{act:ctl} The commands introduced above merely allocate active quotes, but these characters are not immediately made active. All allocated quotes are automatically enabled at the beginning of the document body. If any active quotes are allocated in the document body, they need to be enabled with \cmd{EnableQuotes}. The following commands control the state of the active quotes within a local scope. @@ -444,12 +446,12 @@ Disables and deallocates all active quotes, i.e. performs a complete reset of al \end{ltxsyntax} -\section{Integrated interface} +\section{Integrated Interface} \label{cit} The commands presented in this section are extended versions of some of those discussed in \secref{bas}. They differ from their counterparts in that they integrate automated citations into their syntax. Instead of adding \cmd{cite} manually, you pass the citation arguments to the respective quotation command. See \secref{cfg:blk} on how to use a command other than \cmd{cite} to handle the citations. -\subsection{Formal quoting of regular text} +\subsection{Formal Quoting of Regular Text} \label{int:txt:reg} The basic integrated command is an extended version of \cmd{textquote}: @@ -463,7 +465,7 @@ The \prm{text} may be any arbitrary piece of text to be enclosed in quotation ma \end{ltxsyntax} -\subsection{Formal quoting of text in a foreign language} +\subsection{Formal Quoting of Text in a Foreign Language} \label{int:txt:bbl} The following commands combine \cmd{textcquote} with the language switches of the \sty{babel} or the \sty{polyglossia} package: @@ -482,7 +484,7 @@ This command combines \cmd{textcquote} with the \env{hyphenrules} environment. T \end{ltxsyntax} -\subsection{Block quoting of regular text} +\subsection{Block Quoting of Regular Text} \label{int:blk:reg} Block quotations may be combined with automated citations as well by using the extended version of \cmd{blockquote}: @@ -495,7 +497,7 @@ The difference between \cmd{blockcquote} and \cmd{blockquote} is that there are \end{ltxsyntax} -\subsection{Block quoting of text in a foreign language} +\subsection{Block Quoting of Text in a Foreign Language} \label{int:blk:bbl} The following commands combine \cmd{blockcquote} with the language switches of the \sty{babel} or the \sty{polyglossia} package: @@ -516,12 +518,12 @@ This command behaves like \cmd{hyphenblockcquote} if the quotation is short, and \end{ltxsyntax} -\section{Display environments} +\section{Display Environments} \label{env} The environments introduced in this section will typeset quotations as a separate paragraph which looks exactly like a long quotation set by means of the block quotation facilities. Use them for quotations which are to be presented as a separate paragraph regardless of their length. Note that these environments are not replacements for the standard \env{quote} environment in the strict sense. They function as an additional layer on top of the latter, just like the block quotation facilities. The advantage of using these environments instead of resorting to the standard \env{quote} environment is that they are configurable, support citations, and will always be in sync with the block quotation facilities with respect to the configuration options discussed in \secref{cfg:blk,cfg:aux}. -\subsection{Basic display environments} +\subsection{Basic Display Environments} \label{env:bas} The arguments of all display environments are generally appended to the \cmd{begin} section of the environment: @@ -542,9 +544,8 @@ This environment combines \env{displayquote} with \env{hyphenrules}. Apart from \end{ltxsyntax} -\clearpage - -\subsection{Integrated display environments} +\needspace{4\baselineskip} +\subsection{Integrated Display Environments} \label{env:cit} The following environment is an extended version of \env{displayquote}: @@ -565,7 +566,7 @@ This environment combines \env{displaycquote} with \env{hyphenrules}. Apart from \end{ltxsyntax} -\section{Auxiliary commands} +\section{Auxiliary Commands} \label{aux} When quoting text in a formal way, any changes applied to the quoted material, such as omissions, insertions, or alterations, are typically marked as such by using the ellipsis mark and square brackets or parentheses. Use the following commands to indicate such changes in formal quotations: @@ -627,11 +628,11 @@ If available, this package will load the configuration file \path{csquotes.cfg}. swedish & quotes, guillemets, guillemets\*\\ \bottomrule \end{tabularx} -\caption[Styles and variants]{Quote styles and style variants defined by default} +\caption[Styles and Variants]{Quote Styles and Style Variants Defined by Default} \label{tab:sty} \end{table} -\subsection{Defining quote styles} +\subsection{Defining Quote Styles} \label{cfg:sty} Use the following command to define quote styles and style variants: @@ -646,7 +647,7 @@ This command may be used in the configuration file or in the document preamble. \end{ltxsyntax} -\subsection{Defining quote aliases} +\subsection{Defining Quote Aliases} \label{cfg:als} The following command defines quote aliases: @@ -697,11 +698,11 @@ This command may be used in the configuration file or in the document preamble. \\ \bottomrule \end{tabularx} -\caption[Language aliases]{Language aliases defined by default} +\caption[Language Aliases]{Language Aliases Defined by Default} \label{tab:als} \end{table} -\subsection{Defining package options} +\subsection{Defining Package Options} \label{cfg:opt} The following command creates a new package option based on a key\slash value syntax. It takes one mandatory argument, the quote style name: @@ -714,7 +715,7 @@ When using the new option, the name of the quote style will serve as the key. Th \end{ltxsyntax} -\subsection{Executing package options} +\subsection{Executing Package Options} \label{cfg:exe} Apart from passing options to this package as it is loaded, you may also execute options using the following command: @@ -727,7 +728,7 @@ This command permits presetting package options in the configuration file. It ma \end{ltxsyntax} -\subsection{Defining quotes for \pdf strings} +\subsection{Defining Quotes for \pdf Strings} \label{cfg:pdf} The following command specifies the quotation marks for \pdf strings: @@ -741,7 +742,7 @@ This command may be used in the configuration file or in the document preamble. \end{ltxsyntax} -\subsection{Configuring quotations and citations} +\subsection{Configuring Quotations and Citations} \label{cfg:blk} The following commands change the default values used by various quotation facilities of this package. The commands affected by these parameters are indicated in \tabref{tab:blk}. @@ -781,7 +782,7 @@ The following commands change the default values used by various quotation facil Cite command &\_&\_&\_&\_&\_&\_&\+&\+&\+&\_&\_&\_&\+&\+&\+&\_&\_&\_&\+&\+&\+\\ \bottomrule \end{tabularx} -\caption[Configurable parameters]{Scope of configurable parameters} +\caption[Configurable Parameters]{Scope of Configurable Parameters} \label{tab:blk} \end{table} @@ -795,7 +796,7 @@ The following commands change the default values used by various quotation facil \end{ltxsyntax} -\subsection{Hooks for quotations and citations} +\subsection{Hooks for Quotations and Citations} \label{cfg:aux} The appearance of quotes may be configured at a low level by redefining the hooks introduced below. This section will give an overview of their syntax. See \secref{use:hok} for practical examples. The quotation facilities which are responsive to these hooks are indicated in \tabref{tab:aux}. Also see \secref{cfg:tst} for tests which may be useful when redefining the hooks. @@ -838,7 +839,7 @@ The appearance of quotes may be configured at a low level by redefining the hook \cmd{mkccitation} &\_&\_&\_&\_&\_&\_&\+&\+&\+&\_&\_&\_&\+&\+&\+&\_&\_&\_&\+&\+&\+\\ \bottomrule \end{tabularx} -\caption[Auxiliary hooks]{Availability of auxiliary hooks} +\caption[Auxiliary Hooks]{Availability of Auxiliary Hooks} \label{tab:aux} \end{table} @@ -935,7 +936,7 @@ See \secref{use:hok} for practical examples. \end{ltxsyntax} -\subsection{Additional tests in quotation hooks} +\subsection{Additional Tests in Quotation Hooks} \label{cfg:tst} The commands in this section increase the flexibility of the hooks discussed in \secref{cfg:aux}. For example, it may be desirable to adjust the format of a citation depending on the way the corresponding quotation is typeset. It may also be useful to known if the quotation ends with a punctuation mark. @@ -980,7 +981,7 @@ Removes preceding whitespace, \ie removes all skips and penalties from the end o \end{ltxsyntax} -\subsection{Configuring punctuation look-ahead} +\subsection{Configuring Punctuation Look-Ahead} \label{cfg:dap} \begin{ltxsyntax} @@ -997,7 +998,7 @@ This definition is restored automatically whenever the \opt{autopunct} package o \end{ltxsyntax} -\subsection{Configuring ellipses} +\subsection{Configuring Ellipses} \label{cfg:elp} The appearance of ellipses and insertions formatted with the auxiliary commands from \secref{aux} is controlled by five hooks. When \cmd{textelp} is used with an empty argument (ellipsis only), it will execute \cmd{mktextelp}. When used with a non-empty \prm{text} argument (ellipsis and insertion), the \prm{text} will be passed as an argument to \cmd{mktextelpins}. The starred form will pass the \prm{text} to \cmd{mktextinselp} instead. These are the default definitions: @@ -1023,10 +1024,10 @@ You may redefine the above hooks to change the format of the printed output. For % The \cmd{unkern} in the default definitions is required because \cmd{textellipsis} adds asymmetric kerning by default. The kerning after the final dot is similar to the spacing between the dots, which is fine if \cmd{textellipsis} is followed by any text, but undesirable if it is enclosed in brackets. -\section{Usage notes} +\section{Usage Notes} \label{use} -\subsection{Adding a new quote style} +\subsection{Adding a New Quote Style} \label{use:spl} This section will give some comprehensive examples of how to define new quote styles. The examples presented here will only make use of the most basic components a quote style can be composed of. The main point is to illustrate the interaction of quote styles, variants, aliases, and package options. To get started, consider a simple house style which may be selected by way of the package option \opt{style} or the command \cmd{setquotestyle}: @@ -1088,7 +1089,7 @@ To select the default or the alternative style with multilingual support we use: % The base style must be implemented as an alias in this case since the \opt{newspeak} option will select a variant by redefining and thus overwriting the \opt{newspeak} alias. Since the \opt{otherspeak} alias points to \opt{newspeak} and not directly to any backend style, using the \opt{newspeak} option will also have the desired effect if multilingual support is enabled. Note that there are some style names which have a special meaning. See \secref{hnt:pre} for details. -\subsection{Using quotation and citation hooks} +\subsection{Using Quotation and Citation Hooks} \label{use:hok} Style guides for writers usually make detailed provisions concerning the formatting of quotations and citations, including rules dealing with punctuation placement. This section will discuss some typical usage scenarios, using hooks and other facilities introduced in \secref{cfg:aux,cfg:tst,cfg:dap}. In the examples below, we assume the following input: @@ -1275,15 +1276,15 @@ for parenthetical citations and % for citations in footnotes. -\section{Hints and caveats} +\section{Hints and Caveats} \label{hnt} -\subsection{Input encodings} +\subsection{Input Encodings} \label{hnt:inc} The active quotes provided by this package may depend on or benefit from the \sty{inputenc} package under certain circumstances. As long as the active quotes are in the range 0--127, there is no benefit in loading \sty{inputenc}. If you are using an 8-bit input encoding such as \opt{latin1}, \sty{inputenc} is required for the quotes to function properly in a verbatim context. It should therefore be loaded before any active quotes are allocated (not necessarily before this package is loaded). The \utf support of this package builds on the \path{utf8} module of the inputenc package. When using this encoding, ensure that inputenc is loaded with the \opt{utf8} option. Do not use the \opt{utf8x} option as this would implicitly load the \sty{ucs} package which is not supported by \sty{csquotes}. \utf encoding will be detected automatically. All commands discussed in \secref{act} work as usual with this encoding. See also \secref{hnt:mod}. -\subsection{Output encodings} +\subsection{Output Encodings} \label{hnt:onc} The \acr{OT1} font encoding, the default output encoding of \latex, merely includes the quotation marks used in English. You will need to switch to an encoding like \acr{T1} or \acr{LY1} in order to get guillemets or baseline quotation marks. This package deliberately refrains from providing any workarounds for the \acr{OT1} legacy encoding. If you need \acr{T1} encoding for some of the quotation marks, you will most likely need it anyway to get proper hyphenation for the respective language. See \tabref{tab:out} for a list of common quotation marks included in both \acr{T1} and \acr{LY1} encoding. @@ -1309,21 +1310,21 @@ The \acr{OT1} font encoding, the default output encoding of \latex, merely inclu \cmd{guilsinglright} & \mksample[60]{\guilsinglright} \\ \bottomrule \end{tabularx} -\caption[Quotation marks]{Quotation marks included in \acr{T1} and \acr{LY1} encoding} +\caption[Quotation Marks]{Quotation Marks Included in \acr{T1} and \acr{LY1} Encoding} \label{tab:out} \end{table} -\subsection{Valid active quotes} +\subsection{Valid Active Quotes} \label{hnt:val} In general, an active quote may be any single character with category code 12 or 13, or any multibyte \utf sequence representing a single character. However, there are a few exceptions: numbers, punctuation marks, the apostrophe, the hyphen, and all characters which are part of the \latex syntax are rejected. In sum, the following characters will be considered as reserved by this package: \texttt{A--Z a--z 0--9 . , ; : ! ? \textquotesingle\ - \# \$ \% \& \textasciicircum\ \textunderscore\ \textasciigrave\, \textasciitilde\ \textbackslash\ @ \textasteriskcentered\ \{ \} [ ]} -\subsection{Invalid nesting and unbalanced active quotes} +\subsection{Invalid Nesting and Unbalanced Active Quotes} \label{hnt:grp} Every quotation forms a group which includes both the quoted piece of text and the quotation marks. This package tracks the nesting level of all quotations and thus allows for basic validation. If quotations are nested in an invalid way, it will issue an error message. Keep in mind that the active quotes are more than a convenient way to enter quotation marks. They are fully"=fledged markup elements which imply grouping as well, hence they must always be balanced and must not interfere with other group boundaries. This package ensures that an error is triggered if quotes are unbalanced or nested in an invalid way. However, note that packages generally can not catch low-level errors caused by grouping mistakes, nor do they have any control over the wording of generic error messages. -\subsection{Active quotes in special contexts} +\subsection{Active Quotes in Special Contexts} \label{hnt:mod} The commands provided by this package are designed for use in text mode. If you inadvertently use them in math mode, they will issue an error message. Note that all active quotes retain their original function in math mode. It is perfectly possible to use a character like the greater-than symbol as an active quote without interfering with math mode. @@ -1332,17 +1333,17 @@ In a verbatim context, the active quotes will normally be disabled. If a charact Some care is still required when choosing active quotes. Note that you normally cannot use active characters in the argument to commands expecting a string of characters, such as \cmd{input}, \cmd{label}, or \cmd{cite}. There are two packages which try to remedy this situation: the \sty{babel} package and the \sty{underscore} package (when loaded with the \opt{strings} option). Both packages redefine several standard commands affected by this general problem. If any one of these packages is loaded, \sty{csquotes} will take advantage of all improvements automatically. Unfortunately, both packages patch a different set of commands and neither one covers all possibly vulnerable commands. -\subsection{\pdf strings and \sty{hyperref} support} +\subsection{\pdf Strings and \sty{hyperref} Support} \label{hnt:pdf} This package interfaces with the \sty{hyperref} package as \pdf strings such as bookmarks are generated. See \secref{cfg:pdf} on how to configure the quotation marks used in \pdf strings. Support for \pdf strings is only available with the basic facilities presented in \secref{bas:reg,bas:bbl} as well as \secref{act:reg,act:bbl}. Be advised that the way \sty{hyperref} builds \pdf strings imposes severe limitations on the capabilities of all commands. Most notably, the nesting level of quotations cannot be tracked in this context. Nested quotations will generally get outer marks, but you may use starred commands or active inner quotes to request inner marks explicitly. If quotation marks are to be included in the document properties of a \pdf file, you must use \cmd{hypersetup} to specify the strings. The replacement mechanism will not function within the optional argument to \cmd{usepackage}. For information about \pdf strings see the \sty{hyperref} documentation. -\subsection{Footnotes inside quotations} +\subsection{Footnotes Inside Quotations} \label{hnt:ftn} This package will automatically reset the nesting level within any footnote included in a quotation. If the \sty{babel} or the \sty{polyglossia} package has been loaded, it will also reset the language. The language of the footnote text including the hyphenation patterns will match the language of the text surrounding the quotation. This applies to parboxes, minipages, and floats as well. -\subsection{Using \sty{csquotes} with \sty{babel}'s shorthands} +\subsection{Using \sty{csquotes} with \sty{babel}'s Shorthands} \label{hnt:bbl} The commands discussed in \secref{aut:amk} may be combined with the shorthands of the \sty{babel} package such that \sty{babel} provides the user interface and \sty{csquotes} the backend.\footnote{This also applies to the \sty{polyglossia} package if the \opt{babelshorthands} option of \sty{polyglossia} has been enabled.} For example, the German module of the \sty{babel} package defines, amongst other things, the shorthands |"`| and |"'|. Such shorthands are input aids, \ie physical markup elements with a fixed definition. Typing |"`| is a short way of saying |\quotedblbase| but it is not different in concept. These shorthands can be transformed into <smart quotes> which behave like \cmd{enquote}. Here is a simple ad~hoc solution suitable for documents with only one language: @@ -1369,19 +1370,19 @@ It is possible to move such definitions to \path{csquotes.cfg}. In this case, th % This code redefines the shorthands only if the \sty{babel} package has been loaded and the main language is \texttt{german}. Note that \sty{babel}'s shorthands are language"=specific. The way they are configured and handled is technically and conceptually different from the active quotes discussed in \secref{act}. Active quotes are defined globally and automatically adapt to the current language. With \sty{babel}, each language has its own set of shorthands. Also note that \sty{babel} uses \cmd{AtBeginDocument} to initialize the main document language, including the corresponding shorthands. We use \cmd{AtEndPreamble} to defer the code until the end of the preamble. This way, we can be sure that \sty{babel} has been loaded but that the main document language has not been initialized yet. See the \sty{babel} manual for further details. The \cmd{AtEndPreamble} command is provided by the \sty{etoolbox} package. -\subsection{Miscellaneous notes about the predefined styles} +\subsection{Miscellaneous Notes about the Predefined Styles} \label{hnt:pre} There are three styles which serve a special purpose: \opt{default}, \opt{fallback}, and \opt{debug}. The \opt{default} style is a dynamic alias pointing to the default quote style used if the multilingual interface is not enabled. The package option \opt{style} and the command \cmd{setquotestyle} will redefine this alias. The \opt{fallback} style is a backend style used as a fallback whenever the multilingual interface is enabled but there is no matching quote style for the current language. It will print bold question marks by default. The \opt{debug} style will not print quotation marks but the current quote level as a bold number. This style may be selected using the \opt{style} option or the \cmd{setquotestyle} command. It is intended for debugging only. All variants of the \opt{french} style use spaced out guillemets as outer marks. The style variant \opt{quotes} uses double quotes as inner marks. The starred variant \opt{quotes*} is similar to its regular counterpart except that it will also space out the inner marks. The \opt{guillemets} variant employs spaced out guillemets on all levels. It will also insert guillemets at the beginning of every paragraph inside a quotation spanning multiple paragraphs. In addition to that, two adjoining marks at the end of a quotation are replaced by a single one; if two nested quotations end simultaneously, the second closing mark is omitted automatically. The starred variant \opt{guillemets*} is similar to its regular counterpart, differing only in the middle mark inserted at the beginning of every paragraph. The regular variant uses a left"=pointing guillemet whereas the starred one uses a right"=pointing one. -\section{Author interface} +\section{Author Interface} \label{aut} The following sections discuss the programmer interface to the \sty{csquotes} package as well as some details of the implementation. They are intended for class and package authors who want to interface with this package. -\subsection{Controlling active quotes} +\subsection{Controlling Active Quotes} \label{aut:ctl} The author commands in this section behave essentially like the corresponding user commands discussed in \secref{act:ctl}. The only difference is that they work quietly behind the scenes without writing any notices to the transcript file. The scope of these commands is local so that all changes may be confined to a group. Note that the active quotes are enabled at the beginning of the document body. Under no circumstances will this package make any characters active in the document preamble. You will only need the following commands when dealing with active quotes at the beginning of or in the document body. @@ -1410,7 +1411,7 @@ This command implicitly executes \cmd{@disablequotes} and deallocates all active \end{ltxsyntax} -\subsection{Active quotes in a strings-only context} +\subsection{Active Quotes in a Strings-Only Context} \label{aut:str} A possible problem with active characters are strings-only contexts, i.\,e. cases in which an active character is used in the formation of a control sequence name. A typical example is the \cmd{label} command which expects a string of characters. Any active character may break \cmd{label} when used in its argument. There are two packages which try to remedy this situation, albeit in different ways: \sty{babel} and \sty{underscore}. @@ -1431,7 +1432,7 @@ This is best done in a group. If grouping is not feasible, you must ensure that % This could either be done in a group or without any grouping, but followed by \cmd{restore@protect}. The first approach works with the active characters of the \sty{babel} and the \sty{underscore} packages. The second one works with the \sty{underscore} and the \sty{at} packages. Unfortunately, the active characters of the \sty{inputenc} package support neither of the above"=mentioned techniques. As far as \sty{csquotes} is concerned, it does not matter which approach you take. In both cases all active quotes expand to themselves with category code 12. With macro-level \utf support, \utf encoded active quotes expand to a string of characters with category code 12. This string will be valid \utf. In a verbatim \cmd{write} operation, you should employ one of the techniques discussed in this section rather than \cmd{@verbatimquotes}, which is geared to verbatim typesetting. -\subsection{Block quotations} +\subsection{Block Quotations} \label{aut:blk} The block quotation facilities need to typeset all quotations twice. The first pass is required to measure the length of the quotation. The actual typesetting takes place on the second pass, in a format depending on the result of the first one. In order to prevent any side"=effects of the first (trial) pass, the \sty{csquotes} package (1) performs the first pass inside a group, (2) employs checkpointing to freeze all LaTeX counters, and (3) sets \cmd{if@filesw} to \texttt{false}. However, it can not prevent side"=effects caused by commands that (1) make any global assignments which are not overwritten on the second pass (for example, by way of \cmd{g@addto@macro}), (2) increment counters globally in a way that circumvents \latex's counter commands, or (3) do not check \cmd{if@filesw} every time they are about to write to an auxiliary file. If you observe any malfunctions related to the trial pass (for example, if counters are incremented twice or if an item appears twice in a list), use \cmd{BlockquoteDisable} to redefine or disable the affected command temporarily. @@ -1444,7 +1445,7 @@ The \prm{code} may be arbitrary \latex code which redefines vulnerable commands \end{ltxsyntax} -\subsection{Registering quotation marks} +\subsection{Registering Quotation Marks} \label{aut:sfc} In order to track punctuation marks inside quotations, this package requires that all quotation marks be transparent to the space factor, \ie that they have a space factor code of zero. This setting is specific to the output encoding. Settings for the encodings \acr{OT1}, \acr{OT2}, \acr{OT4}, \acr{T1}, \acr{LY1}, \acr{LGR}, \acr{T2A}, \acr{T2B}, \acr{T2C}, \acr{LCY}, \acr{X2}, \acr{EU1}, and \acr{EU2} are provided by default. Other encodings may be set up in the configuration file using the following command: @@ -1464,7 +1465,7 @@ The \prm{encoding} is the name of the output encoding, for example \texttt{OT1}. % The \prm{position} argument may use any notation accepted by \tex in integer assignments, \eg \texttt{171} in decimal or \verb+"00AB+ in hexadecimal notation. See the settings in \path{csquotes.def} for further examples. The advantage of registering quotes with the above command (rather than adjusting the space factor codes globally) is that the declarations are only used locally inside quotations and will not affect any other part of the document. -\subsection{Automatic quotation marks} +\subsection{Automatic Quotation Marks} \label{aut:amk} The commands in this section provide access to the automatic quotation facilities at a slightly lower level than the user commands in \secref{bas:reg,act:reg}. In contrast to the commands discussed in \secref{aut:imk}, the facilities in this section are fully"=fledged markup elements which verify the nesting level and issue an error if quotations are nested in an invalid way. They form groups and must always be balanced, see \secref{hnt:grp} for details. In other words, the facilities in this section are semantic markup elements, the ones in \secref{aut:imk} are physical markup elements. @@ -1487,7 +1488,7 @@ In terms of their function, the above commands correspond to the regular version The above commands may be used to implement an alternative user interface. For example, you can combine them with the shorthands of the \sty{babel} package such that \sty{babel} provides the user interface and \sty{csquotes} the backend. See \secref{hnt:bbl} and the \sty{babel} manual for details. -\subsection{Internal quotation marks} +\subsection{Internal Quotation Marks} \label{aut:imk} The commands in this section print the quotation marks of the current style, as defined with \cmd{DeclareQuoteStyle}, without any grouping or nesting control. The quotation marks reflect all changes to the quotation style. If the multilingual interface is enabled, they are also synced with the current language. @@ -1515,12 +1516,18 @@ Note that the initialization hooks for the respective quotation style are not ex The scope of these hooks must always be confined to a group. -\section{Revision history} +\section{Revision History} This revision history is a list of changes relevant to users of this package. Changes of a more technical nature which do not affect the user interface or the behavior of the package are not included in the list. If an entry in the revision history states that a feature has been \emph{extended}, this indicates a syntactically backwards compatible modification, such as the addition of an optional argument to an existing command. Entries stating that a feature has been \emph{modified}, \emph{renamed}, or \emph{removed} demand attention. They indicate a modification which may require changes to existing documents in some, hopefully rare, cases. The \opt{version} option from \secref{opt:opt} may be helpful in this case. The numbers on the right indicate the relevant section of this manual. \begin{changelog} +\begin{release}{5.0c}{2010-09-21} +\item Added package option \opt{csdisplay}\see{opt:opt} +\item Added \cmd{csdisplaytrue} and \cmd{csdisplayfalse}\see{opt:opt} +\item Fixed conflict with \sty{polyglossia} +\end{release} + \begin{release}{5.0b}{2010-08-06} \item Fixed issue with \sty{babel}'s active punctuation marks \end{release} @@ -1640,8 +1647,8 @@ This revision history is a list of changes relevant to users of this package. Ch \end{release} \begin{release}{4.0}{2008-03-02} -\item \etex now mandatory requirement\see{int:req} -\item New dependency on \sty{etoolbox} package\see{int:req} +\item \etex now mandatory requirement +\item New dependency on \sty{etoolbox} package \item Added package option \opt{spanish}\see{opt:opt} \item Added variant \opt{mexican} to style \opt{spanish}\see{opt:opt} \item Removed variant \opt{oldstyle} from \opt{english} style\see{opt:opt} |