tgkolda / siam-latex Goto Github PK

From James Haines email on 7/17/15, item 3.

If you’re in the appendices and have a subsection or a subsubsection, it has the word “Appendix” before its number. For instance, if you have:

\documentclass[final,leqno]{siamart}
\begin{document}
\appendix
\section{Appendix}
\subsection{Subappendix}
\subsubsection{Subsubappendix}
\end{document}

It prints as:

Appendix A. Appendix.
Appendix A.1. Subappendix.
Appendix A.1.1. Subsubappendix.

It should be:

Appendix A. Appendix.
A.1. Subappendix.
A.1.1. Subsubappendix.

We also found that if you do:

\documentclass[final,leqno]{siamart}
\begin{document}
\appendix
\section{An appendix}\label{A}
\section{Another appendix}\label{B}
Let's refer to \cref{A,B}.
\end{document}

It prints as:

Appendix A. An appendix.
Appendix B. Another appendix. Let’s refer to Appendices Appendix A and Appendix B.

Typing “Let's refer to \ref{A} and \ref{B}.” prints as “Let’s refer to Appendix A and Appendix B.” and we don’t see how to get “Let’s refer to Appendices A and B.” as we would need to.

Further, if you do:

\documentclass[final,leqno]{siamart}
\numberwithin{theorem}{section}
\numberwithin{equation}{section}
\begin{document}
\appendix
\section{An appendix}
\begin{theorem}
A short theorem.
\end{theorem}
An equation:
\begin{equation}
x+y=z
\end{equation}
\end{document}

You’ll see that the theorem heading comes out as “Theorem Appendix A.1.”, and the equation number as “(Appendix A.1)”.

From James Haines email on 7/17/15, issue 10.

Equation ranges with \cref are not displaying as they should. They result in “(1--3)” instead of “(1)--(3)” as needed.

\documentclass[final,leqno]{siamart}
\begin{document}
Three numbered equations:
\begin{align}
a &= b+c, \label{eq1}
d &= e+f, \label{eq2}
g &= h+i. \label{eq3}
\end{align}
\Cref{eq1,eq2,eq3} are useful. We can solve \cref{eq1,eq2,eq3} like this.
\end{document}

The last line prints as “Equations (1--3) are useful. We can solve (1--3) like this.” What needs to be done so that this results in “Equations (1)--(3) are useful. We can solve (1)--(3) like this.” instead?

From James Haines email on 7/17/15, item 5.

We think the bottom line of Example 3 in docsiamart.pdf should be:

{\MakeUppercase{\siampretitle Guide to Using SIAM'S \LaTeX\ Style}}

(removing the @), since the \siampretitle command seems to be defined to print a space no matter what. (With the extra @, you seem to get two spaces between “SUPPLEMENTARY MATERIALS:” and the rest of the short title.)

We have created a new siamplain.bst, but David Gleich requested also a siamalpha.bst.

Regarding the last issue mentioned in https://github.com/tgkolda/siam-latex/blob/master/requirements.md

@misc{clawpack,
  title={Clawpack software},
  author={{Clawpack Development Team}},
  url={http://www.clawpack.org},
  note={Version x.y},
  year={2013}}

with two sets of braces around the "author" results in "Clawpack Development Team" in the bibliography (alphabetized at C) rather than "C. D. Team".

More generally -- how much guidance do we want to give on how to cite software? Some packages explain how to cite in their documentation, many don't.

From James Haines email on 7/17/15, issue 6.

Steve here at SIAM says that he has noticed for some time that if you set your running heads up with just:

\pagestyle{myheadings}
\markboth{\MakeUppercase{H. Ammari, K. Kang, K. Lee, and J. K. Seo}}{\MakeUppercase{Pressure Distribution Imaging Using EIT}}

immediately before the \begin{document} (and nothing else later on), the headers and footers will come out correctly on all pages, even on the first one. That way you don’t have to worry about those commands ending up on the second page of the paper and making something come out wrong. He personally recommends this as an additional tweak to the macro.

From James Haines email on 7/17/15, item 4.

There are a few pairs of \makeatletter and \makeatother commands in the .cls file (lines 1272, 1275, 1324, and 1331) that should not be there. In class and package files, one can use commands containing @ in their names without doing anything special (In fact, the .cls file already uses such commands without preceding them with a \makeatletter). The \makeatother’s might even cause harm if there are any commands containing @ after them.

(See http://latex-project.org/guides/clsguide.pdf on page 6, section 2.4, the paragraph beginning “Finally, there are the internal ...” which mentions this fact about commands with @ in their names.)

From James Haines email on 7/17/15, issue 13.

Are the changes to how the captions of figures and tables are displayed intentional? Steve recommends that we load the subfig package with:

\usepackage[caption=false]{subfig}

I find the mathtools package very convenient http://ctan.org/pkg/mathtools. By default it loads amsmath and fixes var­i­ous de­fi­cien­cies of ams­math that I consistently have found use for. Perhaps we could load mathtools by default?

This is technically complicated enough that we currently require separate bibliographies.

Requested by Matt Knepley.

Example doc:

\documentclass[final,leqno]{siamart}

\begin{document}

Some equations:
\begin{align}
a &= b+c, \label{eq1}
d &= e+f, \label{eq2}
\end{align}

\Cref{eq1,eq2}.

\begin{theorem}\label{thm1}
A theorem.
\end{theorem}

\begin{theorem}\label{thm2}
A theorem.
\end{theorem}

\Cref{thm1,thm2}.

\end{document}

The first “1” in the example is a link to equation (1), “(2)” (i.e., the number plus the parentheses) is a link to equation (2), “Theorems 1” is a link to Theorem 1, and that last “2” is a link to Theorem 2.

Cref doesn't appear to be totally consistent what text it turns into a link. What behavior is intended? We expected the links to turn out as they did for the Theorems, but were surprised by the equations being treated differently.

From James Haines email on 7/17/15, issue 12a.

If you have something like

\documentclass[final,leqno]{siamart}
\newsiamremark{hypothesis}{Hypothesis}
\crefname{hypothesis}{Hypothesis}{Hypotheses}
\begin{document}
\begin{hypothesis}\label{hyp1}
A short hypothesis.
\end{hypothesis}
\begin{hypothesis}\label{hyp2}
A short hypothesis.
\end{hypothesis}
Now let's refer to \cref{hyp1,hyp2}. \Cref{hyp1,hyp2} are useful.
Now let's refer to \cref{hyp1}. \Cref{hyp1} is useful.
\end{document}

The hypothesis headings come out “Hypothesis 1.” with the number in italic rather than upright as it should be.

Also, it seems that if there’s a \cref command inside an italic environment, like this:

\documentclass[final,leqno]{siamart}
\begin{document}
\begin{theorem}\label{thm1}
A short theorem.
\end{theorem}
\begin{theorem}\label{thm2}
A short theorem that refers to \cref{thm1}.
\end{theorem}
\end{document}

There’s doesn’t appear to be an easy way to romanize just the number, in this instance the “1” in "Theorem 1." If we do the obvious “A short theorem that refers to \textup{\cref{thm1}}.”, it prints as

A short theorem that refers to Theorem 1.

John from Techsetters recommends incorporating something along the lines of the following to enable EPS figures to run with the macros while using pdfLaTeX by converting EPS to PDF on-the-fly:

\RequirePackage{ifpdf}
\ifpdf
\RequirePackage{color}
\definecolor{header1}{cmyk}{0,0,0,1}
\definecolor{blue1}{cmyk}{0,0,0,1}
\definecolor{blue2}{cmyk}{0,0,0,1}
\definecolor{maroon}{cmyk}{0,0,0,1}
\definecolor{gold1}{cmyk}{0,0,0,1}
\definecolor{gray}{cmyk}{0,0,0,1}
\definecolor{green1}{cmyk}{0,0,0,1}
\definecolor{proofcolor}{cmyk}{0,0,0,1}
\definecolor{red1}{cmyk}{0,0,0,1}
\definecolor{orange1}{cmyk}{0,0,0,1}
\definecolor{strip}{cmyk}{0,0,0,1}
\RequirePackage{graphics,graphicx}
\usepackage{epstopdf}
\RequirePackage[colorlinks]{hyperref}
\hypersetup{colorlinks,naturalnames=false,hypertexnames=false,breaklinks}
\urlstyle{same}
\newcommand{\mref}[1]{\href{mailto:#1}{#1}}
\def\wwwbrowser{C:\string\Program\space
Files\string\Plus!\string\Microsoft\space
Internet\string\iexplore.exe}
\definecolor{extlink}{cmyk}{0,0,0,1}
\definecolor{intlink}{cmyk}{0,0,0,1}
\definecolor{softpage}{cmyk}{0,0,0,1}
\def@linkcolor{intlink}
\def@anchorcolor{black}
\def@citecolor{intlink}
\def@filecolor{cyan}
\def@urlcolor{extlink}
\def@menucolor{red}
\newcommand{\email}[1]{\protect\href{mailto:#1}{#1}}
\newcommand{\web}[1]{\href{#1}{#1}}
\else%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%not pdflatex
\RequirePackage[dvips]{color}
\definecolor{header1}{cmyk}{0,0,0,1}
\definecolor{blue1}{cmyk}{0,0,0,1}
\definecolor{blue2}{cmyk}{0,0,0,1}
\definecolor{maroon}{cmyk}{0,0,0,1}
\definecolor{gold1}{cmyk}{0,0,0,1}
\definecolor{gray}{cmyk}{0,0,0,1}
\definecolor{green1}{cmyk}{0,0,0,1}
\definecolor{proofcolor}{cmyk}{0,0,0,1}
\definecolor{red1}{cmyk}{0,0,0,1}
\definecolor{orange1}{cmyk}{0,0,0,1}
\definecolor{strip}{cmyk}{0,0,0,1}
\RequirePackage[dvips]{graphics,graphicx}
\RequirePackage[colorlinks,pdfmark,dvips]{hyperref}
\hypersetup{colorlinks,pdfmark,dvips,naturalnames=false,hypertexnames=false,breaklinks}
\urlstyle{same}
\usepackage{breakurl}
\usepackage{hypdvips}
\newcommand{\mref}[1]{\burlalt{mailto:#1}{#1}}
\def\wwwbrowser{C:\string\Program\space
Files\string\Plus!\string\Microsoft\space
Internet\string\iexplore.exe}
\definecolor{extlink}{cmyk}{0,0,0,1}
\definecolor{intlink}{cmyk}{0,0,0,1}
\definecolor{softpage}{cmyk}{0,0,0,1}
\def@linkcolor{intlink}
\def@anchorcolor{black}
\def@citecolor{intlink}
\def@filecolor{cyan}
\def@urlcolor{extlink}
\def@menucolor{red}
\newcommand{\email}[1]{\protect\href{mailto:#1}{#1}}
\newcommand{\web}[1]{\href{#1}{#1}}
\fi%%%%%%%%end of ifpdf

This comes from a problem with bibtex itself, see
http://tex.stackexchange.com/questions/128556/bibtex-plain-consistency-mystery-with-inproceedings-entries

The question is, should we fix inproceedings and proceedings or just advise folks to use incollection instead?

From James Haines email on 7/17/15, item 14.

The .cls file contains the following lines that Steve here at SIAM added long ago when he was trying to get extra space around theorems (lines 767, etc.):

\newlength{@sectionspace}
\setlength{@sectionspace}{1.3ex @plus .5ex @minus .2ex} %the space added before a new section
\newlength{@negsectionspace}
\setlength{@negsectionspace}{-1.3ex @plus -.5ex @minus -.2ex} %its negation

\newcommand{\insertsectionspace}{\addvspace{@sectionspace}}
\newcommand{\removesectionspace}{\vspace{@negsectionspace}} %I didn't end up needing these, but they might be needed somewhere

We assume these aren’t being used anymore and Steve recommends that they be removed (along with a lot of the old commented-out code).

This seems to be a function of the weirdness of how author names and thanks are processed. There is no problem with the same web page in the main body of the document.

\url{{http://www.sandia.gov/~tgkolda/}

From James Haines email on 7/17/15, issue 11.

How does one get a special theorem-numbering system? We assume we should be able to do this completely automatically, but if we want theorems numbered within sections and examples numbered singly in a separate sequence (we regularly see papers that do things like this) we don’t see how to get it. This doesn’t work:

\documentclass[final,leqno]{siamart}
\numberwithin{theorem}{section}
\newsiamremark{example}{Example} %I want this to be single-numbered
\begin{document}
\setcounter{section}{1}
\begin{theorem}\label{thm1.1}
A short theorem.
\end{theorem}
\begin{example}\label{ex1} %comes out "Example 1.2", not "Example 1"
A short example.
\end{example}
\end{document}

Looking at how the .cls file sets up the theorem-making commands, would it be a problem to change them so you can do this in the preamble:

\siamthmstylenormal %subsequent new theorem-like items will be created with caps-small-caps head and italic body; this will be on by default
\newtheorem{claim}{Claim}
\siamthmstyledefn %subsequent new theorems will be created with caps-small-caps head and roman body
\newtheorem{assumption}{Assumption}
\siamthmstyleremark %subsequent new theorems will be created with italic head and roman body
\newtheorem{example}{Example}

i.e., sort of like how the amsthm package does it.

From James Haines email on 7/17/15, item 15.

In the interest of making things a little clearer, Steve further recommends setting the \parskip to 0pt (so that there is no extra space between paragraphs), removing the “\setlength{\parskip}{1\parskip}” on line 1259, and on line 358 change “\setlength\parskip{0\p@ @plus \p@}” to just “\setlength\parskip{0\p@}”. Further, on lines 1242 and 1243 which are currently:

\newcommand{\mref}[2]{\href{mailto:#1}{#2}}
\renewcommand{\mref}[1]{\burlalt{mailto:#1}{#1}}%new

Delete the first of those lines and just make the second “\newcommand{\mref}[1]{\burlalt{mailto:#1}{#1}}”.

From James Haines email on 7/17/15, issue 8.

Example 17 in docsiamart.pdf implies that it’s all right to have definitions with roman instead of italic text. This needs to be corrected.

If one is trying to do this in the obvious way with \newsiamthm and \newsiamremark, the numbering comes out as Theorem 1, Corollary 2, Corollary 3, Remark 4, etc.

Was there something else intended that didn't get included with the instructions in docsiamart to keep this from happening?

To get these to work properly, we had to define some theorem-like items with \newtheorem:

%special "theorems":
\theoremstyle{plain}
\theoremheaderfont{\normalfont\sc}
\theorembodyfont{\normalfont\itshape}
\theoremseparator{.}
\theoremsymbol{}
\newtheorem{thm}{Theorem}
\newtheorem{cor}{Corollary}

%special "remarks":
\theoremstyle{plain}
\theoremheaderfont{\normalfont\itshape}
\theorembodyfont{\normalfont}
\theoremseparator{.}
\theoremsymbol{}
\newtheorem{rem}{Remark}

Which results in Theorem 1, Corollary 1, Corollary 2, Remark 1, etc.

My first attempt to run latex or pdflatex on siamlatex/docsiamart.tex failed with a host of error messages, on a MacBook using pdfTeX 3.1415926-2.4-1.40.13 (TeX Live 2012). The error messages start at about line 675 in https://github.com/rjleveque/siam-latex/blob/old_latex_log/siamlatex/docsiamart.log

I just updated to pdfTeX 3.14159265-2.6-1.40.15 (TeX Live 2014) and now it compiles fine.

I suspect many authors will be at least as out of date as I was. Is it a problem if they can't use the SIAM style without upgrading?

At the beginning of Section 4, along with the reference \cite{MiGo04}, it might be useful to point readers to online info about amsmath? Such as

• ftp://ftp.ams.org/pub/tex/doc/amsmath/short-math-guide.pdf
• ftp://ftp.ams.org/pub/tex/doc/amsmath/amsldoc.pdf

which can be found from http://www.ams.org/publications/authors/tex/amslatex and are
useful for looking up how to do things, or finding symbols.

The SIAM Style Manual (p31) requires references to section numbers to use the word "section", rather than the symbol "§", e.g., "see section 3.2", rather than "see §3.2". The class file, however, implements the former.

Truth is, I prefer the section symbol, and use it by default, only to find myself changing them all back to SIAM's preferred "section" on submission.

Do we need to adhere to SIAM's style, or does the revised style file imply our request for SIAM to modify the current requirements?

The standard way we remove the period from the end of a section heading is by putting a \nopunct in the section command like this:

\section{What is to be done?\nopunct}

Well, that no longer works when the section is in the appendices. (It comes out as, say, “Appendix A. What is to be done?.”, with the period after the question mark.) We can make the \nopunct work if we change the \append and \sappend commands to

\newcommand\append[2][?]{%
\refstepcounter{section}%
{\par\addvspace{@sectionspace}
\reset@font\normalsize\bfseries\appendixname\ \thesection. #2@mypunct{} }%
\addcontentsline{toc}{section}{\appendixname~\thesection. #2}%
\gobblepars
}

\newcommand\sappend[1]{%
{\par\addvspace{@sectionspace}
\reset@font\normalsize\bfseries#1@mypunct{} }%
\addcontentsline{toc}{section}{#1}%
\gobblepars
}

In coming up with a solution, the only thing different that Steve did was to replace two of the periods with "@mypunct{}". We tested this a bit and it appears to work without messing anything else up.

I'm using the new style files for a paper with a long title. The way the example is set up, it tries to put the long title in the running head, where it doesn't fit.

Perhaps in ex_shared.tex we should illustrate this by adding:

% Replace \TheTitle by shorter version if full title is too long for running header:
\newcommand{\ShortTitle}{\TheTitle}  

% Sets running headers as well as PDF title and authors
\headers{\ShortTitle}{\TheAuthors}

From James Haines email on 7/17/15, issue 12b.

Another concern discovered with testing \cref is that, rather than just the number being clickable in a link (i.e., “Table~\ref{xxx}”), if you type “\cref{xxx}” the whole phrase “Table 1” (or whatever) will be a clickable link. However, we are finding that either the phrase “Table 1” won’t be hyphenated/justified (if “breaklinks” is turned off) or it won’t link to anything if it breaks across two lines (if “breaklinks” is turned on).

From James Haines email on 7/17/15, issue 9.

Is there a way to make a proof start with something other than “Proof.”? If we do:

\documentclass[final,leqno]{siamart}
\begin{document}
\begin{proof}[of main theorem]
A proof with a new name.
\end{proof}
\end{document}

The proof comes out as “Proof (of main theorem). A proof with a new name. [space plus end-of-proof box]”. We can’t see anything in the instructions about how to get “Proof of main theorem. A proof with a new name. [space plus end-of-proof box]” instead.

From James Haines email on 7/17/15, item 2.

Regarding the bookmark feature, we noticed that we needed to type:

\section{For \texorpdfstring{{\boldmath$X\cup Y$}}{\textdollar X \textbackslash cup Y\textdollar} or something else}

So that the bookmark comes out as “For $X \cup Y$ or something else” verbatim. There doesn't seem to be an easier way to do this and it does come up on occasion so we received warnings when running our test papers if we didn't put math or certain other special commands inside a \texorpdfstring command (see: http://www.tex.ac.uk/FAQ-texorpdf.html). For further example,

\section{What?\texorpdfstring{\nopunct}{}}
\section{For \texorpdfstring{{\boldmath$x$}}{x} large}
\section{For \texorpdfstring{{\boldmath$y=\frac{1}{2}$}}{y=1/2} or something else}

Authors should be required to provide the DOIs. If they do not provide them, they will be requested during the copyediting phase. The SIAM style manual will be updated to reflect this.

From James Haines email on 7/17/15, issue 7.

It doesn’t look as if the space around theorems and proofs stretches or shrinks in the way that space around equations and before new sections does. Our best quess is that the lines:

\theorempreskip{1ex}
\theorempostskip{1ex}

in the siamart.cls file could be changed to:

\theorempreskip{1ex plus .25ex minus .1ex}
\theorempostskip{1ex plus .25ex minus .1ex}

Not necessarily using those values for “plus” and “minus”, of course (the space before a new section is “1.3ex plus .5ex minus .2ex”; it’s set in the @startsection commands).

From James Haines email on 7/17/2015, item 1.

The docsiamart.pdf instructions (Examples 1 and 2) seem to imply that people should put \title, \subtitle, and \author after \begin{document} but before \maketitle. Could this be changed to put those three items in the preamble, just before \begin{document}, like this:

\documentclass[…]{siamart}

\title{The Title of the Article\thanks{…
\URL{…}}}

\subtitle{…}

\author{Dianne Doe\thanks{…}
\and Paul T. Frank\thanks{…}
\and Jane E. Smith\footnotemark[3]}

\begin{document}
%siam_id=
%CODEN=
\slugger{siap}{20XX}{0}{0}{000--000}
\maketitle

The SIAM pagination macro works only if \title comes before \begin{document} and if we get a paper at pagination that has them the other way around, we have to switch them. This naturally doesn't need to be explicitly explained to the user, but it would help if the examples used this order.

Steve noticed that we are best off starting an appendix section like this:

\section{An appendix}\label{appA}%
Here is the start of the appendix.

If you don’t have that % to “attach” the \label to the “Here”, you get too much space between “An appendix.” and “Here”.

From James Haines, July 9, 2015:

Regarding the “For review purposes only” issue with the review class of the macro, Steve here at SIAM mentioned that you can change the copyright notice and the footer at the very bottom of each page by adding:

\renewcommand{\footercopyright}{For review purposes only.}

\copyrightlineone{SIAM@. Published by SIAM under the terms}
\copyrightlinetwo{of the Creative Commons 4.0 license}

to the preamble. This is set up in the definitions of \ps@plain and \ps@myheadings, which use the command \f@@terwithc@pyright (and a few related commands) that he defined a little above those. So if you are trying to set that up, that’s where to start looking.

The pages are currently offset of the left. We have a request to center the pages.