Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion de/15.9/admin/theme-guide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Die Theme-Funktion verwaltet „statische Themes" – Pakete aus statischen Asse
Der Suchbildschirm ist immer ein statisches Theme. Ist kein Standardtheme festgelegt, verwendet |Fess| ``bootstrap``, das mitgelieferte statische Theme. Das mitgelieferte Theme kann weder gelöscht noch ersetzt werden; um es zu ändern, kopieren Sie es unter einem neuen Namen (siehe :ref:`theme-customize-bundled`).

.. note::
JSP-basierte (JAR-)Themes werden über die Plug-in-Verwaltung behandelt und sind nicht Gegenstand dieser Seite. Seit 15.9 ändern sie den Suchbildschirm nicht mehr.
JSP-basierte Themes (``fess-theme-*``-JAR-Theme-Plugins) wurden in 15.9 entfernt. Verwenden Sie ein statisches Theme, um das Aussehen zu ändern (siehe :ref:`upgrade-159-static-theme`).
Für die hier beschriebenen Operationen ist die Rolle ``admin-theme`` erforderlich (für reinen Lesezugriff genügt die Rolle ``admin-theme-view``).

Ein Theme beziehen
Expand Down
6 changes: 4 additions & 2 deletions de/15.9/api/admin/api-admin-plugin.rst
Original file line number Diff line number Diff line change
Expand Up @@ -50,10 +50,12 @@ Jedes Element des ``plugins``-Arrays, das von den Auflistungs-Endpunkten (``/ins
* - Feld
- Beschreibung
* - ``type``
- Typ-ID des Artefakts. Einer der folgenden Werte: ``fess-ds`` (Datenspeicher), ``fess-theme`` (Theme),
- Typ-ID des Artefakts. Einer der folgenden Werte: ``fess-ds`` (Datenspeicher),
``fess-ingest`` (Ingest), ``fess-script`` (Skript), ``fess-webapp`` (Web-App),
``fess-thumbnail`` (Thumbnail), ``fess-crawler`` (Crawler), ``fess-llm`` (LLM),
``jar`` (allgemeine JAR-Datei für alle anderen Fälle).
``fess-storage`` (Speicher), ``fess-sso`` (SSO),
``jar`` (allgemeine JAR-Datei für alle anderen Fälle). ``fess-theme`` wurde in 15.9
entfernt; ein ``fess-theme-*``-JAR wird als ``jar`` behandelt.
* - ``id``
- Bezeichner im Format ``{name}:{version}``.
* - ``name``
Expand Down
2 changes: 1 addition & 1 deletion de/15.9/config/load-control.rst
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ Wenn eine Anfrage eintrifft, verarbeitet LoadControlFilter sie in folgender Reih
**Für Web-Anfragen:**

- Gibt HTTP 429-Statuscode zurück
- Zeigt die Fehlerseite (``busy.jsp``) an
- Zeigt die Fehlerseite des Themes an

**Für API-Anfragen:**

Expand Down
5 changes: 3 additions & 2 deletions de/15.9/config/security-virtual-host.rst
Original file line number Diff line number Diff line change
Expand Up @@ -63,8 +63,9 @@ Das Theme muss nicht als Standard festgelegt werden. Wie Sie ein Theme aus dem m

.. note::

Beim Speichern der Konfiguration werden weiterhin JSPs unter ``WEB-INF/view/VirtuellerHostname`` generiert, aber seit |Fess| 15.9 verwendet der Suchbildschirm sie nicht mehr.
Nur der Anmeldebildschirm (``/login/``) wird noch aus ihnen gerendert.
Seit |Fess| 15.9 werden beim Speichern der Konfiguration keine JSPs mehr unter ``WEB-INF/view/VirtuellerHostname`` generiert.
Der Anmeldebildschirm (``/login/``) ist für alle virtuellen Hosts derselbe (``WEB-INF/view/admin/login/``) und kann nicht pro virtuellem Host geändert werden.
Ein eigenes Aussehen pro virtuellem Host erhalten Sie, wie oben beschrieben, mit einem statischen Theme, das nach dem virtuellen Host benannt ist.


Crawl-Konfiguration
Expand Down
2 changes: 1 addition & 1 deletion de/15.9/dev/overview.rst
Original file line number Diff line number Diff line change
Expand Up @@ -149,7 +149,7 @@ Verzeichnisstruktur
│ ├── fess_config.properties # Konfiguration
│ └── fess_*.xml # DI-Konfiguration (app.xml, fess_ds.xml usw.)
└── src/main/webapp/
└── WEB-INF/view/ # JSP-Templates
└── WEB-INF/view/ # JSPs der Verwaltungs- und Anmeldebildschirme

Erweiterungspunkte
====================
Expand Down
11 changes: 6 additions & 5 deletions de/15.9/dev/plugin-architecture.rst
Original file line number Diff line number Diff line change
Expand Up @@ -35,9 +35,6 @@ Artefaktnamens (``PluginHelper.ArtifactType``). Die wichtigsten Typen sind:
* - Ingest
- ``fess-ingest-*``
- Dokumentverarbeitung bei der Index-Registrierung
* - Theme
- ``fess-theme-*``
- Anpassung des Erscheinungsbilds der Suchoberfläche
* - Thumbnail
- ``fess-thumbnail-*``
- Hinzufügen von Verfahren zur Thumbnail-Erzeugung
Expand All @@ -54,6 +51,12 @@ Artefaktnamens (``PluginHelper.ArtifactType``). Die wichtigsten Typen sind:
- ``fess-sso-*``
- Hinzufügen eines über ``sso.type`` ausgewählten Single-Sign-On-Verfahrens

.. note::

Der Typ ``fess-theme-*`` (JAR-Theme), der JSPs bereitstellte, wurde in 15.9 entfernt.
Das Aussehen der Suchoberfläche ändern Sie mit einem statischen Theme, nicht mit
einem Plugin (siehe :doc:`theme-development`).

Plugin-Struktur
===============

Expand Down Expand Up @@ -370,8 +373,6 @@ finden Sie repräsentative Beispiele (diese Liste ist nicht vollständig):
- Git-Repository-Konnektor
* - ``fess-llm-openai``
- OpenAI-LLM-Anbieter
* - ``fess-theme-*``
- Benutzerdefinierte Themes

Darüber hinaus sind DataStore-Konnektoren wie ``fess-ds-csv`` /
``fess-ds-db`` / ``fess-ds-json`` / ``fess-ds-microsoft365`` /
Expand Down
145 changes: 20 additions & 125 deletions de/15.9/dev/theme-development.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,8 @@ die Kopie, wie unter `Mitgeliefertes Theme anpassen`_ beschrieben.

Statische Themes stehen ab |Fess| 15.7 zur Verfügung und wurden in
15.9 zur Standard-Suchoberfläche. JAR-Theme-Plugins, die die JSPs
der Suchoberfläche ersetzen, ändern die Suchoberfläche in 15.9 nicht
mehr; siehe `JAR-Theme-Plugin (Legacy)`_.
der Suchoberfläche ersetzten, wurden in 15.9 entfernt; siehe
`JAR-Theme-Plugin (in 15.9 entfernt)`_.

Statisches Theme
================
Expand Down Expand Up @@ -312,140 +312,35 @@ Sie es stattdessen unter einem neuen Namen.
erneut an, da das mitgelieferte Theme der ``/api/v2/*`` API seiner
|Fess|-Version folgt.

JAR-Theme-Plugin (Legacy)
============================
JAR-Theme-Plugin (in 15.9 entfernt)
====================================

.. warning::
Der Typ JAR-Theme-Plugin, der JSPs, CSS und Bilder in einem ``fess-theme-*``-JAR bündelte
und sie als das nach dem Schlüssel eines virtuellen Hosts benannte Theme anwendete, wurde in
|Fess| 15.9 entfernt. 15.9 entpackt kein JAR-Theme und verwendet es für keinen Bildschirm.

Seit |Fess| 15.9 wird die Suchoberfläche immer von einem statischen
Theme ausgeliefert, daher ändert ein JAR-Theme-Plugin sie nicht mehr.
Von den JSPs, die ein JAR-Theme bereitstellt, werden nur noch die der
Anmeldeseite (``/login/``) verwendet. Übertragen Sie das Design in ein
statisches Theme; siehe `Mitgeliefertes Theme anpassen`_.
- Wenn Sie eines über „System" → „Plugin" in der Verwaltungsoberfläche installieren, wird es
nur als allgemeines JAR vom Typ ``jar`` in ``app/WEB-INF/plugin/`` abgelegt; kein
Bildschirm ändert sich. Ein aus einer früheren Version verbliebenes ``fess-theme-*.jar``
wird ebenso aufgeführt und kann auf dieser Seite oder mit
``bin/fess-setup remove plugin <name>`` gelöscht werden.
- ``bin/fess-setup`` listet ``fess-theme-*`` weder auf noch installiert es sie.

Ein JAR-Theme-Plugin ist ein Plugin, das die Verzeichnisse ``view`` /
``css`` / ``js`` / ``images`` des |Fess|-Kerns pro Theme-Name
überschreibt. Zur allgemeinen Struktur und Build-Methode von Plugins
siehe auch :doc:`plugin-architecture`.
Übertragen Sie die Änderungen aus einem JAR-Theme in ein statisches Theme:

Struktur
--------

::

fess-theme-example/
├── pom.xml
└── src/main/resources/
├── view/ # JSP-Dateien (search.jsp, index.jsp, header.jsp usw.)
├── css/ # CSS-Dateien (style.css usw.)
├── js/ # JavaScript-Dateien
└── images/ # Bilddateien (logo.png usw.)

.. note::

Views (Templates) liegen im JSP-Format vor. Als oberste
Ressourcenverzeichnisse werden nur die vier Verzeichnisse ``view`` /
``css`` / ``js`` / ``images`` erkannt. Der Artefaktname muss mit
``fess-theme-`` beginnen.

pom.xml
-------

Das Plugin wird als jar mit ``fess-parent`` als übergeordnetem POM
gebaut. Da ein Theme ausschließlich aus Ressourcen besteht, müssen in
der Regel keine zusätzlichen Abhängigkeiten deklariert werden.

.. code-block:: xml

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0
http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>

<artifactId>fess-theme-example</artifactId>
<version>15.9.0</version>
<packaging>jar</packaging>

<parent>
<groupId>org.codelibs.fess</groupId>
<artifactId>fess-parent</artifactId>
<version>15.9.0</version>
<relativePath />
</parent>
</project>

Anpassung von CSS und Bildern
--------------------------------

Die JSPs basieren auf Bootstrap. Sie können CSS überschreiben, um
Farbschema und Layout zu ändern, oder ``images/logo.png`` ersetzen, um
das Logo zu ändern. Seit 15.9 wirkt sich dies nur auf die Anmeldeseite
aus; die Suchoberfläche ist ein statisches Theme (siehe
`Mitgeliefertes Theme anpassen`_).

Build und Installation
------------------------

::

mvn clean package

Im Verzeichnis ``target/`` wird eine JAR-Datei erzeugt (Beispiel:
``fess-theme-example-15.9.0.jar``). Sie kann über die
Administrationsoberfläche unter „System" → „Plugin" installiert
werden. Details zum Installationsvorgang finden Sie unter
:doc:`../admin/plugin-guide`.

Nach der Installation werden die einzelnen Verzeichnisse im JAR pro
Theme-Name an folgende Orte entpackt (der Theme-Name ist der Teil des
Artefaktnamens ohne das Präfix ``fess-theme-``; im obigen Beispiel
``example``).

.. list-table::
:header-rows: 1
:widths: 30 70

* - Verzeichnis im JAR
- Zielort
* - ``view/``
- ``WEB-INF/view/<theme>/``
* - ``css/``
- ``css/<theme>/``
* - ``js/``
- ``js/<theme>/``
* - ``images/``
- ``images/<theme>/``

Aktivierung
-----------

JAR-Themes werden über die Funktion für virtuelle Hosts aktiviert.
Wenn Sie den Schlüssel eines virtuellen Hosts mit dem Theme-Namen
abgleichen, wird das Theme beim Zugriff auf diesen Host angewendet.

1. Ordnen Sie in den Einstellungen für virtuelle Hosts unter „System"
→ „Allgemein" den ``Host``-Header der Anfrage dem Theme-Namen
(Schlüssel des virtuellen Hosts) zu, zum Beispiel
``Host:localhost:8080=example``.
2. Legen Sie bei Bedarf denselben Namen (``example``) auch für
virtuelle Hosts an anderen Stellen fest, etwa in den
Web-Crawling-Einstellungen.

Details zur Konfiguration virtueller Hosts finden Sie unter
:doc:`../admin/general-guide`.
- Für Farben, Layout und Logo der Suchoberfläche kopieren Sie das mitgelieferte Theme und
ändern die Kopie (siehe `Mitgeliefertes Theme anpassen`_).
- Wenn Sie das Aussehen pro virtuellem Host geändert haben, installieren Sie ein statisches
Theme, das nach dem virtuellen Host benannt ist (siehe :doc:`../config/security-virtual-host`).
- Der Anmeldebildschirm (``/login/``) ist für alle virtuellen Hosts derselbe. Ein Theme
kann ihn nicht ändern.

Beispiele für vorhandene Themes
===================================

- `fess-themes <https://github.com/codelibs/fess-themes>`__ - Sammlung
statischer Themes (enthält mehrere statische Themes wie
``codesearch`` und ``docsearch``)
- `fess-theme-simple <https://github.com/codelibs/fess-theme-simple>`__
- JAR-Theme
- `fess-theme-classic <https://github.com/codelibs/fess-theme-classic>`__
- JAR-Theme

Referenzinformationen
=========================
Expand Down
25 changes: 10 additions & 15 deletions de/15.9/dev/webapp-plugin.rst
Original file line number Diff line number Diff line change
Expand Up @@ -192,12 +192,13 @@ die Ersetzungsdatei ``fess+systemHelper.xml`` (nicht
Das Ersetzen (einzelnes ``+``) ersetzt die Komponentendefinition
**vollständig**. Aus diesem Grund müssen in der Ersetzungsdatei alle
``<postConstruct>``-Einträge, die in der Kerndefinition vorhanden sind,
erneut angegeben werden. Wenn Sie beispielsweise ``systemHelper``
ersetzen, müssen Sie die Zuordnung der Design-JSP-Namen
(``addDesignJspFileName``) vollständig aus der ``fess.xml`` des Kerns
kopieren und übernehmen. Diese müssen mit jedem |Fess|-Release
synchronisiert werden; fehlt ein Eintrag, können bestimmte Bildschirme
(z. B. ``chat`` / ``login``) nicht mehr aufgelöst werden. Dieser
erneut angegeben werden (z. B. ``queryHelper`` in ``app.xml``). Diese
müssen mit jedem |Fess|-Release synchronisiert werden. Ruft die Datei
weiterhin eine Methode auf, die aus dem Kern entfernt wurde, schlägt die
Initialisierung der Komponentendefinition mit einer
``BeanMethodNotFoundException`` fehl. So wurde in 15.9
``addDesignJspFileName`` aus ``systemHelper`` entfernt; eine
Ersetzungsdatei, die sie noch aufruft, schlägt fehl. Dieser
Wartungsaufwand ist der Grund, warum das Hinzufügen dem Ersetzen
vorgezogen werden sollte.

Expand Down Expand Up @@ -278,15 +279,9 @@ Anpassung der Suchoberfläche
Webanwendungs-Plugins können keine JSP-Views hinzufügen. JSP-Views befinden
sich unter ``WEB-INF/view/`` im WAR des |Fess|-Kerns, während das
Plugin-JAR in den Klassenpfad (``WEB-INF/classes``) gemountet wird. Wenn
Sie das Design der Suchoberfläche ändern möchten, nutzen Sie eine der
folgenden Möglichkeiten:

- **Theme**: Passt das Design der Suchoberfläche (HTML/CSS/JavaScript) an.
Siehe :doc:`theme-development`.
- **Ersetzen von systemHelper**: Über das oben beschriebene „Ersetzen von
Kernkomponenten" lässt sich die Zuordnung der Design-JSP-Namen ändern
(die JSP-Dateien selbst werden jedoch weiterhin vom |Fess|-Kern
bereitgestellt).
Sie das Design der Suchoberfläche ändern möchten, nutzen Sie ein statisches
Theme. Es passt das Design der Suchoberfläche (HTML/CSS/JavaScript) an.
Siehe :doc:`theme-development`.

Build und Installation
=======================
Expand Down
21 changes: 20 additions & 1 deletion de/15.9/install/upgrade.rst
Original file line number Diff line number Diff line change
Expand Up @@ -897,7 +897,26 @@ die Kopie, wie unter :ref:`theme-customize-bundled` beschrieben, oder installier
veröffentlichtes Theme über „System" → „Theme" in der Verwaltungsoberfläche oder mit
``bin/fess-setup install theme <name>``. Ein eigenes Aussehen pro virtuellem Host ist jetzt ein
statisches Theme, das nach dem virtuellen Host benannt ist; siehe
:doc:`../config/security-virtual-host`. Die Anmeldeseite (``/login/``) ist weiterhin eine JSP.
:doc:`../config/security-virtual-host`.

Zwei weitere Dinge entfallen:

- Die Anmeldeseite pro virtuellem Host. Bis 15.8 kopierte das Speichern von „System" → „Allgemein"
JSPs einschließlich der Anmeldeseite nach ``WEB-INF/view/<Name des virtuellen Hosts>/``, wo jeder
virtuelle Host seine eigene Kopie bearbeiten konnte. 15.9 erstellt diese Kopien nicht mehr. Die
Anmeldeseite (``/login/``) ist weiterhin eine JSP, aber alle virtuellen Hosts erhalten dieselbe aus
``WEB-INF/view/admin/login/``. Früher kopierte JSPs werden nicht verwendet.
- JAR-Theme-Plugins (``fess-theme-*``). Bei der Installation wird ein solches nur als allgemeines JAR
vom Typ ``jar`` abgelegt; kein Bildschirm ändert sich. Ein verbliebenes JAR löschen Sie auf der
Seite „System" → „Plugin" oder mit ``bin/fess-setup remove plugin <name>`` (siehe
:doc:`../dev/theme-development`).

Wenn die JSP-Suchergebnisse in 15.8 ein eigenes Feld anzeigten, fügen Sie dieses Feld zusätzlich zu
``query.additional.response.fields`` auch zu ``query.additional.api.response.fields`` hinzu. Das
statische Theme bezieht seine Ergebnisse von ``/api/v2/search``. ``query.additional.response.fields``
fügt ein Feld nur zu den aus der Suchmaschine abgerufenen Feldern hinzu; die API gibt nur die Felder
zurück, die in ``query.additional.api.response.fields`` aufgeführt sind (siehe
:doc:`../config/search-advanced`). Ändern Sie außerdem das Theme so, dass es das Feld anzeigt.

Was Clients sehen
~~~~~~~~~~~~~~~~~
Expand Down
3 changes: 2 additions & 1 deletion de/15.9/user/role-search.rst
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,8 @@ Wenn Sie im Menü auf „Passwort ändern“ klicken, wird der Bildschirm zur Pa
|image1|

Geben Sie im Feld „Aktuelles Passwort“ Ihr aktuelles Passwort, im Feld „Neues Passwort“ das neue Passwort und im Feld „Neues Passwort bestätigen“ das neue Passwort zur Bestätigung (erneut) ein und klicken Sie auf die Schaltfläche „Aktualisieren“, um das Passwort zu aktualisieren.
Nach der Passwortänderung können Sie durch Klicken auf die Schaltfläche „Zurück“ zum Suchbildschirm zurückkehren.
Durch die Passwortänderung werden Sie abgemeldet; melden Sie sich mit dem neuen Passwort erneut an.
Dieser Bildschirm ist die Seite ``/profile`` des Themes der Suchoberfläche, und das Passwort wird mit ``POST /api/v2/auth/password`` geändert (siehe :doc:`../api/api-auth`).

.. note::
Das Menü „Passwort ändern“ wird nur für Benutzer angezeigt, die von |Fess| verwaltet werden (sowie für LDAP-Benutzer, deren Bearbeitung erlaubt ist). Für Benutzer, die per Single Sign-On authentifiziert wurden, wird es nicht angezeigt.
Expand Down
2 changes: 1 addition & 1 deletion en/15.9/admin/theme-guide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ The Theme feature manages "static themes" — a bundled set of static assets (HT
The search interface is always a static theme. When no default theme is set, |Fess| uses ``bootstrap``, the static theme bundled with it. The bundled theme cannot be deleted or replaced; to change it, copy it under a new name (see :ref:`theme-customize-bundled`).

.. note::
JSP-based (JAR) themes are managed through Plugin Management and are outside the scope of this page. Since 15.9 they no longer change the search interface.
JSP-based themes (``fess-theme-*`` JAR theme plugins) were removed in 15.9. Use a static theme to change the look (see :ref:`upgrade-159-static-theme`).
The ``admin-theme`` role is required to perform operations on this page (the ``admin-theme-view`` role is sufficient for read-only access).

Obtaining a Theme
Expand Down
6 changes: 4 additions & 2 deletions en/15.9/api/admin/api-admin-plugin.rst
Original file line number Diff line number Diff line change
Expand Up @@ -51,10 +51,12 @@ is an object with the following fields.
* - Field
- Description
* - ``type``
- The artifact type ID. One of ``fess-ds`` (data store), ``fess-theme`` (theme),
- The artifact type ID. One of ``fess-ds`` (data store),
``fess-ingest`` (ingest), ``fess-script`` (script), ``fess-webapp`` (web app),
``fess-thumbnail`` (thumbnail), ``fess-crawler`` (crawler), ``fess-llm`` (LLM),
or ``jar`` (generic JAR not matching any of the above).
``fess-storage`` (storage), ``fess-sso`` (SSO),
or ``jar`` (generic JAR not matching any of the above). ``fess-theme`` was removed
in 15.9, and a ``fess-theme-*`` JAR is reported as ``jar``.
* - ``id``
- Identifier in ``{name}:{version}`` format.
* - ``name``
Expand Down
2 changes: 1 addition & 1 deletion en/15.9/config/load-control.rst
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ When a request arrives, LoadControlFilter processes it in the following order:
**For web requests:**

- Returns HTTP 429 status code
- Displays the error page (``busy.jsp``)
- Displays the theme's error page

**For API requests:**

Expand Down
5 changes: 3 additions & 2 deletions en/15.9/config/security-virtual-host.rst
Original file line number Diff line number Diff line change
Expand Up @@ -63,8 +63,9 @@ The theme does not have to be set as the default. See :ref:`theme-customize-bund

.. note::

Saving the configuration still generates JSPs under ``WEB-INF/view/virtual_host_name``, but since |Fess| 15.9 the search screen no longer uses them.
Only the login screen (``/login/``) is still rendered from them.
Since |Fess| 15.9, saving the configuration no longer generates JSPs under ``WEB-INF/view/virtual_host_name``.
The login screen (``/login/``) is the same page for every virtual host (``WEB-INF/view/admin/login/``) and cannot be changed per virtual host.
To give a virtual host its own look, use a static theme named after the virtual host, as described above.


Crawl Configuration
Expand Down
2 changes: 1 addition & 1 deletion en/15.9/dev/overview.rst
Original file line number Diff line number Diff line change
Expand Up @@ -149,7 +149,7 @@ Directory Structure
│ ├── fess_config.properties # Configuration
│ └── fess_*.xml # DI configuration (app.xml, fess_ds.xml, etc.)
└── src/main/webapp/
└── WEB-INF/view/ # JSP templates
└── WEB-INF/view/ # JSPs of the admin and login screens

Extension Points
=================
Expand Down
Loading
Loading