Melhor maneira de automatizar um layout

Question

Sou novo nas aulas e gostaria de fazer uma aula que automatizasse o layout completo do documento. Isso inclui :

• definir um determinado arquivo PDF como plano de fundo,
• há um fundo diferente na página de título do resto do documento,
• o ID do documento e o nome do documento devem estar na página de título e no cabeçalho das páginas seguintes.

Consegui colocar o fundo, não tem problema nisso. Mas depois de horas de pesquisa não consegui encontrar uma forma de automatizar o pré-preenchimento de textos recorrentes como o ID e o assunto.

Aqui está um exemplo minimalista de trabalho do meu my_class.clsarquivo:

\NeedsTeXFormat{LaTeX2e}
\ProvidesPackage{my_class}[2023/03/10 A document class for my compagny documents]
\LoadClass[a4paper, 12pt]{article}

\usepackage{fancyhdr}


\RequirePackage{palatino}
\RequirePackage{mathpazo}

\RequirePackage[T1]{fontenc}
\RequirePackage[french]{babel}

\RequirePackage[left=2.5cm, right=2.5cm, top=2.4cm, bottom=2.5cm]{geometry}

% The background
\RequirePackage[pages=1]{background}
\backgroundsetup{scale = 1.01, angle = 0, opacity = 1,
  contents = {
            \ifnum\thepage = 1 \includegraphics[width = \paperwidth, height = \paperheight, keepaspectratio]{bg_title.pdf}
            \else \includegraphics[width = \paperwidth, height = \paperheight, keepaspectratio]{bg_all.pdf}
            \fi}}
            
\pagestyle{fancy}
\renewcommand\headrulewidth{0pt}
\fancyhf{} 
\fancyfootoffset[R]{-0.35cm}
\fancyfoot[R]{\color{white}\vspace{-0.05cm}\textbf{\thepage}}
\fancyheadoffset[R]{-0.30cm}
\fancyhead[R]{document_name \hspace{0.5cm}\textbf{\color{white}document_ID}}

% Title page
\AtBeginDocument{
\thispagestyle{empty}
\begin{center}
       \vspace*{0.15\textheight}
       \textbf{\huge document_ID -- client}
       
       \vspace{0.8cm}
       \textbf{\huge project_name}   
       
       \vspace{0.8cm}
       \includegraphics[width=0.4\textwidth]{title_page_logo}
       \vspace{0.8cm}
       
       \textbf{\huge document_name}
       \vfill
       
       This document is confidential
       
       \vspace{0.8cm}
       
       Date de la dernière mise à jour du document : \today \\
       Rédacteur(s) du document : redactor
            
\end{center}
\newpage
\tableofcontents
\newpage
}

E no meu texarquivo,

\documentclass{my_class}


\begin{document}
Hello world!
\end{document}

Então no meu documento o laout básico já está lá (fundo, cabeçalhos, etc.), porém, você pode ver no clsarquivo que há algumas informações que dependem do documento:

• document_ID(cabeçalhos e página de título)
• document_name(cabeçalhos e página de título)
• client(folha de rosto)
• project_name(folha de rosto)
• title_page_logo(folha de rosto)
• redactor(folha de rosto)

(para nós é importante automatizar esse tipo de coisa => todos os documentos terão exatamente o mesmo layout, e se você não inserir todas as informações ocorre um erro e o documento não pode ser compilado).

Procuro algo como quando você liga \author{...}, e chamando \document_ID{ID 1235} por exemplo, mas não é via classes que funciona.

Existe uma maneira de fazer algo assim? Ou pelo menos no arquivo tex apenas chamando a classe usando: \documentclass[document_ID=ID 1235,...]{my_class}ou algo parecido?

Eu li muito sobre \DeclareOptions, mas não tenho certeza se é adequado para "entrada de string" como aqui! (ou simplesmente não entendi como funciona).

Obrigado pela ajuda!

Answer 1

Deixe-me elaborar um pouco o comentário de John Kormylo. O seguinte deve fazer o que você espera e não sobrecarregar seu documento principal. Você apenas terá que definir alguns valores (ID do documento, nome do documento, ...) no início do seu arquivo principal e importar o .texarquivo contendo o material genérico. Não há necessidade de aulas sofisticadas ou coisas semelhantes.

main.tex

\documentclass[a4paper]{article}

% Fill in these information. Just do it!
\newcommand{\myDocID}{ID~0123456789}
\newcommand{\myDocName}{Important Document}
\newcommand{\myClient}{Claire Client}
\newcommand{\myProjName}{Important Project}
\newcommand{\myTitleLogo}{example-image-duck}
\newcommand{\myEditor}{Ph.\,D.~Eddy Editor}

% Additional packages.
\usepackage{lipsum} % Just to have some blindtext.

% Input generic setup stuff.
\input{genericSetup.tex}

% Start of document.
\begin{document}
    \lipsum
\end{document}

genericSetup.tex

% Necessary packages. If you need to load any package with certain options, e.g. `\usepackage[draft]{graphicx}`, make sure you have this line *before* `\input`ting this code.
\usepackage{graphicx}
\usepackage{fancyhdr}
\usepackage{eso-pic}

% Apply `fancyhdr` stuff.
\pagestyle{fancy}
\renewcommand\headrulewidth{0pt}
\fancyhf{} 
\fancyfootoffset[R]{-0.35cm}
\fancyfoot[R]{\color{white}\vspace{-0.05cm}\textbf{\thepage}}
\fancyheadoffset[R]{-0.30cm}
\fancyhead[R]{\myDocName \hspace{0.5cm}\textbf{\color{white}\myDocID{}}}

% Define behavior at start of the document.
\AtBeginDocument{
    % Create titlepage.
    \begin{titlepage}
        \centering
        \ClearShipoutPicture
        \AddToShipoutPictureBG*{\includegraphics[width=\paperwidth,height=\paperheight]{example-image-a}}% replace with a fixed titlepage background image
        \vspace*{0.15\textheight}
           \textbf{\huge \myDocID{} -- \myClient}
           
           \vspace{0.8cm}
           \textbf{\huge \myProjName}
           
           \vspace{0.8cm}
           \includegraphics[width=0.4\textwidth]{\myTitleLogo}
           \vspace{0.8cm}
           
           \textbf{\huge \myDocName}
           \vfill
           
           This document is confidential.
           
           \vspace{0.8cm}
           
           Date de la dernière mise à jour du document : \today \\
           Rédacteur(s) du document: \myEditor
    \end{titlepage}
    
    % Define background for non-titlepage pages *after* printing the titlepage.
    \AddToShipoutPictureBG{\includegraphics[width=\paperwidth,height=\paperheight]{example-image-b}}% replace with a fixed titlepage background image
}