Adding an Additional Article Revision

Imprint

Contents of this Page

1   Preparation of the New Page

Initialise the new page either by duplicating an existing revision, or by creating an entirely new page. In case you've chosen to start over from scratch, refer to Adding a new Article on how to initialise a new page.

In the following, OLDSTAMP is the stamp of the decommissioned page, NEWSTAMP is the stamp of the new page and ARTICLESTAMP is the stamp of the article which is being updated.

Update the history links in the new page of the article:

  1. Declare a new link target _prev in the section preceding the footer, pointing to the page which is decommissioned, or adapt an already existing link target with this name, when it already exists. You can apply bxclip on the decommissioned source file to place its stamp in the clipboard.
  2. If necessary, complete the |prev| replacement in the footer by appending an underscore, s.t. |prev|_ is written.
  3. When you derived the new page from a revision which is not the last, remove its _next target and shorten the |next|_ in the footer to |next|.
  4. In case that sentences regarding the decommissioning are inherited from the predecessor, remove these.
  5. Similarly, when figures regarding the release of the page are given, update their date, otherwise write such sentences. Observe here that a new page mostly isn't released at the time when it is written first; in this case, you can replace the actual (future) release date by e.g. <tba>.

A typical footer section of a new page with predecessor and without a dynamic version looks like:

.. _prev: OLDSTAMP.html
.. _last: ARTICLESTAMP_

.. footer::

    .. container:: flexfooter

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

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

2   Updating the Decommissioned Page

Update the history bar of the now decommissioned page:

  1. Include the decommissioning comments in the footer:

    *Decommissioned <date>.*
    

    resp.:

    *Ausgemustert am <Datum>.*
    
  2. Add a link target _next to the section preceding the footer, pointing to the now-current version of the article. The target's stamp can be placed in the clipboard by using bxclip on the now-current page.

  3. Extend the substitution |next| in the history bar by an underscore, s.t. it runs now |next|_.

The footer section of a typical decommissioned page not exhibiting a dynamic page and without a predecessor looks like:

.. _next: NEWSTAMP.html
.. _last: ARTICLESTAMP_

.. footer::

    .. container:: flexfooter

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

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

After the time a page has once been decommissioned, there are no adaptions to it required at any later point in time.

3   Including the new Page

To include the new page in your project for compilation, follow these steps for each language LG of the project:

  1. Update for the regarding article in the article registration /Sources/Compounds/LG/Articles.rst the existing stamp in the link target by the stamp NEWSTAMP of the new page:

    .. |ARTICLESTAMP| replace:: TITLE
    .. _ARTICLESTAMP: NEWSTAMP.html
    

    Apply bxclip to the new page source to place its stamp in the clipboard, when necessary.

  2. Locate within /Sources/Compounds/LG the .blox file containing the inclusion lines for the regarding pages. Add the following line to this file:

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

    Place this line just below the last stamped inclusion line belonging to the article of the new page. Add a roman number <REV> to the name field of this last already existing inclusion line, s.t. it runs:

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

    Use the smallest roman number not already in use. By this scheme, the section for an article having 3 pages looks like:

    <Name> I : <Stamp...>.rst :: blox-rst2html
    <Name> II : <OLDSTAMP>.rst :: blox-rst2html
    <Name> : <NEWSTAMP>.rst :: blox-rst2html
    

    When the article uses another navbar than Navbar-Articles.rst, then copy over the navbar dependency statement +Navbar-XXX.rst+ from an existing inclusion line in the article's section into the new inclusion line.

  3. When the article features a dynamic page, replace the existing page stamp in the inclusion line for the dynamic page by the new stamp NEWSTAMP:

    <Name> +Navbar-XXX.rst+ (dyn) : <NEWSTAMP>.rst : <DYNAMIC>.rst : blox-rst2html
    

    Dynamic pages usually use a navbar different from Navbar-Articles.rst; the corresponding dependency statement should not need updating.

Use bxcompose on the old and the new page source file to create or update the pages' stamp files within /Sources/Compounds/LG/.

blox will pick up the regarding pages when compiling your project.