diff options
| author | Norbert Preining <norbert@preining.info> | 2019-09-02 13:46:59 +0900 |
|---|---|---|
| committer | Norbert Preining <norbert@preining.info> | 2019-09-02 13:46:59 +0900 |
| commit | e0c6872cf40896c7be36b11dcc744620f10adf1d (patch) | |
| tree | 60335e10d2f4354b0674ec22d7b53f0f8abee672 /macros/latex/contrib/bosisio/envmath.html | |
Initial commit
Diffstat (limited to 'macros/latex/contrib/bosisio/envmath.html')
| -rw-r--r-- | macros/latex/contrib/bosisio/envmath.html | 419 |
1 files changed, 419 insertions, 0 deletions
diff --git a/macros/latex/contrib/bosisio/envmath.html b/macros/latex/contrib/bosisio/envmath.html new file mode 100644 index 0000000000..73862b4425 --- /dev/null +++ b/macros/latex/contrib/bosisio/envmath.html @@ -0,0 +1,419 @@ +<html> +<!-- ++ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + +| Copyright(C) 1997-2010 by F. Bosisio | +| | +| This program can be redistributed and/or modified under | +| the terms 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 LaTeX distributions | +| version 2005/12/01 or later. | +| | +| This work has the LPPL maintenance status `maintained'. | +| The Current Maintainer of this work is F. Bosisio. | +| | +| This work consists of files envmath.dtx and envmath.html | +| and of the derived files envmath.sty and envmath.pdf. | +| | +| E-mail: fbosisio@bigfoot.com | +| CTAN location: macros/latex/contrib/bosisio/ | ++ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + +--> +<head> + <title>Package envmath</title> +</head> +<body> + +<h1 align="CENTER"> +Package <tt>envmath</tt><br /> +<small> +This is version 2.5, last revised 2010/02/10; documentation date 2005/04/09. +</small> +</h1> + +<p align="CENTER"> +<strong> +Author: <i>F. Bosisio</i><br /> +<small> +E-mail: <a href="mailto:fbosisio@bigfoot.com"> + <tt>fbosisio@bigfoot.com</tt> + </a><br /> +CTAN location: <a href="http://mirror.ctan.org/macros/latex/contrib/bosisio"> + <tt>macros/latex/contrib/bosisio</tt> + </a> +</small> +</strong> +</p> + +<p align="LEFT"></p> + +<!------------------------------------------------------------------------> +<p> + +<h3>Abstract</h3> +<div> +Documentation for the package <tt>envmath</tt>. +</div> + +<hr /><br /> +<!------------------------------------------------------------------------> + +<h2>Table of contents</h2> + +<ul> + <li><a href="#SECTION01">Introduction</a></li> + <li><a href="#SECTION02">The options</a></li> + <li><a href="#SECTION03">Math-mode environments</a> + <ul> + <li><a href="#SECTION03a">The <tt>Equation</tt> environment</a></li> + <li><a href="#SECTION03b">The <tt>MultiLine</tt> equation environment</a></li> + <li><a href="#SECTION03c">The <tt>System</tt> environment</a></li> + <li><a href="#SECTION03d">The <tt>EqSystem</tt> environment</a></li> + </ul></li> + <li><a href="#SECTION04">Math-mode commands</a></li> +</ul> + +<hr /><br /> +<!------------------------------------------------------------------------> + +<h2> +<a name="SECTION01">Introduction</a> +</h2> + +<p> +This package provides some useful math-commands and enviroments, which +are simpler to use and prettier then their standard LaTeX counterpart. +</p> + +<p> +In particular some commands are redefined +(see <a href="#SECTION02">next section</a> if you don't want them to be +redefined), so care should be taken, expecially when including this package +in an already existent LaTeX file. + +<p> +The <a href="#SECTION04">redefined commands</a> are:<br /> +<tt>\(</tt>, <tt>\)</tt>, +<tt>\[</tt>, <tt>\]</tt>, +<tt>\{</tt> and <tt>\}</tt>.<br /> +The effect of ``<tt>\(</tt> ...<tt>\)</tt>'' can still be achieved by +the LaTeX equivalent commands ``<tt>\begin{math} ... \end{math}</tt>'' +or ``<tt>$...$</tt>''. +</p> + +<p> +Similarly, the effect of ``<tt>\[...\]</tt>'' can be achieved by the +LaTeX equivalent commands +``<tt>\begin{displaymath}...\end{displaymath}</tt>'' or +``<tt>$$...$$</tt>''. +</p> + +<p> +The ``<tt>\{</tt>'' and ``<tt>\}</tt>'' commands are the more +error-prone, since one may try to use ``<tt>\left\{</tt>'', which now +is incorrect, because the ``<tt>\{</tt>'' command already contains a +``<tt>\left</tt>'' declaration. +In the rare occasions where a brace of normal size is needed, one can use +the LaTeX commands ``<tt>\lbrace</tt>'' and ``<tt>\rbrace</tt>''. +</p> + +<p> +Also the <a href="#SECTION03a">``<tt>equation</tt>'' environment</a> has been +changed, but it is completly compatible with the original definition, so it +should be safe, perhaps except when the first character of the equation is +an open square bracket or it is placed in a moving argument: +in fact, the new version of this command is fragile, and this is true also +for most of the commands defined by this package. +</p> + +<hr /><br /> +<!------------------------------------------------------------------------> + +<h2> +<a name="SECTION02">The options</a> +</h2> + +<p> +At now, five options are available with the <tt>envmath</tt> package. +</p> + +<p> +The ``<tt>RedefEquation</tt>''/``<tt>StdEquation</tt>'' and +``<tt>RedefBrackets</tt>''/``<tt>StdBrackets</tt>'' options control +whether the ``<tt>equation</tt>'' environment and the brace commands +``<tt>\(</tt>'', ``<tt>\)</tt>'', ``<tt>\[</tt>'', +``<tt>\]</tt>'', ``<tt>\{</tt>'' and ``<tt>\}</tt>'' should +be redefined or retain their original LaTeX meaning. +</p> + +<p> +More precisely, ``<tt>RedefEquation</tt>'' (default) redefines the +``equation'' environment to have an optional argument (used as a label), +while ``<tt>StdEquation</tt>'' leaves it unchanged. +In the first case, the ``equation'' environment will be equivalent to the +<a href="#SECTION03a">``Equation'' environment</a> (capitalized!) described +below, whereas in the second case they will be different. +</p> + +<p> +Similarly, the ``<tt>RedefBrackets</tt>'' option (default) makes the +<a href="#SECTION04"> bracket commands</a> to be redefined, whilst +``<tt>StdBrackets</tt>'' leave them their original meaning. +</p> + +<p> +Also a ``<tt>Standard</tt>'' option exists, which amounts to specify both +the ``<tt>StdEquation</tt>'' and ``<tt>StdBrackets</tt>'' options, thus making +the package fully standard, which may be useful when sending your +LaTeX files to someone else. +</p> + +<hr /><br /> +<!------------------------------------------------------------------------> + +<h2> +<a name="SECTION03">Math-mode environments</a> +</h2> + +<p> +This package provides some math-mode environments, each with a ``*-form'' +which does not generates numbers (or produce sub-numbering). +</p> + +<hr /><br /> +<!------------------------------------------------------------------------> + +<h3> +<a name="SECTION03a">The <tt>Equation</tt> environment</a> +</h3> + +<p> +The ``<tt>Equation</tt>'' environment has an optional argument which is used +as a label to reference it. +<pre> + \begin{Equation}[<label>] + ... + \end{Equation} +</pre> +</p> + +<p> +If the ``<tt>RedefEquation</tt>'' option is in effect (default), then +the ``<tt>equation</tt>'' environment is redefined to have the same optional +argument as ``<tt>Equation</tt>''. +</p> + +<p> +There is also a *-form, which does not generate a number (so this *-form is +really a ``displaymath'' and not an equation, but it has been added for +simmetry and for making it easier to add or remove the number to a formula). +</p> + +<p> +The *-form has an optional argument like the non-* form, which is +disregarded by the environment and is added only for simmetry reasons. +<pre> + \begin{equation*}[<disregarded-label>] + ... + \end{equation*} +</pre> +</p> + +<hr /><br /> +<!------------------------------------------------------------------------> + +<h3> +<a name="SECTION03b">The <tt>MultiLine</tt> equation environment</a> +</h3> + +<p> +The ``<tt>MultiLine</tt>'' environment is intended for formulas that don't +fit on a single line, and so must be broken across lines. +</p> + +<p> +As for the <a href="#SECTION03a"><tt>Equation</tt> environment</a> above, +it has an optional argument which is used as a label. +</p> + +<p> +All the lines but the first are automatically indented by the lenght +``<tt>\MultiLineIndent</tt>'', which is rougthly what one expects, but +can be changed at any time by the user with +``<tt>\setlenght\MultiLineIndent{...}</tt>''. +You can also control the alignment of the continuation rows by placing an +optional <tt>&</tt> in the first row: is such a case all the others line +will <em>not</em> be indented by ``<tt>\MultiLineIndent</tt>'' but wil behave +<em>as if</em> there were an ampersand in front of them (i.e. they will be +left-aligned at the right of the & in the first row). +</p> + +<p> +Each line but the last must end with a ``<tt>\\</tt>'' command +(which can have an optional argument to add some vertical space between +lines). +When the line is broken in the middle (e.g. after a ``+'' sign) and not at +the end (i.e. after a ``='' or similar), the *-form ``<tt>\\*</tt>'' +may be used to indicate the line-break, the difference being in an extra +space added at the beginning of the next line. +The width of a this space defaults to 1em and can be changed by the user +with ``<tt>\setlenght\MultiLineStarIndent{...}</tt>''. +</p> + +<p> +<pre> + \begin{MultiLine}[<label>] + ... [&]= ... = \\ + = ... + \\* + + ... = \\ + = ... + \end{MultiLine} +</pre> +</p> + +<p> +Also this environment has a *-form which differs only in that it does not +generate an equation number. +<pre> + \begin{MultiLine*}[<disregarded-label>] + ... [&]= ... = \\ + = ... + \\* + + ... = \\ + = ... + \end{MultiLine*} +</pre> +</p> + +<hr /><br /> +<!------------------------------------------------------------------------> + +<h3> +<a name="SECTION03c">The <tt>System</tt> environment</a> +</h3> + +<p> +The ``<tt>System</tt>'' environment is used for grouping a set of equations +together inside a left brace, with one only equation number. +</p> + +<p> +Again there is an optional argument to indicate a label and each equation +is separated by a ``<tt>\\</tt>'' or ``<tt>\\*</tt>'' command, +as for the <a href="#SECTION03b">``<tt>MultiLine</tt>'' environment</a>. +</p> + +<p> +The rows (except the ones ended with the *-form ``<tt>\\*</tt>'') +may optionally contain one ``<tt>&</tt>'', which is usually used when +some text should be added to the equation. +<pre> + \begin{System}[<label>] + ... = ... [& ...] \\ + ... = ... + \\* + + ... [& ...] \\ + ... = ... [& ...] + \end{System} +</pre> +</p> + +<p> +A *-form which does not generate any number is also provided. +<pre> + \begin{System*}[<disregarded-label>] + ... = ... [& ...] \\ + ... = ... + \\* + + ... [& ...] \\ + ... = ... [& ...] + \end{System*} +</pre> +</p> + +<hr /><br /> +<!------------------------------------------------------------------------> + +<h3> +<a name="SECTION03d">The <tt>EqSystem</tt> environment</a> +</h3> + +<p> +The ``<tt>EqSystem</tt>'' environment is used for grouping a set of equations +together inside a left brace, each with its own equation number. +</p> + +<p> +Again there is an optional argument to indicate a label and each equation is +separated by a ``<tt>\\</tt>'' or ``<tt>\\*</tt>'' command. +</p> + +<p> +The rows may optionally contain one ``<tt>&</tt>'', which is usually used +when some text should be added to the equation. +<pre> + \begin{EqSystem}[<label>] + ... = ... [& ...] \\ % (1.1) + ... = ... + \\* % + + ... [& ...] \\ % (1.2) + ... = ... [& ...] % (1.3) + \end{EqSystem} +</pre> +</p> + +<p> +A *-form is also provided: it differs in that each equation is numbered with +the same number but with a lowercase letter added, i.e. like (1.1a), (1.1b), +etc. instead of (1.1), (1.2) and so on. +<pre> + \begin{EqSystem*}[<label>] + ... = ... [& ...] \\ % (1.5a) + ... = ... + \\* % + + ... [& ...] \\ % (1.5b) + ... = ... [& ...] % (1.5c) + \end{EqSystem*} +</pre> +In both cases, if the optional argument is present, each equation can be +referenced by <tt>\ref{<label>:a}</tt>, +<tt>\ref{<label>:b}</tt>, ..., where <tt><label></tt>, +stands for the string used as optional argument. +In the case of the *-form, a reference of the kind +<tt>\ref{<label>}</tt> will print the equation number without +any letter, thus referring to the system as a whole, whereas such a +reference is meaningless (and indeed does not exists) when dealing with +the non *-form. +</p> + +<hr /><br /> +<!------------------------------------------------------------------------> + +<h2> +<a name="SECTION04">Math-mode commands</a> +</h2> + +<p> +In addition to the previously mentioned environments, the <tt>envmath</tt> +package defines also some of math-mode commands which considerably simplify +the use of adjustable-size parentheses. +</p> + +<p> +The ``<tt>\(</tt>'', ``<tt>\[</tt>'', ``<tt>\{</tt>'', +``<tt>\)</tt>'', ``<tt>\]</tt>'' and ``<tt>\}</tt>'' generates +the corresponding parenthesis but with a ``<tt>\left</tt>'' or +``<tt>\right</tt>'' declaration (respectively) added, so they must come +in matched pairs or coupled with a ``<tt>\left.</tt>'' or +``<tt>\rigtht.</tt>'' or another adjustable-size delimiter. +</p> + +<hr /><br /> +<!------------------------------------------------------------------------> + +<address> + <i>F. Bosisio</i><br /> + E-mail: <a href="mailto:fbosisio@bigfoot.com"><tt>fbosisio@bigfoot.com</tt></a> +</address> + +<!------------------------------------------------------------------------> + +</body> +</html> |