Hinzufügung eines neuen Artikels

Impressum

Inhalt dieser Seite

1   Initialisierung der neuen Seite

1.1   Auswahl der Seitenvorlage

Seiten werden im Projekt in der Regel mindestens unter Nutzung des Dateinamens eingebunden, welcher sich von ihrem Stempel herleitet. Der Inhalt solcher Stempel-Seiten ändert sich nach ihrer Freigabe bis auf die benutzten Style Sheets und Drop-in-Inhalte nicht mehr. Wenn eine Revision eines Artikel freigegeben wurde, wird für die nächste Version des Artikels ein neuer Stempel verwendet.

Zusätzlich zur den Stempel-Seiten ist es möglich, dass eine sogenannte dynamische Seite für einen Artikel existiert. Diese Seite repräsentiert stets die letzte Version des Artikels. Ihr Name kann entweder für alle Sprachen im Projekt gleich gewählt werden, oder kann für jede Sprache individuell festgelegt werden.

Wenn ein Artikel eine dynamische Seite beinhaltet, ist in seinen ReST-Quellen die Definition eines Links auf diese dynamische Seite zur Verwendung in der Fußzeile notwendig. Auch in allen anderen Artikeln, welche auf die dynamische Seite verweisen, müssen derartige Links bereitgestellt werden. Wenn der dynamische Dateiname für alle Sprachen gleich ist, kann in einer mehrsprachig-verwobenen Seite für alle Sprachen ein gemeinsamer ReST-Code verwendet werden, um den Link herzustellen. Andernfalls, wenn die dynamische Seite für jede Sprache individuell verschiedene Namen trägt, muss diese Wahl im erzeugenden ReST-Code abgebildet werden.

Somit werden hier drei Seitenvorlagen bereitgestellt:

  1. Die rein gestempelte Seitenvorlage ohne jede dynamische Seite:

    Page.rst ohne dynamische Version
    
    .. include:: Symbols.rst
    .. include:: Roles.rst
    .. include:: History.rst
    .. include:: Articles.rst
    
    
    -en-
    Headline
    ########
    -de-
    Überschrift
    ###########
    -all-
    
    .. include:: Navbar-XXX.rst
    
    .. _last: STAMP_
    
    .. footer::
    
        .. container:: flexfooter
    
            -en-
            *Released <tba>.*
            -de-
            *Freigegeben am <tba>.*
    
            -all-
            |prev| | |next| | |last|_
    
  2. Die Vorlage für Seiten mit einer dynamischen Seite, welche in allen Sprachen denselben Namen trägt:

    Page.rst mit sprachlich einheitlichem Dateinamen für die dynamische Version
    
    .. include:: Symbols.rst
    .. include:: Roles.rst
    .. include:: History.rst
    .. include:: Articles.rst
    
    
    -en-
    Headline
    ########
    -de-
    Überschrift
    ###########
    -all-
    
    .. include:: Navbar-XXX.rst
    
    .. _last: STAMP_
    .. _dyn: DYN.html
    
    .. footer::
    
        .. container:: flexfooter
    
            -en-
            *Released <tba>.*
            -de-
            *Freigegeben am <tba>.*
    
            -all-
            |prev| | |next| | |last|_ | |dyn|_
    
  3. Eine Vorlage für Seiten mit einer dynamischen Seite, deren Dateiname in verschiedenen Sprachen unterschiedlich sein kann:

    Page.rst mit sprachspezifischem Dateinamen für die dynamische Version
    
    .. include:: Symbols.rst
    .. include:: Roles.rst
    .. include:: History.rst
    .. include:: Articles.rst
    
    
    -en-
    Headline
    ########
    -de-
    Überschrift
    ###########
    -all-
    
    .. include:: Navbar-XXX.rst
    
    .. _last: STAMP_
    -en-
    .. _dyn: DYN-EN.html
    -de-
    .. _dyn: DYN-DE.html
    -all-
    
    .. footer::
    
        .. container:: flexfooter
    
            -en-
            *Released <tba>.*
            -de-
            *Freigegeben am <tba>.*
    
            -all-
            |prev| | |next| | |last|_ | |dyn|_
    

1.2   Vorbereitung der neuen Seite

Benennen Sie die Templatedatei um, vorzugsweise unter Verwendung eines Namens ID STEMPEL NAME.rst.

