diff options
| -rw-r--r-- | Master/texmf-dist/doc/latex/csquotes/csquotes.tex | 1377 |
1 files changed, 1377 insertions, 0 deletions
diff --git a/Master/texmf-dist/doc/latex/csquotes/csquotes.tex b/Master/texmf-dist/doc/latex/csquotes/csquotes.tex new file mode 100644 index 00000000000..a7b57a2fa19 --- /dev/null +++ b/Master/texmf-dist/doc/latex/csquotes/csquotes.tex @@ -0,0 +1,1377 @@ +% $Id: csquotes.tex,v 4.1 2008/04/11 18:43:44 lehman stable $ +% +% This is the source of csquotes.pdf. This file is primarily included +% in the distribution for legal reasons. It will not compile as is +% because it depends on unpublished classes and packages. +% +\documentclass{latexdoc} +\usepackage[latin9]{inputenc} +\usepackage[american]{babel} +\usepackage[strict,babel=once]{csquotes} +\usepackage{tabularx} +\usepackage{booktabs} +\usepackage{graphicx} +\usepackage{shortvrb} +\usepackage{symbol} +\MakeAutoQuote{«}{»} +\MakeAutoQuote*{<}{>} +\MakeShortVerb{\|} + +\rcsid{$Id: csquotes.tex,v 4.1 2008/04/11 18:43:44 lehman stable $} + +\titlepage{% + 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}, + revision={\rcsrevision}, + date={\rcstoday}} + +\hypersetup{% + pdftitle={The csquotes package}, + pdfsubject={Context sensitive quotation facilities}, + pdfauthor={Philipp Lehman}, + pdfkeywords={tex, e-tex, latex, quote, quotation, + smart quotes, babel, multilingual typesetting}} + +\AtBeginToc{\setcounter{tocdepth}{1}} +\AtEndToc{\setcounter{tocdepth}{5}} + +% tables + +\newcolumntype{H}{>{\sffamily\bfseries\spotcolor}l} +\newcolumntype{P}{>{\raggedright}p{120pt}} +\newcolumntype{Q}{>{\raggedright}p{70pt}} + +\newcommand*{\vcmd}[1]{\rotatehead{1.5em}{9.5em}{\ltxcmd{#1}}} +\newcommand*{\venv}[1]{\rotatehead{1.5em}{9.5em}{\ltxenv{#1}}} + +\ifpdf + \newcommand*{\rotatehead}[3]{% + \makebox[#1][c]{\rotatebox{90}{\makebox[#2][l]{\scriptsize #3}}}} +\else + \newcommand*{\rotatehead}[3]{% + \makebox[#1][c]{\rule{0pt}{#2}}} +\fi + +% samples + +\definecolor{grid}{rgb}{0.7,0.7,0.7} + +\newcommand*{\mksample}[2][25]{% + \mkmetrics[#1]{#2\,\textcolor{grid}{AaGg}\,#2}} + +\newcommand*{\mkmetrics}[2][25]{% + \setlength{\unitlength}{1pt}% + \setlength{\linethickness}{0.25pt}% + \begin{picture}(#1,0)(0,0) + %\put(0,0){\parbox[b]{#1\unitlength}{\mkgrid{\fontdimen9\font}}} + \put(0,0){\parbox[b]{#1\unitlength}{\mkgrid{\fontdimen5\font}}} + \put(0,0){\parbox[b]{#1\unitlength}{\mkgrid{0pt}}} + %\put(0,0){\parbox[b]{#1\unitlength}{\mkgrid{-\fontdimen11\font}}} + \put(0,0){\parbox[b]{#1\unitlength}{\centering #2}} + \end{picture}} + +\newcommand*{\mkgrid}[1]{% + \begingroup\color{grid}% + \hrule height 0.25pt depth 0pt width \linewidth + \hrule height #1 depth 0pt width 0pt + \endgroup} + +% hyphenation + +\hyphenation{star-red} +\hyphenation{New-speak} +\hyphenation{thres-hold} +\hyphenation{re-pre-sent-ing} + +\begin{document} + +\printtitlepage +\tableofcontents +\listoftables + +\section{Introduction} +\label{int} + +This document is a systematic reference manual for the \sty{csquotes} package. It is supplemented by a hands-on tutorial including practical examples.% +\fnurl{http://www.ctan.org/tex-archive/macros/latex/contrib/csquotes/tutorial.tex} + +\subsection{About} + +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. + +\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. + +\subsection{License} + +Copyright © 2003--2008 Philipp Lehman. Permission is granted to copy, distribute and\slash or modify this software under the terms of the \lppl, version 1.3.\fnurl{http://www.ctan.org/tex-archive/macros/latex/base/lppl.txt} This package is author"=maintained. + +\subsection{Contributions} + +The multilingual support of this package depends on user contributions. If you want to contribute a quote style, please refer to section \ref{cfg:sty} for an overview of the components a quote style is composed of and to table \ref{hnt:onc:tab} for a list of commands which should be used in the definition of quote styles. + +\subsection{Acknowledgments} + +I am indebted to Donald Arseneau, Mark Wooding, and David Carlisle for valuable hints in the early stages of development. Frank Mittelbach kindly provided hooks in the \sty{inputenc} package. Additional thanks go to Robert Schlicht. + +\section{Package options} +\label{opt} + +\begin{table} +\tablesetup +\begin{tabularx}{\columnwidth}{@{}P@{}X@{}} + \toprule + \multicolumn{1}{@{}H}{Option key} & \multicolumn{1}{@{}H}{Possible values} \\ + \cmidrule(r){1-1}\cmidrule{2-2} + strict & true, false \\ + babel & true, false, try, once, tryonce \\ + style & \ltxarg{style} or \ltxarg{alias} \\ + danish & quotes, guillemets \\ + english & american, british\\ + french & quotes, quotes\*, guillemets, guillemets\*\\ + german & quotes, guillemets, swiss \\ + italian & quotes, guillemets \\ + norwegian & guillemets, quotes \\ + spanish & spanish, mexican \\ + swedish & quotes, guillemets, guillemets\*\\ + \bottomrule +\end{tabularx} +\caption[Package options]{Package options defined by default} +\label{opt:tab} +\end{table} + +Package options are given in \keyval syntax. Table \ref{opt:tab} indicates the default option keys and their possible values. Additional options may be defined in the configuration file. See sections \ref{cfg:opt} and \ref{cfg:spl} for details. + +\subsection{The \ltxopt{strict} option} +\label{opt:sct} + +Turns all package warnings into error messages. This is useful to ensure that no problem will go unnoticed when finalizing a document. The short form \ltxopt{strict} is equivalent to \ltxkv{strict}{true}. + +\subsection{The \ltxopt{babel} option} +\label{opt:bbl} + +Controls multilingual support. \ltxkv{babel}{true} continuously adapts the quote style to the language of the \sty{babel} package. \ltxkv{babel}{once} will only adapt the style once so that it matches \sty{babel}'s main language. \ltxkv{babel}{try} and \ltxkv{babel}{tryonce} are similar to \ltxkv{babel}{true} and \ltxkv{babel}{once} if \sty{babel} is loaded but will not issue any warnings if it is not. The short form \ltxopt{babel} is equivalent to \ltxkv{babel}{true}. Multilingual support is not enabled by default. See also section \ref{bas:set}. + +\subsection{The \ltxopt{style} option} +\label{opt:sty} + +Selects a fixed quotation style. The style is used throughout the document unless it is changed manually, see section \ref{bas:set} for details. This option implicitly sets \ltxkv{babel}{false}. Please refer to tables \ref{cfg:sty:tab} and \ref{cfg:als:tab} for a list of available quote styles and aliases. See sections \ref{cfg:sty}, \ref{cfg:als}, and \ref{cfg:spl} for instructions on adding or modifying quote styles. + +\subsection{The language options} +\label{opt:lng} + +Use the language options listed in table \ref{opt:tab} to choose a style variant if there is more than one. The first variant in the list is the default for the respective style. In the following example, the quote style would generally be adapted to the current language using the default style for that language. In the English parts of the text, the quotation marks would follow the British standard. The German parts would use guillemets instead of curly quotes: + +\begin{ltxcode} +\usepackage[english,ngerman]{babel} +\usepackage[babel,english=british,german=guillemets]{csquotes} +\end{ltxcode} +% +Note that \sty{babel}'s language name is \ltxopt{ngerman} here whereas this package uses \ltxopt{german}. When selecting a quote style automatically, this package will essentially normalize the language names first, using a list of aliases which map languages to quote styles. See section \ref{cfg:spl} and table \ref{cfg:als:tab} for details. See section \ref{hnt:lng} for some additional notes concerning the predefined styles. + +\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 section \ref{act}. When working with automated citations, you might also want to learn about the integrated quotation facilities presented in section \ref{cit}. + +\subsection{Quoting regular text} +\label{bas:reg} + +The most basic command will simply enclose its argument in quotation marks: + +\begin{ltxsyntax} + +\cmd{enquote}{text} +\cmd*{enquote*}{text} + +Like all quotation facilities, this command is context sensitive. Depending on the nesting level, it will toggle between outer and inner quotation marks with plain and nested quotations. The starred version of this command skips directly to the inner level. If multilingual support is enabled, the style of all quotation marks will be adapted to the current language. + +\end{ltxsyntax} + +\subsection{Quoting text in a foreign language} +\label{bas:bbl} + +To facilitate typesetting quotations in a foreign language, there are two commands which combine \ltxcmd{enquote} with \sty{babel}'s language switches: + +\begin{ltxsyntax} + +\cmd{foreignquote}{lang}{text} +\cmd*{foreignquote*}{lang}{text} + +This command combines \ltxcmd{enquote} with \ltxcmd{foreignlanguage}. It switches hyphenation patterns and enables the extra definitions provided by the \sty{babel} package for \ltxarg{lang}, which must be a language name known to \sty{babel}. The quotation marks will match the language of the quoted piece of text. + +\cmd{hyphenquote}{lang}{text} +\cmd*{hyphenquote*}{lang}{text} + +This command combines \ltxcmd{enquote} with the \ltxenv{hyphenrules} environment, that is, it merely switches hyphenation patterns. The quotation marks will match the language of the text surrounding the quotation. + +\end{ltxsyntax} + +\subsection{Formal quoting of regular text} +\label{bas:txt:reg} + +Formal quotations are always accompanied by a citation indicating the source of the quoted text. The following command is an extended version of \ltxcmd{enquote} which encloses the quoted piece of text in quotation marks and adds a citation after the quotation: + +\begin{ltxsyntax} + +\cmd{textquote}[cite][punct]{text} +\cmd*{textquote*}[cite][punct]{text} + +The argument \ltxarg{text} may be any arbitrary piece of text to be enclosed in quotation marks. The optional arguments \ltxarg{cite} and \ltxarg{punct} specify the citation and any terminal punctuation which is not part of \ltxarg{text}. See section \ref{cfg:aux} on how to change the way these arguments are handled. The starred version of this command skips directly to the inner quotation level. Here are some usage examples: + +\begin{ltxcode} +\textquote{...} +\textquote[][?]{...} +\textquote[Doe 1990, 67]{...} +\textquote[{\cite[67]{doe90}}]{...} +\end{ltxcode} +% +Note the use of the optional arguments in the examples above. As shown in the second example, \ltxarg{cite} has to be given whenever \ltxarg{punct} is used, even if it is empty. Also keep in mind that an optional argument containing square brackets must be wrapped in an additional pair of curly braces as shown in the last example. When working with automated citations, you might also want to learn about the integrated quotation facilities presented in section \ref{cit}. + +\end{ltxsyntax} + +\subsection{Formal quoting of text in a foreign language} +\label{bas:txt:bbl} + +There are two additional commands which combine \ltxcmd{textquote} with \sty{babel}'s language switches: + +\begin{ltxsyntax} + +\cmd{foreigntextquote}{lang}[cite][punct]{text} +\cmd*{foreigntextquote*}{lang}[cite][punct]{text} + +This command combines \ltxcmd{textquote} with \ltxcmd{foreignlanguage}. Apart from the language, the arguments are handled as with \ltxcmd{textquote}. + +\cmd{hyphentextquote}{lang}[cite][punct]{text} +\cmd*{hyphentextquote*}{lang}[cite][punct]{text} + +This command combines \ltxcmd{textquote} with the \ltxenv{hyphenrules} environment. Apart from the language, the arguments are handled as with \ltxcmd{textquote}. + +\end{ltxsyntax} + +\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: + +\begin{ltxsyntax} + +\cmd{blockquote}[cite][punct]{text} + +This command determines the number of lines required to typeset \ltxarg{text}. If \ltxarg{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 \ltxcmd{blockquote} behaves like \ltxcmd{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 \ltxenv{quote} environment. See section \ref{cfg:blk} on how to change these parameters. The optional arguments \ltxarg{cite} and \ltxarg{punct} specify the citation and any terminal punctuation which is not part of \ltxarg{text}. See section \ref{cfg:aux} on how to change the way these arguments are handled. + +\end{ltxsyntax} + +\subsection{Block quoting of text in a foreign language} +\label{bas:blk:bbl} + +There are two additional commands which combine \ltxcmd{blockquote} with \sty{babel}'s language switches: + +\begin{ltxsyntax} + +\cmd{foreignblockquote}{lang}[cite][punct]{text} + +This command behaves the same as \ltxcmd{foreignquote} if the quotation is short. If it exceeds the threshold or spans several paragraphs, it will be wrapped in an \ltxenv{otherlanguage*} environment which is in turn wrapped in a block quotation environment. The arguments are handled as with \ltxcmd{blockquote}. + +\cmd{hyphenblockquote}{lang}[cite][punct]{text} + +This command works like \ltxcmd{hyphenquote} if the quotation is short. If it exceeds the threshold or spans several paragraphs, it will be wrapped in an \ltxenv{hyphenrules} environment which is in turn wrapped in a block quotation environment. The arguments are handled as with \ltxcmd{blockquote}. + +\end{ltxsyntax} + +\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: + +\begin{ltxsyntax} + +\cmd{setquotestyle}[variant]{style} +\cmd*{setquotestyle}{alias} +\cmd*{setquotestyle}* + +The regular form of this command selects a quote style and disables multilingual support. Its mandatory argument may be a quote style or an alias. If it is a quote style, the optional argument indicates the style variant. The starred version, which takes no arguments, enables multilingual support. Please refer to tables \ref{cfg:sty:tab} and \ref{cfg:als:tab} for a list of available styles, style variants, and language aliases. + +\end{ltxsyntax} + +\section{Active quotes} +\label{act} + +This package also supports active characters corresponding to the commands presented in section \ref{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 section \ref{hnt:val} for details on the characters which may be used as active quotes. + +\subsection{Quoting regular text} +\label{act:reg} + +\ltxcmd{MakeOuterQuote} and \ltxcmd{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: + +\begin{ltxsyntax} + +\cmd{MakeOuterQuote}{character} +\cmd{MakeInnerQuote}{character} + +\ltxcmd{MakeAutoQuote} defines active quotes which toggle between outer and inner quotations automatically. The two mandatory arguments serve as opening and closing mark and must be distinct: + +\cmd{MakeAutoQuote}{character 1}{character 2} +\cmd*{MakeAutoQuote*}{character 1}{character 2} + +All active quotes defined with \ltxcmd{MakeAutoQuote} work like \ltxcmd{enquote}. Those defined with \ltxcmd{MakeOuterQuote} and \ltxcmd{MakeInnerQuote} cover only a part of this functionality. The former correspond to the outer level of \ltxcmd{enquote} whereas the latter correspond to the starred version. \ltxcmd{MakeAutoQuote*} is similar to \ltxcmd{MakeInnerQuote}, i.e. it corresponds to \ltxcmd{enquote*}. + +\end{ltxsyntax} + +\subsection{Quoting text in a foreign language} +\label{act:bbl} + +These commands combine \ltxcmd{MakeAutoQuote} with \sty{babel}'s language switches: + +\begin{ltxsyntax} + +\cmd{MakeForeignQuote}{lang}{character 1}{character 2} +\cmd*{MakeForeignQuote*}{lang}{character 1}{character 2} +\cmd{MakeHyphenQuote}{lang}{character 1}{character 2} +\cmd*{MakeHyphenQuote*}{lang}{character 1}{character 2} + +The active quotes defined with the above commands are similar in function to \ltxcmd{foreignquote} and \ltxcmd{hyphenquote}, respectively. The starred variants correspond to \ltxcmd{foreignquote*} and \ltxcmd{hyphenquote*}. + +\end{ltxsyntax} + +\subsection{Block quoting of regular text} +\label{act:blk:reg} + +\ltxcmd{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: + +\begin{ltxsyntax} + +\cmd{MakeBlockQuote}{character 1}{delimiter}{character 2} + +The arguments are automatically checked for validity, see section \ref{hnt:val} for details. All active quotes defined with \ltxcmd{MakeBlockQuote} behave essentially the same as \ltxcmd{blockquote}, but the handling of the citation is slightly different. \ltxarg{character 1} will serve as the opening mark in the source file, \ltxarg{character 2} as the closing one. The character indicated by the middle argument \ltxarg{delimiter} will serve as a delimiter separating the quoted text from the citation which is given last as the active quotes are used: + +\begin{ltxcode} +\MakeBlockQuote{<}{|}{>} +... +<text|citation> +\end{ltxcode} +% +If the delimiter is omitted, the entire text between the opening and the closing mark will be treated as quotation text. See the tutorial for more usage examples. + +\end{ltxsyntax} + +\subsection{Block quoting of text in a foreign language} +\label{act:blk:bbl} + +These commands combine \ltxcmd{MakeBlockQuote} with \sty{babel}'s language switches: + +\begin{ltxsyntax} + +\cmd{MakeForeignBlockQuote}{lang}{character 1}{delimiter}{character 2} +\cmd{MakeHyphenBlockQuote}{lang}{character 1}{delimiter}{character 2} + +The active quotes defined with \ltxcmd{MakeForeignBlockQuote} behave essentially the same as \ltxcmd{foreignblockquote}. Those defined with \ltxcmd{MakeHyphenBlockQuote} work like \ltxcmd{hyphenblockquote}. The behavior of the delimiter character is similar to \ltxcmd{MakeBlockQuote}. + +\end{ltxsyntax} + +\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 \ltxcmd{EnableQuotes}. The following commands control the state of the active quotes within a local scope. + +\begin{ltxsyntax*} + +\cmd{EnableQuotes} +Enables all active quotes by redefining the allocated characters and making them active. It also restores them when disabled, set to verbatim, or overwritten. + +\cmd{DisableQuotes} +Disables all active quotes by restoring the original category codes and definitions of all allocated characters. + +\cmd{VerbatimQuotes} +Switches to verbatim active quotes. All active quotes will be printed verbatim until their default behavior is restored with \ltxcmd{EnableQuotes}. + +\cmd{DeleteQuotes} +Disables and deallocates all active quotes, i.e. performs a complete reset of all allocated characters so that they may be newly defined. + +\end{ltxsyntax*} + +\section{Integrated interface} +\label{cit} + +The commands presented in this section are extended versions of some of those discussed in section \ref{bas}. They differ from their counterparts in that they integrate automated citations into their syntax. Instead of adding \ltxcmd{cite} manually, you pass the citation arguments to the respective quotation command. See section \ref{cfg:blk} on how to use a command other than \ltxcmd{cite} to handle the citations. + +\subsection{Formal quoting of regular text} +\label{cit:txt:reg} + +The most basic integrated command is an extended version of \ltxcmd{textquote}: + +\begin{ltxsyntax} + +\cmd{textcquote}[prenote][postnote]{key}[punct]{text} +\cmd*{textcquote*}[prenote][postnote]{key}[punct]{text} + +\ltxarg{text} may be any arbitrary piece of text. The optional argument \ltxarg{punct} specifies any terminal punctuation which is not part of \ltxarg{text}. See section \ref{cfg:aux} on how to change the way this argument is handled. The starred version of this command skips directly to the inner quotation level. The remaining arguments are handed over to \ltxcmd{cite}. Note that \ltxcmd{cite} normally supports one optional argument only. \ltxarg{prenote} is only available in conjunction with the \sty{natbib}, \sty{jurabib}, and \sty{biblatex} packages. How these arguments are handled depends on the citation command. With \sty{natbib} and \sty{biblatex}, \ltxarg{prenote} is in fact a notice such as <see>. With jurabib, this argument has a different function by default. The argument \ltxarg{postnote}, which is always available, indicates the citation postnote. This is usually a page number. \ltxarg{key} is the citation key. See sections \ref{cfg:blk} and \ref{cfg:aux} on how to customize the citation. Also see the tutorial for usage examples. + +\end{ltxsyntax} + +\subsection{Formal quoting of text in a foreign language} +\label{cit:txt:bbl} + +These commands combine \ltxcmd{textcquote} with \sty{babel}'s language switches: + +\begin{ltxsyntax} + +\cmd{foreigntextcquote}{lang}[prenote][postnote]{key}[punct]{text} +\cmd*{foreigntextcquote*}{lang}[prenote][postnote]{key}[punct]{text} + +This command combines \ltxcmd{textcquote} with \ltxcmd{foreignlanguage}. The handling of the arguments is similar to \ltxcmd{textcquote}. + +\cmd{hyphentextcquote}{lang}[prenote][postnote]{key}[punct]{text} +\cmd*{hyphentextcquote*}{lang}[prenote][postnote]{key}[punct]{text} + +This command combines \ltxcmd{textcquote} with the \ltxenv{hyphenrules} environment. The handling of the arguments is similar to \ltxcmd{textcquote}. + +\end{ltxsyntax} + +\subsection{Block quoting of regular text} +\label{cit:blk:reg} + +Block quotations may be combined with automated citations as well. The core of the integrated block quotation facilities is an extended version of \ltxcmd{blockquote}: + +\begin{ltxsyntax} + +\cmd{blockcquote}[prenote][postnote]{key}[punct]{text} + +The difference between \ltxcmd{blockcquote} and \ltxcmd{blockquote} is that there are three citation arguments instead of one. The handling of these citation arguments is similar to \ltxcmd{textcquote}; see section \ref{cit:txt:reg} for details. Also see sections \ref{cfg:blk} and \ref{cfg:aux} on how to customize block quotations. + +\end{ltxsyntax} + +\subsection{Block quoting of text in a foreign language} +\label{cit:blk:bbl} + +These commands combine \ltxcmd{blockcquote} with \sty{babel}'s language switches: + +\begin{ltxsyntax} + +\cmd{foreignblockcquote}{lang}[prenote][postnote]{key}[punct]{text} + +This command combines \ltxcmd{blockcquote} with \ltxcmd{foreignlanguage}. Long quotations will be wrapped in an \ltxenv{otherlanguage*} environment. The handling of the citation arguments is similar to \ltxcmd{textcquote}. + +\cmd{hyphenblockcquote}{lang}[prenote][postnote]{key}[punct]{text} + +This command combines \ltxcmd{blockcquote} with the \ltxenv{hyphenrules} environment. The handling of the citation arguments is similar to \ltxcmd{textcquote}. + +\end{ltxsyntax} + +\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 \ltxenv{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 \ltxenv{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 sections \ref{cfg:blk} and \ref{cfg:aux}. + +\subsection{Basic display environments} +\label{env:bas} + +The arguments of all display environments are generally appended to the \ltxcmd{begin} section of the environment: + +\begin{ltxsyntax} + +\env{displayquote}[cite][punct] + +The two optional arguments of this environment specify the citation and any terminal punctuation which is not part of the quoted text. The citation will be inserted at the end of the environment. Trailing horizontal white space at the end of the environment is removed automatically. See sections \ref{cfg:blk} and \ref{cfg:aux} on how to customize the display environments. There are two additional environments which combine \ltxenv{displayquote} with \sty{babel}'s language switches: + +\env{foreigndisplayquote}{lang}[cite][punct] + +This environment combines \ltxenv{displayquote} with \ltxenv{otherlanguage*}. Apart from the language, the arguments are handled as with \ltxenv{displayquote}. + +\env{hyphendisplayquote}{lang}[cite][punct] + +This environment combines \ltxenv{displayquote} with \ltxenv{hyphenrules}. Apart from the language, the arguments are handled as with \ltxenv{displayquote}. + +\end{ltxsyntax} + +\subsection{Integrated display environments} +\label{env:int} + +The following environment is an extended version of \ltxenv{displayquote}: + +\begin{ltxsyntax} + +\env{displaycquote}[prenote][postnote]{key}[punct] + +The difference is that there are three citation arguments instead of one in this case. The placement of the citation is similar to \ltxenv{displayquote}. The citation arguments are handled as with \ltxcmd{textcquote}; see section \ref{cit:txt:reg} for details. Also see sections \ref{cfg:blk} and \ref{cfg:aux} on how to customize this environment. There are two environments which combine \ltxenv{displaycquote} with \sty{babel}'s language switches: + +\env{foreigndisplaycquote}{lang}[prenote][postnote]{key}[punct] + +This environment combines \ltxenv{displaycquote} with \ltxenv{otherlanguage*}. Apart from the language, the arguments are handled as with \ltxenv{displaycquote}. + +\env{hyphendisplaycquote}{lang}[prenote][postnote]{key}[punct] + +This environment combines \ltxenv{displaycquote} with \ltxenv{hyphenrules}. Apart from the language, the arguments are handled as with \ltxenv{displaycquote}. + +\end{ltxsyntax} + +\clearpage + +\section{Configuration} +\label{cfg} + +If available, this package will load the configuration file \path{csquotes.cfg}. You may use this file to define new quote styles and aliases or redefine existing ones. + +\begin{table} +\tablesetup +\begin{tabularx}{\columnwidth}{@{}P@{}X@{}} + \toprule + \multicolumn{1}{@{}H}{Quote style} & \multicolumn{1}{@{}H}{Style variants} \\ + \cmidrule(r){1-1}\cmidrule{2-2} + danish & quotes, guillemets \\ + dutch & -- \\ + english & american, british\\ + finnish & -- \\ + french & quotes, quotes\*, guillemets, guillemets\*\\ + german & quotes, guillemets, swiss \\ + italian & quotes, guillemets \\ + norwegian & guillemets, quotes \\ + spanish & spanish, mexican \\ + swedish & quotes, guillemets, guillemets\*\\ + \bottomrule +\end{tabularx} +\caption[Styles and variants]{Quote styles and style variants defined by default} +\label{cfg:sty:tab} +\end{table} + +\subsection{Defining quote styles} +\label{cfg:sty} + +The following command defines additional quote styles and variants or redefines existing ones: + +\begin{ltxsyntax} + +\cmd{DeclareQuoteStyle}[variant]{style}[outer init][inner init]\\ +{opening outer mark}[middle outer mark]{closing outer mark}[kern]\\ +{opening inner mark}[middle inner mark]{closing inner mark} + +This command may be used in the configuration file or in the document preamble. The term <outer> refers to the first quotation level, <inner> means quotations within another quotation. A <middle mark> is a quotation mark inserted at the beginning of every paragraph within a quotation spanning multiple paragraphs. In most cases, the arguments defining the quotation marks will simply contain one of the commands listed in table \ref{hnt:onc:tab}. If both an outer and an inner quotation begin or end simultaneously, the kerning specified by the value \ltxarg{kern} will be inserted between the adjoining quotation marks. While this value can be given in any unit known to \tex, it is advisable to use the relative, font"=dependent unit <em> instead of absolute units such as points, inches, or millimeters. Note that \ltxarg{kern} is used as a fallback value only. If the font provides kerning data for the respective pair of quotation marks the font's kerning takes precedence. + +\ltxarg{outer init} and \ltxarg{inner init} are all"=purpose hooks initializing the quote style. Selecting a quote style will make these hooks available to all quotation commands without expanding them. The execution of \ltxarg{outer init} will take place immediately before the opening outer quote is inserted, but inside the group formed by the quotation. \ltxarg{inner init} is executed before the opening inner quote is inserted. It is advisable to avoid any global assignments in this context to prevent interference with other styles. Whenever \ltxarg{inner init} is used \ltxarg{outer init} has to be given as well, even if the argument is empty. Refer to table \ref{cfg:sty:tab} for a list of all predefined quote styles and their variants. These are the backend styles only, see also table \ref{cfg:als:tab} for a list of language aliases. See section \ref{cfg:spl} for some examples as well as an illustration of how quote styles, aliases, and package options interact. + +\end{ltxsyntax} + +\subsection{Defining quote aliases} +\label{cfg:als} + +The following command defines quote aliases: + +\begin{ltxsyntax} + +\cmd{DeclareQuoteAlias}[variant]{style}{alias} +\cmd*{DeclareQuoteAlias}{first-level alias}{second-level alias} + +This command may be used in the configuration file or in the document preamble. The alias may point to a backend style or to another alias. Most language aliases refer to a backend style, but some point to an intermediate alias instead. If the alias is defined for the sake of the \sty{babel} package, its name must be identical to the language name used by \sty{babel}, i.e. the expansion of \ltxcmd{languagename}. See section \ref{cfg:spl} for an illustration of how quote styles, aliases, and package options interact. A list of all aliases defined by default is given in table \ref{cfg:als:tab}. + +\end{ltxsyntax} + +\begin{table} +\tablesetup +\begin{tabularx}{\columnwidth}{@{}Q@{}X@{}Q@{}X@{}} + \toprule + \multicolumn{1}{@{}H}{Alias} & \multicolumn{1}{@{}H}{Backend style or alias} & + \multicolumn{1}{@{}H}{Alias} & \multicolumn{1}{@{}H}{Backend style or alias} \\ + \cmidrule(r){1-1}\cmidrule(r){2-2}\cmidrule(r){3-3}\cmidrule{4-4} + american & english/american & + naustrian & austrian \\ + australian & english/british & + newzealand & english/british \\ + austrian & german/quotes & + ngerman & german \\ + british & english/british & + norsk & norwegian \\ + canadian & english/american & + norwegian & norwegian/guillemets \\ + danish & danish/quotes & + nynorsk & norwegian \\ + english & english/american & + spanish & spanish/spanish \\ + french & french/quotes & + swedish & swedish/quotes \\ + german & german/quotes & + swiss & german/swiss \\ + italian & italian/quotes & + UKenglish & british \\ + mexican & spanish/mexican & + USenglish & american \\ + \bottomrule +\end{tabularx} +\caption[Language aliases]{Language aliases defined by default} +\label{cfg:als:tab} +\end{table} + +\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: + +\begin{ltxsyntax} + +\cmd{DeclareQuoteOption}{style} + +When using the new option, the name of the quote style will serve as the key. The value may be any style variant defined for the respective style. The package option will select a variant by defining an alias pointing to the desired backend style. This command is available in the configuration file only. See section \ref{cfg:spl} for an illustration of how quote styles, aliases, and package options interact. + +\end{ltxsyntax} + +\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: + +\begin{ltxsyntax} + +\cmd{ExecuteQuoteOptions}{key=value,\,\dots} + +This command permits presetting package options in the configuration file. It may also be used in the document preamble. + +\end{ltxsyntax} + +\subsection{Adding a new quote style} +\label{cfg: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 \ltxopt{style} or the command \ltxcmd{setquotestyle}: + +\begin{ltxcode} +\DeclareQuoteStyle{house} + {\textquotedblleft}{\textquotedblright} + {\textquoteleft}{\textquoteright} +\end{ltxcode} +% +Now suppose that we wanted to add a quote style for an imaginary language called Newspeak and that there were two quote styles commonly used in Newspeak, an official one and an unofficial one. In this case, we need two backend styles implemented as variants of the \ltxopt{newspeak} style, \ltxopt{newspeak/official} and \ltxopt{newspeak/unofficial}: + +\begin{ltxcode} +\DeclareQuoteStyle[official]{newspeak} + {\textquotedblleft}{\textquotedblright} + {\textquoteleft}{\textquoteright} +\DeclareQuoteStyle[unofficial]{newspeak} + {\textquotedblright}{\textquotedblleft} + {\textquoteright}{\textquoteleft} +\end{ltxcode} +% +The official variant should be the default for this style. There is no need to copy the definition of the \ltxopt{official} variant to accomplish that. We simply define an alias labeled \ltxopt{newspeak} which points to the desired variant: + +\begin{ltxcode} +\DeclareQuoteAlias[official]{newspeak}{newspeak} +\end{ltxcode} +% +The reason why we are using variants and aliases instead of two independent styles will become clear in a moment. Suppose that the \sty{babel} package offered support for Newspeak, but this language was known to \sty{babel} as \ltxopt{otherspeak}: + +\begin{ltxcode} +\DeclareQuoteAlias{newspeak}{otherspeak} +\end{ltxcode} +% +This is an example of a second"=level alias pointing to a first"=level alias. If the current language is \ltxopt{otherspeak}, the above aliases will be expanded as follows: + +\begin{lstlisting}[style=plain]{} +otherspeak #\pisymbol{symbol}{108}# newspeak #\pisymbol{symbol}{108}# newspeak/official +\end{lstlisting} +% +We also define a new package option to choose a style variant: + +\begin{ltxcode} +\DeclareQuoteOption{newspeak} +\end{ltxcode} +% +This will add a new package option with a key called \ltxopt{newspeak}. The value of this option may be any variant of the \ltxopt{newspeak} style defined in the configuration file. In this example, there are two possible values: \ltxopt{official} and \ltxopt{unofficial}. To select the default or the alternative style for the entire document we use: + +\begin{ltxcode} +\usepackage[style=newspeak]{csquotes} +\usepackage[style=newspeak,newspeak=unofficial]{csquotes} +\end{ltxcode} +% +To select the default or the alternative style with multilingual support we use: + +\begin{ltxcode} +\usepackage[babel]{csquotes} +\usepackage[babel,newspeak=unofficial]{csquotes} +\end{ltxcode} +% +The base style must be implemented as an alias in this case since the \ltxopt{newspeak} option will select a variant by redefining and thus overwriting the \ltxopt{newspeak} alias. Since the \ltxopt{otherspeak} alias points to \ltxopt{newspeak} and not directly to any backend style, using the \ltxopt{newspeak} option will also have the desired effect if multilingual support is enabled. + +Note that there are two style names which have a special meaning: \ltxopt{default} and \ltxopt{fallback}. The former is an alias pointing to the default quote style used if the multilingual interface is not enabled. The package option \ltxopt{style} and the command \ltxcmd{setquotestyle} will redefine this alias. The latter is a backend style used as a fallback whenever the multilingual interface is enabled but there is no quote style for the current language. It will print bold question marks by default. + +\subsection{Defining quotes for \pdf strings} +\label{cfg:pdf} + +The following command specifies the quotation marks for \pdf strings: + +\begin{ltxsyntax} + +\cmd{DeclarePlainStyle}{opening outer mark}{closing outer mark}\\ +{opening inner mark}{closing inner mark} + +This command may be used in the configuration file or in the document preamble. By default, outer quotations get straight double quotes and inner quotations straight single quotes. See section \ref{hnt:pdf} for additional hints concerning \pdf strings. + +\end{ltxsyntax} + +\subsection{Configuring quotations and citations} +\label{cfg:blk} + +The following commands change the default values used by various quotation facilities of this package: + +\begin{ltxsyntax} + +\cmd{SetBlockThreshold}{integer} +\cmd{SetBlockEnvironment}{environment} +\cmd{SetCiteCommand}{command} + +\ltxcmd{SetBlockThreshold} changes the number of lines the block quotation facilities use as a threshold when deciding whether a quotation should be set inline or as a block quotation. The default is three lines. \ltxcmd{SetBlockEnvironment} specifies the environment used for block and display quotations. It takes the name of an existing environment as its argument. The default is the \ltxenv{quote} environment provided by most document classes. The argument to \ltxcmd{SetCiteCommand} specifies a replacement for \ltxcmd{cite} which will be used by all integrated quotation facilities to handle citations. It must be a single command which takes one or two optional arguments followed by a mandatory one, the citation key. The default is \ltxcmd{cite}. The commands affected by these parameters are indicated in table \ref{cfg:blk:tab}. + +\end{ltxsyntax} + +\begin{table} +\tablesetup +\def\+{\pisymbol{symbol}{117}}% +\def\_{\textendash}% +\begin{tabularx}{\columnwidth}{@{}X@{}*{21}{@{}c}@{}} + \toprule + \multicolumn{1}{@{}H}{Parameter} & \multicolumn{21}{@{}H}{Command or environment} \\ + \cmidrule{2-22} + & \vcmd{enquote} + & \vcmd{foreignquote} + & \vcmd{hyphenquote} + & \vcmd{textquote} + & \vcmd{foreigntextquote} + & \vcmd{hyphentextquote} + & \vcmd{textcquote} + & \vcmd{foreigntextcquote} + & \vcmd{hyphentextcquote} + & \vcmd{blockquote} + & \vcmd{foreignblockquote} + & \vcmd{hyphenblockquote} + & \vcmd{blockcquote} + & \vcmd{foreignblockcquote} + & \vcmd{hyphenblockcquote} + & \venv{displayquote} + & \venv{foreigndisplayquote} + & \venv{hyphendisplayquote} + & \venv{displaycquote} + & \venv{foreigndisplaycquote} + & \venv{hyphendisplaycquote} \\ + \cmidrule(r){1-1}\cmidrule{2-22} + Threshold &\_&\_&\_&\_&\_&\_&\_&\_&\_&\+&\+&\+&\+&\+&\+&\_&\_&\_&\_&\_&\_\\ + Environment &\_&\_&\_&\_&\_&\_&\_&\_&\_&\+&\+&\+&\+&\+&\+&\+&\+&\+&\+&\+&\+\\ + Cite command &\_&\_&\_&\_&\_&\_&\+&\+&\+&\_&\_&\_&\+&\+&\+&\_&\_&\_&\+&\+&\+\\ + \bottomrule +\end{tabularx} +\caption[Configurable parameters]{Scope of configurable parameters} +\label{cfg:blk:tab} +\end{table} + +\subsection{Hooks for quotations and citations} +\label{cfg:aux} + +Apart from the environment specified with \ltxcmd{SetBlockEnvironment}, which envelops both the quoted text and the citation, the quoted text (excluding the citation) of all long quotations is enclosed in an environment called \ltxenv{quoteblock}. This environment does nothing by default but it may be redefined to format the quoted text. In a similar manner, the text block (excluding the quotation marks) of inline quotations is enclosed in an environment called \ltxenv{quotetext}. Like \ltxenv{quoteblock}, this environment does nothing by default but it may be redefined if additional hooks are required to format the quoted text. + +Other aspects of the behavior of the quotation facilities may also be customized at a lower level. All facilities which take a \ltxarg{cite} argument will not insert it directly. They pass it to an auxiliary command called \ltxcmd{mkcitation} which may be redefined to format the citation. When doing so, keep in mind that it must take exactly one mandatory argument. \ltxcmd{mkcitation} will only be executed if there is a citation. The default behavior is to separate the citation from the preceding text by an interword space and enclose it in parentheses. + +The integrated quotation facilities have slightly different requirements since the \ltxcmd{cite} command may enclose the citation in parentheses or brackets. Therefore, they use \ltxcmd{mkccitation} instead of \ltxcmd{mkcitation}. The default behavior of this command is to separate the citation from the preceding text by an interword space. The default settings are equivalent to the following definitions: + +\begin{table} +\tablesetup +\def\+{\pisymbol{symbol}{117}}% +\def\_{\textendash}% +\begin{tabularx}{\columnwidth}{@{}X@{}*{21}{@{}c}@{}} + \toprule + \multicolumn{1}{@{}H}{Hook} & \multicolumn{21}{@{}H}{Command or environment} \\ + \cmidrule{2-22} + & \vcmd{enquote} + & \vcmd{foreignquote} + & \vcmd{hyphenquote} + & \vcmd{textquote} + & \vcmd{foreigntextquote} + & \vcmd{hyphentextquote} + & \vcmd{textcquote} + & \vcmd{foreigntextcquote} + & \vcmd{hyphentextcquote} + & \vcmd{blockquote} + & \vcmd{foreignblockquote} + & \vcmd{hyphenblockquote} + & \vcmd{blockcquote} + & \vcmd{foreignblockcquote} + & \vcmd{hyphenblockcquote} + & \venv{displayquote} + & \venv{foreigndisplayquote} + & \venv{hyphendisplayquote} + & \venv{displaycquote} + & \venv{foreigndisplaycquote} + & \venv{hyphendisplaycquote} \\ + \cmidrule(r){1-1}\cmidrule{2-22} + \ltxcmd{mkcitation} &\_&\_&\_&\+&\+&\+&\_&\_&\_&\+&\+&\+&\_&\_&\_&\+&\+&\+&\_&\_&\_\\ + \ltxcmd{mkccitation} &\_&\_&\_&\_&\_&\_&\+&\+&\+&\_&\_&\_&\+&\+&\+&\_&\_&\_&\+&\+&\+\\ + \ltxcmd{mkpretextpunct} &\_&\_&\_&\+&\+&\+&\+&\+&\+&\_&\_&\_&\_&\_&\_&\_&\_&\_&\_&\_&\_\\ + \ltxcmd{mkmidtextpunct} &\_&\_&\_&\+&\+&\+&\+&\+&\+&\_&\_&\_&\_&\_&\_&\_&\_&\_&\_&\_&\_\\ + \ltxcmd{mkfintextpunct} &\_&\_&\_&\+&\+&\+&\+&\+&\+&\_&\_&\_&\_&\_&\_&\_&\_&\_&\_&\_&\_\\ + \ltxcmd{mkpreblockpunct} &\_&\_&\_&\_&\_&\_&\_&\_&\_&\+&\+&\+&\+&\+&\+&\_&\_&\_&\_&\_&\_\\ + \ltxcmd{mkmidblockpunct} &\_&\_&\_&\_&\_&\_&\_&\_&\_&\+&\+&\+&\+&\+&\+&\_&\_&\_&\_&\_&\_\\ + \ltxcmd{mkfinblockpunct} &\_&\_&\_&\_&\_&\_&\_&\_&\_&\+&\+&\+&\+&\+&\+&\_&\_&\_&\_&\_&\_\\ + \ltxcmd{mkpredisppunct} &\_&\_&\_&\_&\_&\_&\_&\_&\_&\_&\_&\_&\_&\_&\_&\+&\+&\+&\+&\+&\+\\ + \ltxcmd{mkmiddisppunct} &\_&\_&\_&\_&\_&\_&\_&\_&\_&\_&\_&\_&\_&\_&\_&\+&\+&\+&\+&\+&\+\\ + \ltxcmd{mkfindisppunct} &\_&\_&\_&\_&\_&\_&\_&\_&\_&\_&\_&\_&\_&\_&\_&\+&\+&\+&\+&\+&\+\\ + \ltxenv{quotetext} &\_&\_&\_&\+&\+&\+&\+&\+&\+&\+&\+&\+&\+&\+&\+&\_&\_&\_&\_&\_&\_\\ + \ltxenv{quoteblock} &\_&\_&\_&\_&\_&\_&\_&\_&\_&\+&\+&\+&\+&\+&\+&\+&\+&\+&\+&\+&\+\\ + \bottomrule +\end{tabularx} +\caption[Auxiliary hooks]{Availability of auxiliary hooks} +\label{cfg:aux:tab} +\end{table} + +\begin{ltxcode}[showspaces=true] +\newcommand*{<<\mkcitation>>}[1]{ (#1)} +\newcommand*{<<\mkccitation>>}[1]{ #1} +\end{ltxcode} +% +As the block quotation facilities switch between inline and display quotations, changes to the terminal punctuation may be required. The punctuation is controlled by three hooks: \ltxcmd{mkpreblockpunct} is executed before the closing quotation mark. \ltxcmd{mkmidblockpunct} is executed after the closing quotation mark, between the quotation and the citation. \ltxcmd{mkfinblockpunct} is executed after the citation. These hooks serve two purposes. They control the placement of the \ltxarg{punct} argument and they may also be used to insert additional punctuation. Like the \ltxarg{cite} argument, \ltxarg{punct} is not inserted directly. It is passed to all three hooks. When redefining these commands, keep in mind that all of them must take one mandatory argument, but only one of them should insert it. By default, the punctuation is inserted after the citation. This is equivalent to the following definitions: + +\begin{ltxcode} +\newcommand*{<<\mkpreblockpunct>>}[1]{} +\newcommand*{<<\mkmidblockpunct>>}[1]{} +\newcommand*{<<\mkfinblockpunct>>}[1]{#1} +\end{ltxcode} +% +The text quotation facilities also take a \ltxarg{punct} argument whose placement is controlled by \ltxcmd{mkpretextpunct}, \ltxcmd{mkmidtextpunct}, and \ltxcmd{mkfintextpunct}. These commands work like their counterparts for block quotations. Their default behavior is equivalent to the following definitions: + +\begin{ltxcode} +\newcommand*{<<\mkpretextpunct>>}[1]{} +\newcommand*{<<\mkmidtextpunct>>}[1]{} +\newcommand*{<<\mkfintextpunct>>}[1]{#1} +\end{ltxcode} +% +The hooks \ltxcmd{mkpredisppunct}, \ltxcmd{mkmiddisppunct}, and \ltxcmd{mkfindisppunct} handle the placement of the punctuation argument passed to the display environments. The default behavior is equivalent to the following definitions: + +\begin{ltxcode} +\newcommand*{<<\mkpredisppunct>>}[1]{} +\newcommand*{<<\mkmiddisppunct>>}[1]{} +\newcommand*{<<\mkfindisppunct>>}[1]{#1} +\end{ltxcode} +% +The difference between \ltxcmd{mkpredisppunct} is \ltxcmd{mkmiddisppunct} is subtle because there are no closing quotation marks in display quotations. The two hooks differ in that \ltxcmd{mkpredisppunct} is executed before the \ltxenv{quoteblock} environment is closed whereas \ltxcmd{mkmiddisppunct} is executed after this environment. This also applies to \ltxcmd{mkpreblockpunct} and \ltxcmd{mkmidblockpunct} in display mode. Table \ref{cfg:aux:tab} gives an overview of the facilities affected by a redefinition of the above hooks. See the tutorial for usage examples. Also see section \ref{cfg:tst} for tests which may be useful when redefining the above hooks. + +\subsection{Additional tests in quotation hooks} +\label{cfg:tst} + +The commands in this section increase the flexibility of the hooks discussed in section \ref{cfg:aux}. For example, it may be desirable to adjust the format of a citation depending on the way the corresponding quotation is typeset. The following command will test whether the quotation is set inline or as a separate paragraph: + +\begin{ltxsyntax} + +\cmd{ifblockquote}{true}{false} + +This command expands to \ltxarg{true} with block and display quotations, and to \ltxarg{false} otherwise. It may also be useful to known if the quotation ends with a punctuation mark, especially in the definition of the \ltxcmd{mk...punct} hooks. The following tests provide information about the terminal punctuation: + +\cmd{ifquotepunct}{true}{false} +\cmd{ifquoteterm}{true}{false} + +The first command expands to \ltxarg{true} if the quotation ends with any punctuation mark, and to \ltxarg{false} otherwise. The second one will only expand to \ltxarg{true} if the quotation ends with a terminal punctuation mark (period, exclamation mark, or question mark). The following commands allow for more specific tests: + +\cmd{ifquotecolon}{true}{false} +\cmd{ifquotecomma}{true}{false} +\cmd{ifquoteexclam}{true}{false} +\cmd{ifquoteperiod}{true}{false} +\cmd{ifquotequestion}{true}{false} +\cmd{ifquotesemicolon}{true}{false} + +Note that all of the above tests are designed for use in the definition of the hooks from section \ref{cfg:aux}. They will not yield meaningful results when used anywhere else. There is also a stand-alone test which may be used anywhere: + +\cmd{ifstringblank}{string}{true}{false} + +This command expands to \ltxarg{true} if \ltxarg{string} is blank (empty or spaces), and to \ltxarg{false} otherwise. This is useful to test for an empty argument in the definition of the \ltxcmd{mk...punct} commands. Note that this test is redundant in the definition of the citation hooks because they are only executed if there is a citation. + +\end{ltxsyntax} + +\section{Hints and caveats} +\label{hnt} + +\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 \ltxopt{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 \acr{UTF-8} 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 \ltxopt{utf8} option. Do not use the \ltxopt{utf8x} option as this would implicitly load the \sty{ucs} package which is not supported by \sty{csquotes}. \acr{UTF-8} encoding will be detected automatically. All commands discussed in section \ref{act} work as usual with this encoding. See also section~\ref{hnt:mod}. + +\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 \acr{T1} or \acr{LY1} encoding 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 table \ref{hnt:onc:tab} for a list of common quotation marks included in both \acr{T1} and \acr{LY1} encoding. + +\begin{table} +\tablesetup +\begin{tabularx}{\columnwidth}{@{}X@{}p{60pt}X@{}p{60pt}@{}} + \toprule + \multicolumn{2}{@{}H}{Double quotation marks} & \multicolumn{2}{H}{Single quotation marks} \\ + \cmidrule(r){1-2}\cmidrule(l){3-4} + \multicolumn{1}{@{}H}{Command} & \multicolumn{1}{@{}H}{Example} & + \multicolumn{1}{H}{Command} & \multicolumn{1}{@{}H}{Example} \\ + \cmidrule(r){1-1}\cmidrule(r){2-2}\cmidrule(lr){3-3}\cmidrule{4-4} + \ltxcmd{textquotedblleft} & \mksample[60]{\textquotedblleft} & + \ltxcmd{textquoteleft} & \mksample[60]{\textquoteleft} \\ + \ltxcmd{textquotedblright} & \mksample[60]{\textquotedblright} & + \ltxcmd{textquoteright} & \mksample[60]{\textquoteright} \\ + \ltxcmd{quotedblbase} & \mksample[60]{\quotedblbase} & + \ltxcmd{quotesinglbase} & \mksample[60]{\quotesinglbase} \\ + \ltxcmd{guillemotleft} & \mksample[60]{\guillemotleft} & + \ltxcmd{guilsinglleft} & \mksample[60]{\guilsinglleft} \\ + \ltxcmd{guillemotright} & \mksample[60]{\guillemotright} & + \ltxcmd{guilsinglright} & \mksample[60]{\guilsinglright} \\ + \bottomrule +\end{tabularx} +\caption[Quotation marks]{Quotation marks included in \acr{T1} and \acr{LY1} encoding} +\label{hnt:onc:tab} +\end{table} + +\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 \acr{UTF-8} 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} +\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} +\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. + +In a verbatim context, the active quotes will normally be disabled. If a character is in the range 128--255, however, its original function is restored so that the \sty{inputenc} package may handle it in verbatim environments. This implies that \sty{inputenc} must be loaded before any active quotes are allocated. This feature is available with the standard verbatim environments as well as those provided by (or defined via) the packages \sty{verbatim}, \sty{fancyvrb}, \sty{moreverb}, and \sty{alltt}. This also applies to the \ltxcmd{verb} command and the \sty{shortvrb} package. The \sty{listings} package provides dedicated support for extended input encodings. When using this package, activate its <extended characters> option and specify the input encoding. As of this writing, the \sty{listings} package does not support \acr{UTF-8} encoding. + +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 \ltxcmd{input}, \ltxcmd{label}, or \ltxcmd{cite}. There are two packages which try to remedy this situation: the \sty{babel} package and the \sty{underscore} package (when loaded with the \ltxopt{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} +\label{hnt:pdf} + +This package interfaces with the \sty{hyperref} package as \pdf strings such as bookmarks are generated. See section \ref{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 sections \ref{bas:reg} and \ref{bas:bbl} as well as \ref{act:reg} and \ref{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 \ltxcmd{hypersetup} to specify the strings. The replacement mechanism will not function within the optional argument to \ltxcmd{usepackage}. For information about \pdf strings see the \sty{hyperref} documentation. + +\subsection{Footnotes within quotations} +\label{hnt:ftn} + +This package will automatically reset the nesting level within any footnote included in a quotation. If the \sty{babel} 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} +\label{hnt:bbl} + +The commands discussed in section \ref{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. 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 \ltxcmd{enquote}. Here is a simple ad~hoc solution suitable for documents with only one language: + +\begin{ltxexample}[upquote] +\documentclass{article} +\usepackage[german]{babel} +\usepackage[babel=once]{csquotes} +\defineshorthand{"`}{\openautoquote} +\defineshorthand{"'}{\closeautoquote} +\begin{document} +... +\end{document} +\end{ltxexample} +% +It is possible to move such definitions to \path{csquotes.cfg}. In this case, the code is slightly more complex because it needs to be more general: + +\begin{ltxcode}[upquote] +\AtEndPreamble{% + \@ifpackageloaded{babel} + {\iflanguage{german} + {\declare@shorthand{german}{"`}{\openautoquote}% + \declare@shorthand{german}{"'}{\closeautoquote}} + {}} + {}} +\end{ltxcode} +% +The above code redefines the shorthands only if the \sty{babel} package has been loaded and the main language of the document 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 section \ref{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 \ltxcmd{AtBeginDocument} to initialize the main document language, including the corresponding shorthands. We use \ltxcmd{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 \ltxcmd{AtEndPreamble} command is provided by the \sty{etoolbox} package. + +\subsection{Miscellaneous notes about the predefined styles} +\label{hnt:lng} + +All variants of the \ltxopt{french} style use spaced out guillemets as outer marks. The style variant \ltxopt{quotes} uses double quotes as inner marks. The starred variant \ltxopt{quotes*} is similar to its regular counterpart except that it will also space out the inner marks. The \ltxopt{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 \ltxopt{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} +\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} +\label{aut:ctl} + +The author commands in this section behave essentially like the corresponding user commands discussed in section \ref{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. + +\begin{ltxsyntax*} + +\cmd{@enablequotes} + +This command enables all characters allocated as active quotes. It also restores their definitions if they were disabled or accidentally overwritten. With single-byte encodings, this command (re)defines all allocated characters and makes them active. With \acr{UTF-8} encoding, it redefines the internal macro used by the \sty{inputenc} package to typeset the respective \acr{UTF-8} sequence (\ltxcmd{u8:}\ltxarg{character}). \acr{UTF-8} characters in the range 0--127 are handled as with single-byte encodings. + +\cmd{@disablequotes} + +This command restores the \emph{status quo ante} of all active quotes. With single-byte encodings, there are two possible cases. (1) If a character had already been active when it was allocated as active quote, its former definition is restored. (2) If a character had not been active when it was allocated, its former category code is restored. With \acr{UTF-8} encoding, this command restores the former definition of the internal macro used by the \sty{inputenc} package to typeset the respective \acr{UTF-8} sequence. \acr{UTF-8} characters in the range 0--127 are handled as with single-byte encodings. + +\cmd{@verbatimquotes} + +For verbatim environments and similar applications, use this command rather than \ltxcmd{@disablequotes}. It redefines the active quotes in a way that is better suited for verbatim typesetting. With single-byte encodings, it will do one of the following things. (1) If a character is in the range 0--127, it is redefined such that it expands to itself with category code 12. (2) If a character is in the range 128--255, there are two possibilities. (a) If it had already been active when it was allocated, its former definition is restored. (b) If it had not been active before, it is redefined such that it expands to itself with its former category code. + +Characters in the range 0--127 are added to the \ltxcmd{dospecials} list. Characters in the range 128--255 remain active, permitting the \sty{inputenc} package to typeset them verbatim (due to case 2a, which implies that you must load \sty{inputenc} before allocating active quotes). Case 2b is usually undesirable in verbatim environments. If \sty{inputenc} is loaded, however, this should not happen. With \acr{UTF-8} encoding, this command restores the former definition of the internal macro used by the \sty{inputenc} package to typeset the respective \acr{UTF-8} sequence. \acr{UTF-8} characters in the range 0--127 are handled as with single-byte encodings. + +Due to case 1, \ltxcmd{@verbatimquotes} itself is independent of any \ltxcmd{dospecials} processing. You may typeset all active quotes verbatim by using this command exclusively. The advantage of this approach is that it does not require any category code changes, hence this command may also be used to modify an argument after it has been read. Also note that the standard \latex verbatim environments as well as all environments provided by or defined via the packages \sty{verbatim}, \sty{fancyvrb}, \sty{moreverb}, and \sty{alltt} are catered for automatically. This also applies to the \ltxcmd{verb} command and the \sty{shortvrb} package. + +\cmd{@deletequotes} + +This command implicitly executes \ltxcmd{@disablequotes} and deallocates all active quotes, which results in a complete reset of all active quotes so that they may be newly defined. This command should be used with care because the reset is not visible to the user. Using \ltxcmd{DeleteQuotes} may be preferable. + +\end{ltxsyntax*} + +\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 or as a plain string. A typical example is a command like \ltxcmd{label} which expects a string of characters. Any active character may break \ltxcmd{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}. + +The \sty{babel} package defines the switch \ltxcmd{if@safe@actives} and patches several standard commands such that the switch is set to \ltxopt{true} while they process their arguments. The approach taken by the \sty{underscore} package is slightly different. If \sty{underscore} is loaded with the \ltxopt{strings} option, it patches several commands such that \ltxcmd{protect} is equivalent to \ltxcmd{string} while the arguments are processed. If any one of these packages is loaded, \sty{csquotes} will take advantage of that automatically. Unfortunately, both packages patch a different set of commands and neither one covers all possibly vulnerable commands. If \sty{babel} is loaded, for example, you may use active quotes in the argument of \ltxcmd{label}, but not in the argument of \ltxcmd{input}. If you load \sty{underscore} with its \ltxopt{strings} option, active quotes may also be used in the argument of \ltxcmd{input}. + +When writing a package which may have to process user"=supplied arguments in a strings-only context, there are two ways to deal with active quotes. Taking the approach of the \sty{babel} package, you may do the following: + +\begin{ltxcode} +\let\if@safe@actives\iftrue +\end{ltxcode} +% +This is best done in a group. If grouping is not feasible, you must ensure that the switch is properly restored. In contrast to using \ltxcmd{@safe@activestrue}, this approach works even if \sty{babel} is not loaded. However, note that you must take three states into account when restoring the switch in this case: true, false, and undefined. Taking the approach of the \sty{underscore} package, you may also do the following: + +\begin{ltxcode} +\let\@@protect\protect +\let\protect\string +\end{ltxcode} +% +This could either be done in a group or without any grouping, but followed by \ltxcmd{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. \acr{UTF-8} encoded active quotes expand to a string of characters with category code 12. This string will be valid \acr{UTF-8}. In a verbatim \ltxcmd{write} operation, you should employ one of the techniques discussed in this section rather than \ltxcmd{@verbatimquotes}, which is geared to verbatim typesetting. + +\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 \ltxcmd{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 \ltxcmd{g@addto@macro}), (2) increment counters globally in a way that circumvents \latex's counter commands, or (3) do not check \ltxcmd{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 \ltxcmd{BlockquoteDisable} to redefine or disable the affected command temporarily. + +\begin{ltxsyntax} + +\cmd{BlockquoteDisable}{code} + +The \ltxarg{code} may be arbitrary \latex code which redefines vulnerable commands locally such that they work differently during the trial pass. The \ltxarg{code} itself should obviously not include any global assignments. This solution should be considered as a last ressort but may be the quickest way to fix a vulnerable package. Note that there is no need to escape parameter characters by doubling them in the \ltxarg{code} argument. Simply use this command like \ltxcmd{AtBeginDocument} and similar hooks. + +\end{ltxsyntax} + +\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 sections \ref{bas:reg} and \ref{act:reg}. In contrast to the commands discussed in section \ref{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 section \ref{hnt:grp} for details. In other words, the facilities in this section are semantic markup elements, the ones in section \ref{aut:imk} are physical markup elements. + +\begin{ltxsyntax*} + +\cmd{openautoquote} Opens a nestable quotation. +\cmd{closeautoquote} Closes a nestable quotation. + +\end{ltxsyntax*} + +In terms of their function, the above commands correspond to the regular versions of \ltxcmd{enquote} and \ltxcmd{MakeAutoQuote}. The following commands correspond to the starred variants \ltxcmd{enquote*} and \ltxcmd{MakeAutoQuote*}: + +\begin{ltxsyntax*} + +\cmd{openinnerquote} Opens an inner quotation. +\cmd{closeinnerquote} Closes an inner quotation. + +\end{ltxsyntax*} + +The above commands may be used to implement an alternative user interface. 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 section \ref{hnt:bbl} and the \sty{babel} manual for details. + +\subsection{Internal quotation marks} +\label{aut:imk} + +The commands in this section print the quotation marks of the current style, as defined with \ltxcmd{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. + +\begin{ltxsyntax*} + +\cmd{textooquote} Prints the opening outer quotation mark of the currently active quote style. +\cmd{textcoquote} Prints the closing outer quotation mark. +\cmd{textmoquote} Prints the middle outer quotation mark. + +\cmd{textoiquote} Prints the opening inner quotation mark. +\cmd{textciquote} Prints the closing inner quotation mark. +\cmd{textmiquote} Prints the middle inner quotation mark. + +\end{ltxsyntax*} + +Note that the initialization hooks for the respective quotation style are not executed automatically. They may be accessed separately: + +\begin{ltxsyntax*} + +\cmd{initoquote} Executes the outer initialization hook. +\cmd{initiquote} Executes the inner initialization hook. + +\end{ltxsyntax*} + +The scope of these hooks should always be confined to a group. + +\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. The numbers on the right indicate the relevant section of this manual. + +\begin{changelog} + +\begin{release}{4.1}{2008-04-11} +\item Fixed timing issue with active quotes introduced in 4.0 +\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 Added package option \ltxopt{spanish}\see{opt} +\item Added variant \ltxopt{mexican} to style \ltxopt{spanish}\see{opt} +\item Removed variant \ltxopt{oldstyle} from \ltxopt{english} style\see{opt} +\item Removed variant \ltxopt{oldstyle} from \ltxopt{french} style\see{opt} +\item Removed variant \ltxopt{imprimerie} from \ltxopt{french} style\see{opt} +\item Expanded documentation\see{hnt:bbl} +\item Added \ltxcmd{openautoquote} and \ltxcmd{closeautoquote}\see{aut:amk} +\item Added \ltxcmd{openinnerquote} and \ltxcmd{closeinnerquote}\see{aut:amk} +\item Moved predefined styles, variants, options to \path{csquotes.def} +\item Added more hints and examples to \path{csquotes.cfg} +\item Added extended \pdf bookmarks to this manual +\end{release} + +\begin{release}{3.8}{2008-01-05} +\item Added variant \ltxopt{guillemets*} to style \ltxopt{swedish}\see{opt} +\item Added language alias \ltxopt{australian}\see{cfg:als} +\item Added language alias \ltxopt{newzealand}\see{cfg:als} +\item Internal improvements +\end{release} + +\begin{release}{3.7}{2007-03-25} +\item Added package option \ltxkv{babel}{try}\see{opt:bbl} +\item Added package option \ltxkv{babel}{tryonce}\see{opt:bbl} +\item Added \ltxcmd{MakeAutoQuote*}\see{act:reg} +\item Added \ltxcmd{MakeForeignQuote*}\see{act:bbl} +\item Added \ltxcmd{MakeHyphenQuote*}\see{act:bbl} +\item Added \ltxcmd{mkpretextpunct}\see{cfg:aux} +\item Added \ltxcmd{mkpreblockpunct}\see{cfg:aux} +\item Added \ltxcmd{mkpredisppunct}\see{cfg:aux} +\item Dropped compatibility code for \ltxcmd{blockcite} legacy command +\item Internal updates for \path{biblatex} package +\end{release} + +\begin{release}{3.6}{2006-11-09} +\item Added \ltxcmd{BlockquoteDisable}\see{aut:blk} +\item Fix for \sty{amsmath} package (active quotes in \ltxenv{split} and other environments) +\item Fix for \sty{endnotes} package (endnotes in block quotations) +\item Revised Spanish quote style +\end{release} + +\begin{release}{3.5}{2006-08-24} +\item Exchanged definitions of French \ltxopt{quotes} and \ltxopt{quotes*} variants\see{hnt:lng} +\item Internal updates for \path{inputenc} 1.1\,b (2006-05-05) +\end{release} + +\begin{release}{3.4}{2006-04-02} +\item Stricter validation of user"=defined active characters\see{hnt:val} +\item Author interface now documented in this manual\see{aut} +\item Added documentation of \ltxcmd{@enablequotes}\see{aut:ctl} +\item Added documentation of \ltxcmd{@disablequotes}\see{aut:ctl} +\item Added documentation of \ltxcmd{@verbatimquotes}\see{aut:ctl} +\item Added documentation of \ltxcmd{@deletequotes}\see{aut:ctl} +\item Added documentation concerning string handling \see{aut:str} +\item Added documentation of interface to internal marks\see{aut:imk} +\end{release} + +\begin{release}{3.3}{2006-02-27} +\item Added support for \acr{UTF-8} encoded active quotes\see{hnt:inc} +\item Modified active quotes, category codes 7, 8 no longer valid\see{hnt:val} +\item Modified delimiters, category codes 3, 4, 7, 8 no longer valid\see{hnt:val} +\item Active quotes may now be defined in the document body\see{act:ctl} +\item Renamed \ltxcmd{RestoreQuotes} to \ltxcmd{EnableQuotes}\see{act:ctl} +\item Added \ltxcmd{DeleteQuotes}\see{act:ctl} +\item Added \ltxcmd{VerbatimQuotes}\see{act:ctl} +\item Added \ltxcmd{ExecuteQuoteOptions}\see{cfg:exe} +\item Added package option \ltxkv{babel}{once}\see{opt:bbl} +\item Added new style variant for French\see{hnt:lng} +\item Improved nesting control of active block quotes +\item Made active block quotes robust +\end{release} + +\begin{release}{3.2}{2005-12-05} +\item Added quote style for Spanish +\item Fixed bug in \sty{hyperref} interface +\end{release} + +\begin{release}{3.1}{2005-08-29} +\item Added \ltxcmd{textquote}\see{bas:txt:reg} +\item Added \ltxcmd{foreigntextquote}\see{bas:txt:bbl} +\item Added \ltxcmd{hyphentextquote}\see{bas:txt:bbl} +\item Renamed \ltxcmd{cquote} to \ltxcmd{textcquote}\see{cit:txt:reg} +\item Renamed \ltxcmd{foreigncquote} to \ltxcmd{foreigntextcquote}\see{cit:txt:bbl} +\item Renamed \ltxcmd{hyphencquote} to \ltxcmd{hyphentextcquote}\see{cit:txt:bbl} +\item Extended \ltxcmd{textcquote}\see{cit:txt:reg} +\item Extended \ltxcmd{foreigntextcquote}\see{cit:txt:bbl} +\item Extended \ltxcmd{hyphentextcquote}\see{cit:txt:bbl} +\item Modified environment \ltxenv{displayquote}\see{env:bas} +\item Modified environment \ltxenv{foreigndisplayquote}\see{env:bas} +\item Modified environment \ltxenv{hyphendisplayquote}\see{env:bas} +\item Extended environment \ltxenv{displaycquote}\see{env:int} +\item Extended environment \ltxenv{foreigndisplaycquote}\see{env:int} +\item Extended environment \ltxenv{hyphendisplaycquote}\see{env:int} +\item Added \ltxcmd{mkmidtextpunct}\see{cfg:aux} +\item Added \ltxcmd{mkfintextpunct}\see{cfg:aux} +\item Added \ltxcmd{mkmiddisppunct}\see{cfg:aux} +\item Added \ltxcmd{mkfindisppunct}\see{cfg:aux} +\item Added auxiliary environment \ltxenv{quotetext}\see{cfg:aux} +\item Added detection of paragraphs to all block quotation facilities\see{bas:blk:reg} +\item \ltxcmd{ifquote...} now usable in \ltxcmd{mkcitation} and \ltxcmd{mkccitation}\see{cfg:tst} +\item Terminal punctuation now evaluated by all quotation facilities +\item Prevent undesirable ?{}` and !{}` ligatures in \acr{T1} encoding +\item Always adjust space factor codes of backend quotes +\end{release} + +\begin{release}{3.0}{2005-07-14} +\item Extended \ltxcmd{blockquote}\see{bas:blk:reg} +\item Extended \ltxcmd{foreignblockquote}\see{bas:blk:bbl} +\item Extended \ltxcmd{hyphenblockquote}\see{bas:blk:bbl} +\item Extended \ltxcmd{setquotestyle}\see{bas:set} +\item Added \ltxcmd{cquote}\see{cit:txt:reg} +\item Added \ltxcmd{foreigncquote}\see{cit:txt:bbl} +\item Added \ltxcmd{hyphencquote}\see{cit:txt:bbl} +\item Added \ltxcmd{blockcquote}\see{cit:blk:reg} +\item Added \ltxcmd{foreignblockcquote}\see{cit:blk:bbl} +\item Added \ltxcmd{hyphenblockcquote}\see{cit:blk:bbl} +\item Added environment \ltxenv{displayquote}\see{env:bas} +\item Added environment \ltxenv{foreigndisplayquote}\see{env:bas} +\item Added environment \ltxenv{hyphendisplayquote}\see{env:bas} +\item Added environment \ltxenv{displaycquote}\see{env:int} +\item Added environment \ltxenv{foreigndisplaycquote}\see{env:int} +\item Added environment \ltxenv{hyphendisplaycquote}\see{env:int} +\item Modified \ltxcmd{DeclarePlainStyle}\see{cfg:pdf} +\item Added \ltxcmd{SetCiteCommand}\see{cfg:blk} +\item Renamed \ltxcmd{blockcite} to \ltxcmd{mkcitation}\see{cfg:aux} +\item Added \ltxcmd{mkccitation}\see{cfg:aux} +\item Added \ltxcmd{mkmidblockpunct}\see{cfg:aux} +\item Added \ltxcmd{mkfinblockpunct}\see{cfg:aux} +\item Added \ltxcmd{ifquotepunct}\see{cfg:tst} +\item Added \ltxcmd{ifquoteterm}\see{cfg:tst} +\item Added \ltxcmd{ifquoteperiod}\see{cfg:tst} +\item Added \ltxcmd{ifquotecomma}\see{cfg:tst} +\item Added \ltxcmd{ifquotesemicolon}\see{cfg:tst} +\item Added \ltxcmd{ifquotecolon}\see{cfg:tst} +\item Added \ltxcmd{ifquoteexclam}\see{cfg:tst} +\item Added \ltxcmd{ifquotequestion}\see{cfg:tst} +\item Added \ltxcmd{ifstringblank}\see{cfg:tst} +\item Added evaluation of terminal punctuation within block quotations +\item With \ltxcmd{nonfrenchspacing}, adjust space factor codes of backend quotes +\item Improved nesting control when running under \etex +\end{release} + +\begin{release}{2.8}{2005-05-11} +\item Added \ltxcmd{DisableQuotes}\see{act:ctl} +\item Fixed bug causing kerning restoration to fail in some rare cases +\end{release} + +\begin{release}{2.7}{2005-04-13} +\item Use the font's kerning pairs for adjoining quotes, if available\see{cfg:sty} +\item Renamed \ltxcmd{setblockthreshold} to \ltxcmd{SetBlockThreshold}\see{cfg:blk} +\item Renamed \ltxcmd{setblockenvironment} to \ltxcmd{SetBlockEnvironment}\see{cfg:blk} +\item Provided more useful default definition of \ltxcmd{blockcite}\see{cfg:aux} +\item Improved handling of adjoining quotes with respect to line breaking +\item When restoring active quotes, restore catcodes of delimiters as well +\item Improved workaround for \ltxcmd{uppercase} and some \sty{babel} languages +\item Issue error message on quote mismatch regardless of \ltxopt{strict} option +\item Issue \sty{hyperref} warning with block quotation commands in \pdf strings +\item Fixed bug in \ltxcmd{DeclareQuoteStyle} and \ltxcmd{DeclareQuoteAlias} +\end{release} + +\begin{release}{2.6}{2005-02-24} +\item Always reset quote style, even for inner quotations +\item Fixed bug preventing hyphenation in certain places +\end{release} + +\begin{release}{2.5}{2004-12-04} +\item Added \ltxcmd{MakeBlockQuote}\see{act:blk:reg} +\item Added \ltxcmd{MakeForeignBlockQuote}\see{act:blk:bbl} +\item Added \ltxcmd{MakeHyphenBlockQuote}\see{act:blk:bbl} +\item Added \ltxcmd{ifblockquote}\see{cfg:tst} +\item Modified \ltxcmd{blockquote}\see{bas:blk:reg} +\item Modified \ltxcmd{foreignblockquote}\see{bas:blk:bbl} +\item Modified \ltxcmd{hyphenblockquote}\see{bas:blk:bbl} +\item Changed default threshold for block quotations\see{cfg:blk} +\item Improved math mode compatibility\see{hnt:mod} +\item Improved verbatim compatibility\see{hnt:mod} +\item Improved backend and active character handling +\item Improved validation of user"=defined active characters +\item Fixed bug suppressing kerning after block quotations +\item Issue error message with nested block quotations +\end{release} + +\begin{release}{2.4}{2004-11-01} +\item Prevent use of \ltxcmd{RestoreQuotes} in preamble\see{act:ctl} +\item Fixed bug causing premature expansion of backend quote macros +\item Fixed bug suppressing kerning before closing quotes +\end{release} + +\begin{release}{2.3}{2004-09-18} +\item Reduced default kerning between adjoining curved quotes +\item Fixed bug with \ltxcmd{DeclareQuoteStyle} in preamble +\end{release} + +\begin{release}{2.2}{2004-07-13} +\item Extended \ltxcmd{DeclareQuoteStyle}\see{cfg:sty} +\item Added initialization hook for inner quotations\see{cfg:sty} +\item Added support for middle inner quotes\see{cfg:sty} +\item Rearranged French quote styles, removing two variants\see{hnt:lng} +\item Added new style variant for French\see{hnt:lng} +\item Fixed bug causing stacking of reset hook for footnotes +\item Fixed bug preventing hyphenation in certain places +\item Fixed kerning issue specific to \textsc{ec} fonts +\end{release} + +\begin{release}{2.1}{2004-06-15} +\item Added auxiliary environment \ltxenv{quoteblock}\see{cfg:aux} +\item Added support for language reset in footnotes\see{hnt:ftn} +\item Disable active characters in \ltxcmd{verb} and \ltxenv{verbatim}\see{hnt:mod} +\item Disable active characters in \ltxcmd{index} and \ltxcmd{glossary}\see{hnt:mod} +\item Added package option and style variants for Norwegian +\item Removed some uncertain quote styles and aliases +\item Rearranged quote styles and aliases +\end{release} + +\begin{release}{2.0}{2004-06-04} +\item Added \ltxcmd{blockquote}\see{bas:blk:reg} +\item Added \ltxcmd{foreignblockquote}\see{bas:blk:bbl} +\item Added \ltxcmd{hyphenblockquote}\see{bas:blk:bbl} +\item Added \ltxcmd{setblockthreshold}\see{cfg:blk} +\item Added \ltxcmd{setblockenvironment}\see{cfg:blk} +\item Added auxiliary command \ltxcmd{blockcite}\see{cfg:aux} +\item Extended \ltxcmd{DeclareQuoteStyle}\see{cfg:sty} +\item Added initialization hook for outer quotations\see{cfg:sty} +\item Added support for middle outer quotes\see{cfg:sty} +\item Added support for kerning between adjoining quotes\see{cfg:sty} +\item Disable active characters in math and display math mode\see{hnt:mod} +\item Revised and improved error recovery\see{opt:sct} +\item Added package option \ltxopt{strict}\see{opt:sct} +\item Added package option and new style variants for French +\item Added package option and new style variant for Italian +\item Added new style variant for English +\end{release} + +\begin{release}{1.7}{2004-05-14} +\item Added \ltxcmd{setquotestyle}\see{bas:set} +\item Modified \ltxcmd{DeclarePlainStyle}\see{cfg:pdf} +\item Improved quote handling in \pdf strings\see{hnt:pdf} +\item Amended default French quote style\see{hnt:lng} +\end{release} + +\begin{release}{1.5}{2004-02-27} +\item Reset quote nesting level in footnotes within quotations\see{hnt:ftn} +\end{release} + +\begin{release}{1.4}{2003-12-13} +\item Added \ltxcmd{MakeForeignQuote}\see{act:bbl} +\item Added \ltxcmd{MakeHyphenQuote}\see{act:bbl} +\item Added \ltxcmd{RestoreQuotes}\see{act:ctl} +\item Improved \sty{hyperref} interface\see{hnt:pdf} +\end{release} + +\begin{release}{1.0}{2003-09-14} +\item Initial public release +\end{release} + +\end{changelog} + +\end{document} |