diff --git a/CHANGELOG.md b/CHANGELOG.md --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,17 @@ +## 0.3.9.1 + +- [CI] Bump pandoc version +- [Stack] Bump versions in stack.yaml +- [LaTeX][Tests] Update tests for subfigures +- [LaTeX][Tests] Update tests for pandoc 2.11.4 +- [LaTeX] Remove footnotes from "short" subfigure caption (used for lof) +- [LaTeX] An attempt at fixing footnotes inside subfigure env + +Note that this is a fix-release, but it includes some rather drastic changes to +the way subfigures are handled in LaTeX output. Couldn't fix the issue +otherwise. See for +context and some additional pointers. + ## 0.3.9.0 ### New features diff --git a/lib/Text/Pandoc/CrossRef/References/Blocks.hs b/lib/Text/Pandoc/CrossRef/References/Blocks.hs --- a/lib/Text/Pandoc/CrossRef/References/Blocks.hs +++ b/lib/Text/Pandoc/CrossRef/References/Blocks.hs @@ -139,18 +139,23 @@ case outFormat opts of f | isLatexFormat f -> replaceNoRecurse $ Div nullAttr $ - [ RawBlock (Format "latex") "\\begin{figure}\n\\centering" ] + [ RawBlock (Format "latex") "\\begin{pandoccrossrefsubfigures}" ] <> cont <> - [ Para [RawInline (Format "latex") "\\caption" + [ Para [RawInline (Format "latex") "\\caption[" + , Span nullAttr (removeFootnotes caption) + , RawInline (Format "latex") "]" , Span nullAttr caption] , RawBlock (Format "latex") $ mkLaTeXLabel label - , RawBlock (Format "latex") "\\end{figure}"] + , RawBlock (Format "latex") "\\end{pandoccrossrefsubfigures}"] _ -> replaceNoRecurse $ Div (label, "subfigures":cls, attrs) $ toTable cont capt where opts' = opts { figureTemplate = subfigureChildTemplate opts , customLabel = \r i -> customLabel opts ("sub"<>r) i } + removeFootnotes = walk removeFootnote + removeFootnote Note{} = Str "" + removeFootnote x = x toTable :: [Block] -> [Inline] -> [Block] toTable blks capt | subfigGrid opts = [ simpleTable align (map ColWidth widths) (map blkToRow blks) diff --git a/lib/Text/Pandoc/CrossRef/Util/ModifyMeta.hs b/lib/Text/Pandoc/CrossRef/Util/ModifyMeta.hs --- a/lib/Text/Pandoc/CrossRef/Util/ModifyMeta.hs +++ b/lib/Text/Pandoc/CrossRef/Util/ModifyMeta.hs @@ -49,6 +49,7 @@ tell subfig tell floatnames tell listnames + tell subfigures unless (listings opts) $ tell codelisting tell lolcommand @@ -74,6 +75,24 @@ , "\\renewcommand*\\listfigurename{" <> metaString' "lofTitle" <> "}" , "\\renewcommand*\\listtablename{" <> metaString' "lotTitle" <> "}" , "}" + ] + subfigures = [ + "\\newcounter{pandoccrossref@subfigures@footnote@counter}" + , "\\newenvironment{pandoccrossrefsubfigures}{%" + , "\\setcounter{pandoccrossref@subfigures@footnote@counter}{0}" + , "\\begin{figure}\\centering%" + , "\\gdef\\global@pandoccrossref@subfigures@footnotes{}%" + , "\\DeclareRobustCommand{\\footnote}[1]{\\footnotemark%" + , "\\stepcounter{pandoccrossref@subfigures@footnote@counter}%" + , "\\ifx\\global@pandoccrossref@subfigures@footnotes\\empty%" + , "\\gdef\\global@pandoccrossref@subfigures@footnotes{{##1}}%" + , "\\else%" + , "\\g@addto@macro\\global@pandoccrossref@subfigures@footnotes{, {##1}}%" + , "\\fi}}%" + , "{\\end{figure}%" + , "\\addtocounter{footnote}{-\\value{pandoccrossref@subfigures@footnote@counter}}" + , "\\@for\\f:=\\global@pandoccrossref@subfigures@footnotes\\do{\\stepcounter{footnote}\\footnotetext{\\f}}%" + , "\\gdef\\global@pandoccrossref@subfigures@footnotes{}}" ] codelisting = [ usepackage [] "float" diff --git a/pandoc-crossref.cabal b/pandoc-crossref.cabal --- a/pandoc-crossref.cabal +++ b/pandoc-crossref.cabal @@ -4,10 +4,10 @@ -- -- see: https://github.com/sol/hpack -- --- hash: f420e59b52c7b2a0721bad7e6dcccdadc76346e81ef5ee0ced55461962dc3a15 +-- hash: 5ca00ee6e80501d52f8cd0b7fdfc2fe2b83fc57a68b1c2efe471f696dd95567b name: pandoc-crossref -version: 0.3.9.0 +version: 0.3.9.1 synopsis: Pandoc filter for cross-references description: pandoc-crossref is a pandoc filter for numbering figures, equations, tables and cross-references to them. category: Text diff --git a/test/m2m/secLabels/expect.tex b/test/m2m/secLabels/expect.tex --- a/test/m2m/secLabels/expect.tex +++ b/test/m2m/secLabels/expect.tex @@ -20,14 +20,14 @@ \begin{longtable}[]{@{}lll@{}} \caption{\label{tbl:mytable}My table}\tabularnewline \toprule -a & b & c \\ \addlinespace +a & b & c \\ \midrule \endfirsthead \toprule -a & b & c \\ \addlinespace +a & b & c \\ \midrule \endhead -1 & 2 & 3 \\ \addlinespace -4 & 5 & 6 \\ \addlinespace +1 & 2 & 3 \\ +4 & 5 & 6 \\ \bottomrule \end{longtable} diff --git a/test/m2m/subfigures-ccsDelim/expect.tex b/test/m2m/subfigures-ccsDelim/expect.tex --- a/test/m2m/subfigures-ccsDelim/expect.tex +++ b/test/m2m/subfigures-ccsDelim/expect.tex @@ -1,7 +1,6 @@ You can define subfigures: -\begin{figure} -\centering +\begin{pandoccrossrefsubfigures} \subfloat[1]{\includegraphics{fig1.png}\label{fig:subfig1}} \subfloat[2]{\includegraphics{fig2.png}\label{fig:subfig2}} @@ -15,14 +14,13 @@ \subfloat[8]{\includegraphics{fig8.png}} \subfloat[9]{\includegraphics{fig9.png}\label{fig:subfig9}} -\caption{Caption} +\caption[{Caption}]{Caption} \label{fig:subfigures} -\end{figure} +\end{pandoccrossrefsubfigures} -\begin{figure} -\centering +\begin{pandoccrossrefsubfigures} \subfloat[1]{\includegraphics{fig1.png}\label{fig:subfig21}} @@ -42,11 +40,11 @@ \subfloat[9]{\includegraphics{fig9.png}\label{fig:subfig29}} -\caption{Caption} +\caption[{Caption}]{Caption} \label{fig:subfigures2} -\end{figure} +\end{pandoccrossrefsubfigures} Figures themselves can be referenced fig.~\ref{fig:subfigures2}, as well as individual subfigures: diff --git a/test/m2m/subfigures-grid/expect.tex b/test/m2m/subfigures-grid/expect.tex --- a/test/m2m/subfigures-grid/expect.tex +++ b/test/m2m/subfigures-grid/expect.tex @@ -1,7 +1,6 @@ You can define subfigures: -\begin{figure} -\centering +\begin{pandoccrossrefsubfigures} \subfloat[1]{\includegraphics[width=0.3\textwidth,height=\textheight]{fig1.png}\label{fig:subfig1}} \subfloat[2]{\includegraphics[width=0.3\textwidth,height=\textheight]{fig2.png}\label{fig:subfig2}} @@ -15,14 +14,13 @@ \subfloat[8]{\includegraphics[width=0.3\textwidth,height=\textheight]{fig8.png}} \subfloat[9]{\includegraphics[width=0.3\textwidth,height=\textheight]{fig9.png}\label{fig:subfig9}} -\caption{Caption} +\caption[{Caption}]{Caption} \label{fig:subfigures} -\end{figure} +\end{pandoccrossrefsubfigures} -\begin{figure} -\centering +\begin{pandoccrossrefsubfigures} \subfloat[1]{\includegraphics{fig1.png}\label{fig:subfig21}} @@ -42,11 +40,11 @@ \subfloat[9]{\includegraphics{fig9.png}\label{fig:subfig29}} -\caption{Caption} +\caption[{Caption}]{Caption} \label{fig:subfigures2} -\end{figure} +\end{pandoccrossrefsubfigures} Figures themselves can be referenced fig.~\ref{fig:subfigures2}, as well as individual subfigures: diff --git a/test/m2m/subfigures/expect.tex b/test/m2m/subfigures/expect.tex --- a/test/m2m/subfigures/expect.tex +++ b/test/m2m/subfigures/expect.tex @@ -1,7 +1,6 @@ You can define subfigures: -\begin{figure} -\centering +\begin{pandoccrossrefsubfigures} \subfloat[1]{\includegraphics{fig1.png}\label{fig:subfig1}} \subfloat[2]{\includegraphics{fig2.png}\label{fig:subfig2}} @@ -15,14 +14,13 @@ \subfloat[8]{\includegraphics{fig8.png}} \subfloat[9]{\includegraphics{fig9.png}\label{fig:subfig9}} -\caption{Caption} +\caption[{Caption}]{Caption} \label{fig:subfigures} -\end{figure} +\end{pandoccrossrefsubfigures} -\begin{figure} -\centering +\begin{pandoccrossrefsubfigures} \subfloat[1]{\includegraphics{fig1.png}\label{fig:subfig21}} @@ -42,11 +40,11 @@ \subfloat[9]{\includegraphics{fig9.png}\label{fig:subfig29}} -\caption{Caption} +\caption[{Caption}]{Caption} \label{fig:subfigures2} -\end{figure} +\end{pandoccrossrefsubfigures} Figures themselves can be referenced fig.~\ref{fig:subfigures2}, as well as individual subfigures: diff --git a/test/test-pandoc-crossref.hs b/test/test-pandoc-crossref.hs --- a/test/test-pandoc-crossref.hs +++ b/test/test-pandoc-crossref.hs @@ -313,7 +313,7 @@ it "Tbl labels" $ table' "A table" "some_table1" <> para (citeGen "tbl:some_table" [1]) - `test` "\\hypertarget{tbl:some_table1}{}\n\\begin{longtable}[]{@{}@{}}\n\\caption{\\label{tbl:some_table1}A table}\\tabularnewline\n\\toprule\n\\endhead\n \\\\ \\addlinespace\n\\bottomrule\n\\end{longtable}\n\ntbl.~\\ref{tbl:some_table1}" + `test` "\\hypertarget{tbl:some_table1}{}\n\\begin{longtable}[]{@{}@{}}\n\\caption{\\label{tbl:some_table1}A table}\\tabularnewline\n\\toprule\n\\endhead\n \\\\\n\\bottomrule\n\\end{longtable}\n\ntbl.~\\ref{tbl:some_table1}" #endif it "Code block labels" $ do