summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/boolexpr/README
diff options
context:
space:
mode:
authorNorbert Preining <norbert@preining.info>2019-09-02 13:46:59 +0900
committerNorbert Preining <norbert@preining.info>2019-09-02 13:46:59 +0900
commite0c6872cf40896c7be36b11dcc744620f10adf1d (patch)
tree60335e10d2f4354b0674ec22d7b53f0f8abee672 /macros/latex/contrib/boolexpr/README
Initial commit
Diffstat (limited to 'macros/latex/contrib/boolexpr/README')
-rw-r--r--macros/latex/contrib/boolexpr/README64
1 files changed, 64 insertions, 0 deletions
diff --git a/macros/latex/contrib/boolexpr/README b/macros/latex/contrib/boolexpr/README
new file mode 100644
index 0000000000..aefb3b73bd
--- /dev/null
+++ b/macros/latex/contrib/boolexpr/README
@@ -0,0 +1,64 @@
+% boolexpr : Purely expandable boolean expressions and switch (eTeX - v3.1 2009/09/30)
+%
+% The \boolexpr macro evaluate boolean expressions in a *purely expandable way*.
+%
+% \boolexpr{ A \OR B \AND C } expands to 0 if the logical expression is TRUE.
+%
+% A, B, C may be :
+% - numeric expressions such as: x = y, x <> y, x > y or: x < y
+% - boolean switches: \iftrue 0\else 1\fi
+% - conditionals: \ifcsname whatsit\endcsname 0\else 1\fi
+% - another \boolexpr: \boolexpr{ D \OR E \AND F }
+%
+% \boolexpr may be used with \ifcase:
+% \ifcase\boolexpr{ A \OR B \AND C }
+% What to do if true
+% \else
+% What to do if false
+% \fi
+%
+% \switch remains *purely expandable* (it may be used inside \csname...\endcsname f.ex.)
+%
+% \switch
+% \case{ boolean expression} to do in first case
+% \case{ boolean expression} to do in second case
+% \otherwise to do if no case were true
+% \endswitch
+%
+% \switch may have an optional argument to repeat in each \case evaluation, e.g. :
+%
+% \switch[\value{myCounter}]
+% %|--| ---------------------------------------------------> |--|
+% \case{>=12}It's $>=12$% => \case will expand to : \case{\value{myCounter}>=12}
+% \case{=1}It's $1$% => \case will expand to : \case{\value{myCounter}=1}
+% \otherwise ...
+% \endswitch
+%
+% or : *(NB the double curly braces)*
+% \switch[\pdfstrcmp{dummy}}]
+% %|-----| ------------------------------------------------> |-----|
+% \case{{first}}It's "FiRsT"% => \case{\lowercase{\ifstrequal{dummy}}{first}}
+% \case{{second}}It"s "SeCoNd"%=> \case{\lowercase{\ifstrequal{dummy}}{second}
+% \endswitch
+%
+% *********************************************************************************
+% This work consists of the main source file boolexpr.dtx and the derived
+% files : boolexpr.sty, boolexpr.pdf, boolexpr.ins
+%
+% Some examples are included in the documentation: it is preferable (albeit
+% not necessary) to install boolexpr.sty before compiling the documentation.
+%
+% Unpacking:
+% (a) If boolexpr.ins is present:
+% etex boolexpr.ins
+% (b) Without boolexpr.ins:
+% etex boolexpr.dtx
+% (c) If you insist on using LaTeX
+% latex \let\install=y\input{boolexpr.dtx}
+% (quote the arguments according to the demands of your shell)
+%
+% Documentation:
+% (pdf)latex boolexpr.dtx
+% makeindex -s gind.ist boolexpr.idx
+%
+% F Chervet - Jul-Sep 2009 \ No newline at end of file