diff options
Diffstat (limited to 'Master/texmf-dist/doc/latex/bosisio/mathenv.html')
-rw-r--r-- | Master/texmf-dist/doc/latex/bosisio/mathenv.html | 414 |
1 files changed, 414 insertions, 0 deletions
diff --git a/Master/texmf-dist/doc/latex/bosisio/mathenv.html b/Master/texmf-dist/doc/latex/bosisio/mathenv.html new file mode 100644 index 00000000000..6caa594a577 --- /dev/null +++ b/Master/texmf-dist/doc/latex/bosisio/mathenv.html @@ -0,0 +1,414 @@ +<HTML> + +<!------------------------------------------------------------------------> + +<HEAD> +<TITLE>Package mathenv</TITLE> +</HEAD> +<BODY > + +<!------------------------------------------------------------------------> +<P> + +<H1 ALIGN="CENTER"> +Package <TT>mathenv</TT><BR> +<SMALL> +This is version 2.2, last revised 1998/02/04; documentation date 1998/02/06. +</SMALL> +</H1> + +<P ALIGN="CENTER"> +<STRONG> +Author: <I>F. Bosisio</I><BR> +<SMALL> +E-mail: <A HREF="MAILTO:bosisio@mate.polimi.it"> + <TT>bosisio@mate.polimi.it</TT> + </A><BR> +Web page: <A HREF="http://ftp.mate.polimi.it/~bosisio/LaTeX"> + <TT>http://ftp.mate.polimi.it/~bosisio/LaTeX</TT> + </A><BR> +CTAN location: <A HREF="http://www.tex.ac.uk/tex-archive/macros/latex/contrib/supported/bosisio/"> + <TT>CTAN:macros/latex/contrib/supported/bosisio/</TT> + </A> +</SMALL> +</STRONG> +</P> + +<P ALIGN="LEFT"></P> + +<!------------------------------------------------------------------------> +<P> + +<H3>Abstract</H3> +<DIV> +Documentation for the package <TT>mathenv</TT>. +</DIV> + +<HR><BR> +<!------------------------------------------------------------------------> + +<H2>Table of contents</H2> + +<P> +<UL> <!-- Beginning of list --> + <LI><A HREF="#SECTION01">Introduction</A> + <LI><A HREF="#SECTION02">The options</A> + <LI><A HREF="#SECTION03">Math-mode environments</A> + <UL> <!-- Beginning of sublist --> + <LI><A HREF="#SECTION03a">The <TT>Equation</TT> environment</A> + <LI><A HREF="#SECTION03b">The <TT>MultiLine</TT> equation environment</A> + <LI><A HREF="#SECTION03c">The <TT>System</TT> environment</A> + <LI><A HREF="#SECTION03d">The <TT>EqSystem</TT> environment</A> + </UL> <!-- End of sublist --> + <LI><A HREF="#SECTION04">Math-mode commands</A> +</UL> <!-- End of list --> +</P> + +<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>mathenv</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>mathenv</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>Francesco Bosisio</I><BR> +E-mail: <A HREF="MAILTO:bosisio@mate.polimi.it"> + <TT>bosisio@mate.polimi.it</TT> + </A><BR> +Web page: <A HREF="http://ftp.mate.polimi.it/~bosisio/LaTeX"> + <TT>http://ftp.mate.polimi.it/~bosisio/LaTeX</TT> + </A> +</ADDRESS> + +<!------------------------------------------------------------------------> + +</BODY> +</HTML> + |