Skip to content

Modify API to support subfigure labeling #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
szchenshixi wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Modify API to support subfigure labeling #1

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
68ea8f1
Modify API to support subfigure labeling
szchenshixi Aug 30, 2023
6f08d54
Fix the no control sequence problem of \elasticfigure@label
szchenshixi Nov 11, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 10 additions & 3 deletions elasticrow.sty
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,17 +20,23 @@
\newlength{\elasticrow@sep}
\newsavebox{\elasticrow@box}
\newtoks{\elasticbox@argtoks}
\newcommand{\elasticfigure@caption}
\newcommand{\elasticfigure@label}
\newif\ifelasticrow@fullwidth

%% command for adding figures to the row
% syntax: \elasticfigure[<caption>]{<figure_file>}
% syntax: \elasticfigure[<options>]{<figure_file>},
% where <options> use a key-value syntax with keys 'caption' and 'label'
\newcommand{\elasticfigure}[2][\empty]{%
\elasticbox@argtoks=\expandafter{\the\elasticbox@argtoks\elasticfun[#1]{#2}}%
}

%% keys for the elasticrow environment
\define@key{elasticrow@key}{width}{\setlength{\elasticrow@width}{#1}}
\define@key{elasticrow@key}{sep}{\def\elasticrow@whitespace{#1}}
%% keys for the elasticfigure command
\define@key{elasticfigure@key}{caption}{\def\elasticfigure@caption{#1}}
\define@key{elasticfigure@key}{label}{\def\elasticfigure@label{#1}}

%% environment for the elastic row
% syntax: \begin{elasticrow}[<options>],
Expand All @@ -39,7 +45,6 @@
\setlength{\elasticrow@width}{\elasticrowwidth}%
\def\elasticrow@whitespace{\elasticrowsep}%
\setkeys{elasticrow@key}{#1}%
\ifdimequal{\elasticrow@width}{\textwidth}{\elasticrow@fullwidthtrue}{\elasticrow@fullwidthfalse}%
\elasticbox@argtoks={}%
}{%
\addtolength{\elasticrow@width}{\elasticrow@whitespace}%
Expand All @@ -61,7 +66,9 @@
\ifx#1\empty%
\includegraphics[height=\elasticrow@height]{#2}%
\else%
\subcaptionbox{#1}{\includegraphics[height=\elasticrow@height]{#2}}%
% Set the provided key-value pairs
\setkeys{elasticfigure@key}{#1}%
\subcaptionbox{\elasticfigure@caption\label{\elasticfigure@label}}{\includegraphics[height=\elasticrow@height]{#2}}%
\fi%
% set \elasticrow@sep for the next figures
% - uses \fill for full-width rows, to prevent line break due to minor width overflow
Expand Down
22 changes: 18 additions & 4 deletions elasticrow.tex
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,10 +27,17 @@ \section{Usage}
\begin{figure}[!h]
\centering
\begin{elasticrow}[width=0.75\linewidth, sep=1em]
\elasticfigure[Figure with an A]{example-image-a}
\elasticfigure[A 16x9 figure]{example-image-16x9}
\elasticfigure[
caption=Figure with an A,
label=fig:subfig1
]{example-image-a}
\elasticfigure[
caption=A 16x9 figure,
label=fig:subfig2
]{example-image-16x9}
\end{elasticrow}
\caption{Caption of the surrounding \texttt{figure} environment}
\label{fig:fig1}
\end{figure}

\noindent
Expand All @@ -39,13 +46,20 @@ \section{Usage}
\begin{figure}[!h]
\centering
\begin{elasticrow}[width=0.75\linewidth, sep=1em]
\elasticfigure[Figure with an A]{example-image-a}
\elasticfigure[A 16x9 figure]{example-image-16x9}
\elasticfigure[
caption=Figure with an A,
label=fig:subfig1
]{example-image-a}
\elasticfigure[
caption=A 16x9 figure,
label=fig:subfig2
]{example-image-16x9}
\end{elasticrow}
\caption{Caption of the surrounding \texttt{figure} environment}
\end{figure}
\end{verbatim}

, where each subfigure can be individually referenced with \verb*|Fig.~\ref{fig:subfig1}|, \verb*|Fig.~\ref{fig:subfig2}|, and \verb*|Fig.~\ref{fig:sub1}|, rendered as Fig.~\ref{fig:subfig1}, Fig.~\ref{fig:subfig2}, and Fig.~\ref{fig:fig1}.

\subsection{Control parameters}

Expand Down