Bearbeiten Sie die neue Seitenquelle ID STEMPEL NAME.rst:

  1. Ersetzen Sie die Überschriften.

  2. Ersetzen Sie Navbar-XXX.rst durch die passende Navbar. Für die meisten Artikel wird dies Navbar-Articles.rst sein. Spezialisierte Navbars existieren für den Index, das Impressum und die Downloads; die Downloads-Navbar trägt bspw. den Namen Navbar-Downloads.rst.

  3. Ersetzen Sie STAMP im _last-Linkziel (STAMP_) durch den tatsächlichen Stempel des Artikels. Stellen Sie sicher, dass der Stempel des Artikels Verwendung findet, nicht der für die Seite.

    Sie können bxclip auf das Artikelverzeichnis anwenden um dessen Stempel in der Zwischenablage zu plazieren:

    $ bxclip <path/to/article>
    

    Der Pfad kann . oder sogar .. sein, sollten Sie sich in einem Unterverzeichnis des Artikelordners befinden.

  4. Wenn der Artikel eine dynamische Seite aufweist, dann ist das Linkziel _dyn anzupassen. Wenn das Linkziel je nach Sprache verschieden ist, gibt es zwei Zielnamen, DYN-EN und DYN-DE, welche für die jeweilige Sprache verwendet werden. Falls der Name unabhängig von der Sprache ist, existiert bloß ein Zielname DYN.

    Für Artikel mit dynamischer Seite weist die Fußzeile einen zusätzlichen Eintrag |dyn|_ auf, welcher von Anfang an das "_"-Suffix trägt. Die Vorfassung im Template lautet:

    |prev| | |next| | |last|_ | |dyn|_
    

    Beispiele für Namen dynamischer Seiten sind downloads.html für eine Downloads-Seite, deren Name unabhängig von der Sprache ist, und impressum.html (deutschsprachige Version) sowie imprint.html (englischsprachige Version) für das Impressum, dessen Name von der Sprache abhängt.

2   Registrierung des neuen Artikels

Iterieren Sie die folgenden Schritte für jede Sprache LG des Projektes:

  1. Fügen Sie mit dem Artikelstempel im Speicher zu /Sources/Compounds/LG/Articles.rst hinzu (ersetzten Sie dabei LG durch die jeweilige Sprache, z.B. de):

    .. |ARTIKELSTEMPEL| replace:: TITEL
    .. _ARTIKELSPEMPEL:
    
  2. Legen Sie nun den Stempel der Seite in die Zwischenablage, indem Sie bxclip auf die neue Seitendatei anwenden:

    $ bxclip <path/to/page.rst>
    

    und nutzen Sie diesen zur Vervollständigung des neuen Registratureintrags in Articles.rst, so dass er folgendes Aussehen annimmt:

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

Sie können nun auf jeder Seite des Projektes |ARTIKELSTEMPEL|_ schreiben um einen Link mit dem sprachspezifischem Artikelnamen als Titel und der aktuellen Seite des Artikels als Ziel anzulegen.

3   Einschluss der neuen Seite

  1. Ergänzen Sie eine der .blox-Dateien in /Sources/Compounds/LG/ durch:

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

    Der Name der gewählten .blox-Datei sollte mit dem Gültigkeitsbereich des Artikels korrespondieren. Nutzen Sie bspw. Articles.blox für die Artikel, welche die eigentlichen Inhalte des Projekts beinhalten, Site.blox für das Impressum und Online.blox für Downloadseiten.

  2. Wenn der Artikel zusätzlich durch eine dynamische Seite zugänglich gemacht werden soll, fügen Sie hinzu:

    <Name> (dyn) : <SEITENSTEMPEL>.rst : <DYNAMISCH>.rst : blox-rst2html
    
  3. Falls die Seite von einer anderen Navbar als Navbar-Articles.rst abhängt, fügen Sie in allen neuen Zeilen hinzu (sowohl für die Stempelseite wie auch für eine eventuelle dynamische Seite):

    +Navbar-XXX.rst+
    

    wobei Navbar-XXX.rst der Name der benutzten Navbar ist.

    Beispielsweise wird das Impressum von Navbar-Imprint.rst abhängen, sodass die Stempel-Einschlusszeile hier folgendes Aussehen annehmen sollte:

    Imprint +Navbar-Imprint.rst+ : <SEITENSTEMPEL>.rst :: blox-rst2html
    

4   Zusammenstellung des Projekts

Wenden Sie bxcompose auf die Quelldatei der Seite an. Dies wird in den Sprach-Zielverzeichnissen LG/ innerhalb /Sources/Compounds/ Komposita der neuen Seite plazieren, welche nach dem Stempel der Seite benannt werden.

Wiederholen Sie die Anwendung von bxcompose nach Änderungen an der Quelldatei.

Verweisen Sie auf den neuen Artikel in existierenden Seiten je nach Notwendigkeit, und kompilieren Sie das Projekt. Dabei werden die neuen Seiten mittels der angepassten .blox-Datei im Zusammenstellungsresultat eingeschlossen werden.