showyourwork.sty

\NeedsTeXFormat{LaTeX2e}
\ProvidesPackage{showyourwork}[2021/07/07 Open source science articles]


% Imports
\RequirePackage{mathtools} % equation tags
\RequirePackage{xcolor} % custom colors
\RequirePackage{hyperref} % url links
\RequirePackage{suffix} % allows definition of starred commmands
\RequirePackage{ifxetex}
\ifxetex
  \RequirePackage{fontspec}
  \defaultfontfeatures{Extension = .otf}
\fi
\RequirePackage{fontawesome5} % FontAwesome symbols
\RequirePackage{letltxmacro} % command redefinitions
\RequirePackage{xstring} % string manipulation
\RequirePackage{catchfile} % read file into macro
\RequirePackage{totcount} % count total number of errors
\RequirePackage[notref, notcite]{showkeys} % get label refs
\RequirePackage{marginnote} % margin notes
\RequirePackage{xspace} % better spacing after icons
\RequirePackage{graphicx} % includegraphics
\RequirePackage{stackengine} % stacking figure links

\newcommand{\showyourwork}{%
    \href{https://github.com/rodluger/showyourwork}%
    {\raisebox{-1.3ex}{\includegraphics[width=7em]{showyourwork.pdf}}}\hspace{0.2em}%
}

% Generic: replace \LaTeX with \Latex + showyourwork in \maketitle
\let\oldmaketitle\maketitle
\def\maketitle{%
    \let\oldLaTeX\LaTeX
    \def\LaTeX{\oldLaTeX/\showyourwork}
    \oldmaketitle
    \let\LaTeX\oldLaTeX
}

% MNRAS hack for displaying showyourwork logo
\@ifclassloaded{mnras}{
  \ifx\CUP@mtlplain@loaded\undefined
    \def\@printed{Preprint \tod@y\
      \qquad\qquad\qquad Compiled using \showyourwork/MNRAS \LaTeX\ style file v\@version}
  \else
    \def\@printed{}
  \fi
}{}

% A&A hack for displaying showyourwork logo + abstract links
\@ifclassloaded{aa}{
  \renewcommand*\aa@manuscriptname{%
    \LaTeX
    \hspace{\stretch{1}}%
    \smash{\stackunder[0.5em]{\copyright ESO \the\year}{%
        \href{((- repo.url -))/tree/((- repo.sha -))/}{%
          \color{((- status -))}%
          \faGithub%
        }%
        ((* if CI *))
        \hspace{3pt}%
        \href{((- repo.url -))/actions/runs/((- run_id -))/}{%
          \color{sywGreen}%
          \faCheckCircle%
        }%
        ((* endif *))
      }
    }
  }
}{}

% Logging
\newwrite\syw@LogFile
\immediate\openout\syw@LogFile=showyourwork.log
\newcommand\syw@LogMessage[1]{%
  \protected@write
  \syw@LogFile
  {\let\tmp\write\def\write{\immediate\tmp}}%
  {#1}%
}
\syw@LogMessage{This is showyourwork ((- version -)).}

% Custom margin icon
\newcommand\marginicon[1]{
  \renewcommand\showkeyslabelformat[1]{#1}%
}

% Define custom colors
\definecolor{sywRed}{rgb}{0.80,0.14,0.19}
\definecolor{sywOrange}{rgb}{1.0,0.65,0.0}
\definecolor{sywYellow}{rgb}{1.0,0.88,0.30}
\definecolor{sywBlue}{rgb}{0.12,0.47,0.71}
\definecolor{sywGreen}{rgb}{0.13,0.53,0.23}

% Error codes (colors)
\colorlet{sywScriptDoesNotExist}{sywRed}
\colorlet{sywScriptNotVersionControlled}{sywOrange}
\colorlet{sywScriptHasUncommittedChanges}{sywYellow}
\colorlet{sywScriptUpToDate}{sywBlue}

% User-facing commands
\newcommand\GitHubSHA{((- repo.sha -))}
\newcommand\GitHubIcon{\faGithub\xspace}
\newcommand\GitHubIconRed{{\color{sywRed}\faGithub}\xspace}
\newcommand\GitHubIconOrange{{\color{sywOrange}\faGithub}\xspace}
\newcommand\GitHubIconYellow{{\color{sywYellow}\faGithub}\xspace}
\newcommand\GitHubIconBlue{{\color{sywBlue}\faGithub}\xspace}

% Key-value pairs
% See https://tex.stackexchange.com/a/48931
\def\addvalue#1#2{\expandafter\gdef\csname syw@data@\detokenize{#1}\endcsname{#2}}
\def\usevalue#1{%
\ifcsname syw@data@#1\endcsname%
  \csname syw@data@#1\expandafter\endcsname%
\else%
  KEYNOTFOUND%
\fi%
}
((* for key, value in labels.items() *))
\addvalue{((- key -))}{((- value -))}
((* endfor *))

% Add a GitHub link to the end of the abstract
\let\oldabstract\abstract
\let\oldendabstract\endabstract
\renewenvironment{abstract}{%
  \oldabstract%
}{%
  % AASTex631 hack to reduce margin separation
  % in the abstract of a two-column document
  %\ifcsname if@two@col\endcsname%
  %\if@two@col\setlength{\marginparsep}{-45pt}\fi%
  %\fi%
  \marginnote{%
    \href{((- repo.url -))/tree/((- repo.sha -))/}{%
      \color{((- status -))}%
      \faGithub%
    }%
    ((* if CI *))
    \hspace{3pt}%
    \href{((- repo.url -))/actions/runs/((- run_id -))/}{%
      \color{sywGreen}%
      \faCheckCircle%
    }%
  ((* endif *))
  }
  \oldendabstract%
}

% Hack `showkeys' to show margin links for figures
% See https://tex.stackexchange.com/a/580553
\renewcommand\showkeyslabelformat[1]{%
  \IfBeginWith*{#1}{fig:}{\StrBehind*{#1}{fig:}[\syw@CurrentLabelName]%
    \StrBefore*{\syw@CurrentLabelName:}{:}[\syw@CurrentLabelName]% remove label :suffix
    \normalfont%
    \stackon[3pt]{%
      \IfEq*{\usevalue{\syw@CurrentLabelName_status}}{KEYNOTFOUND}{}{%
      \raisebox{0pt}[5pt][5pt]{%
        \href{((- repo.url -))/blob/((- repo.sha -))/\usevalue{\syw@CurrentLabelName_script}}{%
        \color{\usevalue{\syw@CurrentLabelName_status}}\faGithub%
      }%
      }%
      }%
    }{%
      \stackon[3pt]{%
        \IfEq*{\usevalue{\syw@CurrentLabelName_datasetOne}}{KEYNOTFOUND}{}{%
          \IfEq*{\usevalue{\syw@CurrentLabelName_datasetOne}}{UNAUTHORIZED}{%
            \raisebox{0pt}[5pt][5pt]{%
              \color{sywRed}\faDatabase%
            }%
          }{%
            \raisebox{0pt}[5pt][5pt]{%
              \href{\usevalue{\syw@CurrentLabelName_datasetOne}}{%
                \color{sywBlue}\faDatabase%
              }%
            }%
          }%
        }%
      }{%
        \stackon[3pt]{%
          \IfEq*{\usevalue{\syw@CurrentLabelName_datasetTwo}}{KEYNOTFOUND}{}{%
            \IfEq*{\usevalue{\syw@CurrentLabelName_datasetTwo}}{UNAUTHORIZED}{%
              \raisebox{0pt}[5pt][5pt]{%
                \color{sywRed}\faDatabase%
              }%
            }{%
              \raisebox{0pt}[5pt][5pt]{%
                \href{\usevalue{\syw@CurrentLabelName_datasetTwo}}{%
                  \color{sywBlue}\faDatabase%
                }%
              }%
            }%
          }%
        }{%
          \IfEq*{\usevalue{\syw@CurrentLabelName_datasetThree}}{KEYNOTFOUND}{}{%
            \IfEq*{\usevalue{\syw@CurrentLabelName_datasetThree}}{UNAUTHORIZED}{%
              \raisebox{0pt}[5pt][5pt]{%
                \color{sywRed}\faDatabase%
              }%
            }{%
              \raisebox{0pt}[5pt][5pt]{%
                \href{\usevalue{\syw@CurrentLabelName_datasetThree}}{%
                  \color{sywBlue}\faDatabase%
                }%
              }%
            }%
          }%
        }%
      }%
    }%
  }{}%
}

% Set the graphics path for all figures
\graphicspath{{./}{./figures/}}