Some thoughts and documentation.
(1) SSI within the templates and produced html remains a good idea.
(2) SSI directory structure could be replaced could be replaced by a json file.
- footer is always the same.
Path to the footer file to include. Always the same.
- doctype is always the same.
Path to the doctype file to use. Ought to eliminate this hack.
- home is always the same.
The name to use for the first breadcrumb which will take you to "/".
- brand for the top of the page.
Path to the brand file to include. Varies according the language site.
- topnav for the upper navigation bar.
Path to the top nav menu to include. Varies according the language site.
- leftnav is optional and special.
Path to a left nav menu to include. Varies according the language site or "project" site.
- rightnav is optional and only used once for l10n where there is also a leftnav.
Path to a right nav menu to include. Varies according the language site or "project" site.
(3) ssi.json is a directory of directories.
Note this actitivty should also build the breadrcumb list. See (5)
For each template key look up the subpath and then look for the ssi element name.
If missing then go up a level on the subpath.
e.g. if you are looking in "/api/some/deep/path/"
then you look into "/api/some/deep/", "/api/some/", "/api/", and "/"
ssi[path][key]
For api:
"/api/": {
"leftnav":"/api/leftnav.html"
}
"/": {
"doctype":"/doctype.html",
"footer":"/footer.html",
"brand":"/brand.html",
"topnav":"/topnav.html",
"home":"home"
}
For de:
"/de/product/": {
"leftnav":"/de/product/leftnav.html"
}
"/de/": {
"brand":"/de/brand.html",
"topnav":"/de/topnav.html"
}
"/": {
"doctype":"/doctype.html",
"footer":"/footer.html",
"brand":"/brand.html",
"topnav":"/topnav.html",
"home":"home"
}
For xx:
"/xx/why/": {
"leftnav":"/xx/why/leftnav.html"
}
"/xx/product/": {
"leftnav":"/xx/product/leftnav.html"
}
"/xx/": {
"topnav":"/xx/topnav.html",
"brand":"/xx/brand.html"
}
"/": {
"doctype":"/doctype.html",
"footer":"/footer.html",
"brand":"/brand.html",
"topnav":"/topnav.html",
"home":"home"
}
(4) List of templates:
See lib/path.pm
- brand.html
- brand.mdtext
- footer.html
- footer.mdtext
- doctype.html
- doctype.mdtext
- navigator.html
- topnav.mdtext
- leftnav.mdtext
- rightnav.mdtext
- html_page.html
- *.html
- *.htm
- extends skeleton.html
- replaces block content with content extracted from html
- single_narrative.html
- *.mdtext thats not already covered by above.
- extends skeleton.html
- skeleton.html
- this is the page design:
{% if head %}{{ head|safe }}{% else %}
{% block title %}{{ headers.title }}{% endblock %}
{% if headers.css %}{% endif %}
{% endif %}