Creating the Toplevel Index

Imprint

The toplevel index serves as the entry point into the project, at a time when it is not yet decided in which language the project's content shall be delivered. It is therefore sensible to provide all elements of this index in all available languages. An example is:

<Project Name> | <Projektname>
##############################

`In English <en/index.html>`__ | `Auf Deutsch <de/index.html>`__
****************************************************************

Such a page does not favour any of the project's languages. In the filesystem hierarchy of the compilation created by blox it furthermore resides in the topmost level, even before the language folders en/ and de/. For this reason, it won't be placed in any of the language folders /Sources/Compounds/LG/, but instead of this in /Sources/Compounds/toplevel/. To accomplish this, the following content is preceded to the Page Source's body:

.. -toplevel-

such that its entire content runs:

template-index.rst
.. -toplevel-

<Project Name> | <Projektname>
##############################

`In English <en/index.html>`__ | `Auf Deutsch <de/index.html>`__
****************************************************************

When this page source is handed over to bxcompose, its content will end up precisely in /Sources/Compounds/toplevel. The new page is included via /Sources/Comounds/toplevel/Site.blox, by enlarging this file by:

Toplevel Index : <STAMP>.rst : index.rst : blox-rst2html

whereby <STAMP> is the source file's stamp.

The .blox file /Sources/Compounds/toplevel/Site.blox is included precisely in case of Site rendering of the project. It is not included in Plug rendering, as in that case the toplevel index will be provided by the superordinate project.