浏览代码

README: Submodul-Nutzung und Template-Variablen dokumentiert

Matthias Lippmann 3 月之前
父节点
当前提交
af6ad6a82c
共有 1 个文件被更改,包括 41 次插入0 次删除
  1. 41 0
      README.md

+ 41 - 0
README.md

@@ -0,0 +1,41 @@
+# fikusta4header
+
+Django-Template für den globalen Fikusta-Navigationsheader. Dieses Repository wird als Git-Submodul in [lippsites](git@gogspublic.findus-internet-opac.de:horshack/lippsites.git) eingebunden.
+
+## Inhalt
+
+- `customer_cms/partials/fikusta_header.html` — Das eigentliche Template
+
+## Was der Header macht
+
+Der Header erscheint im CMS oben als blauer Balken, wenn für eine Business-Seite eine Fikusta-Portal-URL konfiguriert ist. Er zeigt das Portal-Logo, den Portal-Namen und eine Navigation zurück zum Portal.
+
+Der Header rendert nichts, wenn `fikusta_portal_url` im Template-Kontext nicht gesetzt ist.
+
+## Änderungen vornehmen
+
+Einfach `customer_cms/partials/fikusta_header.html` bearbeiten, committen und pushen:
+
+```bash
+git add customer_cms/partials/fikusta_header.html
+git commit -m "..."
+git push
+```
+
+Danach muss im lippsites-Repo der Submodul-Pointer aktualisiert werden:
+
+```bash
+# im lippsites-Repo:
+git submodule update --remote backend/fikusta4header
+git add backend/fikusta4header
+git commit -m "fikusta4header aktualisiert"
+```
+
+## Verfügbare Template-Variablen
+
+| Variable | Bedeutung |
+|---|---|
+| `fikusta_portal_url` | URL des Portals (Anzeige-Bedingung) |
+| `fikusta_portal_title` | Name des Portals |
+| `cms_brand_logo_url` | URL des Portal-Logos |
+| `base_url` | Basis-URL des CMS |