Hinzufügung einer zusätzlichen Artikel-Revision

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

Inhalt dieser Seite

1   Vorbereitung der neuen Seite

Initialisieren Sie die neue Seite entweder, indem Sie eine bereits existierende Revision duplizieren, oder indem Sie eine vollständig neue Seite erstellen. Wenn Sie die Seite von Grund auf neu beginnen, ziehen Sie Hinzufügung eines neuen Artikels zu Rate, um die neue Seite zu initialisieren.

Im Folgenden bezeichnet ALTERSTEMPEL den Stempel der ausgemusterten Seite, NEUERSTEMPEL den Stempel der neuen Seite und ARTIKELSTEMPEL den Stempel des Artikels, welcher aktualisiert wird.

Aktualisieren Sie die Verlaufslinks in der neuen Seite des Artikels:

  1. Deklarieren Sie in der Sektion vor der Fußleiste ein neues Linkziel _prev, welches auf die Seite zeigt, die gerade ausgemustert wird, oder ändern Sie ein bereits existierendes solches Ziel entsprechend. Sie können bxclip auf die ausgemusterte Quelldatei anwenden, um deren Stempel in der Zwischenablage zu plazieren.
  2. Vervollständigen Sie falls notwendig die |prev|-Ersetzung in der Fußzeile durch einen angefügten Unterstrich, sodass dort |prev|_ geschrieben steht.
  3. Wenn Sie die neue Seite von einer Revision abgeleitet haben, welche nicht die letzte ist, dann entfernen sie das _next-Linkziel und verkürzen Sie in der Fußzeile |next|_ zu |next|.
  4. Wenn bereits vom Vorgänger in der Fußzeile Angaben zur Ausmusterung vorhanden sind, dann entfernen Sie diese.
  5. Wenn gleichermaßen bereits Sätze zur Freigabe vorhanden sind, aktualisieren Sie deren Datum, oder legen Sie andernfalls solche Sätze neu an. Beachten Sie hier, dass eine neue Seite in den meisten Fällen nicht zum Zeitpunkt ihrer ersten Niederschrift freigegeben wird; Sie können dann das tatsächliche (zukünftige) Freigabedatum durch bspw. <tba> ersetzen.

Ein typischer Fußzeilenabschnitt eines Artikels mit Vorgänger und ohne eine dynamische Version gleicht:

.. _prev: ALTERSTEMPEL.html
.. _last: ARTIKELSTEMPEL_

.. footer::

    .. container:: flexfooter

        .. -en-
        *Released <tba>.*
        .. -de-
        *Freigegeben am <tba>.*

        .. -all-
        |prev|_ | |next| | |last|_

2   Aktualisierung der ausgemusterten Seite

Aktualisieren Sie die Verlaufsleiste der nun ausgemusterten Seite:

  1. Fügen Sie die Ausmusterungskommentare in der Fußleiste hinzu:

    *Ausgemustert am <Datum>.*
    

    bzw.:

    *Decommissioned <date>.*
    
  2. Ergänzen Sie ein Linkziel _next mit Ziel auf die jetzt aktuelle Version des Artikels in der Sektion vor der Fußleiste. Den Stempel des Zieles können Sie durch Anwendung von bxclip auf die jetzt aktuelle Seite in der Zwischenablage plazieren.

  3. Fügen sie einen Unterstrich an die Ersetzung |next| in der Verlaufsleiste hinzu, sodass sie nun |next|_ lautet.

Die Fußzeilensektion einer typischen ausgemusterten Seite ohne dynamische Version und ohne Vorgänger lautet wie folgt:

.. _next: NEUERSTEMPEL.html
.. _last: ARTIKELSTEMPEL_

.. footer::

    .. container:: flexfooter

        .. -en-
        *Released <date>.*
        *Decommissioned <date>.*
        .. -de-
        *Freigegeben am <Datum>.*
        *Ausgemustert am <Datum>.*

        .. -all-
        |prev| | |next|_ | |last|_

Nachdem eine Seite einmal ausgemustert wurde, sind später keinerlei Änderungen an ihr mehr notwendig.

3   Eingliederung der neuen Seite

Folgen Sie den folgenden Schritten für jede Sprache LG des Projektes, um die neue Seite in Ihr Projekt zur Zusammenstellung einzugliedern:

  1. Aktualisieren Sie für den betreffenden Artikel in der Artikel-Registratur /Sources/Compounds/LG/Articles.rst den existierenden Stempel im Link-Ziel durch den Stempel NEUERSTEMPEL der neuen Seite:

    .. |ARTIKELSTEMPEL| replace:: TITEL
    .. _ARTIKELSTEMPEL: NEUERSTEMPEL.html
    

    Wenden Sie gegenbenenfalls bxclip auf die neue Seitenquelle an, um deren Stempel in der Zwischenablage zu plazieren.

  2. Lokalisieren Sie die .blox-Datei in /Sources/Compounds/LG/, welche die Einschlusszeilen für die betreffenden Seiten enthält. Fügen Sie zu dieser Datei die folgende Zeile hinzu:

    <Name> : <NEUERSTEMPEL>.rst :: blox-rst2html
    

    Setzen Sie diese Zeile direkt unter die letzte Stempel-Einschlusszeile für den Artikel mit der neuen Seite. Fügen Sie eine römische Zahl <REV> zum Namensfeld dieser letzten bereits existierenden Einschlusszeile hinzu, sodass sie lautet:

    <Name> <REV> : <ALTERSTEMPEL>.rst :: blox-rst2html
    

    Nutzen Sie dabei die kleinste noch nicht in Verwendung befindliche römische Zahl. Unter Nutzung dieses Schemas sollte der Abschnitt für einen Artikel mit 3 Seiten wie folgt aussehen:

    <Name> I : <Stempel...>.rst :: blox-rst2html
    <Name> II : <ALTERSTEMPEL>.rst :: blox-rst2html
    <Name> : <NEUERSTEMPEL>.rst :: blox-rst2html
    

    Wenn der Artikel eine andere Navbar als Navbar-Articles.rst benutzt, dann kopieren Sie die Abhängigkeitserklärung +Navbar-XXX.rst+ von einer bereits existierenden Einschlusszeile im Abschnitt des betreffenden Artikels in die neue Einschlusszeile.

  3. Wenn der Artikel eine dynamische Seite aufweist, dann ersetzen Sie den existierenden Seitenstempel in der Einschlusszeile für die dynamische Seite durch neuen Stempel NEUERSTEMPEL:

    <Name> +Navbar-XXX.rst+ (dyn) : <NEUERSTEMPEL>.rst : <DYNAMISCH>.rst : blox-rst2html
    

    Dynamische Seiten verwenden für gewöhnlich eine andere Navbar als Navbar-Articles.rst; die betreffende Abhängkeitserklärung sollte keine Aktualisierung benötigen.

Wenden Sie bxcompose auf die alte und neue Seitenquelldatei an um die Seitenstempeldateien in /Sources/Compounds/LG/ anzulegen bzw. zu aktualisieren.

blox wird die betreffenden Seiten bei der Kompilierung Ihres Projektes aufgreifen.