Update pandoc_fe to insert a title page

Only when generating slide decks for distribution

Author: frank-at-adacore

pandoc/pandoc_fe.py

@@ -2,9 +2,19 @@
 import os
 import sys
 import subprocess
+import tempfile
 import multiprocessing
 from pathlib import Path
 
+"""
+Keys for content information in title page file.
+If no key is specified on a line in the file,
+the first item in this list will be used as the key.
+"""
+TITLE_KEYS = ["COPYRIGHT", "TITLE", "PRESENTER", "DATE", "OTHER"]
+
+TITLE_FILE_NAME = None
+
 
 def windows():
     return sys.platform.startswith("win")
@@ -23,6 +33,135 @@ def fix_file_case(filename):
     return filename
 
 
+def title_parse(line):
+    key = "COPYRIGHT"
+    pieces = line.split(":", 1)
+    if pieces[0] in TITLE_KEYS:
+        return pieces[0], pieces[1].strip()
+    else:
+        return TITLE_KEYS[0], line.strip()
+
+
+def default_title(source):
+    """
+    If not title is specified, use the folder name to determine title
+    """
+
+    title = os.path.basename(os.path.dirname(os.path.abspath(source)))
+    pieces = title.split("_")
+    title = ""
+    for piece in pieces:
+        title = title + piece[0].upper() + piece[1:] + " "
+    return title.strip()
+
+
+def parse_title_file(args):
+    title_source = args.title.strip()
+
+    retval = {}
+    for key in TITLE_KEYS:
+        if key == "COPYRIGHT":
+            retval[key] = []
+        else:
+            retval[key] = ""
+
+    try:
+        fp = None
+        if os.path.exists(title_source):
+            fp = open(title_source, "r")
+        else:
+            fp = open(os.path.join(os.path.dirname(__file__), "title_page.txt"), "r")
+        for line in fp:
+            key, content = title_parse(line.strip())
+            if len(content) > 0 or key == "COPYRIGHT":
+                if key == "COPYRIGHT":
+                    retval[key].append(content)
+                else:
+                    retval[key] = content
+
+        if len(retval["TITLE"]) == 0:
+            retval["TITLE"] = default_title(args.source[0])
+
+    except:
+        pass
+
+    return retval
+
+
+def print_content(tfp, title_info, prefix=""):
+    if len(title_info) > 0:
+        if title_info is list:
+            for item in title_info:
+                tfp.write(
+                    "   \\small{\\textit{" + prefix + "} \\textbf{" + item + "}}\n\n"
+                )
+        else:
+            tfp.write(
+                "   \\small{\\textit{" + prefix + "} \\textbf{" + title_info + "}}\n\n"
+            )
+
+
+def prepare_title_file(args):
+    """
+    If the "source" command line argument is only one TXT file, then we
+    assume we are producing a slide deck (anything else is just trying
+    to build from individual RST files).
+    In that case, we want to build a title slide for the deck,
+    consisting of the title for the course, possibly the presenter, date
+    and/or other information, and then copyright information.
+    This information will come from the "title_page.txt" file in the
+    "pandoc" folder OR from the "--title" option from the command line.
+    """
+
+    global TITLE_FILE_NAME
+
+    TITLE_FILE_NAME = None
+    if len(args.source) == 1 and args.source[0].lower().endswith(".txt"):
+        tmp = tempfile.NamedTemporaryFile(delete=False)
+        TITLE_FILE_NAME = tmp.name + ".rst"
+        title_info = parse_title_file(args)
+
+        with open(TITLE_FILE_NAME, "w") as tfp:
+
+            """
+            This is the actual title page for the beamer slide deck
+            """
+            separator = "#" * (2 + len(title_info["TITLE"]))
+            tfp.write(separator + "\n")
+            tfp.write(title_info["TITLE"] + "\n")
+            tfp.write(separator + "\n\n")
+
+            """
+            This is the copyright page (which will include any other user-specified
+            information) that appears after the document title page and before
+            the document actually begins.
+            """
+
+            tfp.write(".. raw:: latex\n\n")
+            tfp.write("   \\begin{center}\n")
+
+            tfp.write("   \\colorbox{adacore3}\n")
+            tfp.write(
+                "   {\\color{adacore1}{\\huge{\\textit{\\textbf{"
+                + title_info["TITLE"]
+                + "}}}}}\n\n"
+            )
+
+            print_content(tfp, title_info["PRESENTER"], prefix="Presented by")
+            print_content(tfp, title_info["DATE"])
+            print_content(tfp, title_info["OTHER"])
+
+            tfp.write("   \\end{center}\n\n")
+
+            tfp.write("   \\vspace{3cm}\n\n")
+
+            if len(title_info["COPYRIGHT"]) > 0:
+                tfp.write("   \\tiny{\n")
+                for line in title_info["COPYRIGHT"]:
+                    tfp.write("     " + line + "\n")
+                tfp.write("   }\n")
+
+
 def to_texinputs_path(path):
     abspath = fix_file_case(os.path.abspath(path))
     if path.endswith("//"):
