texsmith 0.0.2.dev0__py3-none-any.whl

texsmith/templates/book/__init__.py

@@ -0,0 +1,75 @@
+"""Book template integration for TeXSmith."""
+
+from __future__ import annotations
+
+from collections.abc import Iterable, Mapping
+from pathlib import Path
+from typing import Any
+
+from texsmith.adapters.latex.utils import escape_latex_chars
+from texsmith.core.templates import TemplateError, WrappableTemplate
+
+
+_PACKAGE_ROOT = Path(__file__).parent.resolve()
+
+
+class Template(WrappableTemplate):
+    """Expose the book template as a wrappable template instance."""
+
+    def __init__(self) -> None:
+        try:
+            super().__init__(_PACKAGE_ROOT)
+        except TemplateError as exc:
+            raise TemplateError(f"Failed to initialise book template: {exc}") from exc
+
+    def prepare_context(
+        self,
+        latex_body: str,
+        *,
+        overrides: Mapping[str, Any] | None = None,
+    ) -> dict[str, Any]:
+        context = super().prepare_context(latex_body, overrides=overrides)
+        context["ts_extra_disable_hyperref"] = True
+
+        raw_authors = context.pop("authors", None)
+        author_value = self._format_authors(raw_authors)
+        if author_value:
+            context["author"] = author_value
+        else:
+            context.pop("author", None)
+        context.pop("press", None)
+        return context
+
+    def _coerce_string(self, value: Any) -> str | None:
+        if value is None:
+            return None
+        candidate = value.strip() if isinstance(value, str) else str(value).strip()
+        return candidate or None
+
+    def _format_authors(self, payload: Any) -> str | None:
+        if not payload:
+            return None
+        if not isinstance(payload, Iterable) or isinstance(payload, (str, bytes)):
+            return None
+
+        formatted: list[str] = []
+        for item in payload:
+            if not isinstance(item, Mapping):
+                continue
+            name_value = self._coerce_string(item.get("name"))
+            if not name_value:
+                continue
+            name_tex = escape_latex_chars(name_value)
+            affiliation = self._coerce_string(item.get("affiliation"))
+            if affiliation:
+                affiliation_tex = escape_latex_chars(affiliation)
+                formatted.append(f"{name_tex}\\thanks{{{affiliation_tex}}}")
+            else:
+                formatted.append(name_tex)
+
+        if not formatted:
+            return None
+        return " \\and ".join(formatted)
+
+
+__all__ = ["Template"]

texsmith/templates/book/overrides/codeblock.tex

@@ -0,0 +1,7 @@
+%\leavevmode % Required to avoid a bug in the tcolorbox package
+\begin{code}{\VAR{language|default('text')}}{\BLOCK{if filename}\VAR{filename}\BLOCK{endif}}{
+    \BLOCK{- if baselinestretch}baselinestretch=\VAR{baselinestretch}, \BLOCK{endif}
+    \BLOCK{- if linenos}linenos, \BLOCK{endif -}
+    \BLOCK{- if highlight }, highlightlines={\VAR{','.join(highlight)}}\BLOCK{endif -}
+}
+\VAR{code}\end{code}

texsmith/templates/book/overrides/codeinline.tex

@@ -0,0 +1 @@
+\mintinline{\BLOCK{if language}\VAR{language}\BLOCK{else}text\BLOCK{endif}}\VAR{delimiter}\VAR{text}\VAR{delimiter}

texsmith/templates/book/template/fixtoc.sty

