Merge branch 'add-title-description-support' into 'develop'

add title and description support

See merge request !356

.ci/generateIndex.py

@@ -56,21 +56,23 @@ def build_section_start(title, shortcut):
 def build_section_end():
     return "\t\t</ul>\n\t</div>"
 
-def save_order(localroot, root, filename):
-    order = ""
+def save_tag(localroot, root, filename, tag):
+    return_tag = ""
     os.chdir(root)
 
+    length_tag = len(tag)
+
     with open(filename, 'r') as f:
         for line in f:
             # check for the start of the section
-            if line[0:6] == "order:":
-                order = line[7:]
+            if line[0:length_tag+1] == tag + ":":
+                return_tag = line[length_tag+2:]
                 break
 
     # change back to the local root
     os.chdir(localroot)
 
-    return order.rstrip()
+    return return_tag.rstrip()
 
 def get_ignore():
     return ["404.html",
@@ -147,7 +149,7 @@ def remove_header(localroot, root, filename):
 
     return n
 
-def generate_header(folder, permalink, shortcut, order, legacy_from):
+def generate_header(folder, permalink, shortcut, order, legacy_from, title, description):
     header = "---\n"
 
     if len(order) > 0:
@@ -167,6 +169,13 @@ def generate_header(folder, permalink, shortcut, order, legacy_from):
     if "lab-software" in permalink or "lab-equipment" in permalink or "lab-hsa" in permalink:
         header += "  - /cards/" + root_lab(shortcut) + "\n"
         header += "  - /" + folder + "/cards/" + root_lab(shortcut) + "\n"
+
+    # add the title and description
+    if len(title) > 0:
+        header += "title: " + title + "\n"
+    if len(description) > 0:
+        header += "description: " + description + "\n"
+
     # include the legacy section
     if len(legacy_from) > 0:
         for item in legacy_from:
@@ -254,8 +263,10 @@ for folder in cardDirs:
                                 print(" > Generating header for: " + fileName)
 
                                 # save order and legacy section
-                                order = save_order(localroot, root, file)
+                                order = save_tag(localroot, root, file, "order")
                                 legacy_from = save_legacy_from(localroot, root, file)
+                                title = save_tag(localroot, root, file, "title")
+                                description = save_tag(localroot, root, file, "description")
 
                                 # remove the previous header
                                 n = remove_header(localroot, root, file)
@@ -289,7 +300,7 @@ for folder in cardDirs:
                                     orderArr[indexS] = []
 
                                 # generate the header for each card
-                                header = generate_header(folder, permalink, shortcut, order, legacy_from)
+                                header = generate_header(folder, permalink, shortcut, order, legacy_from, title, description)
 
                                 # add autogenerated links to whitelist
                                 whiteList += generate_whitelist_entry(folder, permalink, shortcut)

external/access/harrenhal-access/harrenhal-access.md

@@ -6,6 +6,8 @@ shortcut: access:harrenhal-access
 redirect_from:
   - /cards/access:harrenhal-access
   - /external/cards/access:harrenhal-access
+title: HARRENHAL access
+description: This is the howto card that describes the access procedure to the HARRENHAL system
 ---
 # HARRENHAL access