From 4cb35354a461914e5026f9be4234c3231d987158 Mon Sep 17 00:00:00 2001
From: Lephenixnoir <sebastien.michelland@protonmail.com>
Date: Wed, 28 Apr 2021 14:35:55 +0200
Subject: [PATCH] html: add a summary that repeats the most important fields

---
 lang/en.yaml         |  1 +
 lang/fr.yaml         |  1 +
 tools/render-html.py | 22 +++++++++++++++++-----
 3 files changed, 19 insertions(+), 5 deletions(-)

diff --git a/lang/en.yaml b/lang/en.yaml
index 1ba4822..f6b1b9b 100644
--- a/lang/en.yaml
+++ b/lang/en.yaml
@@ -4,6 +4,7 @@ constants:
   yes: "Yes"
 
 categories:
+  summary: "Essential summary"
   general: "General information"
   teaching: "Teaching"
   packaging: "Packaging and power"
diff --git a/lang/fr.yaml b/lang/fr.yaml
index 611d955..90f5617 100644
--- a/lang/fr.yaml
+++ b/lang/fr.yaml
@@ -4,6 +4,7 @@ constants:
   yes: "Oui"
 
 categories:
+  summary: "Les essentiels"
   general: "Informations générales"
   teaching: "Enseignement"
   packaging: "Caractéristiques physiques"
diff --git a/tools/render-html.py b/tools/render-html.py
index e305557..05da1ee 100755
--- a/tools/render-html.py
+++ b/tools/render-html.py
@@ -9,6 +9,12 @@ import calcdb
 db = calcdb.CalcDB(".")
 md = markdown.Markdown()
 
+# Fields for the summary
+summary = [
+  "teaching.exam_mode",
+  "devices.transfer_tutorial",
+]
+
 # Parse arguments
 
 def usage():
@@ -118,24 +124,30 @@ for (name, calc) in db.all_calcs():
     print(f"<td class='borderless {cssname}{active}'><b>{value}</b></td>")
 print("</tr>")
 
-for category in db.all_categories():
+# First category, the "summary"
+for category in ["summary"] + db.all_categories():
     r = lang.category(category)
     print(f"<tr class='category'>")
     print(f"  <th class='category'>{r}</th>")
     print(f"  <td colspan={len(db.calcs)}></td>")
     print(f"</tr>")
 
-    for field in db.all_fields(category):
+    if category == "summary":
+      fields = (name.split(".", 1) for name in summary)
+    else:
+      fields = ((category, field) for field in db.all_fields(category))
+
+    for (cat, field) in fields:
         if category == "general" and field == "full_name":
             continue
 
-        r = lang.field(category, field)
+        r = lang.field(cat, field)
         print(f"<tr><th class='field'>{r}</th>")
 
         for (name, calc) in db.all_calcs():
-            value = calc.get(category,{}).get(field)
+            value = calc.get(cat,{}).get(field)
 
-            r, styles = calcdb.render(db, lang, category, field, value)
+            r, styles = calcdb.render(db, lang, cat, field, value)
             r = lang.filter(r)
             r = md.convert(r)