@@ -0,0 +1,81 @@
+\NeedsTeXFormat{LaTeX2e}
+\ProvidesPackage{fixtoc}[2025/12/03 Dynamic TOC widths]
+
+\RequirePackage{refcount}
+
+\gdef\LASTPART{0}
+\gdef\LASTCHAPTER{0}
+\gdef\LASTSECTION{0}
+\newcounter{tssectionmax}
+\makeatletter
+\AddToHook{cmd/part/before}{\protected@write\@mainaux{}{\gdef\string\LASTPART{\arabic{part}}}}
+\AddToHook{cmd/chapter/before}{\protected@write\@mainaux{}{\gdef\string\LASTCHAPTER{\arabic{chapter}}}}
+\newcommand*\tsAfterSectionHook{%
+  \ifnum\numexpr\value{section}+1\relax>\value{tssectionmax}%
+    \setcounter{tssectionmax}{\value{section}}%
+    \addtocounter{tssectionmax}{1}%
+  \fi
+}
+\AddToHook{cmd/section/before}{\tsAfterSectionHook}
+\AddToHook{shipout/lastpage}{%
+  \protected@write\@mainaux{}{\string\gdef\string\LASTSECTION{\arabic{tssectionmax}}}%
+}
+\makeatother
+
+\AtBeginDocument{%
+  \setcounter{tssectionmax}{\LASTSECTION}%
+  \computemaxpartnumberwidth
+  \computemaxchapternumberwidth
+  \computemaxsectionnumberwidth
+}
+\renewcommand{\cftpartpresnum}{\partname\ }
+
+\ExplSyntaxOn
+\NewDocumentCommand{\computemaxpartnumberwidth}{}
+ {
+  \dim_set:Nn \l_tmpa_dim {0pt}
+  \int_step_inline:nn { \use:c{LASTPART}+1 }
+   {
+    \settowidth{\l_tmpb_dim}
+     {
+      \cftpartfont \cftpartpresnum \int_to_Roman:n {##1}
+     }
+   \dim_compare:nT { \l_tmpb_dim > \l_tmpa_dim } { \dim_set:Nn \l_tmpa_dim { \l_tmpb_dim } }
+  }
+  \addtolength{\l_tmpa_dim}{1em}
+  \setlength{\cftpartnumwidth}{\l_tmpa_dim}
+ }
+\NewDocumentCommand{\computemaxchapternumberwidth}{}
+ {
+  \dim_set:Nn \l_tmpa_dim {0pt}
+  \int_step_inline:nn { \use:c{LASTCHAPTER}+1 }
+   {
+    \settowidth{\l_tmpb_dim}
+     {
+      \cftchapterfont \cftchapterpresnum \int_to_arabic:n {##1} \cftchapteraftersnum
+     }
+    \dim_compare:nT { \l_tmpb_dim > \l_tmpa_dim } { \dim_set:Nn \l_tmpa_dim { \l_tmpb_dim } }
+   }
+  \addtolength{\l_tmpa_dim}{1em}
+  \setlength{\cftchapternumwidth}{\l_tmpa_dim}
+ }
+\NewDocumentCommand{\computemaxsectionnumberwidth}{}
+ {
+  \dim_set:Nn \l_tmpa_dim {0pt}
+  \int_set:Nn \l_tmpa_int { \value{chapter} }
+  \int_set:Nn \l_tmpb_int { \value{section} }
+  \int_step_inline:nn { \int_max:nn {1}{ \use:c{LASTSECTION} } }
+   {
+    \int_set:cn { c@section } {##1}
+    \int_set:cn { c@chapter } { \use:c{LASTCHAPTER} }
+    \settowidth{\l_tmpb_dim}
+     { \cftsectionfont \cftsectionpresnum \thesection \cftsectionaftersnum }
+    \dim_compare:nT { \l_tmpb_dim > \l_tmpa_dim }
+      { \dim_set:Nn \l_tmpa_dim { \l_tmpb_dim } }
+   }
+  \int_set:cn { c@chapter } { \l_tmpa_int }
+  \int_set:cn { c@section } { \l_tmpb_int }
+  \addtolength{\l_tmpa_dim}{1em}
+  \setlength{\cftsectionnumwidth}{\l_tmpa_dim}
+ }
+\ExplSyntaxOff

texsmith/templates/book/template/manifest.toml

@@ -0,0 +1,198 @@
+[compat]
+texsmith = ">=0.6,<1.0"
+
+[latex.template]
+name = "book"
+version = "0.2.0"
+entrypoint = "template/template.tex"
+engine = "lualatex"
+shell_escape = false
+texlive_year = 2023
+tlmgr_packages = [
+    "babel",
+    "babel-french",
+    "csquotes",
+    "fontspec",
+    "fancyvrb",
+    "geometry",
+    "hyperref",
+    "longtable",
+    "microtype",
+    "titlesec",
+    "titletoc",
+    "xcolor",
+    "xunicode",
+]
+override = ["codeblock.tex", "codeinline.tex"]
+fragments = [
+    "ts-geometry",
+    "ts-typesetting",
+    "ts-fonts",
+    "ts-extra",
+    "ts-keystrokes",
+    "ts-callouts",
+    "ts-code",
+    "ts-glossary",
+    "ts-index",
+    "ts-bibliography",
+    "ts-todolist",
+]
+
+[latex.template.attributes.base_level]
+default = 0
+type = "integer"
+sources = ["base_level"]
+description = "Base heading level offset for slots (0 = chapter, -1 = part)."
+
+[latex.template.attributes.title]
+default = "A LaTeX Book Template"
+type = "string"
+escape = "latex"
+allow_empty = true
+sources = ["title"]
+
+[latex.template.attributes.subtitle]
+default = "An example of a book template for MkDocs LaTeX"
+type = "string"
+escape = "latex"
+allow_empty = true
+sources = ["subtitle"]
+
+[latex.template.attributes.authors]
+default = []
+type = "list"
+sources = ["authors"]
+
+[latex.template.attributes.email]
+default = "john.doe@acme.corp"
+type = "string"
+escape = "latex"
+allow_empty = true
+sources = ["email"]
+
+[latex.template.attributes.date]
+default = ""
+type = "string"
+escape = "latex"
+allow_empty = true
+sources = ["date"]
+
+[latex.template.attributes.language]
+default = "english"
+type = "string"
+allow_empty = false
+normaliser = "babel_language"
+sources = ["language"]
+description = "Language for hyphenation and document terms (babel)."
+
+[latex.template.attributes.documentclass]
+default = "memoir"
+type = "string"
+allow_empty = false
+sources = ["documentclass"]
+description = "Document class to use (memoir by default)."
+
+[latex.template.attributes.hyperref_options]
+default = "colorlinks=true, linkcolor=black, citecolor=black, plainpages=false, unicode=true, urlcolor=urlcolor"
+type = "string"
+allow_empty = true
+sources = ["hyperref_options"]
+description = "Custom hyperref options appended to defaults."
+
+[latex.template.attributes.edition]
+default = ""
+type = "string"
+allow_empty = true
+sources = ["edition"]
+description = "Edition label rendered in imprint."
+
+[latex.template.attributes.publisher]
+default = ""
+type = "string"
+allow_empty = true
+sources = ["publisher"]
+description = "Publisher string rendered in imprint."
+
+[latex.template.attributes.imprint_thanks]
+default = ""
+type = "string"
+allow_empty = true
+format = "markdown"
+sources = ["imprint.thanks", "imprint_thanks"]
+description = "Imprint thanks paragraph (Markdown)."
+
+[latex.template.attributes.imprint_license]
+default = ""
+type = "string"
+allow_empty = true
+format = "markdown"
+sources = ["imprint.license", "imprint_license"]
+description = "Imprint license paragraph (Markdown)."
+
+[latex.template.attributes.imprint_copyright]
+default = ""
+type = "string"
+allow_empty = true
+format = "markdown"
+sources = ["imprint.copyright", "imprint_copyright"]
+description = "Imprint copyright paragraph (Markdown)."
+
+[latex.template.attributes.glossary]
+default = false
+type = "boolean"
+sources = ["glossary"]
+description = "Enable glossary section."
+
+[latex.template.attributes.glossary_style]
+default = "long3col"
+type = "string"
+allow_empty = false
+sources = ["glossary_style"]
+description = "Glossary style to use."
+
+[latex.template.attributes.listoffigures]
+default = true
+type = "boolean"
+sources = ["listoffigures"]
+description = "Render list of figures when figures exist."
+
+[latex.template.attributes.listoftables]
+default = true
+type = "boolean"
+sources = ["listoftables"]
+description = "Render list of tables when tables exist."
+
+[latex.template.attributes.part]
+default = false
+type = "boolean"
+sources = ["part"]
+description = "Use parts above chapters (adjusts mainmatter depth)."
+
+
+[latex.template.slots.frontmatter]
+depth = "chapter"
+
+[latex.template.slots.dedication]
+depth = "chapter"
+strip_heading = true
+
+[latex.template.slots.mainmatter]
+default = true
+depth = "chapter"
+
+[latex.template.slots.preface]
+base_level = 0
+
+[latex.template.slots.backmatter]
+depth = "chapter"
+
+[latex.template.slots.appendix]
+depth = "chapter"
+description = "Appendix content inserted before backmatter."
+
+[latex.template.slots.colophon]
+depth = "chapter"
+strip_heading = true
+
+[latex.template.assets]
+"fixtoc.sty" = { source = "template/fixtoc.sty" }

texsmith/templates/book/template/template.tex

@@ -0,0 +1,314 @@
+\documentclass\VAR{documentclass_options|default('')}{\VAR{documentclass|default('memoir')}}
+
+\usepackage{amssymb} % Additional math symbols
+\usepackage{nicefrac} % For support of: ½, ⅔...
+\usepackage{xurl} % For better URL line breaking reduce overfull hbox
+
+\usepackage[svgnames,dvipsnames,x11names]{xcolor}
+\VAR{extra_packages}
+
+\usepackage{fancyhdr}
+
+\usepackage{graphicx} % For including images
+\usepackage{multicol}
+\usepackage{booktabs}
+\usepackage{csquotes}
+\usepackage{epigraph}
+\usepackage{capt-of}
+\usepackage{enumitem}
+\usepackage{etoolbox}
+\usepackage{tocloft}
+\usepackage{caption}
+\usepackage[colorlinks=true, linkcolor=DarkBlue, urlcolor=DarkBlue, citecolor=DarkBlue]{hyperref}
+\usepackage[\VAR{language|default('english')}]{babel}
+\usepackage{emptypage}
+\usepackage{fixtoc} % Custom package to fix TOC number widths
+
+\graphicspath{{assets/}}
+
+%
+% Heading style
+%
+\chapterstyle{default} % ou ton style préféré (vehttp, ell, etc.)
+
+\renewcommand*{\partnamefont}{\normalfont\sffamily\Huge\bfseries\scshape}
+\renewcommand*{\partnumfont}{\normalfont\sffamily\Huge\bfseries}
+\renewcommand*{\parttitlefont}{\normalfont\sffamily\Huge\bfseries}
+
+\renewcommand*{\chapnamefont}{\normalfont\sffamily\Large\scshape}
+\renewcommand*{\chapnumfont}{\normalfont\sffamily\Huge\bfseries}
+\renewcommand*{\chaptitlefont}{\normalfont\sffamily\Huge\bfseries}
+\setsecheadstyle{\sffamily\Large\bfseries}
+\setsubsecheadstyle{\sffamily\large\bfseries}
+
+%
+% Table of contents style
+%
+\renewcommand{\cftpartfont}{\sffamily\Large\bfseries}
+\renewcommand{\cftpartpagefont}{\sffamily\Large\bfseries}
+\renewcommand{\cftpartpresnum}{\partname~}
+
+%
+% Adjust spacing
+%
+
+% Prevent too many overful \hbox (with some fonts)
+\tolerance=2000
+\emergencystretch=10pt
+\hfuzz=1pt
+\hbadness=2000
+
+% Give more spaces on Table of content (between numbers and text)
+\setlength{\cftpartnumwidth}{4em}
+\setlength{\cftsectionnumwidth}{3em}
+\setlength{\cftsubsectionnumwidth}{3.5em}
+\setlength{\cftfigurenumwidth}{3em}
+\setlength{\cfttablenumwidth}{3em}
+
+% Make quotations italic and smaller
+\AtBeginEnvironment{displayquote}{\small\itshape}
+
+% Fit table to page width while keeping tabular optional args (alignment)
+\let\oldtabular\tabular
+\let\endoldtabular\endtabular
+
+\newsavebox{\mytablebox}
+\renewenvironment{tabular}[2][c]
+  {\begin{lrbox}{\mytablebox}\small\oldtabular[#1]{#2}} % Temporary box to store table
+  {\endoldtabular\end{lrbox}%
+   \ifdim\wd\mytablebox>\linewidth
+     \resizebox{\linewidth}{!}{\usebox{\mytablebox}} % Adjust to fit line width
+   \else
+     \usebox{\mytablebox} % Otherwise, use the table as is
+   \fi
+  }
+
+\newif\ifgeometryduplex
+\BLOCK{ if geometry_duplex|default(false) }\geometryduplextrue\BLOCK{ else }\geometryduplexfalse\BLOCK{ endif }
+
+%
+% Headers and footers
+%
+
+% No line on the footer
+\renewcommand{\footrulewidth}{0pt}
+
+% Part head pages
+\fancypagestyle{part}{%
+  \fancyhf{}
+  \renewcommand{\headrulewidth}{0pt}
+}
+
+% Chapter head pages
+\fancypagestyle{plain}{%
+  \fancyhf{}
+  \renewcommand{\headrulewidth}{0pt}
+  \ifgeometryduplex
+    \fancyfoot[LE,RO]{\thepage}
+  \else
+    \fancyfoot[RO]{\thepage}
+  \fi
+}
+
+% Mainmatter regular page style
+\fancypagestyle{fancy}{%
+  \fancyhf{}
+  \renewcommand{\headrulewidth}{0.5pt}
+  \ifgeometryduplex
+    \fancyhead[LE]{\scshape \leftmark}
+    \fancyhead[RO]{\scshape \rightmark}
+    \fancyfoot[LE,RO]{\thepage}
+  \else
+    \fancyhead[RO]{\scshape \rightmark}
+    \fancyhead[LO]{\scshape \leftmark}
+    \fancyfoot[RO]{\thepage}
+  \fi
+}
+\makeatletter
+\nouppercaseheads
+\renewcommand{\chaptermark}[1]{%
+  \markboth{\thechapter\quad #1}{}%
+}
+\renewcommand{\sectionmark}[1]{%
+  \markright{\thesection\quad #1}%
+}
+\makeatother
+
+% Associate the part page style to the part
+\patchcmd{\part}{\thispagestyle{plain}}{\thispagestyle{part}}{}{}
+
+\newcommand{\changelocaltocdepth}[1]{%
+  \addtocontents{toc}{\protect\setcounter{tocdepth}{#1}}%
+  \setcounter{tocdepth}{#1}%
+}
+
+\apptocmd{\frontmatter}{%
+  \pagestyle{plain}%
+  \changelocaltocdepth{1}%
+  \setcounter{secnumdepth}{0}
+}{}{}
+
+\apptocmd{\mainmatter}{%
+  \pagestyle{fancy}%
+  \changelocaltocdepth{2}%
+  \setcounter{secnumdepth}{2}
+}{}{}
+
+%
+% Tweaks
+%
+
+% Allow hyphenation after a hyphen
+\providecommand{\allowhyphens}{\ifvmode\else\nobreak\hspace{0pt}\fi}
+
+% To number paragraphs and subparagraphs
+\setcounter{secnumdepth}{5}
+
+% Paragraph indentation
+% \setlength{\parindent}{0pt}
+\setlength\parskip{\smallskipamount}
+
+% Avoid orphans at the end of a page, encourage page breaks if there are
+% a section with less than 3 lines
+% https://tex.stackexchange.com/a/723704/85416
+\makeatletter
+\patchcmd\@afterheading{\clubpenalty \@M}{\clubpenalties 3 \@M\@M 5000 }{%
+  \typeout{patched}}{\typeout{patch failed}
+}
+\makeatother
+
+% Allow for short text below parts
+% https://tex.stackexchange.com/a/336401/85416
+% \makeatletter
+% \newcommand{\extraPartText}[1]{\def\@extraPartText{#1}}
+% \pretocmd{\@endpart}{\vspace{8ex}\begingroup\centering\@extraPartText\par\endgroup\let\@extraPartText\relax}{}{}
+% \makeatother
+
+% Description item and text are displayed by default on the same line
+% this is not very readable. This command changes the style to display
+% the description text on the next line.
+% https://tex.stackexchange.com/a/430454/85416
+% https://tex.stackexchange.com/a/726879/85416
+\AddToHook{cmd/descriptionlabel/after}{\rule[-8pt]{0pt}{0pt}}
+\setlist[description]{
+  style=nextline,
+  labelindent=0pt,
+  leftmargin=1cm,
+  itemindent=\dimexpr-5pt-\labelsep\relax
+}
+
+
+\newcommand{\booktitle}{\VAR{title}}
+\newcommand{\booksubtitle}{\VAR{subtitle}}
+\newcommand{\bookauthor}{\VAR{author|default('', true)}}
+\newcommand{\bookemail}{\VAR{email}}
+\newcommand{\bookpublisher}{\VAR{publisher}}
+\newcommand{\bookedition}{\VAR{edition}}
+\BLOCK{ set effective_date = date|default('')|trim }
+\newcommand{\bookdate}{\BLOCK{ if effective_date }\VAR{date}\BLOCK{ else }\today\BLOCK{ endif }}
+
+\title{\Huge\bfseries\booktitle}
+\author{\bookauthor}
+\makeatletter
+\gdef\@subtitle{\booksubtitle}
+\gdef\@authoremail{\bookemail}
+\makeatother
+\newcommand{\subtitletext}{\booksubtitle}
+\newcommand{\authorname}{\bookauthor}
+\newcommand{\authoremail}{\bookemail}
+\providecommand{\texsmithEmoji}[1]{#1}
+
+\definecolor{indigo(dye)}{rgb}{0.0, 0.25, 0.42}
+
+\BLOCK{ if glossary }\input{glossary}\BLOCK{ endif }
+
+\begin{document}
+\hypersetup{pageanchor=false}
+\frontmatter
+\maketitle
+\thispagestyle{empty}
+\BLOCK{ if imprint_thanks|trim or imprint_license|trim or imprint_copyright|trim }
+\cleardoublepage
+\thispagestyle{plain}
+\phantomsection
+\BLOCK{ if imprint_thanks|trim }
+\subsection*{Thanks}
+\VAR{imprint_thanks}
+\BLOCK{ endif }
+\BLOCK{ if imprint_license|trim }
+\subsection*{License}
+\VAR{imprint_license}
+\BLOCK{ endif }
+\BLOCK{ if imprint_copyright|trim }
+\subsection*{Copyright}
+\VAR{imprint_copyright}
+\BLOCK{ endif }
+\BLOCK{ endif }
+
+\BLOCK{ if dedication|trim }
+\cleardoublepage
+\thispagestyle{plain}
+\phantomsection
+\begin{center}
+  \vspace*{3cm}
+  {\Large\itshape \VAR{dedication}}
+\end{center}
+\BLOCK{ endif }
+
+\thispagestyle{empty}
+
+\raggedbottom
+
+
+\BLOCK{ if preface|trim }
+\cleardoublepage
+\thispagestyle{plain}
+\begingroup
+\setsecnumdepth{none}
+\phantomsection
+\VAR{preface}
+\endgroup
+\BLOCK{ endif }
+
+\VAR{frontmatter}
+
+\clearpage
+\tableofcontents*
+
+\hypersetup{pageanchor=true}
+\mainmatter
+
+\VAR{mainmatter}
+
+\BLOCK{ if appendix }
+\appendix
+\VAR{appendix}
+\BLOCK{ endif }
+
+\backmatter
+
+\BLOCK{ if listoffigures }
+\ifnum\value{figure}>0
+\clearpage
+\listoffigures
+\fi
+\BLOCK{ endif }
+\BLOCK{ if listoftables }
+\ifnum\value{table}>0
+\clearpage
+\listoftables
+\fi
+\BLOCK{ endif }
+
+\VAR{backmatter}
+\VAR{fragment_backmatter}
+
+\BLOCK{ if colophon|trim }
+\cleardoublepage
+\phantomsection
+\addcontentsline{toc}{chapter}{Colophon}
+\chapter*{Colophon}
+\VAR{colophon}
+\BLOCK{ endif }
+
+\end{document}

texsmith/templates/common/__init__.py

@@ -0,0 +1 @@
+"""Shared LaTeX assets reused by built-in templates."""