.. -*- coding: utf-8 -*-












.. role:: sref(numref)
.. role:: xref(numref)
.. Copyright (C) 2018, Wolfgang Scherer, <Wolfgang.Scherer at gmx.de>
..
.. This file is part of Documentation Standard.
..
.. Permission is granted to copy, distribute and/or modify this document
.. under the terms of the GNU Free Documentation License, Version 1.3
.. or any later version published by the Free Software Foundation;
.. with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.
.. A copy of the license is included in the section entitled "GNU
.. Free Documentation License".

.. inline comments (with du_comment_role)
.. role:: rem(comment)
.. role:: html(raw)
   :format: html
.. role:: shx(code)
   :language: sh

.. rst-class:: xnarrow xmedium large xhuge xultra

##################################################
:rem:`|||:sec:|||`\ Tools
##################################################
.. >>CODD See `the components of a doctoral dissertation and their order <http://site.uit.no/english/writing-style/bookstructure/>`_
.. >>CODD Dedication
.. >>CODD Epigraph
.. >>CODD Abstract
.. compound::

   Besides the scripts from |chapter-doc-management|, there are a couple of local tools available.

   The script :file:`bin/inst.sh` installs the programs in the
   appropriate places. See section `Activity Diagrams for bin/inst.sh`_.

   .. \|:here:|

.. include:: tools.inc

.. >>CODD Introduction
.. >>CODD Chapter

==================================================
:rem:`|||:sec:|||`\ Document Generation Issues
==================================================

- ImageMagick permissions problems with PDF (see `imagemagick -
  convert:not authorized aaaa @ error/constitute.c/ReadImage/453`_):

  In file :file:`/etc/ImageMagick-6/policy.xml` (or
  :file:`/etc/ImageMagick/policy.xml`)

  #. comment line (security risk!) ::

         <!-- <policy domain="coder" rights="none" pattern="MVG" /> -->

  #. change lines ::

         <policy domain="coder" rights="none" pattern="PS" />
         <policy domain="coder" rights="none" pattern="EPS" />
         <policy domain="coder" rights="none" pattern="PDF" />

     to ::

         <policy domain="coder" rights="read|write" pattern="PS" />
         <policy domain="coder" rights="read|write" pattern="EPS" />
         <policy domain="coder" rights="read|write" pattern="PDF" />

  #. add line ::

         <policy domain="coder" rights="read|write" pattern="LABEL" />

.. _`imagemagick - convert:not authorized aaaa @ error/constitute.c/ReadImage/453`: https://stackoverflow.com/questions/42928765/convertnot-authorized-aaaa-error-constitute-c-readimage-453

- ImageMagick conversion problems SVG -> PNG with inkscape (see `convert aus ImageMagick verhält sich anders`_)

  In file :file:`/etc/ImageMagick-6/delegates.xml` (or
  :file:`/etc/ImageMagick/delegates.xml`)

  #. change line ::

        <delegate decode="svg:decode" stealth="True" command="&quot;inkscape&quot; &quot;%s&quot; --export-eps=&quot;%s&quot; --export-dpi=&quot;%s&quot; --export-background=&quot;%s&quot; --export-background-opacity=&quot;%s&quot; &gt; &quot;%s&quot; 2&gt;&amp;1"/>

     to ::

        <delegate decode="svg:decode" stealth="True" command="&quot;inkscape&quot; &quot;%s&quot; --export-png=&quot;%s&quot; --export-dpi=&quot;%s&quot; --export-background=&quot;%s&quot; --export-background-opacity=&quot;%s&quot; &gt; &quot;%s&quot; 2&gt;&amp;1"/>

     This avoids the mentioned artifacts (actually caused by ghostscript, not inkscape).

.. _`convert aus ImageMagick verhält sich anders`: https://forum.ubuntuusers.de/topic/convert-aus-imagemagick-verhaelt-sich-anders/2/

.. _`activity diagrams for rst2md.sh`:

======================================================================
:rem:`|||:sec:|||`\ Activity Diagrams for :file:`rst2md.sh`
======================================================================

.. uml:: _static/rst2md_act.puml

.. _`activity diagrams for sphinx-doc-locate.sh`:

======================================================================
:rem:`|||:sec:|||`\ Activity Diagrams for :file:`sphinx-doc-locate.sh`
======================================================================

.. uml:: _static/sphinx-doc-locate_act.puml

.. _`activity diagrams for bin/inst.sh`:

=============================================================
:rem:`|||:sec:|||`\ Activity Diagrams for :file:`bin/inst.sh`
=============================================================

.. uml:: _static/inst_act.puml

.. uml:: _static/inst_act_sys_pkg.puml

.. uml:: _static/inst_act_extra_app.puml

.. uml:: _static/inst_act_py_env.puml

.. uml:: _static/inst_act_py_pkg.puml

.. uml:: _static/inst_act_inst_tools.puml

.. >>CODD Conclusion
.. >>CODD Appendix A

.. \|:here:|

.. >>CODD Notes
.. ==================================================
.. :rem:`|||:sec:|||`\ Footnotes
.. ==================================================

:html:`<hr>`

.. \[#]

.. include:: doc_defs.inc
.. include:: doc_defs_combined.inc
.. include:: abbrev_defs.inc
..
  .. \||<-snap->|| doc_standalone
  .. include:: doc/doc_defs_secret.inc
  .. \||<-snap->|| doc_standalone
  .. \||<-snap->|| not_doc_standalone
  .. include:: doc_defs_secret.inc
  .. \||<-snap->|| not_doc_standalone

.. _`Wolfgang Scherer`: wolfgang.scherer@gmx.de