======================================
 Steps for creating a new publication
======================================

.. note::
   Use a dockerized version locally to test the publication thoroughly before thinking of putting it on a server.

In general, see :doc:`publishing`.

Chapterinfo page
================

The chapter download PDFs are prefixed by an informative page which states the provenience of the piece. The tool `metadator`_ is used for its creation.

It works like this: after having attached the PDF downloads to the chapters in the Django admin back-end, the script is run to typeset the info pages and glue them to the PDFs. It requires access to the database for the publications and supports both Postgres and SQLite. The PDF files are not written back automatically, but a shell script is created instead that will perform this step as well as creating backup copies of the original (:doc:`Manual <metadator:index>`).


Static version
==============

In order to create a static version on the outbound server, two shell scripts are available there (available in `eoa-utilities`_)::

   pulldjango.sh

   updatestatic.sh

``pulldjango.sh`` uses ``wget`` to create a static view of a page. This performs pretty well except for the Hyperimage functionality where some links are rewritten. For that purpose, the ``makestatic.py`` script is executed (available at `eoa_makestatic`_) that will correct these issues.

``updatestatic.sh`` is then used to sync the files with the directory that are seen by the webserver.

Ad-hoc changes could still be made on the final html version but would be overwritten during the next site generation.

In general, the two scripts could run as a cron job, but since the pages are not updated frequently, this is hardly necessary. It would be nice though, if the scripts could be triggered whenever changes are made to the Django CMS pages (see the `corresponding issue`_).

.. _metadator: https://github.molgen.mpg.de/EditionOpenAccess/metadator
.. _eoa-utilities: https://github.molgen.mpg.de/EditionOpenAccess/eoa-utilities
.. _eoa_makestatic: https://github.molgen.mpg.de/EditionOpenAccess/eoa_makestatic
.. _corresponding issue: https://github.molgen.mpg.de/EditionOpenAccess/new_server/issues/50