recurse into brand.typography on reference page

somewhat messy but fairly complete

Author: gordonwoodhull

docs/reference/formats/docx.json

@@ -93,7 +93,7 @@
     "options": [
       {
         "name": "page-width",
-        "description": "Target page width for output (used to compute columns widths for `layout` divs).\nDefaults to 6.5 inches, which corresponds to default letter page settings in \ndocx and odt.\n"
+        "description": "Target body page width for output (used to compute columns widths for `layout` divs).\nDefaults to 6.5 inches, which corresponds to default letter page settings in \ndocx and odt (8.5 inches with 1 inch for each margins).\n"
       },
       {
         "name": "grid",

docs/reference/formats/odt.json

@@ -85,7 +85,7 @@
     "options": [
       {
         "name": "page-width",
-        "description": "Target page width for output (used to compute columns widths for `layout` divs).\nDefaults to 6.5 inches, which corresponds to default letter page settings in \ndocx and odt.\n"
+        "description": "Target body page width for output (used to compute columns widths for `layout` divs).\nDefaults to 6.5 inches, which corresponds to default letter page settings in \ndocx and odt (8.5 inches with 1 inch for each margins).\n"
       },
       {
         "name": "grid",

docs/reference/formats/presentations/revealjs.json

@@ -186,6 +186,10 @@
       {
         "name": "multiplex",
         "description": "Configuration for reveal presentation multiplexing."
+      },
+      {
+        "name": "scroll-view",
+        "description": "Control the scroll view feature of Revealjs"
       }
     ]
   },

docs/reference/metadata/brand.json

@@ -45,7 +45,7 @@
     "options": [
       {
         "name": "images",
-        "description": ""
+        "description": "A dictionary of named logo resources."
       },
       {
         "name": "small",
@@ -113,10 +113,6 @@
         "name": "dark",
         "description": "A dark color, used as a high-contrast foreground color on light elements or high-contrast background color on light elements.\n"
       },
-      {
-        "name": "emphasis",
-        "description": "A color used to emphasize or highlight text or elements.\n"
-      },
       {
         "name": "link",
         "description": "The color used for hyperlinks. If not defined, the `primary` color is used.\n"
@@ -133,27 +129,189 @@
       },
       {
         "name": "base",
-        "description": "The base font settings for the brand. These are used as the default for all text.\n"
+        "description": "The base font settings for the brand. These are used as the default for all text.\n See [base](#base) for more information."
       },
       {
         "name": "headings",
-        "description": "Settings for headings\n"
+        "description": "Settings for headings. See [headings](#headings) for more information."
       },
       {
         "name": "monospace",
-        "description": "Settings for monospace text\n"
+        "description": "Settings for monospace text. See [monospace](#monospace) for more information."
       },
       {
         "name": "monospace-inline",
-        "description": "Settings for inline code"
+        "description": "Settings for inline code. See [monospace-inline](#monospace-inline) for more information."
       },
       {
         "name": "monospace-block",
-        "description": "Settings for code blocks"
+        "description": "Settings for code blocks. See [monospace-block](#monospace-block) for more information."
       },
       {
         "name": "link",
-        "description": "Settings for links"
+        "description": "Settings for links. See [link](#link) for more information."
+      }
+    ]
+  },
+  {
+    "name": "brand-typography-options-base",
+    "title": "base",
+    "level": 3,
+    "options": [
+      {
+        "name": "family",
+        "description": "The font family."
+      },
+      {
+        "name": "size",
+        "description": "The font size."
+      },
+      {
+        "name": "weight",
+        "description": "The font weight."
+      },
+      {
+        "name": "color",
+        "description": "The text color."
+      },
+      {
+        "name": "line-height",
+        "description": "The distance between lines of text."
+      }
+    ]
+  },
+  {
+    "name": "brand-typography-options-headings",
+    "title": "headings",
+    "level": 3,
+    "options": [
+      {
+        "name": "family",
+        "description": "The font family."
+      },
+      {
+        "name": "weight",
+        "description": "The font weight."
+      },
+      {
+        "name": "style",
+        "description": "The font style."
+      },
+      {
+        "name": "color",
+        "description": "The text color."
+      },
+      {
+        "name": "line-height",
+        "description": "The distance between lines of text."
+      }
+    ]
+  },
+  {
+    "name": "brand-typography-options-monospace",
+    "title": "monospace",
+    "level": 3,
+    "options": [
+      {
+        "name": "family",
+        "description": "The font family."
+      },
+      {
+        "name": "size",
+        "description": "The font size."
+      },
+      {
+        "name": "weight",
+        "description": "The font weight."
+      },
+      {
+        "name": "color",
+        "description": "The text color."
+      },
+      {
+        "name": "background-color",
+        "description": "The text background color."
+      }
+    ]
+  },
+  {
+    "name": "brand-typography-options-monospace-inline",
+    "title": "monospace-inline",
+    "level": 3,
+    "options": [
+      {
+        "name": "family",
+        "description": "The font family."
+      },
+      {
+        "name": "size",
+        "description": "The font size."
+      },
+      {
+        "name": "weight",
+        "description": "The font weight."
+      },
+      {
+        "name": "color",
+        "description": "The text color."
+      },
+      {
+        "name": "background-color",
+        "description": "The text background color."
+      }
+    ]
+  },
+  {
+    "name": "brand-typography-options-monospace-block",
+    "title": "monospace-block",
+    "level": 3,
+    "options": [
+      {
+        "name": "family",
+        "description": "The font family."
+      },
+      {
+        "name": "size",
+        "description": "The font size."
+      },
+      {
+        "name": "weight",
+        "description": "The font weight."
+      },
+      {
+        "name": "color",
+        "description": "The text color."
+      },
+      {
+        "name": "background-color",
+        "description": "The text background color."
+      },
+      {
+        "name": "line-height",
+        "description": "The distance between lines of text."
+      }
+    ]
+  },
+  {
+    "name": "brand-typography-options-link",
+    "title": "link",
+    "level": 3,
+    "options": [
+      {
+        "name": "weight",
+        "description": "The font weight."
+      },
+      {
+        "name": "color",
+        "description": "The text color."
+      },
+      {
+        "name": "background-color",
+        "description": "The text background color."
+      },
+      {
+        "name": "decoration",
+        "description": "The text decoration, i.e. underline"
       }
     ]
   }

docs/reference/reference.lua

@@ -52,7 +52,7 @@ function Pandoc(doc)
     local groups = jsonDecode(refJson)
     for _,group in ipairs(groups) do
       -- title
-      doc.blocks:insert(pandoc.Header(2, markdownToInlines(group.title), pandoc.Attr(autoId(group.title))))
+      doc.blocks:insert(pandoc.Header(group.level or 2, markdownToInlines(group.title), pandoc.Attr(autoId(group.title))))
       -- optionalal description
       if group.description then
         local description = pandoc.read(group.description).blocks

tools/reference.ts

@@ -267,6 +267,28 @@ function readDefinitionsId(id: string, descriptions?: Record<string, string>) {
   return results;
 }
 
+function readTypographyOptions(id: string, toFollow: Array<string>) {
+  const obj = definitions.find(value => value.id === id) as any;
+
+  const baseObject = (obj["object"] || obj["schema"]["object"]);
+  const props = baseObject["properties"];
+  const descriptions = {};
+
+  for (const [key, prop] of Object.entries(props).filter(([_, {ref}]) => ref)) {
+    if (prop.hidden) {
+      continue;
+    }
+    const shortref = prop.ref.replace(/^brand-typography-options-/, '');
+    descriptions[key] = asDescriptionString(findVal(prop, "description")) +" See [" + shortref + "](#" + shortref + ") for more information.";
+    toFollow.push(prop.ref)
+  }
+
+  const results = [];
+  results.push(...readProjectProperties(props, descriptions));
+
+  return results;
+}
+
 function readNavigationItem(descriptions?: Record<string, string>) {
   const obj = definitions.find(value => value.id === "navigation-item") as any;
   const refId = obj["anyOf"][1]["ref"];
@@ -343,6 +365,19 @@ const brandOptions = readDefinitionsId("brand",{
   "defaults": "Default settings"
 });
 
+const toFollow : Array<string> = []
+
+const typographyOptionDescriptions = {
+  "family": "The font family.",
+  "size": "The font size.",
+  "weight": "The font weight.",
+  "style": "The font style.",
+  "color": "The text color.",
+  "background-color": "The text background color.",
+  "decoration": "The text decoration, i.e. underline",
+  "line-height": "The distance between lines of text.",
+};
+
 const brandMetadata = [
   {
     "name": "brand",
@@ -367,8 +402,22 @@ const brandMetadata = [
   {
     "name": "brand-typography",
     "title": "Typography",
-    "options": readDefinitionsId("brand-typography")
-  }
+    "options": readTypographyOptions("brand-typography", toFollow)
+  },
+  ...toFollow.map(id => {
+    const typography = definitions.find(value => value.id === id);
+    const root = typography?.["anyOf"][1]?.object;
+    if (root?.properties) {
+      return {
+        "name": id,
+        "title": id.replace(/^brand-typography-options-/, ''),
+        "level": 3,
+        "options": readProjectProperties(root.properties, typographyOptionDescriptions)
+      }
+    } else {
+      return null;
+    }
+  }).filter(x => x),
 ]
 Deno.writeTextFileSync(`docs/reference/metadata/brand.json`, JSON.stringify(brandMetadata, undefined, 2));