LaTeX generator upgrades (#49).

Fysiksektionen · Aug 22, 2023 · cf9ad4a · cf9ad4a
1 parent 63d893c
commit cf9ad4a
Show file tree

Hide file tree

Showing 6 changed files with 135 additions and 29 deletions.
diff --git a/public/tex/blad.cls b/public/tex/blad.cls
@@ -1,8 +1,9 @@
 % Filename: blad.cls
-% Author: Arno Lepisk (2003, v 1.0)
-%         Oskar Rune (2021, v 1.2.0)
+% Author: Arno Lepisk (v1.0, 2003)
+%         Oskar Rune (v1.2.0, 2021 & v1.2.1, 2023)
 % 
-% Version: 1.2.0. Not backwards-compatible with versions 1.0 and 1.1.x
+% Version: 1.2.1. Not backwards-compatible with versions 1.0-1.1.x.
+%   Compatible with 1.2.0 when song indices are disabled. (I.e. use \newcommand{\songindex}[1]{})
 
 % This is a LaTeX2e document class.
 
@@ -16,6 +17,9 @@
 
 \LoadClass[a4paper]{article}
 
+%
+% Packages
+%
 \RequirePackage[swedish]{babel}
 \RequirePackage[utf8]{inputenc}
 \RequirePackage[T1]{fontenc}
@@ -25,11 +29,13 @@
 \RequirePackage{xspace}
 \RequirePackage{ifthen}
 \RequirePackage{quoting}
-
 \RequirePackage{verbatim}
+\RequirePackage{comment}
+
+\RequirePackage{amsmath,amsfonts,amssymb,bm}
+\RequirePackage{graphicx,svg}
+\RequirePackage{fancyhdr}
 
-\RequirePackage{amsmath,amsfonts,amssymb,graphicx}
-\RequirePackage{svg}
 
 %
 % Layout
@@ -59,41 +65,43 @@
 \setlength{\paperwidth}{.5\paperwidth}
 
 \setlength{\textwidth}{.96\paperwidth}
-\setlength{\textheight}{.95\paperheight}
+\setlength{\textheight}{.95\paperheight-10mm} % One may want to remove the "-10mm" when not using page-numbering
 
 %
 % Booklet setup
 %
-\usepackage[print]{booklet}
+\RequirePackage[print]{booklet}
 \source{\magstep1}{\paperwidth}{\paperheight}
 \target{\magstep1}{2\paperwidth}{\paperheight}
 
+%
+% Page numbering
+%
+\pagestyle{fancy} % May be set to "empty" if not using numbering
+\pagenumbering{arabic} % May be set to "none" if not using numbering
+\renewcommand{\headrulewidth}{0pt} % Removes the horizontal line from the header
+\fancyhead{} % Clear default header
+\fancyfoot[C]{\thepage} % Set footer (C = center) to display page numbers
+
+\pagestyle{empty}
+
 %
 % Song template
 %
-\newcommand{\songtitle}[1]{
+\newcommand{\songindex}[1]{#1. } % Extracted so that it can be overridden.
+\newcommand{\songtitle}[2][]{
     \begin{flushleft}
-        \subsection*{#1}
+        \subsection*{\boldmath\songindex{#1}#2\unboldmath}
     \end{flushleft}
     % \nopagebreak
 }
 \newcommand{\melody}[1]{
     % \nopagebreak
     \vspace*{0.1cm}
-        \begin{quoting}[leftmargin=6mm]
-            \small{\textit{#1}}
-        \end{quoting}
+    \begin{quoting}[leftmargin=6mm]\small{\textit{#1}}\end{quoting}
     \vspace*{-3mm}
     % \nopagebreak
 }
-\newenvironment{lyrics}{
-%  \nopagebreak
- \vspace*{1mm}
- \begin{verse}
-}{
- \end{verse}
-%  \nopagebreak
-}
 \newcommand{\auth}[1]{
     % \nopagebreak
     \vspace*{0.1cm}
@@ -103,42 +111,98 @@
         \end{flushright}
     \end{verse}
 }
+\newenvironment{lyrics}{
+%  \nopagebreak
+ \vspace*{1mm}
+ \begin{verse}
+}{
+ \end{verse}
+%  \nopagebreak
+}
 
 % fkm* logo
 \newcommand{\fkm}{\mbox{{\raisebox{-0.2ex}
     {\rotatebox{22}{\bf{f}}}\hspace{-0.16em}\raisebox{0.2ex}
     {\rotatebox{-15}{\bf{k}}}\hspace{-0.17em}\bf{m}\hspace{-0.15em}\raisebox{0.6ex}
     {\scalebox{0.6}{\bf{*}}}}}\xspace}
 
-\pagenumbering{none}
-\pagestyle{empty}
-
 %
-% Special character handling 
+% Special character handling
 %
+
+% Greek uppercase
+\DeclareUnicodeCharacter{0391}{A} % Α
+\DeclareUnicodeCharacter{0392}{B} % Β
+\DeclareUnicodeCharacter{0393}{$\Gamma$} % Γ
 \DeclareUnicodeCharacter{0394}{$\Delta$} % Δ
+\DeclareUnicodeCharacter{0395}{E} % Ε
+\DeclareUnicodeCharacter{0396}{Z} % Ζ
+\DeclareUnicodeCharacter{0397}{H} % Η
+\DeclareUnicodeCharacter{0398}{$\Theta$} % Θ
+\DeclareUnicodeCharacter{0399}{I} % Ι
+\DeclareUnicodeCharacter{039A}{K} % Κ
+\DeclareUnicodeCharacter{039B}{$\Lambda$} % Λ
+\DeclareUnicodeCharacter{039C}{M} % Μ
+\DeclareUnicodeCharacter{039D}{N} % Ν
+\DeclareUnicodeCharacter{039E}{$\Xi$} % Ξ
+\DeclareUnicodeCharacter{039F}{O} % Ο
+\DeclareUnicodeCharacter{03A0}{$\Pi$} % Π
+\DeclareUnicodeCharacter{03A1}{P} % Ρ
+% \DeclareUnicodeCharacter{03A2}{$\CHANGEME$} % ΢
+\DeclareUnicodeCharacter{03A3}{$\Sigma$} % Σ
+\DeclareUnicodeCharacter{03A4}{T} % Τ
+\DeclareUnicodeCharacter{03A5}{Y} % Υ
+\DeclareUnicodeCharacter{03A6}{$\Phi$} % Φ
+\DeclareUnicodeCharacter{03A7}{X} % Χ
+\DeclareUnicodeCharacter{03A8}{$\Psi$} % Ψ
 \DeclareUnicodeCharacter{03A9}{$\Omega$} % Ω
+
+% Greek lowercase
+\DeclareUnicodeCharacter{03B1}{$\alpha$} % α
 \DeclareUnicodeCharacter{03B2}{$\beta$} % β
+\DeclareUnicodeCharacter{03B3}{$\gamma$} % γ
 \DeclareUnicodeCharacter{03B4}{$\delta$} % δ
 \DeclareUnicodeCharacter{03B5}{$\varepsilon$} % ε
 \DeclareUnicodeCharacter{03B6}{$\zeta$} % ζ
+\DeclareUnicodeCharacter{03B7}{$\eta$} % η
+\DeclareUnicodeCharacter{03B8}{$\theta$} % θ
+\DeclareUnicodeCharacter{03B9}{$\iota$} % ι
+\DeclareUnicodeCharacter{03BA}{$\kappa$} % κ
+\DeclareUnicodeCharacter{03BB}{$\lambda$} % λ
+\DeclareUnicodeCharacter{03BC}{$\mu$} % μ
+\DeclareUnicodeCharacter{03BD}{$\nu$} % ν
+\DeclareUnicodeCharacter{03BE}{$\xi$} % ξ
+\DeclareUnicodeCharacter{03BF}{o} % ο
 \DeclareUnicodeCharacter{03C0}{$\pi$} % π
 \DeclareUnicodeCharacter{03C1}{$\rho$} % ρ
 \DeclareUnicodeCharacter{03C3}{$\sigma$} % σ
 \DeclareUnicodeCharacter{03C4}{$\tau$} % τ
+\DeclareUnicodeCharacter{03C5}{$\upsilon$} % υ
+\DeclareUnicodeCharacter{03C6}{$\phi$} % φ
+\DeclareUnicodeCharacter{03C7}{$\chi$} % χ
+\DeclareUnicodeCharacter{03C8}{$\psi$} % ψ
 \DeclareUnicodeCharacter{03C9}{$\omega$} % ω
+\DeclareUnicodeCharacter{03D1}{$\vartheta$} % ϑ
 \DeclareUnicodeCharacter{03D5}{$\varphi$} % ϕ
-\DeclareUnicodeCharacter{2207}{$\nabla$} % ∇
+\DeclareUnicodeCharacter{03F1}{$\varrho$} % ϱ
 
+% Math, sub-/superscripts
 \DeclareUnicodeCharacter{00B0}{$^\circ$} % °
 \DeclareUnicodeCharacter{00B2}{$^2$} % ²
 \DeclareUnicodeCharacter{00B3}{$^3$} % ³
 \DeclareUnicodeCharacter{2082}{$_2$} % ₂
 \DeclareUnicodeCharacter{2099}{$_n$} % ₙ
 
+% Math, other
 \DeclareUnicodeCharacter{1E8D}{$\ddot{x}$} % ẍ
 \DeclareUnicodeCharacter{1E8B}{$\dot{x}$} % ẋ
+\DeclareUnicodeCharacter{2124}{$\mathbb{Z}$} % ℤ
+\DeclareUnicodeCharacter{2200}{$\forall$} % ∀
+\DeclareUnicodeCharacter{2208}{$\in$} % ∈
+\DeclareUnicodeCharacter{2297}{$\otimes$} % ⊗
+\DeclareUnicodeCharacter{221E}{$\infty$} % ∞
 \DeclareUnicodeCharacter{2205}{$\emptyset$} % ∅
+\DeclareUnicodeCharacter{2207}{$\nabla$} % ∇
 \DeclareUnicodeCharacter{2229}{$\cap$} % ∩
 \DeclareUnicodeCharacter{222A}{$\cup$} % ∪
 \DeclareUnicodeCharacter{222B}{$\int$} % ∫
@@ -147,4 +211,6 @@
 \DeclareUnicodeCharacter{27F8}{$\Leftarrow$} % ⟸
 \DeclareUnicodeCharacter{2202}{$\partial$} % ∂
 \DeclareUnicodeCharacter{2260}{$\neq$} % ≠
-\DeclareUnicodeCharacter{2228}{$\lor$} % ∨
+\DeclareUnicodeCharacter{2228}{$\lor$} % ∨
+\DeclareUnicodeCharacter{230A}{$\lfloor$} % ⌊
+\DeclareUnicodeCharacter{230B}{$\rfloor$} % ⌋
diff --git a/public/tex/unicode-gen.py b/public/tex/unicode-gen.py
@@ -0,0 +1,19 @@
+#!/usr/bin/env python3
+# May be used to generate a list of characters to be handled in blad.cls
+# Note that the actual LaTeX equivalent must be set manually, by changing "\CHANGEME" in the output.
+
+# E.g. 0x0394 to 0x03D5, input 0394 and 03D5
+print("Enter your unicode range (base 16, e.g. 03D5).")
+start_codepoint = int(input("Starting codepoint: "), 16)
+stop_codepoint = int(input("Ending codepoint: "), 16)
+
+if stop_codepoint < start_codepoint:
+    print("Empty or negative codepoint range.")
+elif stop_codepoint - start_codepoint > 1000:
+    print("More than 1000 codepoints would be generated. Aborting.")
+else:
+    for codepoint in range(start_codepoint, stop_codepoint + 1):
+        unicode_char = chr(codepoint)
+        padded_codepoint = format(codepoint, '04X')
+        latex_representation = f"\\DeclareUnicodeCharacter{{{padded_codepoint}}}{{$\\CHANGEME$}} % {unicode_char}"
+        print(latex_representation)
diff --git a/src/lyrics/README.md b/src/lyrics/README.md
@@ -19,4 +19,11 @@ Låtar kan ha taggar, och dessa går att söka på. Detta kan vara användbart o
 }
 ```
 
-Dessutom finns taggen `+`, som gör att låten kommer högre upp i sökresultat.
+Dessutom finns taggen `+`, som gör att låten kommer högre upp i sökresultat.
+
+## Specialtecken
+När sångblad ska genereras har LaTeX ofta problem med unicode-symboler. Detta kan lösas genom att lägga till en rad likt följande i [blad.cls](../../public/tex/blad.cls):
+```tex
+\DeclareUnicodeCharacter{2124}{$\mathbb{Z}$} % ℤ
+```
+Raden ovan definierar unicode-tecknet U+2124 (dvs. ℤ), och säger åt LaTeX att ersätta det med `$\mathbb{Z}$`.
diff --git a/src/utils/export/contentTeX.ts b/src/utils/export/contentTeX.ts
@@ -43,7 +43,7 @@ export default function getContentTeX(songs: Song[], gs: GeneralSettings, ss: Sp
       '\\pagebreak[3]\n',
       // Try to get everything else on the same page
       '\\begin{samepage}\n',
-      `\\songtitle{${escapeAll(song.title)}}\n`,
+      `\\songtitle[${escapeAll(song.index)}]{${escapeAll(song.title)}}\n`,
       ...getMelodyContent(gs, song),
       '\\begin{lyrics}\n'
     )

diff --git a/src/utils/export/generalSettings.ts b/src/utils/export/generalSettings.ts
@@ -5,7 +5,9 @@ export type GeneralSettings = {
   title: StringSetting,
   showLogo: BoolSetting,
   showDate: BoolSetting,
+  showPageNumbers: BoolSetting,
   showMelody: BoolSetting,
+  showIndices: BoolSetting,
   showAuthor: BoolSetting,
   showSheetMusicNotice: BoolSetting
 }
@@ -27,11 +29,21 @@ export const generalSettings: GeneralSettings = {
     type: 'bool',
     value: true
   },
+  showPageNumbers: {
+    text: 'Inkludera sidnummer',
+    type: 'bool',
+    value: true
+  },
   showMelody: {
     text: 'Inkludera melodi',
     type: 'bool',
     value: true
   },
+  showIndices: {
+    text: 'Inkludera index',
+    type: 'bool',
+    value: false
+  },
   showAuthor: {
     text: 'Inkludera författare',
     type: 'bool',

diff --git a/src/utils/export/mainTeX.ts b/src/utils/export/mainTeX.ts
@@ -16,6 +16,8 @@ export default function getMainTeX(gs: GeneralSettings): string {
     `${gs.showDate.value ? '%' : ''}\\date{}\t%Ta bort kommentaren om du inte vill ha med datum.`,
     `${gs.showAuthor.value ? '%' : ''}\\renewcommand{\\auth}[1]{}\t%Ta bort kommentaren om du inte vill ha med upphovspersons-angivelse.`,
     `${gs.showMelody.value ? '%' : ''}\\renewcommand{\\melody}[1]{}\t%Ta bort kommentaren om du inte vill ha med melodier.`,
+    `${gs.showIndices.value ? '%' : ''}\\renewcommand{\\songindex}[1]{}\t%Ta bort kommentaren om du inte vill ha med index.`,
+    `${gs.showPageNumbers.value ? '%' : ''}\\fancyfoot{}\\setlength{\\textheight}{.95\\paperheight} \t%Ta bort kommentaren om du inte vill ha med sidnummer.`,
     '\n\n\\begin{document}\n\\maketitle\n\\input{content.tex}\n\\end{document}'
   )
   return out.join('\n')