Re: Another modest proposal for docs formatting: catalog descriptions - Mailing list pgsql-docs

From Tom Lane
Subject Re: Another modest proposal for docs formatting: catalog descriptions
Date
Msg-id 14810.1589128043@sss.pgh.pa.us
Whole thread Raw
In response to Re: Another modest proposal for docs formatting: catalog descriptions  (Tom Lane <tgl@sss.pgh.pa.us>)
Responses Re: Another modest proposal for docs formatting: catalog descriptions
Re: Another modest proposal for docs formatting: catalog descriptions
List pgsql-docs
Just FTR, here's a complete patch for this.  I successfully regenerated
the column names, types, and ordering from the system catalogs, and
plugged the descriptions back into that by dint of parsing them out of
the XML.  The "references" data was based on findoidjoins' results plus
hand additions to cover all the cases we are calling out now (there are
a lot of "references" links for attnums and a few other non-OID columns,
plus references links for views which findoidjoins doesn't consider).
So I have pretty high confidence that this info is OK.  I'd be too
embarrassed to show anybody the code though ;-) ... it was just a brute
force hack.

            regards, tom lane

--- main.css~    2020-05-10 12:18:39.773129302 -0400
+++ main.css    2020-05-09 21:46:22.424776849 -0400
@@ -792,13 +792,6 @@
 }

 /** Formatting for entries in tables of functions: indent all but first line **/
-#docContent table.table th.functableentry,
-#docContent table.table td.functableentry {
-    padding-left: 4em;
-    text-indent: -3.5em;
-    text-align: left;
-}
-
 #docContent table.table th.func_table_entry p,
 #docContent table.table td.func_table_entry p {
   margin-top: 0.1em;
@@ -820,6 +813,38 @@
   padding-left: 4em;
 }

+/** Formatting for entries in tables of catalog/view columns **/
+#docContent table.table th.catalog_table_entry p,
+#docContent table.table td.catalog_table_entry p {
+  margin-top: 0.1em;
+  margin-bottom: 0.1em;
+  padding-left: 4em;
+  text-align: left;
+}
+
+#docContent table.table th.catalog_table_entry p.column_definition {
+  text-indent: -3.5em;
+  word-spacing: 0.25em;
+}
+
+#docContent table.table td.catalog_table_entry p.column_definition {
+  text-indent: -3.5em;
+}
+
+#docContent table.table p.column_definition code.type {
+  padding-left: 0.25em;
+  padding-right: 0.25em;
+}
+
+#docContent table.table td.catalog_table_entry pre.programlisting {
+  background-color: inherit;
+  border: 0;
+  margin-bottom: 0.1em;
+  margin-top: 0.1em;
+  padding: 0;
+  padding-left: 4em;
+}
+
 /**
  * Titles, Navigation
  */

Attachment

pgsql-docs by date:

Previous
From: "postgresql_2016@163.com"
Date:
Subject: 【memory barrier】Should we update the README.barrier description.
Next
From: "Jonathan S. Katz"
Date:
Subject: Re: Another modest proposal for docs formatting: catalog descriptions