From e0c6872cf40896c7be36b11dcc744620f10adf1d Mon Sep 17 00:00:00 2001 From: Norbert Preining Date: Mon, 2 Sep 2019 13:46:59 +0900 Subject: Initial commit --- macros/latex/contrib/xellipsis/CHANGES | 17 + macros/latex/contrib/xellipsis/README | 32 ++ macros/latex/contrib/xellipsis/lppl.txt | 416 +++++++++++++++++++ macros/latex/contrib/xellipsis/xellipsis.dtx | 592 +++++++++++++++++++++++++++ macros/latex/contrib/xellipsis/xellipsis.ins | 65 +++ macros/latex/contrib/xellipsis/xellipsis.pdf | Bin 0 -> 340946 bytes 6 files changed, 1122 insertions(+) create mode 100644 macros/latex/contrib/xellipsis/CHANGES create mode 100644 macros/latex/contrib/xellipsis/README create mode 100644 macros/latex/contrib/xellipsis/lppl.txt create mode 100644 macros/latex/contrib/xellipsis/xellipsis.dtx create mode 100644 macros/latex/contrib/xellipsis/xellipsis.ins create mode 100644 macros/latex/contrib/xellipsis/xellipsis.pdf (limited to 'macros/latex/contrib/xellipsis') diff --git a/macros/latex/contrib/xellipsis/CHANGES b/macros/latex/contrib/xellipsis/CHANGES new file mode 100644 index 0000000000..6e3df90832 --- /dev/null +++ b/macros/latex/contrib/xellipsis/CHANGES @@ -0,0 +1,17 @@ +13 Apr 1202 (15 Apr 2018): Made all of the configuration +options configurable either by command or by package option. +Version 2.0. + +18 December 1200 (20 December 2016): Ellipses were able to +start lines, which shouldn't happen; fixed that. Added +command \xelipend, which eliminates closing spaces for the +situation in which the ellipsis is immediately followed by +punctuation. Version 1.2. + +12 November 1200 (14 November 2016): Fixed a bug in how +\xelip behaved at the beginning of an environment. +Specifically, it was set before paragraph mode began. A +zero-space \hskip puts TeX in paragraph mode now, so \xelip +is placed properly. Version 1.1. + +10 October 11EE (12 October 2015): Initial release. diff --git a/macros/latex/contrib/xellipsis/README b/macros/latex/contrib/xellipsis/README new file mode 100644 index 0000000000..b3256d6d29 --- /dev/null +++ b/macros/latex/contrib/xellipsis/README @@ -0,0 +1,32 @@ ++AMDG + +This document is copyright 2015 by Donald P. Goodman, and is +released publicly under the LaTeX Project Public License. The +distribution and modification of this work is constrained by the +conditions of that license. See + http://www.latex-project.org/lppl.txt +for the text of the license. This document is released +under version 1.3 of that license, and this work may be distributed +or modified under the terms of that license or, at your option, any +later version. + +This work has the LPPL maintenance status 'maintained'. + +The Current Maintainer of this work is Donald P. Goodman +(dgoodmaniii@gmail.com). + +This work consists of the files xellipsis.ins and +xellipsis.dtx, along with derived files xellipsis.sty and +xellipsis.pdf. + +The xellipsis package provides a system for configuring +(almomst) every possible aspect of ellipses, including +preceding and proceeding characters; the character itself; +distances before and after each of these; and number of +characters. It comes with both a compatibility option for +standard LaTeX \ldots as well as preset package options for +the Chicago Manual of Style (Turabian); the Bluebook; and +MLA guidelines. + +This package should run properly on any properly running LaTeX +system. diff --git a/macros/latex/contrib/xellipsis/lppl.txt b/macros/latex/contrib/xellipsis/lppl.txt new file mode 100644 index 0000000000..2244313901 --- /dev/null +++ b/macros/latex/contrib/xellipsis/lppl.txt @@ -0,0 +1,416 @@ +The LaTeX Project Public License +=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=- + +LPPL Version 1.3c 2008-05-04 + +Copyright 1999 2002-2008 LaTeX3 Project + Everyone is allowed to distribute verbatim copies of this + license document, but modification of it is not allowed. + + +PREAMBLE +======== + +The LaTeX Project Public License (LPPL) is the primary license under +which the LaTeX kernel and the base LaTeX packages are distributed. + +You may use this license for any work of which you hold the copyright +and which you wish to distribute. This license may be particularly +suitable if your work is TeX-related (such as a LaTeX package), but +it is written in such a way that you can use it even if your work is +unrelated to TeX. + +The section `WHETHER AND HOW TO DISTRIBUTE WORKS UNDER THIS LICENSE', +below, gives instructions, examples, and recommendations for authors +who are considering distributing their works under this license. + +This license gives conditions under which a work may be distributed +and modified, as well as conditions under which modified versions of +that work may be distributed. + +We, the LaTeX3 Project, believe that the conditions below give you +the freedom to make and distribute modified versions of your work +that conform with whatever technical specifications you wish while +maintaining the availability, integrity, and reliability of +that work. If you do not see how to achieve your goal while +meeting these conditions, then read the document `cfgguide.tex' +and `modguide.tex' in the base LaTeX distribution for suggestions. + + +DEFINITIONS +=========== + +In this license document the following terms are used: + + `Work' + Any work being distributed under this License. + + `Derived Work' + Any work that under any applicable law is derived from the Work. + + `Modification' + Any procedure that produces a Derived Work under any applicable + law -- for example, the production of a file containing an + original file associated with the Work or a significant portion of + such a file, either verbatim or with modifications and/or + translated into another language. + + `Modify' + To apply any procedure that produces a Derived Work under any + applicable law. + + `Distribution' + Making copies of the Work available from one person to another, in + whole or in part. Distribution includes (but is not limited to) + making any electronic components of the Work accessible by + file transfer protocols such as FTP or HTTP or by shared file + systems such as Sun's Network File System (NFS). + + `Compiled Work' + A version of the Work that has been processed into a form where it + is directly usable on a computer system. This processing may + include using installation facilities provided by the Work, + transformations of the Work, copying of components of the Work, or + other activities. Note that modification of any installation + facilities provided by the Work constitutes modification of the Work. + + `Current Maintainer' + A person or persons nominated as such within the Work. If there is + no such explicit nomination then it is the `Copyright Holder' under + any applicable law. + + `Base Interpreter' + A program or process that is normally needed for running or + interpreting a part or the whole of the Work. + + A Base Interpreter may depend on external components but these + are not considered part of the Base Interpreter provided that each + external component clearly identifies itself whenever it is used + interactively. Unless explicitly specified when applying the + license to the Work, the only applicable Base Interpreter is a + `LaTeX-Format' or in the case of files belonging to the + `LaTeX-format' a program implementing the `TeX language'. + + + +CONDITIONS ON DISTRIBUTION AND MODIFICATION +=========================================== + +1. Activities other than distribution and/or modification of the Work +are not covered by this license; they are outside its scope. In +particular, the act of running the Work is not restricted and no +requirements are made concerning any offers of support for the Work. + +2. You may distribute a complete, unmodified copy of the Work as you +received it. Distribution of only part of the Work is considered +modification of the Work, and no right to distribute such a Derived +Work may be assumed under the terms of this clause. + +3. You may distribute a Compiled Work that has been generated from a +complete, unmodified copy of the Work as distributed under Clause 2 +above, as long as that Compiled Work is distributed in such a way that +the recipients may install the Compiled Work on their system exactly +as it would have been installed if they generated a Compiled Work +directly from the Work. + +4. If you are the Current Maintainer of the Work, you may, without +restriction, modify the Work, thus creating a Derived Work. You may +also distribute the Derived Work without restriction, including +Compiled Works generated from the Derived Work. Derived Works +distributed in this manner by the Current Maintainer are considered to +be updated versions of the Work. + +5. If you are not the Current Maintainer of the Work, you may modify +your copy of the Work, thus creating a Derived Work based on the Work, +and compile this Derived Work, thus creating a Compiled Work based on +the Derived Work. + +6. If you are not the Current Maintainer of the Work, you may +distribute a Derived Work provided the following conditions are met +for every component of the Work unless that component clearly states +in the copyright notice that it is exempt from that condition. Only +the Current Maintainer is allowed to add such statements of exemption +to a component of the Work. + + a. If a component of this Derived Work can be a direct replacement + for a component of the Work when that component is used with the + Base Interpreter, then, wherever this component of the Work + identifies itself to the user when used interactively with that + Base Interpreter, the replacement component of this Derived Work + clearly and unambiguously identifies itself as a modified version + of this component to the user when used interactively with that + Base Interpreter. + + b. Every component of the Derived Work contains prominent notices + detailing the nature of the changes to that component, or a + prominent reference to another file that is distributed as part + of the Derived Work and that contains a complete and accurate log + of the changes. + + c. No information in the Derived Work implies that any persons, + including (but not limited to) the authors of the original version + of the Work, provide any support, including (but not limited to) + the reporting and handling of errors, to recipients of the + Derived Work unless those persons have stated explicitly that + they do provide such support for the Derived Work. + + d. You distribute at least one of the following with the Derived Work: + + 1. A complete, unmodified copy of the Work; + if your distribution of a modified component is made by + offering access to copy the modified component from a + designated place, then offering equivalent access to copy + the Work from the same or some similar place meets this + condition, even though third parties are not compelled to + copy the Work along with the modified component; + + 2. Information that is sufficient to obtain a complete, + unmodified copy of the Work. + +7. If you are not the Current Maintainer of the Work, you may +distribute a Compiled Work generated from a Derived Work, as long as +the Derived Work is distributed to all recipients of the Compiled +Work, and as long as the conditions of Clause 6, above, are met with +regard to the Derived Work. + +8. The conditions above are not intended to prohibit, and hence do not +apply to, the modification, by any method, of any component so that it +becomes identical to an updated version of that component of the Work as +it is distributed by the Current Maintainer under Clause 4, above. + +9. Distribution of the Work or any Derived Work in an alternative +format, where the Work or that Derived Work (in whole or in part) is +then produced by applying some process to that format, does not relax or +nullify any sections of this license as they pertain to the results of +applying that process. + +10. a. A Derived Work may be distributed under a different license + provided that license itself honors the conditions listed in + Clause 6 above, in regard to the Work, though it does not have + to honor the rest of the conditions in this license. + + b. If a Derived Work is distributed under a different license, that + Derived Work must provide sufficient documentation as part of + itself to allow each recipient of that Derived Work to honor the + restrictions in Clause 6 above, concerning changes from the Work. + +11. This license places no restrictions on works that are unrelated to +the Work, nor does this license place any restrictions on aggregating +such works with the Work by any means. + +12. Nothing in this license is intended to, or may be used to, prevent +complete compliance by all parties with all applicable laws. + + +NO WARRANTY +=========== + +There is no warranty for the Work. Except when otherwise stated in +writing, the Copyright Holder provides the Work `as is', without +warranty of any kind, either expressed or implied, including, but not +limited to, the implied warranties of merchantability and fitness for a +particular purpose. The entire risk as to the quality and performance +of the Work is with you. Should the Work prove defective, you assume +the cost of all necessary servicing, repair, or correction. + +In no event unless required by applicable law or agreed to in writing +will The Copyright Holder, or any author named in the components of the +Work, or any other party who may distribute and/or modify the Work as +permitted above, be liable to you for damages, including any general, +special, incidental or consequential damages arising out of any use of +the Work or out of inability to use the Work (including, but not limited +to, loss of data, data being rendered inaccurate, or losses sustained by +anyone as a result of any failure of the Work to operate with any other +programs), even if the Copyright Holder or said author or said other +party has been advised of the possibility of such damages. + + +MAINTENANCE OF THE WORK +======================= + +The Work has the status `author-maintained' if the Copyright Holder +explicitly and prominently states near the primary copyright notice in +the Work that the Work can only be maintained by the Copyright Holder +or simply that it is `author-maintained'. + +The Work has the status `maintained' if there is a Current Maintainer +who has indicated in the Work that they are willing to receive error +reports for the Work (for example, by supplying a valid e-mail +address). It is not required for the Current Maintainer to acknowledge +or act upon these error reports. + +The Work changes from status `maintained' to `unmaintained' if there +is no Current Maintainer, or the person stated to be Current +Maintainer of the work cannot be reached through the indicated means +of communication for a period of six months, and there are no other +significant signs of active maintenance. + +You can become the Current Maintainer of the Work by agreement with +any existing Current Maintainer to take over this role. + +If the Work is unmaintained, you can become the Current Maintainer of +the Work through the following steps: + + 1. Make a reasonable attempt to trace the Current Maintainer (and + the Copyright Holder, if the two differ) through the means of + an Internet or similar search. + + 2. If this search is successful, then enquire whether the Work + is still maintained. + + a. If it is being maintained, then ask the Current Maintainer + to update their communication data within one month. + + b. If the search is unsuccessful or no action to resume active + maintenance is taken by the Current Maintainer, then announce + within the pertinent community your intention to take over + maintenance. (If the Work is a LaTeX work, this could be + done, for example, by posting to comp.text.tex.) + + 3a. If the Current Maintainer is reachable and agrees to pass + maintenance of the Work to you, then this takes effect + immediately upon announcement. + + b. If the Current Maintainer is not reachable and the Copyright + Holder agrees that maintenance of the Work be passed to you, + then this takes effect immediately upon announcement. + + 4. If you make an `intention announcement' as described in 2b. above + and after three months your intention is challenged neither by + the Current Maintainer nor by the Copyright Holder nor by other + people, then you may arrange for the Work to be changed so as + to name you as the (new) Current Maintainer. + + 5. If the previously unreachable Current Maintainer becomes + reachable once more within three months of a change completed + under the terms of 3b) or 4), then that Current Maintainer must + become or remain the Current Maintainer upon request provided + they then update their communication data within one month. + +A change in the Current Maintainer does not, of itself, alter the fact +that the Work is distributed under the LPPL license. + +If you become the Current Maintainer of the Work, you should +immediately provide, within the Work, a prominent and unambiguous +statement of your status as Current Maintainer. You should also +announce your new status to the same pertinent community as +in 2b) above. + + +WHETHER AND HOW TO DISTRIBUTE WORKS UNDER THIS LICENSE +====================================================== + +This section contains important instructions, examples, and +recommendations for authors who are considering distributing their +works under this license. These authors are addressed as `you' in +this section. + +Choosing This License or Another License +---------------------------------------- + +If for any part of your work you want or need to use *distribution* +conditions that differ significantly from those in this license, then +do not refer to this license anywhere in your work but, instead, +distribute your work under a different license. You may use the text +of this license as a model for your own license, but your license +should not refer to the LPPL or otherwise give the impression that +your work is distributed under the LPPL. + +The document `modguide.tex' in the base LaTeX distribution explains +the motivation behind the conditions of this license. It explains, +for example, why distributing LaTeX under the GNU General Public +License (GPL) was considered inappropriate. Even if your work is +unrelated to LaTeX, the discussion in `modguide.tex' may still be +relevant, and authors intending to distribute their works under any +license are encouraged to read it. + +A Recommendation on Modification Without Distribution +----------------------------------------------------- + +It is wise never to modify a component of the Work, even for your own +personal use, without also meeting the above conditions for +distributing the modified component. While you might intend that such +modifications will never be distributed, often this will happen by +accident -- you may forget that you have modified that component; or +it may not occur to you when allowing others to access the modified +version that you are thus distributing it and violating the conditions +of this license in ways that could have legal implications and, worse, +cause problems for the community. It is therefore usually in your +best interest to keep your copy of the Work identical with the public +one. Many works provide ways to control the behavior of that work +without altering any of its licensed components. + +How to Use This License +----------------------- + +To use this license, place in each of the components of your work both +an explicit copyright notice including your name and the year the work +was authored and/or last substantially modified. Include also a +statement that the distribution and/or modification of that +component is constrained by the conditions in this license. + +Here is an example of such a notice and statement: + + %% pig.dtx + %% Copyright 2005 M. Y. Name + % + % This work may be distributed and/or modified under the + % conditions of the LaTeX Project Public License, either version 1.3 + % of this license or (at your option) any later version. + % The latest version of this license is in + % http://www.latex-project.org/lppl.txt + % and version 1.3 or later is part of all distributions of LaTeX + % version 2005/12/01 or later. + % + % This work has the LPPL maintenance status `maintained'. + % + % The Current Maintainer of this work is M. Y. Name. + % + % This work consists of the files pig.dtx and pig.ins + % and the derived file pig.sty. + +Given such a notice and statement in a file, the conditions +given in this license document would apply, with the `Work' referring +to the three files `pig.dtx', `pig.ins', and `pig.sty' (the last being +generated from `pig.dtx' using `pig.ins'), the `Base Interpreter' +referring to any `LaTeX-Format', and both `Copyright Holder' and +`Current Maintainer' referring to the person `M. Y. Name'. + +If you do not want the Maintenance section of LPPL to apply to your +Work, change `maintained' above into `author-maintained'. +However, we recommend that you use `maintained', as the Maintenance +section was added in order to ensure that your Work remains useful to +the community even when you can no longer maintain and support it +yourself. + +Derived Works That Are Not Replacements +--------------------------------------- + +Several clauses of the LPPL specify means to provide reliability and +stability for the user community. They therefore concern themselves +with the case that a Derived Work is intended to be used as a +(compatible or incompatible) replacement of the original Work. If +this is not the case (e.g., if a few lines of code are reused for a +completely different task), then clauses 6b and 6d shall not apply. + + +Important Recommendations +------------------------- + + Defining What Constitutes the Work + + The LPPL requires that distributions of the Work contain all the + files of the Work. It is therefore important that you provide a + way for the licensee to determine which files constitute the Work. + This could, for example, be achieved by explicitly listing all the + files of the Work near the copyright notice of each file or by + using a line such as: + + % This work consists of all files listed in manifest.txt. + + in that place. In the absence of an unequivocal list it might be + impossible for the licensee to determine what is considered by you + to comprise the Work and, in such a case, the licensee would be + entitled to make reasonable conjectures as to which files comprise + the Work. + diff --git a/macros/latex/contrib/xellipsis/xellipsis.dtx b/macros/latex/contrib/xellipsis/xellipsis.dtx new file mode 100644 index 0000000000..27678a6b3f --- /dev/null +++ b/macros/latex/contrib/xellipsis/xellipsis.dtx @@ -0,0 +1,592 @@ +% \iffalse +% +AMDG This document was begun on E October 11EE, the +% feast of the Maternity of the Blessed Virgin Mary, and it +% is humbly dedicated to her and to her Immaculate Heart for +% her prayers, and to the Sacred Heart of Jesus for His +% mercy. +% +% This document is copyright 2015 by Donald P. Goodman, and is +% released publicly under the LaTeX Project Public License. The +% distribution and modification of this work is constrained by the +% conditions of that license. See +% http://www.latex-project.org/lppl.txt +% for the text of the license. This document is released +% under version 1.3 of that license, and this work may be distributed +% or modified under the terms of that license or, at your option, any +% later version. +% +% This work has the LPPL maintenance status 'maintained'. +% +% The Current Maintainer of this work is Donald P. Goodman +% (dgoodmaniii@gmail.com). +% +% This work consists of xellipsis.dtx, xellipsis.ins, and +% derived files xellipsis.sty and xellipsis.pdf. +% \fi + +% \iffalse +%\NeedsTeXFormat{LaTeX2e}[1999/12/01] +%\ProvidesPackage{xellipsis}[2015/11/01 v2.0 support for highly configurable ellipses of arbitrary symbol, number, and distance] +%<*driver> +\documentclass{ltxdoc} + +\usepackage{doc} +\usepackage{array} +\usepackage{lettrine} + \setcounter{DefaultLines}{3} + \setlength{\DefaultFindent}{2pt} + \renewcommand{\LettrineFontHook}{\color{red}} +\usepackage{url} +\usepackage{spverbatim} +\usepackage[typeone]{dozenal} +\usepackage{lmodern} +\usepackage[]{xellipsis} +\usepackage[colorlinks]{hyperref} +\usepackage{makeidx} +\EnableCrossrefs +\PageIndex +\CodelineNumbered +\RecordChanges +\makeindex + +\long\def\example#1#2{% + \bigskip% + \hrule% + \hbox to\linewidth{% + \hbox to0.5\linewidth{% + \vbox to2in{\vfil#1\vfil}% + }\hbox to0.5\linewidth{% + \vbox to2in{\vfil#2\vfil}% + }% + }% + \hrule% + \bigskip% +} + +\tracingmacros=3 \begin{document} \DocInput{xellipsis.dtx} +\end{document} +% \fi +% +% \title{The |xellipsis| Package, v2.0} \author{Donald P.\ +% Goodman III} \date{\today} +% +% \maketitle +% +% \begin{abstract} \TeX\ users have long been remarking that +% the default characteristics of ellipses, whether produced +% by |\dots|, |\ldots|, or some other command, just aren't +% quite right. While some packages have attempted to +% resolve this issue (e.g., |lips| and |ellipsis|), these +% have never quite fit my use cases. |xellipsis| attempts +% to fill this gap by providing absurdly configurable +% ellipses, along with preconfigured options for the Chicago +% Manual of Style (and Turabian), MLA, and the Bluebook. \end{abstract} +% +% \tableofcontents +% +% \section{Introduction} +% +% Typography has long made use of these strange sequences of +% (usually) dots called \emph{ellipses} (singular +% \emph{ellipsis}). An ellipsis typically indicates an +% omission from a quotation (indeed, the Greek root means +% ``omission''), but they have also been used in a huge +% variety of other ways over the years: +% +% \begin{itemize} \item The aforementioned omission. ``Four +% score and\xelip seven years ago.'' \item An unfinished +% thought. ``Our forefathers brought forth\xelip I don't +% know; something, I guess.'' \item Indications of preceding +% matter. ``\xelip a new nation, conceived in liberty.'' +% \item A pause. ``I think\xelip therefore, I am.'' \item +% Probably lots of other things, as well. \end{itemize} +% +% \LaTeX, by default, produces ellipses with the |\dots| +% (\dots) or |\ldots| (\ldots) commands. These are fine, as +% far as they go; however, they suffer a few clear faults. +% For example, there is much less space at the beginning +% than at the end, which many people don't like; they are +% fairly close together, which not only do many people not +% like, but which goes against some important style manuals; +% they cannot have four or more dots, which some style +% manuals require in certain circumstances; and their +% spacing is not in any way configurable. +% +% So |xellipsis| gives you all the configuration options for +% your ellipses that you could possibly want, and probably +% lots more than you'll ever need. It also comes +% prepackaged with a few common formats, which are selected +% as package options at load time. +% +% |xellipsis| is packaged according to the \LaTeX\ +% \textsc{docstrip} utility, which allows automatic +% extraction of code and documentation from the same files. +% +% \section{Preconfigured Formats} +% \label{sect:preconf} +% +% |xellipsis| comes with some preconfigured ellipsis formats +% for the convenience of users. These are all set as +% package options; so, for example, when loading the package +% one states |\usepackage{xellipsis}| for the default +% behavior, but |\usepackage[latex]{xellipsis}| to specify +% the |latex| format. +% +% Please note that the usage of these ellipses is not always +% clear, even according to the manuals. I've done my best +% to get them right here, but if they're wrong on some +% detail, please let me know and I'll try to fix them. +% |xellipsis| offers ample configuration options to get +% these things right. +% +% \DescribeMacro{latex} +% The |latex| option sets up |\xelip| to behave identically +% to the default \LaTeX\ setting of |\dots| or |\ldots|. +% (The \LaTeX\ kernel defines |\ldots| as +% |\let\ldots=\dots|, so the two are the same.) In a +% convoluted way, |\dots| is defined in terms of +% |\textellipsis|, which itself is simply three dots +% separated by the current font's |\fontdimen3|, which is +% the stretchability of interword space. Not the interword +% space itself, mind you, but just the stretchability of +% that space. This leads to pretty tightly spaced ellipses +% for most fonts; but there we are. It also specifies no +% particular space before the ellipsis, but the same space +% as the gaps afterwards. This option yields the following: +% \begin{quote} +% {\xelipbef=0pt\xelipaft=\fontdimen3\font\xelipgap=\fontdimen3\font +% This is\xelip pretty tight, really. (|\xelip|) +% +% This is\ldots pretty tight, really. (|\ldots|) +% } +% \end{quote} +% +% \DescribeMacro{chicago} +% \textit{The Chicago Manual of Style} has some very +% specific rules about ellipses; specifically, that they +% should be three periods plus two nonbreaking spaces. So +% |xellipsis| defines them precisely that way, in terms of +% |\fontdimen2| (the non-glue portion of the interword space +% for the font), and adds no space before the first dot. +% The \textsc{cmos} also specifies that, at the end of a +% natural sentence, the period of the sentence should remain +% \emph{prior} to the ellipsis; this works fine with our +% definition. +% This system yields: +% \begin{quote} +% {\xelipbef=0pt\xelipaft=\fontdimen2\font\xelipgap=\fontdimen2\font +% This is\xelip pretty loose, really. (|\xelip|) +% +% I like that.\ \xelip It makes some sense. (|.\ \xelip|) +% } +% \end{quote} +% +% \DescribeMacro{mla} +% The \textsc{mla} advises similar ellipses to the \textsc{cmos}, +% except that there should always be a space before the +% first period. +% \begin{quote} +% {\xelipbef=\fontdimen2\font\xelipaft=\fontdimen2\font\xelipgap=\fontdimen2\font +% This is\xelip pretty loose, really. (|\xelip|) +% } +% \end{quote} +% +% \DescribeMacro{oldmla} +% The \textsc{mla} formerly advised that ellipses indicating +% omissions should be surrounded by square brackets ([]). +% The materials I've seen seem to indicate that this might +% still be required when the quotation already contains +% ellipses in the original material; however, usually they +% are not required. Either way, here's the option: +% \begin{quote} +% {\xelipbef=\fontdimen2\font\xelipaft=\fontdimen2\font\xelipgap=\fontdimen2\font\def\xelipprechar{[}\def\xelippostchar{]}\xelipprebef=\fontdimen2\font\xelippostaft=\fontdimen2\font +% This is\xelip how it's supposed to work, I guess? (|\xelip|) +% } +% \end{quote} +% +% \DescribeMacro{bluebook} +% Finally, in the United States legal citations are governed +% by our overlords at the Harvard Law Review, who publish +% \textit{The Bluebook}. Their ellipses are formatted just +% like the \textsc{mla} ellipses: +% \begin{quote} +% {\xelipbef=\fontdimen2\font\xelipaft=\fontdimen2\font\xelipgap=\fontdimen2\font +% This is\xelip pretty loose, really. (|\xelip|) +% } +% \end{quote} +% +% Finally, there is a special command +% \DescribeMacro{\xelipend}|\xelipend|. This is identical +% to |\xelip| except that the closing space is omitted. +% +% \begin{quote} +% ``This is pretty neat\xelipend'' (|\xelipend|) +% +% ``This is pretty neat\xelip'' (|\xelip|) +% \end{quote} +% +% |\xelipend| is primarily useful immediately preceding some +% quoting character; some people prefer there to be no or +% much more limited spacing in this location. Use +% |\xelipend| if you prefer this type of behavior. +% +% \section{The Nitty-Gritty: Configuration} +% \label{sect:nittygritty} +% +% We've already seen examples of the |xellipsis| defaults +% used (any time in this document that we haven't been +% explicitly demonstrating something else), so let's get +% down-and-dirty with the internals and do some customizing. +% +% The first is the most obvious: the character from which +% the ellipsis is constructed. This defaults to ``.'' (a +% period), and is held in the variable +% \DescribeMacro{\xelipchar}|\xelipchar|. Simply redefine +% |\xelipchar| in the normal way to get something different +% from the ordinary: +% +% \bigskip \hbox to\linewidth{% \hfil% \hbox +% to0.4\linewidth{% \hfil% \vbox{% +% \hbox{|\def\xelipchar{*}|} \hbox{|\xelip|} } \hfil% }\hbox +% to0.4\linewidth{% \hfil% \vbox{% \def\xelipchar{*}\xelip } +% \hfil% } \hfil% } \bigskip +% +% \def\xelipchar{*} This was actually quite common in older +% legal documents (using asterisks for ellipses, that is): +% ``And the ruling of the lower court\xelip is hereby +% \textsc{affirmed}.'' \def\xelipchar{.} So this sort of +% thing has some real functionality at times. +% +% The same effect can be achieved by using the +% \DescribeMacro{char}|char| package option; e.g., by +% loading |xellipsis| with |\usepackage[char=*]{xellipsis}|. +% Indeed, as of version 2.0, all these settings can be made +% at the time of package loading. +% +% The \emph{number} of characters in an ellipsis is governed +% by \DescribeMacro{\xelipnum}|\xelipnum|. |\xelipnum| is +% a \emph{counter}, not a macro, so if you change it, do so +% with a simple |=|: +% +% \bigskip \hbox to\linewidth{% \hfil% \hbox +% to0.4\linewidth{% \hfil% \vbox{% \hbox{|\xelipnum=6|} +% \hbox{|\xelip|} } \hfil% }\hbox to0.4\linewidth{% \hfil% +% \vbox{% \xelipnum=6 \xelip } \hfil% } \hfil% } \bigskip +% +% Most likely this would be 3 or 4, but I'm not going to try +% to limit you. |\xelipnum| defaults to 3. The package +% option is \DescribeMacro{num}|num|. +% +% There are three lengths responsible for controlling the +% spacing of the ellipses. The space \emph{before} the +% first character of the ellipses is +% \DescribeMacro{\xelipbef}|\xelipbef|; the space +% \emph{after} the last character of the ellipses is +% \DescribeMacro{\xelipaft}|\xelipaft|; and the space +% \emph{between} the characters of the ellipses is +% \DescribeMacro{\xelipgap}|\xelipgap|. Each of these +% default to |3pt|. Their package options are +% \DescribeMacro{before}|before|, +% \DescribeMacro{after}|after|, and +% \DescribeMacro{gap}|gap|. +% +% The benefit of having each of these independently +% configurable is that you don't have to worry about +% inserting special spacing before the ellipsis. +% Furthermore, you don't have to worry about |\xelip| eating the space +% after your command unless you prevent that with |{}| or +% |\ |; it \emph{does} +% eat the space, but that's okay, because the appropriate +% spacing is built into it. So you can say +% |I went\xelip to the store| and you'll get +% ``I went\xelip to the store'', exactly as you undoubtedly +% wanted. No need for |\xelip{}| or such expedients. +% +% Remember that these lengths are |dimen|s, so they are +% reset using a simple |=|; you can also use the \LaTeX\ +% |\setlength| incantation if you'd prefer: +% +% \bigskip +% \hbox to\linewidth{% +% \hfil% +% \hbox to0.49\linewidth{% +% \hfil% +% \vbox{% +% \hbox{|\xelipbef=1em|} +% \hbox{|\xelipgap=2em|} +% \hbox{|\setlength{\xelipaft}{2pt}|} +% \hbox{|This is\xelip strange.|} +% }% +% \hfil% +% }\hbox to0.49\linewidth{% +% \hfil% +% \vbox{% +% \xelipbef=1em +% \xelipgap=2em +% \setlength{\xelipaft}{2pt} +% This is\xelip strange. +% } +% \hfil% +% }% +% \hfil% +% } +% \bigskip +% +% Finally, some style guides (including the MLA, until +% recently) require some surrounding punctuation for an +% ellipsis. |xellipsis| provides for this, too. The +% character that is to go \emph{before} the ellipsis is +% \DescribeMacro{\xelipprechar}|\xelipprechar|, while the +% character that is to go \emph{after} the ellipsis is +% \DescribeMacro{\xelippostchar}|\xelippostchar|. Both of +% these default to be empty. Their package options are +% \DescribeMacro{prechar}|prechar| and +% \DescribeMacro{postchar}|postchar|. +% +% \bigskip +% \hbox to\linewidth{% +% \hfil% +% \hbox to0.49\linewidth{% +% \hfil% +% \vbox{% +% \hbox{|\def\xelipprechar{[}|} +% \hbox{|\def\xelippostchar{]}|} +% \hbox{|This is\xelip strange.|} +% }% +% \hfil% +% }\hbox to0.49\linewidth{% +% \hfil% +% \vbox{% +% \def\xelipprechar{[} +% \def\xelippostchar{]} +% This is\xelip strange. +% } +% \hfil% +% }% +% \hfil% +% } +% \bigskip +% +% As with |\xelipchar|, you can use really anything for +% this, even things that would be truly bizarre (daggers? +% fleur-de-lis?); but this is a typical use case. +% +% The unsurprisingly-named +% \DescribeMacro{\xelipprebef}|\xelipprebef|, +% \DescribeMacro{\xelippreaft}|\xelippreaft|, +% \DescribeMacro{\xelippostbef}|\xelippostbef|, and +% \DescribeMacro{\xelippostaft}|\xelippostaft| control the +% spacing around these two characters; by default, all four +% are set to |0pt|. They are |dimen|s and can be set in +% either the \TeX\ way or the \LaTeX\ |\setlength| way. +% Their package options are +% \DescribeMacro{prebefore}|prebefore|, +% \DescribeMacro{preafter}|preafter|, +% \DescribeMacro{postbefore}|postbefore|, and +% \DescribeMacro{postafter}|postafter|, +% +% \bigskip +% \hbox to\linewidth{% +% \hfil% +% \hbox to0.49\linewidth{% +% \hfil% +% \vbox{% +% \hbox{|\def\xelipprechar{[}|} +% \hbox{|\def\xelippostchar{]}|} +% \hbox{|\xelipprebef=6pt|} +% \hbox{|\xelippreaft=3pt|} +% \hbox{|\setlength{\xelippostbef}{3pt}|} +% \hbox{|\setlength{\xelippostaft}{6pt}|} +% \hbox{|This is\xelip strange.|} +% }% +% \hfil% +% }\hbox to0.49\linewidth{% +% \hfil% +% \vbox{% +% \def\xelipprechar{[} +% \def\xelippostchar{]} +% \xelipprebef=6pt +% \xelippreaft=3pt +% \setlength{\xelippostbef}{3pt} +% \setlength{\xelippostaft}{6pt} +% This is\xelip strange. +% } +% \hfil% +% }% +% \hfil% +% } +% \bigskip +% +% Please be aware that |\xelippreaft| \emph{stacks} +% with |\xelipbef|, and |\xelippostbef| stacks with +% |\xelipaft|; so their sum should be the spacing you want. +% Often this means simply leaving the two of them alone, as +% you've already got the appropriate space in the +% shorter-named |dimen|s. +% +% And that's it; if |xellipsis| can't meet your ellipsis +% needs somehow, please contact me and let me know, and I'll +% endeavor to add what you require. Happy \TeX{}ing! +% +% \section{Implementation} +% +% Our first task, as usual, is to define our options. We +% have options for default \LaTeX\ ellipsis behavior, +% Chicago Manual of Style behavior, old MLA behavior, and +% current MLA behavior. These all default to \emph{off}, +% and the default |xellipsis| behavior described above is +% \emph{on}. We define the conditions for the options, then +% process the options themselves. We use |xkeyval| to get +% these options, so we can easily give them key-value +% arguments. We also need to define our default characters. +% \begin{macrocode} +\RequirePackage{xkeyval} +\def\xelipchar{.} +\def\xelipprechar{} +\def\xelippostchar{} +% \end{macrocode} +% Proceed to define the dimens that we will need. These are +% mostly self-explanatory; the first is for the gap +% between the characters of the ellipsis, the second is for +% the space \emph{before} the ellipsis begins, and the third +% is for the space \emph{after} the ellipsis ends. The +% fourth and fifth are for the spaces around the +% pre-ellipsis character, and the sixth and seventh are for +% the spaces around the post-ellipsis character. +% \begin{macrocode} +\newdimen\xelipgap\xelipgap=3pt +\newdimen\xelipbef\xelipbef=3pt +\newdimen\xelipaft\xelipaft=3pt +\newdimen\xelipprebef\xelipprebef=0pt +\newdimen\xelippreaft\xelippreaft=0pt +\newdimen\xelippostbef\xelippostbef=0pt +\newdimen\xelippostaft\xelippostaft=0pt +% \end{macrocode} +% Now we define the counter which holds the number of +% ellipsis characters we want. Defaults to 3. +% \begin{macrocode} +\newcount\xelipnum\xelipnum = 3% +% \end{macrocode} +% \begin{macrocode} +\newif\ifxel@latex\xel@latexfalse +\newif\ifxel@chicago\xel@chicagofalse +\newif\ifxel@oldmla\xel@oldmlafalse +\newif\ifxel@mla\xel@mlafalse +\newif\ifxel@bluebook\xel@bluebookfalse +\DeclareOptionX{latex}{\xel@latextrue} +\DeclareOptionX{chicago}{\xel@chicagotrue} +\DeclareOptionX{oldmla}{\xel@oldmlatrue} +\DeclareOptionX{mla}{\xel@mlatrue} +\DeclareOptionX{bluebook}{\xel@bluebooktrue} +\DeclareOptionX{char}{\def\xelipchar{#1}} +\DeclareOptionX{num}{\xelipnum=#1} +\DeclareOptionX{before}{\xelipbef=#1} +\DeclareOptionX{after}{\xelipaft=#1} +\DeclareOptionX{gap}{\xelipgap=#1} +\DeclareOptionX{prechar}{\def\xelipprechar{#1}} +\DeclareOptionX{postchar}{\def\xelippostchar{#1}} +\DeclareOptionX{prebefore}{\xelipprebef=#1} +\DeclareOptionX{preafter}{\xelippreaft=#1} +\DeclareOptionX{postbefore}{\xelippostbef=#1} +\DeclareOptionX{postafter}{\xelippostaft=#1} +\ProcessOptionsX +% \end{macrocode} +% Now we define the loop variable. +% \begin{macrocode} +\newcount\xel@loopi\xel@loopi = 0% +% \end{macrocode} +% Next, we define the box which will hold the ellipsis; this +% way we can be sure that it won't break across lines. +% \begin{macrocode} +\def\xelip{% + \nobreak\hskip0pt\hbox{% +% \end{macrocode} +% Put it the code for the |\xelipprechar| and its spacing: +% \begin{macrocode} + \hskip\xelipprebef\xelipprechar\hskip\xelippreaft% +% \end{macrocode} +% Now, we use |\xelipbef| to skip the pre-ellipsis distance. +% \begin{macrocode} + \hskip\xelipbef\xelipchar% +% \end{macrocode} +% Now we loop, printing |\xelipchar| and skipping +% |\xelipgap| as many times as |\xelipnum| requires. We +% start be resetting the |\xel@loopi| variable, just in +% case. +% \begin{macrocode} + \xel@loopi = 1% + \loop\ifnum\xelipnum>\xel@loopi% + \advance\xel@loopi by1% + \hskip\xelipgap% + \xelipchar% + \repeat +% \end{macrocode} +% Lastly, we skip |\xelipaft|, then skip for +% |\xelippostchar| and its |dimen|s, close our box, and sit +% back in the satisfaction of an ellipsis well-made. +% \begin{macrocode} + \hskip\xelipaft% + \hskip\xelippostbef\xelippostchar\hskip\xelippostaft% + }% +}% +% \end{macrocode} +% Set up a special command, |\xelipend|, which omits the +% spacing at the end and can be used immediately before +% quotations or the like. +% \begin{macrocode} +\def\xelipend{% + \begingroup% + \xelipaft=0pt + \xelip% + \endgroup% +}% +% +% Set up the |latex| option. +% \begin{macrocode} +\ifxel@latex + \xelipbef=0pt% + \xelipaft=\fontdimen3\font% + \xelipgap=\fontdimen3\font% +\fi +% \end{macrocode} +% \textit{The Chicago Manual of Style} option. +% \begin{macrocode} +\ifxel@chicago + \xelipbef=0pt% + \xelipaft=\fontdimen2\font% + \xelipgap=\fontdimen2\font% +\fi +% \end{macrocode} +% The \textsc{mla} option. +% \begin{macrocode} +\ifxel@mla + \xelipbef=\fontdimen2\font% + \xelipaft=\fontdimen2\font% + \xelipgap=\fontdimen2\font% +\fi +% \end{macrocode} +% \textit{The Bluebook} option. +% \begin{macrocode} +\ifxel@bluebook + \xelipbef=\fontdimen2\font% + \xelipaft=\fontdimen2\font% + \xelipgap=\fontdimen2\font% +\fi +% \end{macrocode} +% The old \textsc{mla} option. +% \begin{macrocode} +\ifxel@oldmla + \xelipbef=\fontdimen2\font% + \xelipaft=\fontdimen2\font% + \xelipgap=\fontdimen2\font% + \def\xelipprechar{[}% + \def\xelippostchar{]}% + \xelipprebef=\fontdimen2\font% + \xelippostaft=\fontdimen2\font% +\fi +% } +% \end{macrocode} +% And there's the |xellipsis| package. I hope it proves +% useful to someone besides myself. Happy \TeX{}ing! +% +% \PrintIndex diff --git a/macros/latex/contrib/xellipsis/xellipsis.ins b/macros/latex/contrib/xellipsis/xellipsis.ins new file mode 100644 index 0000000000..0798460d6f --- /dev/null +++ b/macros/latex/contrib/xellipsis/xellipsis.ins @@ -0,0 +1,65 @@ +% +AMDG This document was begun on E October 11EE, the +% feast of the Maternity of the Blessed Virgin Mary, and it +% is humbly dedicated to her and to her Immaculate Heart for +% her prayers, and to the Sacred Heart of Jesus for His +% mercy. +% +% This document is copyright 2015 by Donald P. Goodman, and is +% released publicly under the LaTeX Project Public License. The +% distribution and modification of this work is constrained by the +% conditions of that license. See +% http://www.latex-project.org/lppl.txt +% for the text of the license. This document is released +% under version 1.3 of that license, and this work may be distributed +% or modified under the terms of that license or, at your option, any +% later version. +% +% This work has the LPPL maintenance status 'maintained'. +% +% The Current Maintainer of this work is Donald P. Goodman +% (dgoodmaniii@gmail.com). +% +% This work consists of xellipsis.dtx, xellipsis.ins, and +% derived files xellipsis.sty and xellipsis.pdf. + +\input docstrip.tex + +\preamble +This is a generated file. + +This document is copyright 2014 by Donald P. Goodman, and is +released publicly under the LaTeX Project Public License. The +distribution and modification of this work is constrained by the +conditions of that license. See + http://www.latex-project.org/lppl.txt +for the text of the license. This document is released +under version 1.3 of that license, and this work may be distributed +or modified under the terms of that license or, at your option, any +later version. + +This work has the LPPL maintenance status 'maintained'. + +The Current Maintainer of this work is Donald P. Goodman +(dgoodmaniii@gmail.com). + +This work consists of xellipsis.dtx, xellipsis.ins, and +derived files xellipsis.sty and xellipsis.pdf. +\endpreamble + +\keepsilent +\generate{\file{xellipsis.sty}{\from{xellipsis.dtx}{package}}} + +\Msg{******************************************************} +\Msg{*} +\Msg{* To finish the installation you have to move the} +\Msg{* following file into a directory searched by TeX:} +\Msg{*} +\Msg{* \space\space xellipsis.sty} +\Msg{*} +\Msg{* To produce the documentation run the file xellipsis.dtx} +\Msg{* through LaTeX.} +\Msg{*} +\Msg{* Happy TeXing!} +\Msg{******************************************************} + +\endbatchfile diff --git a/macros/latex/contrib/xellipsis/xellipsis.pdf b/macros/latex/contrib/xellipsis/xellipsis.pdf new file mode 100644 index 0000000000..b4cd29a524 Binary files /dev/null and b/macros/latex/contrib/xellipsis/xellipsis.pdf differ -- cgit v1.2.3