The structure of the page files
The structure of the source files for the web pages consist of a header (using YAML syntax) and the page content written in markdown. (pdf)
2019-03-05
The YAML
header
The first part of each web page describes the page. It is fenced off
from the page content proper by ---
lines above and beyond.
It follows the YAML
syntax:
---
title: text which becomes the title of the page
abstract: typically a multi line text describing the page.
It becomes the abstract of the page and is shown
together with the title on the index pages.
author: the author of the page,
there is a mechanism to suppress this
for the author of a site
([see](/Essays/SSGdesign/004settings.html))
keywords: some descriptive keywords.
date: 2019-03-05
image: if present a reference to the image file
which will become the pages banner
(if blank, the default site banner image is used).
bibliography: a reference to the `bib` file
version: publish or draft
visibility: public or private
---
Web page content
It is followed by the text written as markdown.
- titles are marked with
#
and##
, which give second and third level titlesThe text after thetitle:
keyword in the header gives the first level.
.
For more details of the (Pandoc) markdown syntax see.
Index pages
The structure of the site is revealed to the user through
index pages
index.html
files
. They list the titles and abstracts of the web pages
included in a directory, starting from the root
in a
hierarchy. The pages are clickable
and permit
navigationIn addition to the ribbon under the banner image which
is always linking to the major subdivisions, listed in the
settings
file and clickable sitename
.
.
The index pages must be started by the author of the site as a file
index.md
with keywords
- indexPage: true
- indexSort: title
where the indexSort
field indicates the order in which
pages are listed. A sort by title
sorts the pages by their
filename, which permits to use filenames starting with a number to
achieve a specific order.
Alternatives are sort by data
or
reverseDate
(newest first).
Referencing images and other static content
The references can be either absolute to the web rootI.e. starting with “".
, i.e. the directory in which the dough
is
placed or relative to the location to the current page fileThe directory name, not starting with “".
.
Remember that the references must include the .html
extension of the files in the baked form and not the md
extensio of the original content files.
It is often useful to place the static content in a
resources
directorywith exactly this name!
in the same directory as the pages for a topic.
Pages rendered as PDF
For every web page transformed to html
a corresponding
pdf
is produced, using the KOMA
tools for
latex
and rendered as a scartcl
.
The pdf format uses footnotes at the foot of the page, whereas the
footnotes in the web output are pushed to the marginTufte style
. The bibliography in both output formats are at the end
of the page.