Release 0.11.0 of stog is available from the page.
Changes include:
- the term "element" is replaced by "document", and all
elt* rules are replaced by doc* rules,
- the term "human id" is replaced by "path". In all rules and
attributes, "hid" is replaced by "path". The doc-path rule
is replace by doc-navpath,
- document path now includes the extension of the document's filename;
when referencing a document, the extension is only needed where
an ambiguity is possible between two documents whose paths differ
only by their extension,
- new rules as-cdata,
late-cdata,
date-now,
date-today,
- new option --publish-only,
- more generic way to define an alternative document when using
the documents rule,
- new attribute format="..." for rules
date, datetime,
date-now and date-today,
- defining twice the same id in a document is not an
error anymore but a warning is emitted,
- use Higlo syntax highlighter when possible,
- cut-doc: add previous-path and next-path in definitions
of cut documents, to create navigation links,
- merge CData in resulting XML trees when computing documents,
- urls of .../index.html documents now include a final "/",
- the new stog-dir rule is pre-defined to return the
absolute stog directory,
- (fix) compile and install odoc_stog.cmo,
- (fix) when creating by-topic, by-keyword and by-month documents,
update existing documents if they exist,
- (fix) default doc-in-list.tmpl template now handles
dependencies on listed documents,
- (fix) compile and install .cmxs files,
To migrate a site made with Stog <= 0.10.0, you have to perform
the following steps to handle the change in the terminology
(paths instead of hids, documents instead of elements)
and the corresponding renaming of rules:
- In
.stog/config
: replace the fields elements
and not-elements
with documents
and not-documents
,
- In all your documents, templates (in
.stog/templates/
)
and modules (in .stog/modules
):
- replace
elt-path
with elt-navpath
,
- replace
hid
with path
,
- replace
elt
with doc
.
Of course, if elt-path
, hid
or elt
appeared in another context than Stog rules, beware not to replace them,
- Rename the templates whose name contains
elt
, typically
elt-in-list.tmpl
must be renamed to doc-in-list.tmpl
,
- In your commands (for example in your Makefile),
the
stog.multi-elt
plugin must be renamed to stog.multi-doc
.
You can (adapt and) apply the following script: