From 3ab8869849350f9a9b873cc52d4b67ba2f4c0810 Mon Sep 17 00:00:00 2001 From: "Karl O. Pinc" Date: Tue, 30 Jan 2024 18:02:24 -0600 Subject: [PATCH] Note how the table listing a view's columns should be constructed --- doc/README | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/doc/README b/doc/README index 03f98d0..4951679 100644 --- a/doc/README +++ b/doc/README @@ -12,7 +12,17 @@ To include the statement used to generate a particular view use: Where $SCHEMA is the schema the view is in and $VIEWNAME is the name of the view. -Each table, and each column, has replacement text defined in epilog.rst.m4. +Notes on the tables listing the columns of the views: The "grid table" +format is used because it allows literal line blocks (like "| line1") +in table cells. This (sphinx-build v7.1.0) seems to force an extra +newline at the top of the cell when rendering in LaTeX. But otherwise +the LaTeX output hypenates the column names and puts line breaks in +odd spots, making the PDF output hard to read. The ".tabularlcolumns" +directive is used in conjuction with the "table:", allowing control of +LaTeX column widths and forcing all the tables into "longtable" LaTeX +format for consistency. + +Each db table, and each column, has replacement text defined in epilog.rst.m4. This is so that the section headings can have "extra comment" in them. (Simplest to just always have replacement text, rather than worrying about whether to use :ref:`foo` or |foo|.) -- 2.34.1