Erzeugung des Index' auf höchster Ebene

Downloads des Blox-Projektes | Downloads der gesamten Site | Impressum

Der Index auf höchster Ebene dient dem Einstieg in das Projekt, bevor klar ist in welcher Sprache die Inhalte präsentiert werden sollen. Man gibt deswegen sinnvoller Weise alle Elemente dieses Index' in allen verfügbaren Sprachen an. Ein Beispiel ist:

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

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

Eine derartige Seite bevorzugt keine der Sprachen des Projektes. In der Dateisystemhierarchie der von blox erzeugten Zusammenstellung residiert sie außerdem in der obersten Stufe, noch vor den Sprachordnern en/ und de/. Sie wird deswegen nicht in einem der Sprachordner /Sources/Compounds/LG/ abgelegt, sondern stattdessen in /Sources/Compounds/toplevel/. Dafür wird dem Inhalt der Datei vorangestellt:

.. -toplevel-

sodass der komplette Inhalt lautet:

template-index.rst
.. -toplevel-

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

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

Wird diese Seitenquelle bxcompose übergeben, gelangt ihr Inhalt genau nach /Sources/Compounds/toplevel. Man schließt die neue Seite in /Sources/Compounds/toplevel/Site.blox ein, indem man diese Datei ergänzt durch:

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

wobei <STEMPEL> der Stempel der Quelldatei ist.

Die .blox-Datei /Sources/Compounds/toplevel/Site.blox wird genau im Falle von Site-Darstellung des Projektes eingeschlossen. Bei Plug-Darstellung wird sie nicht verwendet, da dabei die Indexdatei auf der höchsten Ebene vom übergeordneten Projekt bereitgestellt wird.