gazette.layout
==============

.. py:module:: gazette.layout


Attributes
----------

.. autoapisummary::

   gazette.layout.NestedMenu


Classes
-------

.. autoapisummary::

   gazette.layout.Layout
   gazette.layout.MailLayout


Module Contents
---------------

.. py:type:: NestedMenu
   :canonical: list[tuple[str, str | None, bool, 'NestedMenu']]


.. py:class:: Layout(model: Any, request: onegov.gazette.request.GazetteRequest)

   Bases: :py:obj:`onegov.core.layout.ChameleonLayout`


   Extends the base layout class with methods related to chameleon
   template rendering.

   This class assumes the existance of two templates:

   - layout.pt -> Contains the page skeleton with headers, body and so on.
   - macros.pt -> Contains chameleon macros.



   .. py:attribute:: request
      :type:  onegov.gazette.request.GazetteRequest


   .. py:attribute:: date_with_weekday_format
      :value: 'EEEE dd.MM.yyyy'



   .. py:attribute:: date_long_format
      :value: 'd. MMMM yyyy'



   .. py:attribute:: datetime_with_weekday_format
      :value: 'EEEE dd.MM.yyyy HH:mm'



   .. py:attribute:: breadcrumbs
      :type:  list[str]
      :value: []



   .. py:attribute:: session


   .. py:method:: title() -> str


   .. py:property:: principal
      :type: onegov.gazette.models.Principal



   .. py:property:: user
      :type: onegov.user.User | None



   .. py:property:: font_awesome_path
      :type: str



   .. py:property:: sentry_init_path
      :type: str



   .. py:property:: copyright_year
      :type: int



   .. py:property:: homepage_link
      :type: str



   .. py:property:: manage_users_link
      :type: str



   .. py:property:: manage_groups_link
      :type: str



   .. py:property:: manage_organizations_link
      :type: str



   .. py:property:: manage_categories_link
      :type: str



   .. py:property:: manage_issues_link
      :type: str



   .. py:property:: manage_notices_link
      :type: str



   .. py:property:: dashboard_link
      :type: str



   .. py:property:: dashboard_or_notices_link
      :type: str



   .. py:property:: export_users_link
      :type: str



   .. py:property:: export_issues_link
      :type: str



   .. py:property:: export_organisation_link
      :type: str



   .. py:property:: export_categories_link
      :type: str



   .. py:property:: login_link
      :type: str | None



   .. py:property:: logout_link
      :type: str | None



   .. py:property:: sortable_url_template
      :type: str



   .. py:property:: publishing
      :type: bool



   .. py:property:: importation
      :type: bool



   .. py:property:: menu
      :type: NestedMenu



   .. py:property:: current_issue
      :type: onegov.gazette.models.Issue | None



   .. py:method:: format_date(dt: datetime.datetime | datetime.date | None, format: str) -> str

      Returns a readable version of the given date while automatically
      converting to the principals timezone if the date is timezone aware.




   .. py:method:: format_issue(issue: onegov.gazette.models.Issue, date_format: str = 'date', notice: onegov.gazette.models.GazetteNotice | None = None) -> str

      Returns the issues number and date and optionally the publication
      number of the given notice. 



   .. py:method:: format_text(text: str | None) -> str


.. py:class:: MailLayout(model: Any, request: onegov.gazette.request.GazetteRequest)

   Bases: :py:obj:`Layout`


   A special layout for creating HTML E-Mails. 


   .. py:property:: base
      :type: chameleon.PageTemplateFile


      Returns the layout, which defines the base layout of all pages.

      See ``templates/layout.pt``.




   .. py:property:: primary_color
      :type: str