Branding

​

Header

In diesem Abschnitt erklären wir, wie Sie zentrale Elemente Ihrer On-Premises-Instanz personalisieren. Sie können den Seitentitel, die Navigationslinks, den Header, den Footer und das Logo nach Ihren Wünschen anpassen.

​

Seitentitel

Der Titel der Navigationsleiste kann mit der Umgebungsvariablen OVERLEAF_NAV_TITLE angepasst werden. Dieser Text wird oben links in der Navigation angezeigt, wenn kein Logo festgelegt ist.

# add to config/variables.env
OVERLEAF_NAV_TITLE=Our Overleaf Instance

​

Logo

Statt Text können Sie ein eigenes Logo verwenden, indem Sie die Umgebungsvariable OVERLEAF_HEADER_IMAGE_URL setzen. Dieser Wert sollte auf eine extern gehostete Bilddatei verweisen.

config/variables.env

# add to config/variables.env
OVERLEAF_HEADER_IMAGE_URL=https://mysite.somewhere.com/img/logo.png

​

Logos für helles und dunkles Theme

Ab Version 6.3.0 können Sie mit den Umgebungsvariablen OVERLEAF_HEADER_IMAGE_URL_LIGHT und OVERLEAF_HEADER_IMAGE_URL_DARK separate Logos für das helle und das dunkle Theme festlegen. Beide Werte sollten auf eine extern gehostete Bilddatei verweisen.

# add to config/variables.env
OVERLEAF_HEADER_IMAGE_URL_LIGHT=https://mysite.somewhere.com/img/logo-light.png
OVERLEAF_HEADER_IMAGE_URL_DARK=https://mysite.somewhere.com/img/logo-dark.png

Ist eine der beiden Variablen nicht gesetzt, verwendet das betreffende Theme ersatzweise das in OVERLEAF_HEADER_IMAGE_URL festgelegte Logo.

​

Navigationslinks im Header

Zusätzliche Navigationselemente können zum Navigations-Header hinzugefügt werden, indem Sie die Umgebungsvariable OVERLEAF_HEADER_EXTRAS auf ein JSON-Array von Objekten setzen. Zum Beispiel:

[\
  {\
    "text": "Some link",\
    "url": "http://example.com/somelink",\
    "class": "subdued",\
    "only_when_logged_out": true\
  },\
  {\
    "text": "Help",\
    "class": "subdued",\
    "dropdown": [\
      {\
        "text": "Documentation",\
        "url": "/learn"\
      },\
      {\
        "text": "Contact Admin",\
        "url": "http://example.com/contact"\
      }\
    ]\
  }\
]

Fügen Sie die escapte JSON-Form zu toolkit/variables.env hinzu:

toolkit/variables.env

# add to toolkit/variables.env
OVERLEAF_HEADER_EXTRAS=[{"text":"Some link","url":"http://example.com/somelink","class":"subdued","only_when_logged_out":true},{"text":"Help","class":"subdued","dropdown":[{"text":"Documentation","url":"/learn"},{"text":"Contact Admin","url":"http://example.com/contact"}]}]

​

Footer

Sowohl der linke als auch der kleinere rechte Footer (zu finden auf Seiten wie /project) können über die Umgebungsvariablen OVERLEAF_LEFT_FOOTER und OVERLEAF_RIGHT_FOOTER angepasst werden. Beide erwarten ein Array von JSON-Objekten, das eingefügt wird.

Beide erwarten ein JSON-Array, das eingefügt wird.

[\
  {\
    "text": "This is an example text footer entry!"\
  },\
  {\
    "text": "This is an example URL footer link!", "url" : "/my-first-link.htm"\
  }\
]

Wenn Sie nur text verwenden, darf dieser kein HTML enthalten, da der Wert als reiner Text dargestellt wird.

Diese Daten müssen gültiges JSON sein, damit sie funktionieren, wobei Anführungszeichen bei der Übergabe als Umgebungsvariable escapt werden müssen.

config/variables.env

# add to config/variables.env
OVERLEAF_LEFT_FOOTER=[{"text": "This is an example text footer entry!"}]
OVERLEAF_RIGHT_FOOTER=["text": "This is an example URL footer link!", "url" : "/my-first-link.htm"]

Zusätzlich zu text und url akzeptiert das JSON-Objekt auch die Eigenschaften class und label für weitere Anpassungen.

​

Wartungsseite

Sie können die auf der Wartungsseite angezeigte Nachricht mit der Umgebungsvariablen OVERLEAF_MAINTENANCE_MESSAGE anpassen. Dieser Text ersetzt die Standardnachricht unterhalb des Seitentitels.

# add to config/variables.env
OVERLEAF_MAINTENANCE_MESSAGE=Our Overleaf Instance is down for maintenance and will be back shortly.

Um Links oder andere Formatierungen einzubinden, verwenden Sie stattdessen OVERLEAF_MAINTENANCE_MESSAGE_HTML. Sind beide gesetzt, hat OVERLEAF_MAINTENANCE_MESSAGE_HTML Vorrang.

# add to config/variables.env
OVERLEAF_MAINTENANCE_MESSAGE_HTML=Our Overleaf Instance is down for maintenance. For urgent requests, contact <a href="mailto:[e-mail]">[e-mail]</a>.

OVERLEAF_MAINTENANCE_MESSAGE wird als reiner Text dargestellt und darf daher kein HTML enthalten. OVERLEAF_MAINTENANCE_MESSAGE_HTML wird ohne Escaping als HTML dargestellt.

Ist keine der beiden Variablen gesetzt, verlinkt die Standardnachricht auf Ihre Statusseite, wenn OVERLEAF_STATUS_PAGE_URL gesetzt ist, andernfalls wird die E-Mail-Adresse des Administrators angezeigt.