summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/optidef
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2017-06-22 22:35:49 +0000
committerKarl Berry <karl@freefriends.org>2017-06-22 22:35:49 +0000
commit8a0cee58cc8a81c1afc562c1644b2356f2dbf84c (patch)
tree7bfe24189afd1541daf3b517d086bbe8c7e62798 /Master/texmf-dist/doc/latex/optidef
parentbdb82a6f104d448ea7d31a4f464b8f2af69577ca (diff)
optidef (21jun17)
git-svn-id: svn://tug.org/texlive/trunk@44669 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/latex/optidef')
-rw-r--r--Master/texmf-dist/doc/latex/optidef/README.md4
-rw-r--r--Master/texmf-dist/doc/latex/optidef/optidef.pdfbin269670 -> 282569 bytes
-rw-r--r--Master/texmf-dist/doc/latex/optidef/optidef.tex40
3 files changed, 38 insertions, 6 deletions
diff --git a/Master/texmf-dist/doc/latex/optidef/README.md b/Master/texmf-dist/doc/latex/optidef/README.md
index e6dde606dab..0a0889242e0 100644
--- a/Master/texmf-dist/doc/latex/optidef/README.md
+++ b/Master/texmf-dist/doc/latex/optidef/README.md
@@ -62,11 +62,11 @@ Finally note that \begin{mini#} can be substituted by \begin{maxi#}, \begin{argm
## Contact for issue reporting or suggestions
-E-mail: j.lagogarcia(at)tudelft.nl
+E-mail: J.LagoGarcia(at)tudelft.nl
Github: https://github.com/jeslago/optidef
-## Latest stable version: Optidef 2.4
+## Latest stable version: Optidef 2.5
CTAN: https://www.ctan.org/pkg/optidef
diff --git a/Master/texmf-dist/doc/latex/optidef/optidef.pdf b/Master/texmf-dist/doc/latex/optidef/optidef.pdf
index 1b3dc5b3b18..a8c2de08b21 100644
--- a/Master/texmf-dist/doc/latex/optidef/optidef.pdf
+++ b/Master/texmf-dist/doc/latex/optidef/optidef.pdf
Binary files differ
diff --git a/Master/texmf-dist/doc/latex/optidef/optidef.tex b/Master/texmf-dist/doc/latex/optidef/optidef.tex
index dd146952fe5..02ee52f3404 100644
--- a/Master/texmf-dist/doc/latex/optidef/optidef.tex
+++ b/Master/texmf-dist/doc/latex/optidef/optidef.tex
@@ -7,7 +7,7 @@
\lstset{basicstyle=\ttfamily,breaklines=true}
% Title Page
-\title{\textit{\textbf{Optidef}} \\ A Latex library for optimization problems\\ \textnormal{Version - 2.4}}
+\title{\textit{\textbf{Optidef}} \\ A Latex library for optimization problems\\ \textnormal{Version - 2.5}}
\author{Jesus Lago Garcia}
@@ -683,9 +683,41 @@ The standard appearance for long optimization variables is as follows:
\addConstraint{r(x_0,x_N)}{= 0. \label{dOCP:boundary}}
\end{mini!}
+\section{Compatibility issues with other packages}
+When using the cleveref package in couple with the optidef package two measures have to taken for the packages to work properly:
+
+\begin{enumerate}
+ \item As also indicated in the cleveref documentation, the optidef package has to be loaded before the cleveref package.
+ \item To avoid crashes, the \verb|\label| commands in the optidef environments have to be replaced by the protected counterparts \verb|\protect\label|. This is required because of the standard Latex issue of moving arguments and fragile commands\footnote{\url{goo.gl/wmKbNU}}.
+\end{enumerate}
+
+\noindent A code example taking into account both measures is the following:
+
+\begin{verbatim}
+ \documentclass{article}
+ \usepackage{optidef}
+ \usepackage{cleveref}
+
+ \begin{document}
+
+ \begin{mini!}
+ {w}{f(w)+ R(w+6x) \protect\label{eq:ObjectiveExample1}}
+ {\label{eq:Example1}}{}
+ \addConstraint{g(w)}{=0 \protect\label{eq:C1Example3}}
+ \addConstraint{n(w)}{= 6 \protect\label{eq:C2Example1}}
+ \addConstraint{L(w)+r(x)}{=Kw+p \protect\label{eq:C3Example1}}
+ \end{mini!}
+
+ Example labels: \cref{eq:Example1} and \cref{eq:ObjectiveExample1}.
+
+ \end{document}
+\end{verbatim}
+
+
+
\section{Code definition}
\begin{lstlisting}
-% optidef - Version 2.4
+% optidef - Version 2.5
%
%Copyright 2017 J. Lago Garcia
%
@@ -694,12 +726,12 @@ The standard appearance for long optimization variables is as follows:
%
%This work has the LPPL maintenance status 'maintained'. The Current Maintainer of this work is J. Lago Garcia.
%
-%E-mail: j.lagogarcia@tudelft.nl
+%E-mail: J.LagoGarcia@tudelft.nl
%
%This work consists of the file optidef.sty.
\NeedsTeXFormat{LaTeX2e}
-\ProvidesPackage{optidef}[2017/05/24 - version=2.4, Package for defining optimization problems]
+\ProvidesPackage{optidef}[2017/06/21 - version=2.5, Package for defining optimization problems]
\RequirePackage{environ}
\RequirePackage{mathtools}