Add syntax comment to \marginfig.

This commit is contained in:
2025-07-29 22:27:11 -05:00
parent bee660efc2
commit 86c343532e

View File

@@ -38,6 +38,19 @@
\RequirePackage{ifthen} \RequirePackage{ifthen}
\newcommand{\marginfig}[5][0pt]{% \newcommand{\marginfig}[5][0pt]{%
% Syntax:
% \marginfig[
% vertical_offset
% ]{
% graphic_file_name
% }{
% (width|height)=lengthvalue
% }{
% label
% }{
% caption
% }
%
% This strut ensures that the margin figure is counted as part of the % This strut ensures that the margin figure is counted as part of the
% following paragraph and is vertically aligned with it. % following paragraph and is vertically aligned with it.
\strut% \strut%