@@ -182,13 +321,17 @@ def parse_rst_list_file(dirname, f):
 
 
 def expand_source(source_file):
+    global TITLE_FILE_NAME
+
     if source_file.lower().endswith(".rst"):
         return [os.path.abspath(source_file)]
     else:
         dirname = os.path.dirname(source_file)
         # Read lines from source file
         with open(source_file) as f:
             files = parse_rst_list_file(dirname, f)
+        if TITLE_FILE_NAME != None:
+            files.insert(0, TITLE_FILE_NAME)
         return files
 
 
@@ -212,11 +355,7 @@ def pandoc_prepare_run_single(n, source_or_source_list, args):
     if len(color) > 0:
         color = " -V colortheme=" + color
 
-    pandoc_title_arg = args.title
-    if args.title:
-        pandoc_title_arg = ' -V title="' + args.title.replace("_", " ") + '"'
-
-    input_file = args.title or source_or_source_list
+    input_file = source_or_source_list
 
     extension = args.extension
     if extension is None:
@@ -258,7 +397,6 @@ def pandoc_prepare_run_single(n, source_or_source_list, args):
         "--resource-path",
         texinputs,
         filter,
-        pandoc_title_arg,
         theme,
         color,
         "--fail-if-warnings",
@@ -301,6 +439,13 @@ def run_pandoc(args):
     print(f"[end  ] {task_name}")
 
 
+def delete_temp_file():
+    global TITLE_FILE_NAME
+    if TITLE_FILE_NAME != None and os.path.exists(TITLE_FILE_NAME):
+        os.remove(TITLE_FILE_NAME)
+        # print (TITLE_FILE_NAME)
+
+
 if __name__ == "__main__":
     PANDOC = Path(sys.argv[0]).resolve().parent
     ROOT = PANDOC.parent
@@ -371,10 +516,14 @@ def run_pandoc(args):
 
     args = parser.parse_args()
 
+    prepare_title_file(args)
+
     pandoc_prepared = pandoc_prepare_run(args)
 
     try:
         with multiprocessing.Pool(None if args.jobs == 0 else args.jobs) as p:
             p.map(run_pandoc, pandoc_prepared)
+        delete_temp_file()
     except subprocess.CalledProcessError as e:
+        delete_temp_file()
         sys.exit(2)

pandoc/title_page.txt

@@ -0,0 +1,16 @@
+TITLE:
+PRESENTER: Foo Bar
+DATE: 26 Jul 2025
+OTHER:
+Copyright (C) 2018-2025, AdaCore under CC BY-SA
+
+Published under a CC BY-SA license, which means that you can copy,
+redistribute, remix, transform, and build upon the content for any
+purpose, even commercially, as long as you give appropriate credit,
+provide a link to the license, and indicate if changes were made.
+If you remix, transform, or build upon the material, you must
+distribute your contributions under the same license as the
+original. You can find license details on this page
+http://creativecommons.org/licenses/by-sa/4.0
+
+