Document templates.

ad95fc72 · Hugo Hörnquist · 4ece6b0d · ad95fc72 · ad95fc72 · ad95fc72
Commit ad95fc72 authored 1 year ago by Hugo Hörnquist
--- a/templates/base.html
+++ b/templates/base.html
+{#
+Base full page template, which all other page templates should extend.
+
+Blocks:
+	content:
+		Primary content of page, will be placed within the <body/> tag.
+
+Parameters:
+	path_base:
+		Base path on which the page will be uhoetans
+
+	breadcrumbs:
+		An optional list of breadcrumb items.
+#}
 <!doctype html>
 <html>
 	<head>

--- a/templates/code_page.html
+++ b/templates/code_page.html
+{#
+A page containing puppet code.
+
+Parameters:
+	content:
+		Content of page
+#}
 {% extends "base.html" %}
 {% block content %}
 	<ul>

--- a/templates/content.html
+++ b/templates/content.html
+{#
+A page containing arbitrary content, nothing is assumed of it.
+
+Parameters:
+	Content:
+		Content of page
+#}
+{% extends "base.html" %}
+{% block content %}{{ content }}{% endblock %}
+{# ft: jinja #}
--- a/templates/index.html
+++ b/templates/index.html
+{#
+Root index page for output.
+
+Contains a list of all found modules.
+
+Parameters:
+	modules:
+		List of modules.
+#}
 {% extends "base.html" %}
 {% block content %}
 	<h1>Muppet Strings</h1>

--- a/templates/module_index.html
+++ b/templates/module_index.html
+{#
+Index page for each module.
+
+Parameters:
+	module_name:
+	doc_files:
+	content:
+#}
 {% extends "base.html" %}
 {% block content %}
 <h1>{{ module_name }}</h1>

--- a/templates/tabset.html
+++ b/templates/tabset.html
-{# https://www.w3.org/WAI/ARIA/apg/patterns/tabs/examples/tabs-automatic/ #}
+{#
+A single tabset.
+
+A tabstep is a list of tabs, where one of them are being shown at a time.
+
+Parameters:
+	tabset:
+		id:
+		tabs:
+
+https://www.w3.org/WAI/ARIA/apg/patterns/tabs/examples/tabs-automatic/
+#}
 <div class="tabs" data-tabset="{{ tabset.id }}">
 	<menu class="yesscript"
 		  role="tablist" >