DOC: add reference navigation

Author: chrisws

_build/Makefile

@@ -25,7 +25,7 @@ scripts = $(patsubst scripts/%.html, $(out)/scripts2/%.html, $(wildcard scripts/
 reference = $(patsubst reference/%.markdown, $(out)/reference3/%.html, $(wildcard reference/*.markdown))
 
 # rules
-.data: reference.json page.bas site.bas mkdata.bas includes/header.html
+.data: reference.json page.bas site.bas mkdata.bas refindex.bas includes/header.html
 	@mkdir -p $(out)/data
 	$(sbasic) mkdata.bas
 

_build/layouts/reference.html

@@ -2,7 +2,11 @@
   <h1>{{ upper(page.name) }}</h1>
   <blockquote>{{ page.title }}</blockquote>
   <div class="siteSub">
-    <p><a href="/pages/index.html">Home</a> &gt; <a href="/pages/reference.html">Reference</a></p>
+    <p>
+      <a href="/pages/index.html">Home</a> &gt;
+      <a href="/pages/reference.html">Reference</a> &gt;
+      <a href="/pages/{{ lcase(page.package) }}.html">{{ page.package }}</a>
+    </p>
   </div>
   {% rem header left inside each markdown in case required for PDF generation %}
   {%
@@ -35,14 +39,14 @@ <h1>{{ upper(page.name) }}</h1>
     </div>
   </div>
   <div class="categories">
-    <a href="/reference/521.html">Console </a>
-    <a href="/reference/581.html">Data </a>
-    <a href="/reference/575.html">Date </a>
-    <a href="/reference/580.html">File </a>
-    <a href="/reference/611.html">Graphics </a>
-    <a href="/reference/662.html">Language </a>
-    <a href="/reference/704.html">Math </a>
-    <a href="/reference/771.html">String </a>
-    <a href="/reference/1439.html">System </a>
+    <a href="/pages/console.html">Console </a>
+    <a href="/pages/data.html">Data </a>
+    <a href="/pages/date.html">Date </a>
+    <a href="/pages/file.html">File </a>
+    <a href="/pages/graphics.html">Graphics </a>
+    <a href="/pages/language.html">Language </a>
+    <a href="/pages/math.html">Math </a>
+    <a href="/pages/string.html">String </a>
+    <a href="/pages/system.html">System </a>
   </div>
 </div>

_build/pages/reference.markdown

@@ -11,15 +11,15 @@ popular languages for several decades.
 Contents
 :::
 
-#. [Console](/reference/521.html)
-#. [Data](/reference/581.html)
-#. [Date](/reference/575.html)
-#. [File](/reference/580.html)
-#. [Graphics](/reference/611.html)
-#. [Language](/reference/622.html)
-#. [Math](/reference/704.html)
-#. [String](/reference/771.html)
-#. [System](/reference/1439.html)
+#. [Console](/pages/console.html)
+#. [Data](/pages/data.html)
+#. [Date](/pages/date.html)
+#. [File](/pages/file.html)
+#. [Graphics](/pages/graphics.html)
+#. [Language](/pages/language.html)
+#. [Math](/pages/math.html)
+#. [String](/pages/string.html)
+#. [System](/pages/system.html)
 :::
 
 How to read the language reference syntax

_build/refindex.bas

@@ -0,0 +1,30 @@
+unit refindex
+
+export build
+
+sub build(label_str, package)
+  tload "reference.json", s, 1
+  local ref = array(s)
+  local num_items = len(ref[package]) - 1
+  local i, item
+
+  print ("<div class=\"article\">")
+  print ("<h1>" + label_str + "</h1>")
+  print ("<div class=\"siteSub\">")
+  print ("<p><a href=\"/pages/index.html\">Home</a> &gt;")
+  print ("<a href=\"/pages/reference.html\">Reference</a></p>")
+  print ("</div>")
+  print ("<div class=\"contentsPanel\">")
+  print ("<div class=\"contentsHeader\">Contents</div><ul>")
+
+  func cmpfunc(a, b)
+    return iff(a.keyword == b.keyword, 0, iff(a.keyword < b.keyword, -1, 1))
+  end
+  sort ref[package] use cmpfunc(x,y)
+
+  for i = 0 to num_items
+    item = ref[package][i]
+    print("<li><a href=\"/reference/" + item.nodeId + ".html\">" + item.keyword + "</a></li>")
+  next i
+  print ("</ul></div></div>")
+end  

_build/scripts/console.html

@@ -0,0 +1,3 @@
+{% import refindex
+   refindex.build("Console", "console")
+%}

_build/scripts/data.html

@@ -0,0 +1,3 @@
+{% import refindex
+   refindex.build("Data", "data")
+%}

_build/scripts/date.html

@@ -0,0 +1,3 @@
+{% import refindex
+   refindex.build("Date", "date")
+%}

_build/scripts/file.html

@@ -0,0 +1,3 @@
+{% import refindex
+   refindex.build("File", "file")
+%}

_build/scripts/graphics.html

@@ -0,0 +1,3 @@
+{% import refindex
+   refindex.build("Graphics", "graphics")
+%}

_build/scripts/language.html

@@ -0,0 +1,3 @@
+{% import refindex
+   refindex.build("Language", "language")
+%}