diff --git a/templates/base.html b/templates/base.html index abc40f1975a8116e9791beda27cdd20cc2728a25..0244a8265129b46d29d9f6471b3db595c592b701 100644 --- a/templates/base.html +++ b/templates/base.html @@ -1,3 +1,17 @@ +{# +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> diff --git a/templates/code_page.html b/templates/code_page.html index 2840bfc25f5bac46eeefd8eb18c522ba91832615..80ad0373ffe705ec60670ae72c266e3fdce74ed2 100644 --- a/templates/code_page.html +++ b/templates/code_page.html @@ -1,3 +1,10 @@ +{# +A page containing puppet code. + +Parameters: + content: + Content of page +#} {% extends "base.html" %} {% block content %} <ul> diff --git a/templates/content.html b/templates/content.html new file mode 100644 index 0000000000000000000000000000000000000000..d956087a8c7a37c8a15d8abe8a2e81b23b28ae6c --- /dev/null +++ b/templates/content.html @@ -0,0 +1,10 @@ +{# +A page containing arbitrary content, nothing is assumed of it. + +Parameters: + Content: + Content of page +#} +{% extends "base.html" %} +{% block content %}{{ content }}{% endblock %} +{# ft: jinja #} diff --git a/templates/index.html b/templates/index.html index f1cd34284027f1a64ba6767b978d5824abf277ce..5cd468361ace6fa4ceaf40b39f26e3d78080b7cf 100644 --- a/templates/index.html +++ b/templates/index.html @@ -1,3 +1,12 @@ +{# +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> diff --git a/templates/module_index.html b/templates/module_index.html index 3d0f1a8bd5d6fb20b8dd93a53b18364ba6328895..f638e8ca1786751cf0b2224b05d081d564f5a956 100644 --- a/templates/module_index.html +++ b/templates/module_index.html @@ -1,3 +1,11 @@ +{# +Index page for each module. + +Parameters: + module_name: + doc_files: + content: +#} {% extends "base.html" %} {% block content %} <h1>{{ module_name }}</h1> diff --git a/templates/tabset.html b/templates/tabset.html index d29f85e970a4f6a241d8d506fb8d13d34c2616bc..559af0a2c33d659eab8957dd1961d3127f647656 100644 --- a/templates/tabset.html +++ b/templates/tabset.html @@ -1,4 +1,15 @@ -{# 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" >