From 375bccdeed8eb51ca2d15467d5117b38ab998324 Mon Sep 17 00:00:00 2001 From: Shinsuke Sugaya Date: Sun, 27 Sep 2026 09:16:54 +0900 Subject: [PATCH] docs(15.9): follow the removal of the JSP search UI and the JAR theme type Fess 15.9 removed the JSP search screens and the fess-theme plugin type (codelibs/fess#3497). Saving the General settings no longer copies JSP files per virtual host, the login page is served from WEB-INF/view/admin/login/ for every virtual host, and a fess-theme-*.jar is only kept as a plain jar that changes nothing. Update the 15.9 pages in all seven languages that still described the old behavior: the virtual host note, the JAR theme section of the theme development guide (now a short "removed in 15.9, move to a static theme" section), the plugin type tables, the plugin API type list, the theme guide note, the webapp plugin guide's addDesignJspFileName advice, the busy.jsp error page of load control, and the password change flow of the role search page. The upgrade notes now say that per-virtual-host login pages and JAR themes are gone, and that custom fields shown in the JSP results must also be added to query.additional.api.response.fields. --- de/15.9/admin/theme-guide.rst | 2 +- de/15.9/api/admin/api-admin-plugin.rst | 6 +- de/15.9/config/load-control.rst | 2 +- de/15.9/config/security-virtual-host.rst | 5 +- de/15.9/dev/overview.rst | 2 +- de/15.9/dev/plugin-architecture.rst | 11 +- de/15.9/dev/theme-development.rst | 145 +++--------------- de/15.9/dev/webapp-plugin.rst | 25 ++- de/15.9/install/upgrade.rst | 21 ++- de/15.9/user/role-search.rst | 3 +- en/15.9/admin/theme-guide.rst | 2 +- en/15.9/api/admin/api-admin-plugin.rst | 6 +- en/15.9/config/load-control.rst | 2 +- en/15.9/config/security-virtual-host.rst | 5 +- en/15.9/dev/overview.rst | 2 +- en/15.9/dev/plugin-architecture.rst | 11 +- en/15.9/dev/theme-development.rst | 138 +++-------------- en/15.9/dev/webapp-plugin.rst | 26 ++-- en/15.9/install/upgrade.rst | 20 ++- en/15.9/user/role-search.rst | 3 +- es/15.9/admin/theme-guide.rst | 2 +- es/15.9/api/admin/api-admin-plugin.rst | 6 +- es/15.9/config/load-control.rst | 2 +- es/15.9/config/security-virtual-host.rst | 5 +- es/15.9/dev/overview.rst | 2 +- es/15.9/dev/plugin-architecture.rst | 11 +- es/15.9/dev/theme-development.rst | 159 ++++---------------- es/15.9/dev/webapp-plugin.rst | 26 ++-- es/15.9/install/upgrade.rst | 22 ++- es/15.9/user/role-search.rst | 3 +- fr/15.9/admin/theme-guide.rst | 2 +- fr/15.9/api/admin/api-admin-plugin.rst | 6 +- fr/15.9/config/load-control.rst | 2 +- fr/15.9/config/security-virtual-host.rst | 5 +- fr/15.9/dev/overview.rst | 2 +- fr/15.9/dev/plugin-architecture.rst | 11 +- fr/15.9/dev/theme-development.rst | 157 ++++--------------- fr/15.9/dev/webapp-plugin.rst | 26 ++-- fr/15.9/install/upgrade.rst | 23 ++- fr/15.9/user/role-search.rst | 3 +- ja/15.9/admin/theme-guide.rst | 2 +- ja/15.9/api/admin/api-admin-plugin.rst | 6 +- ja/15.9/config/load-control.rst | 2 +- ja/15.9/config/security-virtual-host.rst | 5 +- ja/15.9/dev/overview.rst | 2 +- ja/15.9/dev/plugin-architecture.rst | 10 +- ja/15.9/dev/theme-development.rst | 129 +++------------- ja/15.9/dev/webapp-plugin.rst | 19 +-- ja/15.9/install/upgrade.rst | 20 ++- ja/15.9/user/role-search.rst | 3 +- ko/15.9/admin/theme-guide.rst | 2 +- ko/15.9/api/admin/api-admin-plugin.rst | 6 +- ko/15.9/config/load-control.rst | 2 +- ko/15.9/config/security-virtual-host.rst | 5 +- ko/15.9/dev/overview.rst | 2 +- ko/15.9/dev/plugin-architecture.rst | 10 +- ko/15.9/dev/theme-development.rst | 131 +++------------- ko/15.9/dev/webapp-plugin.rst | 21 ++- ko/15.9/install/upgrade.rst | 20 ++- ko/15.9/user/role-search.rst | 3 +- zh-cn/15.9/admin/theme-guide.rst | 2 +- zh-cn/15.9/api/admin/api-admin-plugin.rst | 6 +- zh-cn/15.9/config/load-control.rst | 2 +- zh-cn/15.9/config/security-virtual-host.rst | 5 +- zh-cn/15.9/dev/overview.rst | 2 +- zh-cn/15.9/dev/plugin-architecture.rst | 10 +- zh-cn/15.9/dev/theme-development.rst | 121 ++------------- zh-cn/15.9/dev/webapp-plugin.rst | 20 +-- zh-cn/15.9/install/upgrade.rst | 18 ++- zh-cn/15.9/user/role-search.rst | 3 +- 70 files changed, 478 insertions(+), 1023 deletions(-) diff --git a/de/15.9/admin/theme-guide.rst b/de/15.9/admin/theme-guide.rst index ec3008ba9..ba39a2a16 100644 --- a/de/15.9/admin/theme-guide.rst +++ b/de/15.9/admin/theme-guide.rst @@ -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 diff --git a/de/15.9/api/admin/api-admin-plugin.rst b/de/15.9/api/admin/api-admin-plugin.rst index 25911c1a2..ef9caf30a 100644 --- a/de/15.9/api/admin/api-admin-plugin.rst +++ b/de/15.9/api/admin/api-admin-plugin.rst @@ -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`` diff --git a/de/15.9/config/load-control.rst b/de/15.9/config/load-control.rst index 1881ea313..e75a4e8c2 100644 --- a/de/15.9/config/load-control.rst +++ b/de/15.9/config/load-control.rst @@ -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:** diff --git a/de/15.9/config/security-virtual-host.rst b/de/15.9/config/security-virtual-host.rst index 33a6895c0..87978ab77 100644 --- a/de/15.9/config/security-virtual-host.rst +++ b/de/15.9/config/security-virtual-host.rst @@ -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 diff --git a/de/15.9/dev/overview.rst b/de/15.9/dev/overview.rst index d79d523b6..841db0fce 100644 --- a/de/15.9/dev/overview.rst +++ b/de/15.9/dev/overview.rst @@ -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 ==================== diff --git a/de/15.9/dev/plugin-architecture.rst b/de/15.9/dev/plugin-architecture.rst index 6c7b16abe..d9b861ba0 100644 --- a/de/15.9/dev/plugin-architecture.rst +++ b/de/15.9/dev/plugin-architecture.rst @@ -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 @@ -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 =============== @@ -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`` / diff --git a/de/15.9/dev/theme-development.rst b/de/15.9/dev/theme-development.rst index b85fb83fc..a5462b9a3 100644 --- a/de/15.9/dev/theme-development.rst +++ b/de/15.9/dev/theme-development.rst @@ -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 ================ @@ -312,129 +312,28 @@ 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 `` 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 - - - - 4.0.0 - - fess-theme-example - 15.9.0 - jar - - - org.codelibs.fess - fess-parent - 15.9.0 - - - - -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//`` - * - ``css/`` - - ``css//`` - * - ``js/`` - - ``js//`` - * - ``images/`` - - ``images//`` - -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 =================================== @@ -442,10 +341,6 @@ Beispiele für vorhandene Themes - `fess-themes `__ - Sammlung statischer Themes (enthält mehrere statische Themes wie ``codesearch`` und ``docsearch``) -- `fess-theme-simple `__ - - JAR-Theme -- `fess-theme-classic `__ - - JAR-Theme Referenzinformationen ========================= diff --git a/de/15.9/dev/webapp-plugin.rst b/de/15.9/dev/webapp-plugin.rst index 4626acab0..59bde12fd 100644 --- a/de/15.9/dev/webapp-plugin.rst +++ b/de/15.9/dev/webapp-plugin.rst @@ -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 ````-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. @@ -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 ======================= diff --git a/de/15.9/install/upgrade.rst b/de/15.9/install/upgrade.rst index b9d7d99e3..6e6f11fce 100644 --- a/de/15.9/install/upgrade.rst +++ b/de/15.9/install/upgrade.rst @@ -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 ``. 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//``, 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 `` (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 ~~~~~~~~~~~~~~~~~ diff --git a/de/15.9/user/role-search.rst b/de/15.9/user/role-search.rst index 034bc43f1..119182a30 100644 --- a/de/15.9/user/role-search.rst +++ b/de/15.9/user/role-search.rst @@ -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. diff --git a/en/15.9/admin/theme-guide.rst b/en/15.9/admin/theme-guide.rst index a0a36c863..b10c7b478 100644 --- a/en/15.9/admin/theme-guide.rst +++ b/en/15.9/admin/theme-guide.rst @@ -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 diff --git a/en/15.9/api/admin/api-admin-plugin.rst b/en/15.9/api/admin/api-admin-plugin.rst index fdbd8f303..bbbd73b44 100644 --- a/en/15.9/api/admin/api-admin-plugin.rst +++ b/en/15.9/api/admin/api-admin-plugin.rst @@ -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`` diff --git a/en/15.9/config/load-control.rst b/en/15.9/config/load-control.rst index 32ff9e4e1..97b16e47c 100644 --- a/en/15.9/config/load-control.rst +++ b/en/15.9/config/load-control.rst @@ -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:** diff --git a/en/15.9/config/security-virtual-host.rst b/en/15.9/config/security-virtual-host.rst index 9076c0059..52015a9de 100644 --- a/en/15.9/config/security-virtual-host.rst +++ b/en/15.9/config/security-virtual-host.rst @@ -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 diff --git a/en/15.9/dev/overview.rst b/en/15.9/dev/overview.rst index 2faed227f..1bf8051c7 100644 --- a/en/15.9/dev/overview.rst +++ b/en/15.9/dev/overview.rst @@ -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 ================= diff --git a/en/15.9/dev/plugin-architecture.rst b/en/15.9/dev/plugin-architecture.rst index dc1fe58b0..b84eb552e 100644 --- a/en/15.9/dev/plugin-architecture.rst +++ b/en/15.9/dev/plugin-architecture.rst @@ -35,9 +35,6 @@ Plugin Types * - Ingest - ``fess-ingest-*`` - Processes documents during index registration - * - Theme - - ``fess-theme-*`` - - Customizes the design of the search screen * - Thumbnail - ``fess-thumbnail-*`` - Adds new thumbnail generation methods @@ -54,6 +51,12 @@ Plugin Types - ``fess-sso-*`` - Adds a single sign-on authenticator selected by ``sso.type`` +.. note:: + + The ``fess-theme-*`` (JAR theme) type, which supplied JSPs, was removed in 15.9. + Change the look of the search screen with a static theme, not a plugin + (see :doc:`theme-development`). + Plugin Structure ================= @@ -364,8 +367,6 @@ representative examples (this is not an exhaustive list): - Git repository connector * - ``fess-llm-openai`` - OpenAI LLM provider - * - ``fess-theme-*`` - - Custom themes In addition, Data Store connectors such as ``fess-ds-csv`` / ``fess-ds-db`` / ``fess-ds-json`` / ``fess-ds-microsoft365`` / diff --git a/en/15.9/dev/theme-development.rst b/en/15.9/dev/theme-development.rst index 7b560284d..87061476f 100644 --- a/en/15.9/dev/theme-development.rst +++ b/en/15.9/dev/theme-development.rst @@ -19,9 +19,9 @@ is to copy the bundled theme and change the copy, as described in .. note:: Static themes are available in |Fess| 15.7 and later, and became the - default search screen in 15.9. JAR theme plugins, which replace the - JSPs of the search screen, no longer change the search screen in - 15.9; see `JAR Theme Plugin (Legacy)`_. + default search screen in 15.9. JAR theme plugins, which replaced the + JSPs of the search screen, were removed in 15.9; see + `JAR Theme Plugin (Removed in 15.9)`_. Static Theme ============ @@ -288,123 +288,27 @@ nor replaced by an upload. Copy it under a new name instead. |Fess| upgrade and reapply your changes, as the bundled theme follows the ``/api/v2/*`` API of its |Fess| version. -JAR Theme Plugin (Legacy) -========================= - -.. warning:: - - Since |Fess| 15.9, the search screen is always served by a static - theme, so a JAR theme plugin no longer changes it. Of the JSPs a JAR - theme provides, only those of the login screen (``/login/``) are - still used. Move the design to a static theme; see - `Customizing the Bundled Theme`_. - -A JAR theme plugin overrides the |Fess| core's ``view`` / ``css`` / -``js`` / ``images`` directories on a per-theme-name basis. For the -general plugin structure and build process, also see -:doc:`plugin-architecture`. - -Structure ---------- - -:: - - fess-theme-example/ - ├── pom.xml - └── src/main/resources/ - ├── view/ # JSP files (search.jsp, index.jsp, header.jsp, etc.) - ├── css/ # CSS files (style.css, etc.) - ├── js/ # JavaScript files - └── images/ # Image files (logo.png, etc.) - -.. note:: - - Views (templates) are in JSP format. Only the four top-level - resource directories ``view`` / ``css`` / ``js`` / ``images`` are - recognized. The artifact name must start with ``fess-theme-``. - -pom.xml -------- - -The plugin is built as a jar with ``fess-parent`` as the parent POM. -Since a theme consists only of resources, there is usually no need to -declare additional dependencies. - -.. code-block:: xml - - - - 4.0.0 - - fess-theme-example - 15.9.0 - jar - - - org.codelibs.fess - fess-parent - 15.9.0 - - - - -Customizing CSS and Images ---------------------------- - -The JSPs are Bootstrap-based. You can override the CSS to change colors -and layout, or replace ``images/logo.png`` to change the logo. Since -15.9 this affects only the login screen; the search screen is a static -theme (see `Customizing the Bundled Theme`_). - -Build and Installation ------------------------ - -:: - - mvn clean package - -A JAR file (e.g., ``fess-theme-example-15.9.0.jar``) is generated in -the ``target/`` directory. You can install it from "System" -> -"Plugin" in the admin console. For details on the installation -procedure, see :doc:`../admin/plugin-guide`. - -Once installed, each directory in the JAR is expanded to the following -locations, per theme name (the theme name is the artifact name with -the ``fess-theme-`` prefix removed; in the example above, ``example``). +JAR Theme Plugin (Removed in 15.9) +================================== -.. list-table:: - :header-rows: 1 - :widths: 30 70 - - * - Directory in the JAR - - Expansion destination - * - ``view/`` - - ``WEB-INF/view//`` - * - ``css/`` - - ``css//`` - * - ``js/`` - - ``js//`` - * - ``images/`` - - ``images//`` - -Activation ----------- +The JAR theme plugin type, which put JSPs, CSS and images in a ``fess-theme-*`` JAR and +applied them as the theme named after a virtual host key, was removed in |Fess| 15.9. +15.9 does not extract a JAR theme and does not use it for any screen. -A JAR theme is activated using the virtual host feature. If you match -a virtual host key to the theme name, the theme is applied when that -host is accessed. +- Installing one from "System" > "Plugin" in the admin UI only places it in + ``app/WEB-INF/plugin/`` as a generic JAR of type ``jar``; no screen changes. A + ``fess-theme-*.jar`` left over from an earlier version is listed the same way, and can be + deleted on that page or with ``bin/fess-setup remove plugin ``. +- ``bin/fess-setup`` neither lists nor installs ``fess-theme-*``. -1. In the virtual host settings under "System" -> "General", map the - request's ``Host`` header to a theme name (virtual host key), for - example ``Host:localhost:8080=example``. -2. If needed, also set the same name (``example``) for the virtual - host in the crawling web configuration, etc. +Move the changes you made in a JAR theme to a static theme: -For details on how to configure virtual hosts, see -:doc:`../admin/general-guide`. +- For the colors, layout and logo of the search screen, copy the bundled theme and change + the copy (see `Customizing the Bundled Theme`_). +- If you changed the look per virtual host, install a static theme named after the + virtual host (see :doc:`../config/security-virtual-host`). +- The login screen (``/login/``) is the same for every virtual host. A theme cannot + change it. Examples of Existing Themes ============================ @@ -412,8 +316,6 @@ Examples of Existing Themes - `fess-themes `__ - A collection of static themes (includes multiple static themes such as ``codesearch`` and ``docsearch``) -- `fess-theme-simple `__ - JAR theme -- `fess-theme-classic `__ - JAR theme Reference ========= diff --git a/en/15.9/dev/webapp-plugin.rst b/en/15.9/dev/webapp-plugin.rst index dc24e34f7..26e1e5975 100644 --- a/en/15.9/dev/webapp-plugin.rst +++ b/en/15.9/dev/webapp-plugin.rst @@ -188,14 +188,14 @@ is declared in the |Fess| core's ``fess.xml``, the replacement file is Replacement (a single ``+``) replaces the component definition **in its entirety**. This means the replacement file must include - every ```` entry that the core definition performs. - For example, when replacing ``systemHelper``, you must copy and - describe all of the design JSP name mappings - (``addDesignJspFileName``) from the core's ``fess.xml``. These must - be kept in sync with each |Fess| release, and any omission will - make some screens (such as ``chat`` / ``login``) impossible to - resolve. This maintenance cost is why addition is recommended over - replacement. + every ```` entry that the core definition performs + (for example, ``queryHelper`` in ``app.xml``). These must be kept in + sync with each |Fess| release. If the file keeps calling a method + that the core removed, the component definition fails to initialize + with a ``BeanMethodNotFoundException``. For example, 15.9 removed + ``addDesignJspFileName`` from ``systemHelper``, so a replacement file + that still calls it fails. This maintenance cost is why addition is + recommended over replacement. Adding a REST API (fess_api++.xml) ------------------------------------ @@ -274,14 +274,8 @@ Customizing the Search Screen Web App plugins cannot add JSP views. JSP views are located under ``WEB-INF/view/`` in the |Fess| core WAR, while plugin JARs are mounted onto the classpath (``WEB-INF/classes``). To change the design of the -search screen, use one of the following: - -- **Theme**: Customizes the design (HTML/CSS/JavaScript) of the - search screen. See :doc:`theme-development`. -- **Replacing systemHelper**: Using the "Replacing Core Components" - approach described above, you can change the design JSP name - mapping (however, the JSP files themselves are still provided by the - |Fess| core). +search screen, use a static theme, which customizes the design +(HTML/CSS/JavaScript) of the search screen. See :doc:`theme-development`. Build and Installation ======================== diff --git a/en/15.9/install/upgrade.rst b/en/15.9/install/upgrade.rst index 2ae5a51c8..73ea43273 100644 --- a/en/15.9/install/upgrade.rst +++ b/en/15.9/install/upgrade.rst @@ -864,7 +864,25 @@ or in a JAR theme plugin, those changes no longer show. Make them in a static th theme and change the copy, as described in :ref:`theme-customize-bundled`, or install a published theme from "System" > "Theme" in the admin UI or with ``bin/fess-setup install theme ``. A per-virtual-host look is now a static theme named after the virtual host; see -:doc:`../config/security-virtual-host`. The login screen (``/login/``) is still a JSP. +:doc:`../config/security-virtual-host`. + +Two more things are gone: + +- The per-virtual-host login screen. Up to 15.8, saving "System" > "General" copied JSPs, + including the login screen, into ``WEB-INF/view//``, where each virtual host + could edit its own copy. 15.9 no longer makes these copies. The login screen (``/login/``) is + still a JSP, but every virtual host gets the same one from ``WEB-INF/view/admin/login/``. JSPs + copied earlier are not used. +- JAR theme plugins (``fess-theme-*``). Installing one only places it as a generic JAR of type + ``jar``; no screen changes. Delete a leftover JAR on the "System" > "Plugin" page or with + ``bin/fess-setup remove plugin `` (see :doc:`../dev/theme-development`). + +If the JSP search results showed a field of your own in 15.8, add that field to +``query.additional.api.response.fields`` as well as ``query.additional.response.fields``. The static +theme gets its results from ``/api/v2/search``. ``query.additional.response.fields`` only adds a field +to what is fetched from the search engine; the API returns only the fields listed in +``query.additional.api.response.fields`` (see :doc:`../config/search-advanced`). Change the theme to +show the field as well. What Clients See ~~~~~~~~~~~~~~~~ diff --git a/en/15.9/user/role-search.rst b/en/15.9/user/role-search.rst index 3dd317055..2a165bb35 100644 --- a/en/15.9/user/role-search.rst +++ b/en/15.9/user/role-search.rst @@ -34,7 +34,8 @@ Clicking "Change Password" in the menu displays the password change screen. |image1| Enter your Current Password, New Password, and Confirm New Password (re-enter), then click the Update button to update your password. -After changing your password, click the Back button to return to the search screen. +Changing your password logs you out, so log in again with the new password. +This screen is the ``/profile`` page of the search screen's theme, and the password is changed with ``POST /api/v2/auth/password`` (see :doc:`../api/api-auth`). .. note:: The "Change Password" menu item is displayed only for users managed by |Fess| (and LDAP users permitted to edit their password). It is not displayed for users authenticated via single sign-on. diff --git a/es/15.9/admin/theme-guide.rst b/es/15.9/admin/theme-guide.rst index c0d949133..d3a2a3375 100644 --- a/es/15.9/admin/theme-guide.rst +++ b/es/15.9/admin/theme-guide.rst @@ -10,7 +10,7 @@ La función de temas gestiona los «temas estáticos», que agrupan el aspecto v La pantalla de búsqueda es siempre un tema estático. Cuando no hay ningún tema predeterminado configurado, |Fess| utiliza ``bootstrap``, el tema estático incluido con él. El tema incluido no se puede eliminar ni reemplazar; para modificarlo, cópielo con otro nombre (consulte :ref:`theme-customize-bundled`). .. note:: - Los temas basados en JSP (JAR) se gestionan desde la administración de complementos y quedan fuera del ámbito de esta página. Desde la versión 15.9 ya no modifican la pantalla de búsqueda. + Los temas basados en JSP (plugins de tema JAR ``fess-theme-*``) se eliminaron en 15.9. Para cambiar el aspecto, utilice un tema estático (consulte :ref:`upgrade-159-static-theme`). Para realizar las operaciones de esta página se requiere el rol ``admin-theme`` (o el rol ``admin-theme-view`` si solo se necesita acceso de lectura). Obtención de un tema diff --git a/es/15.9/api/admin/api-admin-plugin.rst b/es/15.9/api/admin/api-admin-plugin.rst index 534f4a408..6962e8737 100644 --- a/es/15.9/api/admin/api-admin-plugin.rst +++ b/es/15.9/api/admin/api-admin-plugin.rst @@ -51,10 +51,12 @@ cuyos elementos son objetos con los siguientes campos. * - Campo - Descripción * - ``type`` - - ID de tipo del artefacto. Puede ser uno de: ``fess-ds`` (almacén de datos), ``fess-theme`` (tema), + - ID de tipo del artefacto. Puede ser uno de: ``fess-ds`` (almacén de datos), ``fess-ingest`` (Ingest), ``fess-script`` (script), ``fess-webapp`` (aplicación web), ``fess-thumbnail`` (miniatura), ``fess-crawler`` (crawler), ``fess-llm`` (LLM), - ``jar`` (JAR de propósito general no incluido en los anteriores). + ``fess-storage`` (almacenamiento), ``fess-sso`` (SSO), + ``jar`` (JAR de propósito general no incluido en los anteriores). ``fess-theme`` se eliminó en + 15.9, y un JAR ``fess-theme-*`` se trata como ``jar``. * - ``id`` - Identificador con formato ``{name}:{version}``. * - ``name`` diff --git a/es/15.9/config/load-control.rst b/es/15.9/config/load-control.rst index e600463f3..f2021b1ea 100644 --- a/es/15.9/config/load-control.rst +++ b/es/15.9/config/load-control.rst @@ -88,7 +88,7 @@ Cuando llega una solicitud, LoadControlFilter la procesa en el siguiente orden: **Para solicitudes web:** - Devuelve el código de estado HTTP 429 -- Muestra la página de error (``busy.jsp``) +- Muestra la página de error del tema **Para solicitudes API:** diff --git a/es/15.9/config/security-virtual-host.rst b/es/15.9/config/security-virtual-host.rst index 579953f25..fe041a0a0 100644 --- a/es/15.9/config/security-virtual-host.rst +++ b/es/15.9/config/security-virtual-host.rst @@ -63,8 +63,9 @@ No es necesario establecer el tema como predeterminado. Consulte :ref:`theme-cus .. note:: - Al guardar la configuración se siguen generando archivos JSP en ``WEB-INF/view/nombre_host_virtual``, pero desde |Fess| 15.9 la pantalla de búsqueda ya no los utiliza. - Solo la pantalla de inicio de sesión (``/login/``) se sigue generando a partir de ellos. + Desde |Fess| 15.9, al guardar la configuración ya no se generan archivos JSP en ``WEB-INF/view/nombre_host_virtual``. + La pantalla de inicio de sesión (``/login/``) es la misma para todos los hosts virtuales (``WEB-INF/view/admin/login/``) y no se puede cambiar por host virtual. + El aspecto de cada host virtual se cambia con un tema estático con el mismo nombre que el host virtual, como se describe arriba. Configuración de Rastreo diff --git a/es/15.9/dev/overview.rst b/es/15.9/dev/overview.rst index 386d746c9..e36087c61 100644 --- a/es/15.9/dev/overview.rst +++ b/es/15.9/dev/overview.rst @@ -151,7 +151,7 @@ Estructura de Directorios │ ├── fess_config.properties # Configuración │ └── fess_*.xml # Configuración DI (app.xml, fess_ds.xml, etc.) └── src/main/webapp/ - └── WEB-INF/view/ # Plantillas JSP + └── WEB-INF/view/ # JSP de la administración y del inicio de sesión Puntos de Extensión =================== diff --git a/es/15.9/dev/plugin-architecture.rst b/es/15.9/dev/plugin-architecture.rst index 4e1a607a6..872a4082e 100644 --- a/es/15.9/dev/plugin-architecture.rst +++ b/es/15.9/dev/plugin-architecture.rst @@ -37,9 +37,6 @@ siguientes: * - Ingest - ``fess-ingest-*`` - Procesamiento de documentos durante el registro en el índice - * - Tema - - ``fess-theme-*`` - - Personalización del diseño de la pantalla de búsqueda * - Miniatura - ``fess-thumbnail-*`` - Adición de métodos de generación de miniaturas @@ -56,6 +53,12 @@ siguientes: - ``fess-sso-*`` - Adición de métodos de autenticación Single Sign-On seleccionados mediante ``sso.type`` +.. note:: + + El tipo ``fess-theme-*`` (tema JAR), que proporcionaba JSP, se eliminó en 15.9. + El aspecto de la pantalla de búsqueda se cambia con un tema estático, no con un plugin + (consulte :doc:`theme-development`). + Estructura del Plugin ====================== @@ -369,8 +372,6 @@ muestran algunos ejemplos representativos (esta lista no es exhaustiva): - Conector de repositorios Git * - ``fess-llm-openai`` - Proveedor de LLM OpenAI - * - ``fess-theme-*`` - - Tema personalizado Además de estos, también se publican conectores de almacén de datos como ``fess-ds-csv`` / ``fess-ds-db`` / ``fess-ds-json`` / diff --git a/es/15.9/dev/theme-development.rst b/es/15.9/dev/theme-development.rst index 6a17a1875..f5b22363a 100644 --- a/es/15.9/dev/theme-development.rst +++ b/es/15.9/dev/theme-development.rst @@ -21,9 +21,9 @@ describe en `Personalización del Tema Incluido`_. Los temas estáticos están disponibles a partir de |Fess| 15.7 y se convirtieron en la pantalla de búsqueda predeterminada en 15.9. Los - plugins de tema JAR, que sustituyen las JSP de la pantalla de - búsqueda, ya no modifican la pantalla de búsqueda en 15.9; consulte - `Plugin de Tema JAR (heredado)`_. + plugins de tema JAR, que sustituían las JSP de la pantalla de + búsqueda, se eliminaron en 15.9; consulte + `Plugin de Tema JAR (eliminado en 15.9)`_. Tema Estático ============= @@ -311,128 +311,33 @@ lugar, cópielo con otro nombre. nueva copia del tema incluido y vuelva a aplicar sus cambios, ya que el tema incluido sigue la API ``/api/v2/*`` de su versión de |Fess|. -Plugin de Tema JAR (heredado) -============================= - -.. warning:: - - Desde |Fess| 15.9, la pantalla de búsqueda se sirve siempre con un - tema estático, por lo que un plugin de tema JAR ya no la modifica. - De las JSP que proporciona un tema JAR, solo se siguen utilizando - las de la pantalla de inicio de sesión (``/login/``). Traslade el - diseño a un tema estático; consulte - `Personalización del Tema Incluido`_. - -El plugin de tema JAR es un plugin que sobrescribe los directorios -``view`` / ``css`` / ``js`` / ``images`` del propio |Fess| para cada -nombre de tema. Para conocer la estructura general de los plugins y el -método de compilación, consulte también :doc:`plugin-architecture`. - -Estructura ----------- - -:: - - fess-theme-example/ - ├── pom.xml - └── src/main/resources/ - ├── view/ # Archivos JSP (search.jsp, index.jsp, header.jsp, etc.) - ├── css/ # Archivos CSS (style.css, etc.) - ├── js/ # Archivos JavaScript - └── images/ # Archivos de imagen (logo.png, etc.) - -.. note:: - - Las vistas (plantillas) están en formato JSP. Solo se reconocen los - cuatro directorios de nivel superior de recursos: ``view`` / ``css`` - / ``js`` / ``images``. El nombre del artefacto debe comenzar con - ``fess-theme-``. - -pom.xml -------- - -El plugin se construye como un jar con ``fess-parent`` como POM padre. -Puesto que el tema se compone únicamente de recursos, normalmente no es -necesario declarar dependencias adicionales. - -.. code-block:: xml - - - - 4.0.0 - - fess-theme-example - 15.9.0 - jar - - - org.codelibs.fess - fess-parent - 15.9.0 - - - - -Personalización de CSS e Imágenes ----------------------------------- - -Las JSP están basadas en Bootstrap. Puede sobrescribir el CSS para -cambiar los colores y el diseño, o sustituir ``images/logo.png`` para -cambiar el logotipo. Desde 15.9 esto solo afecta a la pantalla de -inicio de sesión; la pantalla de búsqueda es un tema estático -(consulte `Personalización del Tema Incluido`_). - -Compilación e Instalación --------------------------- - -:: - - mvn clean package - -En el directorio ``target/`` se genera un archivo JAR (por ejemplo, -``fess-theme-example-15.9.0.jar``). Puede instalarlo desde «Sistema» → -«Plugin» en la consola de administración. Para más detalles sobre el -procedimiento de instalación, consulte :doc:`../admin/plugin-guide`. - -Al instalarlo, cada directorio dentro del JAR se expande, para cada -nombre de tema, en las siguientes ubicaciones (el nombre del tema es -la parte del nombre del artefacto que resulta de eliminar -``fess-theme-``; en el ejemplo anterior, ``example``). - -.. list-table:: - :header-rows: 1 - :widths: 30 70 - - * - Directorio dentro del JAR - - Destino de expansión - * - ``view/`` - - ``WEB-INF/view//`` - * - ``css/`` - - ``css//`` - * - ``js/`` - - ``js//`` - * - ``images/`` - - ``images//`` - -Activación ----------- - -Los temas JAR se activan mediante la función de host virtual. Si la -clave del host virtual coincide con el nombre del tema, este se aplica -al acceder a ese host. - -1. En la configuración de host virtual de «Sistema» → «General», - asocie la cabecera ``Host`` de la solicitud con el nombre del tema - (la clave del host virtual), como en - ``Host:localhost:8080=example``. -2. Si es necesario, configure el mismo nombre (``example``) también en - el host virtual de la configuración web del rastreo, entre otros. - -Para más detalles sobre cómo configurar el host virtual, consulte -:doc:`../admin/general-guide`. +Plugin de Tema JAR (eliminado en 15.9) +====================================== + +El tipo de plugin de tema JAR, que empaquetaba JSP, CSS e imágenes en un +JAR ``fess-theme-*`` y los aplicaba como el tema con el mismo nombre que +la clave del host virtual, se eliminó en |Fess| 15.9. 15.9 no expande +los temas JAR ni los utiliza en ninguna pantalla. + +- Si lo instala desde «Sistema» → «Plugin» en la consola de + administración, solo se coloca en ``app/WEB-INF/plugin/`` como un JAR + de propósito general del tipo ``jar`` y no cambia ninguna pantalla. + Un ``fess-theme-*.jar`` que haya quedado de una versión anterior se + muestra de la misma manera y se puede eliminar desde esa pantalla o + con ``bin/fess-setup remove plugin ``. +- ``bin/fess-setup`` no muestra ``fess-theme-*`` en la lista ni lo + instala. + +Traslade a un tema estático los cambios que hacía con un tema JAR. + +- Para los colores, el diseño y el logotipo de la pantalla de búsqueda, + copie el tema incluido y modifíquelo (consulte + `Personalización del Tema Incluido`_). +- Si cambiaba el aspecto por host virtual, instale un tema estático con + el mismo nombre que el host virtual (consulte + :doc:`../config/security-virtual-host`). +- La pantalla de inicio de sesión (``/login/``) es la misma para todos + los hosts virtuales y no se puede cambiar con un tema. Ejemplos de Temas Existentes ============================ @@ -440,10 +345,6 @@ Ejemplos de Temas Existentes - `fess-themes `__ - Colección de temas estáticos (incluye varios temas estáticos como ``codesearch`` y ``docsearch``) -- `fess-theme-simple `__ - - Tema JAR -- `fess-theme-classic `__ - - Tema JAR Información de Referencia ========================= diff --git a/es/15.9/dev/webapp-plugin.rst b/es/15.9/dev/webapp-plugin.rst index 09a95f7b8..2d94e1bfe 100644 --- a/es/15.9/dev/webapp-plugin.rst +++ b/es/15.9/dev/webapp-plugin.rst @@ -195,13 +195,14 @@ propio |Fess|, el archivo de sustitución será ``fess+systemHelper.xml`` La sustitución (con un único ``+``) reemplaza **por completo** la definición del componente. Por ello, el archivo de sustitución debe incluir todos los elementos ```` que realiza la - definición del núcleo. Por ejemplo, al sustituir ``systemHelper``, es - necesario copiar y describir todo el mapeo de nombres de JSP de - diseño (``addDesignJspFileName``) desde el ``fess.xml`` del núcleo. - Esto debe sincronizarse en cada versión de |Fess|, y cualquier - omisión hará que algunas pantallas (como ``chat`` o ``login``) no - puedan resolverse. Este coste de mantenimiento es la razón por la - que se recomienda la adición en lugar de la sustitución. + definición del núcleo (por ejemplo, ``queryHelper`` en ``app.xml``). + Esto debe sincronizarse en cada versión de |Fess|. Si el archivo + sigue llamando a un método que se eliminó del núcleo, la + inicialización de esa definición de componente falla con + ``BeanMethodNotFoundException``. Por ejemplo, en 15.9 se eliminó + ``addDesignJspFileName`` de ``systemHelper``, por lo que un archivo + de sustitución que lo llame falla. Este coste de mantenimiento es la + razón por la que se recomienda la adición en lugar de la sustitución. Adición de una API REST (fess_api++.xml) ------------------------------------------- @@ -281,14 +282,9 @@ Los plugins de aplicación web no pueden añadir vistas JSP. Esto se debe a que las vistas JSP se ubican en ``WEB-INF/view/`` del WAR del propio |Fess|, mientras que el JAR del plugin se monta en el classpath (``WEB-INF/classes``). Si desea modificar el diseño de la pantalla de -búsqueda, utilice una de las siguientes opciones: - -- **Tema**: personaliza el diseño de la pantalla de búsqueda - (HTML/CSS/JavaScript). Consulte :doc:`theme-development`. -- **Sustitución de systemHelper**: mediante la «sustitución de - componentes del núcleo» descrita anteriormente, puede cambiar el - mapeo de nombres de JSP de diseño (aunque los propios archivos JSP - los proporciona el núcleo de |Fess|). +búsqueda, utilice un tema estático. El tema estático personaliza el +diseño de la pantalla de búsqueda (HTML/CSS/JavaScript). Consulte +:doc:`theme-development`. Construcción e Instalación ============================ diff --git a/es/15.9/install/upgrade.rst b/es/15.9/install/upgrade.rst index 6bdcfad4f..79211a8d8 100644 --- a/es/15.9/install/upgrade.rst +++ b/es/15.9/install/upgrade.rst @@ -897,8 +897,26 @@ Aplíquelos en un tema estático: copie el tema incluido y modifique la copia, c :ref:`theme-customize-bundled`, o instale un tema publicado desde "Sistema" > "Tema" en la pantalla de administración o con ``bin/fess-setup install theme ``. Un aspecto distinto por host virtual es ahora un tema estático con el nombre del host virtual; consulte -:doc:`../config/security-virtual-host`. La pantalla de inicio de sesión (``/login/``) sigue siendo -un JSP. +:doc:`../config/security-virtual-host`. + +También desaparecieron estas dos funciones: + +- La pantalla de inicio de sesión por host virtual. Hasta 15.8, al guardar "Sistema" > "General" se + copiaban los JSP, incluida la pantalla de inicio de sesión, en ``WEB-INF/view//``, + y se podían editar por host virtual. 15.9 ya no crea esas copias. La pantalla de inicio de sesión + (``/login/``) sigue siendo un JSP, pero todos los hosts virtuales muestran el mismo, el de + ``WEB-INF/view/admin/login/``. Los JSP copiados anteriormente no se utilizan. +- Los plugins de tema JAR (``fess-theme-*``). Si instala uno, solo se coloca como un JAR de propósito + general del tipo ``jar`` y no cambia ninguna pantalla. Los JAR que queden se pueden eliminar en la + página "Sistema" > "Plugin" o con ``bin/fess-setup remove plugin `` (consulte + :doc:`../dev/theme-development`). + +Si en 15.8 mostraba campos propios en los resultados de búsqueda JSP, añada los mismos campos a +``query.additional.api.response.fields`` además de a ``query.additional.response.fields``. El tema +estático obtiene los resultados de búsqueda de ``/api/v2/search``. ``query.additional.response.fields`` +solo añade los campos que se obtienen del motor de búsqueda, y esta API incluye en la respuesta únicamente +los campos enumerados en ``query.additional.api.response.fields`` (consulte :doc:`../config/search-advanced`). +Modifique también el tema para que muestre esos campos. Lo que ven los clientes ~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/es/15.9/user/role-search.rst b/es/15.9/user/role-search.rst index fb409b167..d389d73d9 100644 --- a/es/15.9/user/role-search.rst +++ b/es/15.9/user/role-search.rst @@ -34,7 +34,8 @@ Al hacer clic en «Cambiar contraseña» dentro del menú, se muestra la pantall |image1| Introduzca la contraseña actual, la nueva contraseña y la confirmación de la nueva contraseña (reintroducida), y haga clic en el botón «Actualizar» para actualizar la contraseña. -Después de cambiar la contraseña, puede volver a la pantalla de búsqueda haciendo clic en el botón «Volver». +Al cambiar la contraseña se cierra la sesión, así que vuelva a iniciar sesión con la nueva contraseña. +Esta pantalla es la página ``/profile`` del tema de la pantalla de búsqueda, y la contraseña se cambia con ``POST /api/v2/auth/password`` (consulte :doc:`../api/api-auth`). .. note:: El menú «Cambiar contraseña» solo se muestra para los usuarios administrados por |Fess| (y para los usuarios LDAP a los que se les ha permitido editar). No se muestra para los usuarios autenticados mediante inicio de sesión único. diff --git a/fr/15.9/admin/theme-guide.rst b/fr/15.9/admin/theme-guide.rst index f04e16e87..8acb7bd7b 100644 --- a/fr/15.9/admin/theme-guide.rst +++ b/fr/15.9/admin/theme-guide.rst @@ -10,7 +10,7 @@ La fonctionnalité de thèmes permet de gérer les « thèmes statiques », c'es L'écran de recherche est toujours un thème statique. Lorsqu'aucun thème par défaut n'est défini, |Fess| utilise ``bootstrap``, le thème statique fourni avec lui. Le thème fourni ne peut être ni supprimé ni remplacé ; pour le modifier, copiez-le sous un nouveau nom (voir :ref:`theme-customize-bundled`). .. note:: - Les thèmes basés sur JSP (JAR) sont gérés via la page de configuration des plugins et ne font pas l'objet de cette page. Depuis la version 15.9, ils ne modifient plus l'écran de recherche. + Les thèmes basés sur JSP (plugins de thème JAR ``fess-theme-*``) ont été supprimés en 15.9. Pour modifier l'apparence, utilisez un thème statique (voir :ref:`upgrade-159-static-theme`). Pour effectuer les opérations décrites sur cette page, le rôle ``admin-theme`` est requis (le rôle ``admin-theme-view`` suffit pour la consultation seule). Obtenir un thème diff --git a/fr/15.9/api/admin/api-admin-plugin.rst b/fr/15.9/api/admin/api-admin-plugin.rst index 392adffc5..f2c837b33 100644 --- a/fr/15.9/api/admin/api-admin-plugin.rst +++ b/fr/15.9/api/admin/api-admin-plugin.rst @@ -52,10 +52,12 @@ Chaque élément du tableau ``plugins`` renvoyé par les endpoints de liste - Description * - ``type`` - Identifiant de catégorie de l'artefact. L'une des valeurs suivantes : - ``fess-ds`` (data store), ``fess-theme`` (thème), + ``fess-ds`` (data store), ``fess-ingest`` (Ingest), ``fess-script`` (script), ``fess-webapp`` (application web), ``fess-thumbnail`` (miniature), ``fess-crawler`` (crawler), ``fess-llm`` (LLM), - ``jar`` (JAR générique pour tout autre cas). + ``fess-storage`` (stockage), ``fess-sso`` (SSO), + ``jar`` (JAR générique pour tout autre cas). ``fess-theme`` a été supprimé en 15.9, + et un JAR ``fess-theme-*`` est traité comme ``jar``. * - ``id`` - Identifiant au format ``{name}:{version}``. * - ``name`` diff --git a/fr/15.9/config/load-control.rst b/fr/15.9/config/load-control.rst index ac6439cea..a01da6177 100644 --- a/fr/15.9/config/load-control.rst +++ b/fr/15.9/config/load-control.rst @@ -89,7 +89,7 @@ Lorsqu'une requête arrive, LoadControlFilter la traite dans l'ordre suivant : **Pour les requêtes web :** - Retourne le code de statut HTTP 429 -- Affiche la page d'erreur (``busy.jsp``) +- Affiche la page d'erreur du thème **Pour les requêtes API :** diff --git a/fr/15.9/config/security-virtual-host.rst b/fr/15.9/config/security-virtual-host.rst index 04ad132f9..e9d74acde 100644 --- a/fr/15.9/config/security-virtual-host.rst +++ b/fr/15.9/config/security-virtual-host.rst @@ -63,8 +63,9 @@ Il n'est pas nécessaire de définir ce thème comme thème par défaut. Consult .. note:: - L'enregistrement de la configuration génère toujours des JSP dans ``WEB-INF/view/nom_hôte_virtuel``, mais depuis |Fess| 15.9, l'écran de recherche ne les utilise plus. - Seul l'écran de connexion (``/login/``) est encore rendu à partir de ceux-ci. + Depuis |Fess| 15.9, l'enregistrement de la configuration ne génère plus de JSP dans ``WEB-INF/view/nom_hôte_virtuel``. + L'écran de connexion (``/login/``) est le même pour tous les hôtes virtuels (``WEB-INF/view/admin/login/``) et ne peut pas être modifié par hôte virtuel. + L'apparence de chaque hôte virtuel se modifie avec un thème statique portant le même nom que l'hôte virtuel, comme décrit ci-dessus. Configuration de l'exploration diff --git a/fr/15.9/dev/overview.rst b/fr/15.9/dev/overview.rst index e8ca1f9f6..97cc5b6b5 100644 --- a/fr/15.9/dev/overview.rst +++ b/fr/15.9/dev/overview.rst @@ -160,7 +160,7 @@ Structure des répertoires │ ├── fess_config.properties # Configuration │ └── fess_*.xml # Configuration DI (app.xml, fess_ds.xml, etc.) └── src/main/webapp/ - └── WEB-INF/view/ # Templates JSP + └── WEB-INF/view/ # JSP de l'administration et de la connexion Points d'extension ==================== diff --git a/fr/15.9/dev/plugin-architecture.rst b/fr/15.9/dev/plugin-architecture.rst index 0f976d09e..141cc362f 100644 --- a/fr/15.9/dev/plugin-architecture.rst +++ b/fr/15.9/dev/plugin-architecture.rst @@ -37,9 +37,6 @@ suivants : * - Ingest - ``fess-ingest-*`` - Traitement des documents lors de leur enregistrement dans l'index - * - Thème - - ``fess-theme-*`` - - Personnalisation du design de l'écran de recherche * - Miniature - ``fess-thumbnail-*`` - Ajout de méthodes de génération de miniatures @@ -56,6 +53,12 @@ suivants : - ``fess-sso-*`` - Ajout d'une méthode d'authentification Single Sign-On sélectionnée par ``sso.type`` +.. note:: + + Le type ``fess-theme-*`` (thème JAR), qui fournissait des JSP, a été supprimé en 15.9. + L'apparence de l'écran de recherche se modifie avec un thème statique, et non avec un + plugin (voir :doc:`theme-development`). + Structure d'un plugin ====================== @@ -366,8 +369,6 @@ exemples représentatifs (cette liste n'est pas exhaustive) : - Connecteur de dépôt Git * - ``fess-llm-openai`` - Fournisseur LLM OpenAI - * - ``fess-theme-*`` - - Thèmes personnalisés D'autres connecteurs DataStore tels que ``fess-ds-csv`` / ``fess-ds-db`` / ``fess-ds-json`` / ``fess-ds-microsoft365`` / ``fess-ds-sharepoint``, ainsi diff --git a/fr/15.9/dev/theme-development.rst b/fr/15.9/dev/theme-development.rst index f19a1f642..7a5149e61 100644 --- a/fr/15.9/dev/theme-development.rst +++ b/fr/15.9/dev/theme-development.rst @@ -21,8 +21,8 @@ copier le thème fourni et de modifier la copie, comme décrit dans Les thèmes statiques sont disponibles à partir de |Fess| 15.7 et sont devenus l'écran de recherche par défaut en 15.9. Les plugins de thème JAR, - qui remplacent les JSP de l'écran de recherche, ne modifient plus l'écran - de recherche en 15.9 ; voir `Plugin de thème JAR (legacy)`_. + qui remplaçaient les JSP de l'écran de recherche, ont été supprimés en + 15.9 ; voir `Plugin de thème JAR (supprimé en 15.9)`_. Thème statique ============== @@ -306,126 +306,35 @@ nom. copie du thème fourni et réappliquez vos modifications, car le thème fourni suit l'API ``/api/v2/*`` de sa version de |Fess|. -Plugin de thème JAR (legacy) -============================ - -.. warning:: - - Depuis |Fess| 15.9, l'écran de recherche est toujours servi par un thème - statique ; un plugin de thème JAR ne le modifie donc plus. Parmi les JSP - fournies par un thème JAR, seules celles de l'écran de connexion - (``/login/``) sont encore utilisées. Transférez le design vers un thème - statique ; voir `Personnalisation du thème fourni`_. - -Un plugin de thème JAR est un plugin qui remplace les répertoires ``view`` / -``css`` / ``js`` / ``images`` du cœur de |Fess| pour chaque nom de thème. -Pour la structure générale des plugins et la méthode de build, reportez-vous -également à :doc:`plugin-architecture`. - -Structure ---------- - -:: - - fess-theme-example/ - ├── pom.xml - └── src/main/resources/ - ├── view/ # Fichiers JSP (search.jsp, index.jsp, header.jsp, etc.) - ├── css/ # Fichiers CSS (style.css, etc.) - ├── js/ # Fichiers JavaScript - └── images/ # Fichiers image (logo.png, etc.) - -.. note:: - - Les vues (templates) sont au format JSP. Seuls les quatre répertoires de - premier niveau ``view`` / ``css`` / ``js`` / ``images`` sont reconnus - comme ressources. Le nom de l'artefact doit commencer par - ``fess-theme-``. - -pom.xml -------- - -Le plugin est construit comme un jar ayant ``fess-parent`` pour POM parent. -Comme le thème est constitué uniquement de ressources, il n'est généralement -pas nécessaire de déclarer de dépendances supplémentaires. - -.. code-block:: xml - - - - 4.0.0 - - fess-theme-example - 15.9.0 - jar - - - org.codelibs.fess - fess-parent - 15.9.0 - - - - -Personnalisation du CSS et des images ---------------------------------------- - -Les JSP sont basées sur Bootstrap. Vous pouvez modifier les couleurs et la -mise en page en remplaçant le CSS, ou changer le logo en remplaçant -``images/logo.png``. Depuis la version 15.9, cela ne concerne que l'écran de -connexion ; l'écran de recherche est un thème statique (voir -`Personnalisation du thème fourni`_). - -Build et installation ------------------------ - -:: - - mvn clean package - -Le fichier JAR (par exemple ``fess-theme-example-15.9.0.jar``) est généré -dans le répertoire ``target/``. Vous pouvez l'installer depuis « Système » → -« Plugin » dans l'écran d'administration. Pour plus de détails sur la -procédure d'installation, reportez-vous à :doc:`../admin/plugin-guide`. - -Après l'installation, chaque répertoire du JAR est déployé pour le nom de -thème correspondant aux emplacements suivants (le nom du thème correspond à -la partie de l'artefact restant après avoir retiré ``fess-theme-`` ; dans -l'exemple ci-dessus, il s'agit de ``example``). - -.. list-table:: - :header-rows: 1 - :widths: 30 70 - - * - Répertoire dans le JAR - - Emplacement de déploiement - * - ``view/`` - - ``WEB-INF/view//`` - * - ``css/`` - - ``css//`` - * - ``js/`` - - ``js//`` - * - ``images/`` - - ``images//`` - -Activation ----------- - -Un thème JAR s'active à l'aide de la fonctionnalité d'hôte virtuel. Si la clé -de l'hôte virtuel correspond au nom du thème, le thème est appliqué lors de -l'accès à cet hôte. - -1. Dans les paramètres d'hôte virtuel de « Système » → « Général », associez - l'en-tête ``Host`` de la requête au nom du thème (clé de l'hôte virtuel), - par exemple ``Host:localhost:8080=example``. -2. Si nécessaire, définissez également le même nom (``example``) pour - l'hôte virtuel des paramètres Web de crawl, entre autres. - -Pour plus de détails sur la configuration des hôtes virtuels, reportez-vous à -:doc:`../admin/general-guide`. +Plugin de thème JAR (supprimé en 15.9) +====================================== + +Le type de plugin de thème JAR, qui regroupait des JSP, du CSS et des +images dans un JAR ``fess-theme-*`` et les appliquait comme le thème +portant le même nom que la clé de l'hôte virtuel, a été supprimé dans +|Fess| 15.9. 15.9 ne déploie plus les thèmes JAR et ne les utilise pour +aucun écran. + +- Si vous en installez un depuis « Système » → « Plugin » dans l'écran + d'administration, il est seulement placé dans ``app/WEB-INF/plugin/`` + comme un JAR générique de type ``jar`` et ne modifie aucun écran. Un + ``fess-theme-*.jar`` laissé par une version antérieure s'affiche de la + même manière et peut être supprimé depuis cet écran ou avec + ``bin/fess-setup remove plugin ``. +- ``bin/fess-setup`` n'affiche pas ``fess-theme-*`` dans ses listes et ne + l'installe pas. + +Reportez dans un thème statique les modifications que vous faisiez avec +un thème JAR. + +- Pour les couleurs, la mise en page et le logo de l'écran de recherche, + copiez le thème fourni et modifiez-le (voir + `Personnalisation du thème fourni`_). +- Si vous changiez l'apparence par hôte virtuel, installez un thème + statique portant le même nom que l'hôte virtuel (voir + :doc:`../config/security-virtual-host`). +- L'écran de connexion (``/login/``) est le même pour tous les hôtes + virtuels et ne peut pas être modifié par un thème. Exemples de thèmes existants ============================= @@ -433,10 +342,6 @@ Exemples de thèmes existants - `fess-themes `__ - Collection de thèmes statiques (regroupe plusieurs thèmes statiques tels que ``codesearch`` et ``docsearch``) -- `fess-theme-simple `__ - - Thème JAR -- `fess-theme-classic `__ - - Thème JAR Informations complémentaires ============================= diff --git a/fr/15.9/dev/webapp-plugin.rst b/fr/15.9/dev/webapp-plugin.rst index 2062dec3e..43556d576 100644 --- a/fr/15.9/dev/webapp-plugin.rst +++ b/fr/15.9/dev/webapp-plugin.rst @@ -195,13 +195,14 @@ remplacement sera ``fess+systemHelper.xml`` (et non Le remplacement (un seul ``+``) remplace **entièrement** la définition du composant. Pour cette raison, le fichier de remplacement doit contenir tous les éléments ```` définis par la définition - du cœur. Par exemple, pour remplacer ``systemHelper``, vous devez copier - intégralement le mapping des noms de JSP de design - (``addDesignJspFileName``) depuis le ``fess.xml`` du cœur. Ces éléments - doivent être synchronisés à chaque nouvelle version de |Fess|, et tout - oubli empêchera la résolution de certains écrans (``chat``, ``login``, - etc.). Ce coût de maintenance explique pourquoi l'ajout est recommandé - plutôt que le remplacement. + du cœur (par exemple ``queryHelper`` dans ``app.xml``). Ces éléments + doivent être synchronisés à chaque nouvelle version de |Fess|. Si le + fichier continue d'appeler une méthode supprimée du cœur, + l'initialisation de cette définition de composant échoue avec + ``BeanMethodNotFoundException``. Par exemple, ``addDesignJspFileName`` + de ``systemHelper`` a été supprimé en 15.9, si bien qu'un fichier de + remplacement qui l'appelle échoue. Ce coût de maintenance explique + pourquoi l'ajout est recommandé plutôt que le remplacement. Ajout d'une API REST (fess_api++.xml) --------------------------------------- @@ -281,14 +282,9 @@ Les plugins d'application Web ne peuvent pas ajouter de vues JSP. En effet, les vues JSP sont placées dans ``WEB-INF/view/`` du WAR de |Fess| lui-même, alors que le JAR du plugin est monté dans le classpath (``WEB-INF/classes``). Pour modifier le design de l'écran de recherche, -utilisez l'une des approches suivantes : - -- **Thème** : personnalise le design (HTML/CSS/JavaScript) de l'écran de - recherche. Reportez-vous à :doc:`theme-development`. -- **Remplacement de systemHelper** : comme décrit ci-dessus dans - « Remplacement d'un composant du cœur », vous pouvez modifier le mapping - des noms de JSP de design (les fichiers JSP eux-mêmes restent toutefois - fournis par |Fess| lui-même). +utilisez un thème statique. Le thème statique personnalise le design +(HTML/CSS/JavaScript) de l'écran de recherche. Reportez-vous à +:doc:`theme-development`. Build et installation ====================== diff --git a/fr/15.9/install/upgrade.rst b/fr/15.9/install/upgrade.rst index 165cfd7c3..c0071541b 100644 --- a/fr/15.9/install/upgrade.rst +++ b/fr/15.9/install/upgrade.rst @@ -905,8 +905,27 @@ s'affichent plus. Reportez-les dans un thème statique : copiez le thème fourni copie, comme décrit dans :ref:`theme-customize-bundled`, ou installez un thème publié depuis « Système » → « Thème » dans l'écran d'administration ou avec ``bin/fess-setup install theme ``. Une apparence propre à un hôte virtuel est désormais un thème statique portant le nom de -cet hôte virtuel ; voir :doc:`../config/security-virtual-host`. L'écran de connexion (``/login/``) -reste une JSP. +cet hôte virtuel ; voir :doc:`../config/security-virtual-host`. + +Ces deux fonctionnalités ont également disparu : + +- L'écran de connexion par hôte virtuel. Jusqu'en 15.8, l'enregistrement de « Système » → « Général » + copiait les JSP, y compris l'écran de connexion, dans ``WEB-INF/view//``, et + on pouvait les modifier par hôte virtuel. 15.9 ne crée plus ces copies. L'écran de connexion + (``/login/``) reste une JSP, mais tous les hôtes virtuels affichent la même, celle de + ``WEB-INF/view/admin/login/``. Les JSP copiées auparavant ne sont pas utilisées. +- Les plugins de thème JAR (``fess-theme-*``). S'il est installé, un tel plugin est seulement placé + comme un JAR générique de type ``jar`` et ne modifie aucun écran. Les JAR restants peuvent être + supprimés depuis la page « Système » → « Plugin » ou avec ``bin/fess-setup remove plugin `` + (voir :doc:`../dev/theme-development`). + +Si, en 15.8, vous affichiez vos propres champs dans les résultats de recherche JSP, ajoutez les mêmes +champs à ``query.additional.api.response.fields`` en plus de ``query.additional.response.fields``. +Le thème statique obtient les résultats de recherche depuis ``/api/v2/search``. +``query.additional.response.fields`` ajoute seulement les champs récupérés depuis le moteur de +recherche, et cette API n'inclut dans sa réponse que les champs listés dans +``query.additional.api.response.fields`` (voir :doc:`../config/search-advanced`). Modifiez aussi le +thème pour qu'il affiche ces champs. Ce que voient les clients ~~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/fr/15.9/user/role-search.rst b/fr/15.9/user/role-search.rst index ebf08a4a5..bcd9e12d3 100644 --- a/fr/15.9/user/role-search.rst +++ b/fr/15.9/user/role-search.rst @@ -34,7 +34,8 @@ En cliquant sur « Changer le mot de passe » dans le menu, l'écran de modifica |image1| Saisissez le mot de passe actuel dans le champ « Mot de passe actuel », le nouveau mot de passe dans le champ « Nouveau mot de passe », confirmez-le dans le champ « Confirmer le nouveau mot de passe », puis cliquez sur le bouton « Mettre à jour » pour mettre à jour le mot de passe. -Après avoir modifié le mot de passe, vous pouvez revenir à l'écran de recherche en cliquant sur le bouton « Retour ». +La modification du mot de passe ferme la session : reconnectez-vous avec le nouveau mot de passe. +Cet écran est la page ``/profile`` du thème de l'écran de recherche, et le mot de passe est modifié via ``POST /api/v2/auth/password`` (voir :doc:`../api/api-auth`). .. note:: Le menu « Changer le mot de passe » ne s'affiche que pour les utilisateurs gérés par |Fess| (ainsi que pour les utilisateurs LDAP autorisés à modifier leur mot de passe). Il ne s'affiche pas pour les utilisateurs authentifiés via l'authentification unique. diff --git a/ja/15.9/admin/theme-guide.rst b/ja/15.9/admin/theme-guide.rst index 98be73414..bd12b271a 100644 --- a/ja/15.9/admin/theme-guide.rst +++ b/ja/15.9/admin/theme-guide.rst @@ -10,7 +10,7 @@ 検索画面は常に静的テーマで表示されます。デフォルトテーマを設定していない場合は、 |Fess| に同梱の静的テーマ ``bootstrap`` が使われます。同梱のテーマは削除も置き換えもできません。変更するには、別の名前で複製します（ :ref:`theme-customize-bundled` を参照）。 .. note:: - JSP ベースのテーマ（JAR テーマ）はプラグイン管理で扱うため、本ページの対象外です。15.9 からは、JAR テーマでは検索画面を変えられません。 + JSP ベースのテーマ（ ``fess-theme-*`` の JAR テーマプラグイン）は 15.9 で削除されました。見た目を変えるには静的テーマを使います（ :ref:`upgrade-159-static-theme` を参照）。 本ページの操作を行うには ``admin-theme`` ロール（参照のみの場合は ``admin-theme-view`` ロール）が必要です。 テーマの入手 diff --git a/ja/15.9/api/admin/api-admin-plugin.rst b/ja/15.9/api/admin/api-admin-plugin.rst index e41a2100e..cd034e0a1 100644 --- a/ja/15.9/api/admin/api-admin-plugin.rst +++ b/ja/15.9/api/admin/api-admin-plugin.rst @@ -51,10 +51,12 @@ Plugin APIは、|Fess| のプラグイン（アーティファクト）を管理 * - フィールド - 説明 * - ``type`` - - アーティファクトの種別ID。\ ``fess-ds`` （データストア）、``fess-theme`` （テーマ）、 + - アーティファクトの種別ID。\ ``fess-ds`` （データストア）、 ``fess-ingest`` （Ingest）、``fess-script`` （スクリプト）、``fess-webapp`` （Webアプリ）、 ``fess-thumbnail`` （サムネイル）、``fess-crawler`` （クローラ）、``fess-llm`` （LLM）、 - ``jar`` （上記以外の汎用JAR）のいずれかです。 + ``fess-storage`` （ストレージ）、``fess-sso`` （SSO）、 + ``jar`` （上記以外の汎用JAR）のいずれかです。15.9 で ``fess-theme`` は削除され、 + ``fess-theme-*`` の JAR は ``jar`` として扱われます。 * - ``id`` - ``{name}:{version}`` 形式の識別子。 * - ``name`` diff --git a/ja/15.9/config/load-control.rst b/ja/15.9/config/load-control.rst index 5d5553fe3..f7c4dc78c 100644 --- a/ja/15.9/config/load-control.rst +++ b/ja/15.9/config/load-control.rst @@ -88,7 +88,7 @@ HTTPリクエスト負荷制御の設定 **Web リクエストの場合:** - HTTP 429 ステータスコードを返却 -- エラーページ（``busy.jsp``）を表示 +- テーマのエラーページを表示 **API リクエストの場合:** diff --git a/ja/15.9/config/security-virtual-host.rst b/ja/15.9/config/security-virtual-host.rst index 252ebd5b8..b2b0ad323 100644 --- a/ja/15.9/config/security-virtual-host.rst +++ b/ja/15.9/config/security-virtual-host.rst @@ -63,8 +63,9 @@ .. note:: - 設定を保存すると、引き続き ``WEB-INF/view/仮想ホスト名`` にJSPが生成されますが、 |Fess| 15.9 からは検索画面にこれらのJSPは使われません。 - ログイン画面（ ``/login/`` ）だけが、引き続きこれらのJSPで表示されます。 + |Fess| 15.9 からは、設定を保存しても ``WEB-INF/view/仮想ホスト名`` にJSPは生成されません。 + ログイン画面（ ``/login/`` ）はすべての仮想ホストで共通の画面（ ``WEB-INF/view/admin/login/`` ）で表示され、仮想ホストごとに変えることはできません。 + 仮想ホストごとの見た目は、上記のとおり仮想ホスト名と同じ名前の静的テーマで変えます。 クロール設定 diff --git a/ja/15.9/dev/overview.rst b/ja/15.9/dev/overview.rst index a31b45f08..093dfe0d1 100644 --- a/ja/15.9/dev/overview.rst +++ b/ja/15.9/dev/overview.rst @@ -149,7 +149,7 @@ │ ├── fess_config.properties # 設定 │ └── fess_*.xml # DI設定（app.xml, fess_ds.xml など） └── src/main/webapp/ - └── WEB-INF/view/ # JSPテンプレート + └── WEB-INF/view/ # 管理画面とログイン画面のJSP 拡張ポイント ============ diff --git a/ja/15.9/dev/plugin-architecture.rst b/ja/15.9/dev/plugin-architecture.rst index 4d88c3142..52d91a083 100644 --- a/ja/15.9/dev/plugin-architecture.rst +++ b/ja/15.9/dev/plugin-architecture.rst @@ -35,9 +35,6 @@ DI コンテナ(Lasta Di)によってコンポーネントが読み込まれ、 * - Ingest - ``fess-ingest-*`` - インデックス登録時のドキュメント加工 - * - テーマ - - ``fess-theme-*`` - - 検索画面デザインのカスタマイズ * - サムネイル - ``fess-thumbnail-*`` - サムネイル生成方式の追加 @@ -54,6 +51,11 @@ DI コンテナ(Lasta Di)によってコンポーネントが読み込まれ、 - ``fess-sso-*`` - ``sso.type`` で選択されるシングルサインオン認証方式の追加 +.. note:: + + JSP を提供する ``fess-theme-*`` (JAR テーマ)の種類は 15.9 で削除されました。 + 検索画面の見た目は、プラグインではなく静的テーマで変えます(:doc:`theme-development` を参照)。 + プラグイン構造 ============== @@ -347,8 +349,6 @@ Fess本体との依存 - Git リポジトリコネクター * - ``fess-llm-openai`` - OpenAI LLM プロバイダー - * - ``fess-theme-*`` - - カスタムテーマ このほかにも、``fess-ds-csv`` / ``fess-ds-db`` / ``fess-ds-json`` / ``fess-ds-microsoft365`` / ``fess-ds-sharepoint`` などのデータストアコネクターや、 diff --git a/ja/15.9/dev/theme-development.rst b/ja/15.9/dev/theme-development.rst index fe65f1572..1142f2299 100644 --- a/ja/15.9/dev/theme-development.rst +++ b/ja/15.9/dev/theme-development.rst @@ -17,8 +17,8 @@ .. note:: 静的テーマは |Fess| 15.7 以降で利用でき、15.9 で既定の検索画面になりました。検索画面の - JSP を差し替える JAR テーマプラグインは、15.9 では検索画面を変えません。 - `JAR テーマプラグイン(レガシー)`_ を参照してください。 + JSP を差し替える JAR テーマプラグインは、15.9 で削除されました。 + `JAR テーマプラグイン(15.9 で削除)`_ を参照してください。 静的テーマ ========== @@ -259,124 +259,33 @@ 同梱のテーマは、その |Fess| のバージョンの ``/api/v2/*`` API に合わせてあります。 |Fess| をアップグレードしたら、新しい同梱テーマから複製し直して変更を再適用してください。 -JAR テーマプラグイン(レガシー) -================================ - -.. warning:: - - |Fess| 15.9 からは検索画面が常に静的テーマで表示されるため、JAR テーマプラグインでは - 検索画面を変えられません。JAR テーマが提供する JSP のうち、使われるのはログイン画面 - (``/login/``)のものだけです。デザインは静的テーマに移してください。 - `同梱テーマのカスタマイズ`_ を参照してください。 - -JAR テーマプラグインは、|Fess| 本体の ``view`` / ``css`` / ``js`` / ``images`` -ディレクトリをテーマ名ごとに上書きするプラグインです。プラグインの一般的な構造や -ビルド方法については :doc:`plugin-architecture` も参照してください。 - -構造 ----- - -:: - - fess-theme-example/ - ├── pom.xml - └── src/main/resources/ - ├── view/ # JSP ファイル(search.jsp, index.jsp, header.jsp など) - ├── css/ # CSS ファイル(style.css など) - ├── js/ # JavaScript ファイル - └── images/ # 画像ファイル(logo.png など) - -.. note:: - - ビュー(テンプレート)は JSP 形式です。リソースの最上位ディレクトリは - ``view`` / ``css`` / ``js`` / ``images`` の 4 つのみが認識されます。 - アーティファクト名は ``fess-theme-`` で始まる必要があります。 - -pom.xml -------- - -プラグインは ``fess-parent`` を親 POM とする jar としてビルドします。テーマは -リソースのみで構成されるため、通常は追加の依存関係を宣言する必要はありません。 - -.. code-block:: xml - - - - 4.0.0 - - fess-theme-example - 15.9.0 - jar - - - org.codelibs.fess - fess-parent - 15.9.0 - - - - -CSS・画像のカスタマイズ ------------------------ - -JSP は Bootstrap ベースです。CSS を上書きして配色やレイアウトを変更したり、 -``images/logo.png`` を差し替えてロゴを変更したりできます。15.9 では、この変更が -反映されるのはログイン画面だけです。検索画面は静的テーマです -(`同梱テーマのカスタマイズ`_ を参照)。 - -ビルドとインストール --------------------- - -:: - - mvn clean package - -``target/`` ディレクトリに JAR ファイル(例: ``fess-theme-example-15.9.0.jar``)が -生成されます。管理画面の「システム」→「プラグイン」からインストールできます。 -インストール手順の詳細は :doc:`../admin/plugin-guide` を参照してください。 - -インストールすると、JAR 内の各ディレクトリはテーマ名ごとに以下の場所へ展開されます -(テーマ名はアーティファクト名から ``fess-theme-`` を除いた部分。上記の例では -``example``)。 - -.. list-table:: - :header-rows: 1 - :widths: 30 70 - - * - JAR 内のディレクトリ - - 展開先 - * - ``view/`` - - ``WEB-INF/view//`` - * - ``css/`` - - ``css//`` - * - ``js/`` - - ``js//`` - * - ``images/`` - - ``images//`` +JAR テーマプラグイン(15.9 で削除) +================================== -有効化 ------- +JSP・CSS・画像を ``fess-theme-*`` の JAR に入れ、仮想ホストのキーと同じ名前のテーマとして +適用する JAR テーマプラグインの種類は、|Fess| 15.9 で削除されました。15.9 は JAR テーマを +展開せず、どの画面にも使いません。 -JAR テーマは、仮想ホスト機能を使って有効化します。仮想ホストのキーをテーマ名に -一致させると、そのホストへのアクセスでテーマが適用されます。 +- 管理画面の「システム」→「プラグイン」からインストールしても、種類 ``jar`` の汎用 JAR として + ``app/WEB-INF/plugin/`` に置かれるだけで、画面は何も変わりません。以前のバージョンから + 残った ``fess-theme-*.jar`` も同じように表示され、この画面または + ``bin/fess-setup remove plugin `` で削除できます。 +- ``bin/fess-setup`` は ``fess-theme-*`` を一覧に表示せず、インストールもしません。 -1. 「システム」→「全般」の仮想ホスト設定で、``Host:localhost:8080=example`` の - ように、リクエストの ``Host`` ヘッダーとテーマ名(仮想ホストのキー)を対応付けます。 -2. 必要に応じて、クローリングの Web 設定などの仮想ホストにも同じ名前(``example``)を - 設定します。 +JAR テーマで行っていた変更は、静的テーマに移してください。 -仮想ホストの設定方法の詳細は :doc:`../admin/general-guide` を参照してください。 +- 検索画面の配色・レイアウト・ロゴは、同梱のテーマを複製して変更します + (`同梱テーマのカスタマイズ`_ を参照)。 +- 仮想ホストごとに見た目を変えていた場合は、仮想ホスト名と同じ名前の静的テーマを + インストールします(:doc:`../config/security-virtual-host` を参照)。 +- ログイン画面(``/login/``)は、すべての仮想ホストで共通の画面です。テーマで変えることは + できません。 既存テーマの例 ============== - `fess-themes `__ - 静的テーマ集 (``codesearch``、``docsearch`` など複数の静的テーマを収録) -- `fess-theme-simple `__ - JAR テーマ -- `fess-theme-classic `__ - JAR テーマ 参考情報 ======== diff --git a/ja/15.9/dev/webapp-plugin.rst b/ja/15.9/dev/webapp-plugin.rst index 1ce01cd73..c828530da 100644 --- a/ja/15.9/dev/webapp-plugin.rst +++ b/ja/15.9/dev/webapp-plugin.rst @@ -178,11 +178,11 @@ Lasta Di は、クラスパス上の ``app++.xml`` を |Fess| 本体の ``app.xm 置き換え(単一の ``+``)は、コンポーネント定義を **丸ごと** 置き換えます。 このため、置き換えファイルにはコア定義が行っている ```` を - すべて記述する必要があります。例えば ``systemHelper`` を置き換える場合は、 - デザイン JSP 名のマッピング(``addDesignJspFileName``)をコアの ``fess.xml`` から - すべてコピーして記述しなければなりません。これらは |Fess| のリリースごとに - 同期する必要があり、漏れがあると一部の画面(``chat`` / ``login`` など)が - 解決できなくなります。この保守コストが、置き換えよりも追加が推奨される理由です。 + すべて記述する必要があります(例えば ``app.xml`` の ``queryHelper``)。これらは + |Fess| のリリースごとに同期する必要があります。コアから削除されたメソッドを呼び続けると、 + そのコンポーネント定義は ``BeanMethodNotFoundException`` で初期化に失敗します。例えば + 15.9 では ``systemHelper`` の ``addDesignJspFileName`` が削除されたため、これを呼ぶ + 置き換えファイルは失敗します。この保守コストが、置き換えよりも追加が推奨される理由です。 REST APIの追加(fess_api++.xml) ------------------------------- @@ -260,13 +260,8 @@ REST APIの追加(fess_api++.xml) Web アプリプラグインは JSP ビューを追加できません。JSP ビューは |Fess| 本体の WAR の ``WEB-INF/view/`` に配置されており、プラグイン JAR はクラスパス (``WEB-INF/classes``)にマウントされるためです。検索画面のデザインを変更する場合は、 -次のいずれかを使用します: - -- **テーマ**: 検索画面のデザイン(HTML/CSS/JavaScript)をカスタマイズします。 - :doc:`theme-development` を参照してください。 -- **systemHelper の置き換え**: 上記の「コアコンポーネントの置き換え」により、 - デザイン JSP 名のマッピングを変更できます(ただし JSP ファイル自体は |Fess| 本体が - 提供します)。 +静的テーマを使用します。静的テーマは検索画面のデザイン(HTML/CSS/JavaScript)を +カスタマイズします。:doc:`theme-development` を参照してください。 ビルドとインストール ==================== diff --git a/ja/15.9/install/upgrade.rst b/ja/15.9/install/upgrade.rst index f2e632120..763f6186c 100644 --- a/ja/15.9/install/upgrade.rst +++ b/ja/15.9/install/upgrade.rst @@ -859,8 +859,24 @@ jcifs の既定値のままになります。 その変更は表示されなくなります。変更は静的テーマで行ってください。同梱のテーマを複製して変更するか （ :ref:`theme-customize-bundled` を参照）、公開されているテーマを管理画面の「システム」>「テーマ」または ``bin/fess-setup install theme `` でインストールします。仮想ホストごとの見た目は、仮想ホスト名と -同じ名前の静的テーマで変えます（ :doc:`../config/security-virtual-host` を参照）。ログイン画面 -（ ``/login/`` ）は引き続き JSP です。 +同じ名前の静的テーマで変えます（ :doc:`../config/security-virtual-host` を参照）。 + +次の 2 つも無くなりました。 + +- 仮想ホストごとのログイン画面。15.8 までは「システム」>「全般」を保存すると、ログイン画面を含む + JSP が ``WEB-INF/view/<仮想ホスト名>/`` にコピーされ、仮想ホストごとに編集できました。15.9 は + このコピーを作りません。ログイン画面（ ``/login/`` ）は引き続き JSP ですが、すべての仮想ホストで + 共通の ``WEB-INF/view/admin/login/`` のものが表示されます。以前にコピーされた JSP は使われません。 +- JAR テーマプラグイン（ ``fess-theme-*`` ）。インストールしても種類 ``jar`` の汎用 JAR として + 置かれるだけで、画面は変わりません。残っている JAR は「システム」>「プラグイン」ページ、または + ``bin/fess-setup remove plugin `` で削除できます（ :doc:`../dev/theme-development` を参照）。 + +15.8 で JSP の検索結果に独自のフィールドを表示していた場合は、 ``query.additional.response.fields`` +に加えて ``query.additional.api.response.fields`` にも同じフィールドを追加してください。静的テーマは +検索結果を ``/api/v2/search`` から取得します。 ``query.additional.response.fields`` は検索エンジンから +取得するフィールドを追加するだけで、この API が応答に含めるのは ``query.additional.api.response.fields`` +に列挙されたフィールドだけです（ :doc:`../config/search-advanced` を参照）。そのフィールドを表示するように +テーマも変更してください。 クライアントから見た変化 ~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/ja/15.9/user/role-search.rst b/ja/15.9/user/role-search.rst index 74e715c9b..25b18518c 100644 --- a/ja/15.9/user/role-search.rst +++ b/ja/15.9/user/role-search.rst @@ -34,7 +34,8 @@ |image1| 現在のパスワード、新しいパスワード、および確認用の新しいパスワード（再入力）を入力して、更新ボタンをクリックすることでパスワードが更新されます。 -パスワードの変更後、戻るボタンをクリックすることで検索画面に戻ることができます。 +パスワードを変更するとログアウトされるため、新しいパスワードでログインし直してください。 +この画面は検索画面のテーマの ``/profile`` ページで、パスワードは ``POST /api/v2/auth/password`` で変更されます（ :doc:`../api/api-auth` を参照）。 .. note:: 「パスワード変更」メニューは、|Fess| で管理しているユーザー（および編集が許可された LDAP ユーザー）にのみ表示されます。シングルサインオンで認証したユーザーには表示されません。 diff --git a/ko/15.9/admin/theme-guide.rst b/ko/15.9/admin/theme-guide.rst index 1d45218fc..a75e176cf 100644 --- a/ko/15.9/admin/theme-guide.rst +++ b/ko/15.9/admin/theme-guide.rst @@ -10,7 +10,7 @@ 검색 화면은 항상 정적 테마로 표시됩니다. 기본 테마를 설정하지 않은 경우에는 |Fess| 에 번들된 정적 테마 ``bootstrap`` 이 사용됩니다. 번들된 테마는 삭제하거나 교체할 수 없습니다. 변경하려면 다른 이름으로 복사하십시오( :ref:`theme-customize-bundled` 참조). .. note:: - JSP 기반 테마(JAR 테마)는 플러그인 관리에서 취급하므로, 이 페이지의 대상 외입니다. 15.9 부터는 JAR 테마로 검색 화면을 변경할 수 없습니다. + JSP 기반 테마( ``fess-theme-*`` JAR 테마 플러그인)는 15.9 에서 삭제되었습니다. 외관을 변경하려면 정적 테마를 사용합니다( :ref:`upgrade-159-static-theme` 참조). 이 페이지의 작업을 수행하려면 ``admin-theme`` 역할(참조만 하는 경우는 ``admin-theme-view`` 역할)이 필요합니다. 테마 입수 diff --git a/ko/15.9/api/admin/api-admin-plugin.rst b/ko/15.9/api/admin/api-admin-plugin.rst index 50c32b732..ef3ea3f50 100644 --- a/ko/15.9/api/admin/api-admin-plugin.rst +++ b/ko/15.9/api/admin/api-admin-plugin.rst @@ -51,10 +51,12 @@ Plugin API는 |Fess| 의 플러그인(아티팩트)을 관리하기 위한 API * - 필드 - 설명 * - ``type`` - - 아티팩트의 종별 ID. ``fess-ds`` (데이터 스토어), ``fess-theme`` (테마), + - 아티팩트의 종별 ID. ``fess-ds`` (데이터 스토어), ``fess-ingest`` (Ingest), ``fess-script`` (스크립트), ``fess-webapp`` (웹 앱), ``fess-thumbnail`` (썸네일), ``fess-crawler`` (크롤러), ``fess-llm`` (LLM), - ``jar`` (위 이외의 범용 JAR) 중 하나입니다. + ``fess-storage`` (스토리지), ``fess-sso`` (SSO), + ``jar`` (위 이외의 범용 JAR) 중 하나입니다. 15.9 에서 ``fess-theme`` 은 삭제되었으며, + ``fess-theme-*`` JAR 는 ``jar`` 로 취급됩니다. * - ``id`` - ``{name}:{version}`` 형식의 식별자. * - ``name`` diff --git a/ko/15.9/config/load-control.rst b/ko/15.9/config/load-control.rst index e95b2fc4f..e543ae0b4 100644 --- a/ko/15.9/config/load-control.rst +++ b/ko/15.9/config/load-control.rst @@ -88,7 +88,7 @@ HTTP 요청 부하 제어 설정 **웹 요청의 경우:** - HTTP 429 상태 코드를 반환 -- 오류 페이지 (``busy.jsp``)를 표시 +- 테마의 오류 페이지를 표시 **API 요청의 경우:** diff --git a/ko/15.9/config/security-virtual-host.rst b/ko/15.9/config/security-virtual-host.rst index cc9093edc..753b22642 100644 --- a/ko/15.9/config/security-virtual-host.rst +++ b/ko/15.9/config/security-virtual-host.rst @@ -63,8 +63,9 @@ .. note:: - 설정을 저장하면 여전히 ``WEB-INF/view/가상호스트명`` 에 JSP가 생성되지만, |Fess| 15.9 부터 검색 화면은 이를 사용하지 않습니다. - 이 JSP로 표시되는 것은 로그인 화면( ``/login/`` )뿐입니다. + |Fess| 15.9 부터는 설정을 저장해도 ``WEB-INF/view/가상호스트명`` 에 JSP가 생성되지 않습니다. + 로그인 화면( ``/login/`` )은 모든 가상 호스트에서 공통 화면( ``WEB-INF/view/admin/login/`` )으로 표시되며, 가상 호스트별로 변경할 수 없습니다. + 가상 호스트별 외관은 위와 같이 가상 호스트 이름과 같은 이름의 정적 테마로 변경합니다. 크롤 설정 diff --git a/ko/15.9/dev/overview.rst b/ko/15.9/dev/overview.rst index 424279eca..6d2ad6f07 100644 --- a/ko/15.9/dev/overview.rst +++ b/ko/15.9/dev/overview.rst @@ -149,7 +149,7 @@ │ ├── fess_config.properties # 설정 │ └── fess_*.xml # DI 설정(app.xml, fess_ds.xml 등) └── src/main/webapp/ - └── WEB-INF/view/ # JSP 템플릿 + └── WEB-INF/view/ # 관리 화면과 로그인 화면의 JSP 확장 포인트 ============ diff --git a/ko/15.9/dev/plugin-architecture.rst b/ko/15.9/dev/plugin-architecture.rst index 4fd5ed13e..d8c83408f 100644 --- a/ko/15.9/dev/plugin-architecture.rst +++ b/ko/15.9/dev/plugin-architecture.rst @@ -35,9 +35,6 @@ * - Ingest - ``fess-ingest-*`` - 인덱스 등록 시 문서 가공 - * - 테마 - - ``fess-theme-*`` - - 검색 화면 디자인 커스터마이징 * - 썸네일 - ``fess-thumbnail-*`` - 썸네일 생성 방식 추가 @@ -54,6 +51,11 @@ - ``fess-sso-*`` - ``sso.type`` 으로 선택되는 싱글 사인온 인증 방식 추가 +.. note:: + + JSP 를 제공하는 ``fess-theme-*`` (JAR 테마) 종류는 15.9 에서 삭제되었습니다. + 검색 화면의 외관은 플러그인이 아니라 정적 테마로 변경합니다(:doc:`theme-development` 참조). + 플러그인 구조 ============== @@ -347,8 +349,6 @@ Fess 본체 의존성 - Git 리포지토리 커넥터 * - ``fess-llm-openai`` - OpenAI LLM 프로바이더 - * - ``fess-theme-*`` - - 커스텀 테마 이 밖에도 ``fess-ds-csv`` / ``fess-ds-db`` / ``fess-ds-json`` / ``fess-ds-microsoft365`` / ``fess-ds-sharepoint`` 등의 데이터스토어 커넥터나, diff --git a/ko/15.9/dev/theme-development.rst b/ko/15.9/dev/theme-development.rst index d0af40f8e..76a0840b5 100644 --- a/ko/15.9/dev/theme-development.rst +++ b/ko/15.9/dev/theme-development.rst @@ -18,9 +18,9 @@ .. note:: 정적 테마는 |Fess| 15.7 이후 버전에서 사용할 수 있으며, 15.9 에서 기본 - 검색 화면이 되었습니다. 검색 화면의 JSP 를 교체하는 JAR 테마 플러그인으로는 - 15.9 에서 더 이상 검색 화면을 변경할 수 없습니다. - `JAR 테마 플러그인(레거시)`_ 을 참조하십시오. + 검색 화면이 되었습니다. 검색 화면의 JSP 를 교체하는 JAR 테마 플러그인은 + 15.9 에서 삭제되었습니다. + `JAR 테마 플러그인(15.9 에서 삭제)`_ 을 참조하십시오. 정적 테마 ========== @@ -264,124 +264,33 @@ |Fess| 를 업그레이드할 때마다 번들 테마에서 새로 복사본을 만들어 변경 사항을 다시 적용하십시오. -JAR 테마 플러그인(레거시) -================================ +JAR 테마 플러그인(15.9 에서 삭제) +==================================== -.. warning:: +JSP·CSS·이미지를 ``fess-theme-*`` JAR 에 넣고, 가상 호스트의 키와 같은 이름의 테마로 +적용하는 JAR 테마 플러그인 종류는 |Fess| 15.9 에서 삭제되었습니다. 15.9 는 JAR 테마를 +전개하지 않으며, 어떤 화면에도 사용하지 않습니다. - |Fess| 15.9 부터 검색 화면은 항상 정적 테마로 제공되므로, JAR 테마 플러그인으로는 - 더 이상 검색 화면을 변경할 수 없습니다. JAR 테마가 제공하는 JSP 중 여전히 - 사용되는 것은 로그인 화면(``/login/``)의 JSP 뿐입니다. 디자인은 정적 테마로 - 옮기십시오. `번들 테마 커스터마이징`_ 을 참조하십시오. +- 관리 화면의 「시스템」→「플러그인」에서 설치해도, 종류 ``jar`` 의 범용 JAR 로 + ``app/WEB-INF/plugin/`` 에 놓일 뿐이며 화면은 아무것도 바뀌지 않습니다. 이전 버전에서 + 남은 ``fess-theme-*.jar`` 도 같은 방식으로 표시되며, 이 화면 또는 + ``bin/fess-setup remove plugin `` 으로 삭제할 수 있습니다. +- ``bin/fess-setup`` 은 ``fess-theme-*`` 를 목록에 표시하지 않으며, 설치하지도 않습니다. -JAR 테마 플러그인은 |Fess| 본체의 ``view`` / ``css`` / ``js`` / ``images`` -디렉터리를 테마 이름별로 덮어쓰는 플러그인입니다. 플러그인의 일반적인 구조나 -빌드 방법에 대해서는 :doc:`plugin-architecture` 도 참조하십시오. +JAR 테마에서 하던 변경은 정적 테마로 옮기십시오. -구조 ----- - -:: - - fess-theme-example/ - ├── pom.xml - └── src/main/resources/ - ├── view/ # JSP 파일(search.jsp, index.jsp, header.jsp 등) - ├── css/ # CSS 파일(style.css 등) - ├── js/ # JavaScript 파일 - └── images/ # 이미지 파일(logo.png 등) - -.. note:: - - 뷰(템플릿)는 JSP 형식입니다. 리소스의 최상위 디렉터리는 - ``view`` / ``css`` / ``js`` / ``images`` 의 4 가지만 인식됩니다. - 아티팩트 이름은 ``fess-theme-`` 로 시작해야 합니다. - -pom.xml -------- - -플러그인은 ``fess-parent`` 를 부모 POM 으로 하는 jar 로 빌드합니다. 테마는 -리소스만으로 구성되므로, 일반적으로 추가 의존 관계를 선언할 필요는 없습니다. - -.. code-block:: xml - - - - 4.0.0 - - fess-theme-example - 15.9.0 - jar - - - org.codelibs.fess - fess-parent - 15.9.0 - - - - -CSS·이미지 커스터마이징 ------------------------ - -JSP 는 Bootstrap 기반입니다. CSS 를 덮어써서 배색이나 레이아웃을 변경하거나, -``images/logo.png`` 를 교체하여 로고를 변경할 수 있습니다. 15.9 부터 이는 -로그인 화면에만 영향을 줍니다. 검색 화면은 정적 테마입니다 -(`번들 테마 커스터마이징`_ 참조). - -빌드와 설치 --------------------- - -:: - - mvn clean package - -``target/`` 디렉터리에 JAR 파일(예: ``fess-theme-example-15.9.0.jar``)이 -생성됩니다. 관리 화면의 [시스템 > 플러그인]에서 설치할 수 있습니다. -설치 절차의 자세한 내용은 :doc:`../admin/plugin-guide` 를 참조하십시오. - -설치하면 JAR 내의 각 디렉터리는 테마 이름별로 다음 위치에 전개됩니다 -(테마 이름은 아티팩트 이름에서 ``fess-theme-`` 를 제외한 부분입니다. 위 예에서는 -``example``). - -.. list-table:: - :header-rows: 1 - :widths: 30 70 - - * - JAR 내 디렉터리 - - 전개 위치 - * - ``view/`` - - ``WEB-INF/view//`` - * - ``css/`` - - ``css//`` - * - ``js/`` - - ``js//`` - * - ``images/`` - - ``images//`` - -활성화 ------- - -JAR 테마는 가상 호스트 기능을 사용하여 활성화합니다. 가상 호스트의 키를 테마 -이름과 일치시키면, 해당 호스트로의 접속 시 테마가 적용됩니다. - -1. [시스템 > 일반]의 가상 호스트 설정에서 ``Host:localhost:8080=example`` 과 - 같이, 요청의 ``Host`` 헤더와 테마 이름(가상 호스트의 키)을 대응시킵니다. -2. 필요에 따라 크롤링의 웹 설정 등의 가상 호스트에도 같은 이름(``example``)을 - 설정합니다. - -가상 호스트 설정 방법의 자세한 내용은 :doc:`../admin/general-guide` 를 참조하십시오. +- 검색 화면의 배색·레이아웃·로고는 번들 테마를 복사하여 변경합니다 + (`번들 테마 커스터마이징`_ 참조). +- 가상 호스트별로 외관을 바꾸던 경우에는 가상 호스트 이름과 같은 이름의 정적 테마를 + 설치합니다(:doc:`../config/security-virtual-host` 참조). +- 로그인 화면(``/login/``)은 모든 가상 호스트에서 공통인 화면입니다. 테마로 변경할 수 + 없습니다. 기존 테마 예시 ============== - `fess-themes `__ - 정적 테마 모음집 (``codesearch``, ``docsearch`` 등 여러 정적 테마 수록) -- `fess-theme-simple `__ - JAR 테마 -- `fess-theme-classic `__ - JAR 테마 참고 정보 ========= diff --git a/ko/15.9/dev/webapp-plugin.rst b/ko/15.9/dev/webapp-plugin.rst index 148e105ea..ff0c2a2ef 100644 --- a/ko/15.9/dev/webapp-plugin.rst +++ b/ko/15.9/dev/webapp-plugin.rst @@ -180,11 +180,12 @@ pom.xml 전체 구성(부모 POM·의존 관계 선언 방법 등)은 교체(단일 ``+``)는 컴포넌트 정의를 **통째로** 교체합니다. 이 때문에 교체 파일에는 코어 정의가 수행하고 있는 ```` 를 모두 - 기술해야 합니다. 예를 들어 ``systemHelper`` 를 교체하는 경우, 디자인 - JSP 이름 매핑(``addDesignJspFileName``)을 코어의 ``fess.xml`` 로부터 - 전부 복사하여 기술해야 합니다. 이는 |Fess| 릴리스마다 동기화해야 하며, - 누락이 있으면 일부 화면(``chat`` / ``login`` 등)을 해결할 수 없게 - 됩니다. 이러한 유지보수 비용이 교체보다 추가가 권장되는 이유입니다. + 기술해야 합니다(예: ``app.xml`` 의 ``queryHelper``). 이는 |Fess| + 릴리스마다 동기화해야 합니다. 코어에서 삭제된 메서드를 계속 호출하면, 그 + 컴포넌트 정의는 ``BeanMethodNotFoundException`` 으로 초기화에 실패합니다. + 예를 들어 15.9 에서는 ``systemHelper`` 의 ``addDesignJspFileName`` 이 + 삭제되었기 때문에, 이를 호출하는 교체 파일은 실패합니다. 이러한 유지보수 + 비용이 교체보다 추가가 권장되는 이유입니다. REST API 추가(fess_api++.xml) ------------------------------- @@ -263,13 +264,9 @@ REST API 추가(fess_api++.xml) 웹앱 플러그인은 JSP 뷰를 추가할 수 없습니다. JSP 뷰는 |Fess| 본체 WAR 의 ``WEB-INF/view/`` 에 배치되어 있으며, 플러그인 JAR 는 클래스패스 (``WEB-INF/classes``)에 마운트되기 때문입니다. 검색 화면의 디자인을 -변경하려면 다음 중 하나를 사용합니다: - -- **테마**: 검색 화면의 디자인(HTML/CSS/JavaScript)을 커스터마이즈합니다. - :doc:`theme-development` 를 참조하십시오. -- **systemHelper 교체**: 위의 「코어 컴포넌트 교체」를 통해 디자인 JSP - 이름 매핑을 변경할 수 있습니다(단, JSP 파일 자체는 |Fess| 본체가 - 제공합니다). +변경하려면 정적 테마를 사용합니다. 정적 테마는 검색 화면의 디자인 +(HTML/CSS/JavaScript)을 커스터마이즈합니다. :doc:`theme-development` 를 +참조하십시오. 빌드와 설치 =========== diff --git a/ko/15.9/install/upgrade.rst b/ko/15.9/install/upgrade.rst index 7c5328cf7..7b4f4acda 100644 --- a/ko/15.9/install/upgrade.rst +++ b/ko/15.9/install/upgrade.rst @@ -862,7 +862,25 @@ jcifs 의 기본값으로 동작했습니다. 15.9 는 새 이름을 전달합 설명된 대로 번들 테마를 복사하여 그 복사본을 변경하거나, 관리 화면의 「시스템」 > 「테마」 또는 ``bin/fess-setup install theme `` 으로 공개된 테마를 설치합니다. 가상 호스트별 외관은 이제 가상 호스트 이름을 딴 정적 테마로 제공됩니다. :doc:`../config/security-virtual-host` 를 -참조하십시오. 로그인 화면( ``/login/`` )은 여전히 JSP 입니다. +참조하십시오. + +다음 2가지도 없어졌습니다. + +- 가상 호스트별 로그인 화면. 15.8 까지는 「시스템」 > 「일반」을 저장하면 로그인 화면을 포함한 + JSP 가 ``WEB-INF/view/<가상 호스트 이름>/`` 에 복사되어, 가상 호스트별로 편집할 수 있었습니다. + 15.9 는 이 복사본을 만들지 않습니다. 로그인 화면( ``/login/`` )은 여전히 JSP 이지만, 모든 가상 + 호스트에서 공통인 ``WEB-INF/view/admin/login/`` 의 것이 표시됩니다. 이전에 복사된 JSP 는 + 사용되지 않습니다. +- JAR 테마 플러그인( ``fess-theme-*`` ). 설치해도 종류 ``jar`` 의 범용 JAR 로 놓일 뿐이며, + 화면은 바뀌지 않습니다. 남아 있는 JAR 는 「시스템」 > 「플러그인」 페이지, 또는 + ``bin/fess-setup remove plugin `` 으로 삭제할 수 있습니다( :doc:`../dev/theme-development` 참조). + +15.8 에서 JSP 검색 결과에 독자적인 필드를 표시하고 있었다면, ``query.additional.response.fields`` +에 더해 ``query.additional.api.response.fields`` 에도 같은 필드를 추가하십시오. 정적 테마는 +검색 결과를 ``/api/v2/search`` 에서 가져옵니다. ``query.additional.response.fields`` 는 검색 엔진에서 +가져오는 필드를 추가할 뿐이며, 이 API 가 응답에 포함하는 것은 ``query.additional.api.response.fields`` +에 나열된 필드뿐입니다( :doc:`../config/search-advanced` 참조). 그 필드를 표시하도록 테마도 +변경하십시오. 클라이언트에서 보이는 변화 ~~~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/ko/15.9/user/role-search.rst b/ko/15.9/user/role-search.rst index 1d847ff78..3cf9362a7 100644 --- a/ko/15.9/user/role-search.rst +++ b/ko/15.9/user/role-search.rst @@ -34,7 +34,8 @@ |image1| 현재 비밀번호, 새 비밀번호, 확인용 새 비밀번호(재입력)를 입력하고 갱신 버튼을 클릭하면 비밀번호가 갱신됩니다. -비밀번호 변경 후 뒤로 버튼을 클릭하면 검색 화면으로 돌아갈 수 있습니다. +비밀번호를 변경하면 로그아웃되므로, 새 비밀번호로 다시 로그인하십시오. +이 화면은 검색 화면 테마의 ``/profile`` 페이지이며, 비밀번호는 ``POST /api/v2/auth/password`` 로 변경됩니다( :doc:`../api/api-auth` 참조). .. note:: "비밀번호 변경" 메뉴는 |Fess| 에서 관리하는 사용자(및 편집이 허용된 LDAP 사용자)에게만 표시됩니다. 싱글 사인온으로 인증한 사용자에게는 표시되지 않습니다. diff --git a/zh-cn/15.9/admin/theme-guide.rst b/zh-cn/15.9/admin/theme-guide.rst index 7fb1c5c17..355851c8c 100644 --- a/zh-cn/15.9/admin/theme-guide.rst +++ b/zh-cn/15.9/admin/theme-guide.rst @@ -10,7 +10,7 @@ 搜索界面始终是静态主题。未设置默认主题时， |Fess| 使用其内置的静态主题 ``bootstrap`` 。内置主题无法删除或替换；如需修改，请以新名称复制后再修改（参见 :ref:`theme-customize-bundled` ）。 .. note:: - 基于 JSP 的（JAR）主题通过插件管理进行处理，不在本页的介绍范围内。自 15.9 起，它们不再改变搜索界面。 + 基于 JSP 的主题（ ``fess-theme-*`` JAR 主题插件）已在 15.9 中删除。要更改外观，请使用静态主题（参见 :ref:`upgrade-159-static-theme` ）。 执行本页的操作需要 ``admin-theme`` 角色（仅查看时需要 ``admin-theme-view`` 角色）。 获取主题 diff --git a/zh-cn/15.9/api/admin/api-admin-plugin.rst b/zh-cn/15.9/api/admin/api-admin-plugin.rst index 5748231da..50fecfbb2 100644 --- a/zh-cn/15.9/api/admin/api-admin-plugin.rst +++ b/zh-cn/15.9/api/admin/api-admin-plugin.rst @@ -51,10 +51,12 @@ Plugin API是用于管理 |Fess| 插件（构件）的API。 * - 字段 - 说明 * - ``type`` - - 构件的种类ID。取值为 ``fess-ds`` （数据存储）、``fess-theme`` （主题）、 + - 构件的种类ID。取值为 ``fess-ds`` （数据存储）、 ``fess-ingest`` （Ingest）、``fess-script`` （脚本）、``fess-webapp`` （Web应用）、 ``fess-thumbnail`` （缩略图）、``fess-crawler`` （爬虫）、``fess-llm`` （LLM）、 - ``jar`` （上述以外的通用JAR）之一。 + ``fess-storage`` （存储）、``fess-sso`` （SSO）、 + ``jar`` （上述以外的通用JAR）之一。 ``fess-theme`` 已在 15.9 中删除， + ``fess-theme-*`` 的 JAR 将作为 ``jar`` 处理。 * - ``id`` - 格式为 ``{name}:{version}`` 的标识符。 * - ``name`` diff --git a/zh-cn/15.9/config/load-control.rst b/zh-cn/15.9/config/load-control.rst index 4c0dbcb75..6ee46fa67 100644 --- a/zh-cn/15.9/config/load-control.rst +++ b/zh-cn/15.9/config/load-control.rst @@ -88,7 +88,7 @@ HTTP请求负载控制配置 **Web请求的情况:** - 返回HTTP 429状态码 -- 显示错误页面（``busy.jsp``） +- 显示主题的错误页面 **API请求的情况:** diff --git a/zh-cn/15.9/config/security-virtual-host.rst b/zh-cn/15.9/config/security-virtual-host.rst index f83370eb8..08f00a8b4 100644 --- a/zh-cn/15.9/config/security-virtual-host.rst +++ b/zh-cn/15.9/config/security-virtual-host.rst @@ -63,8 +63,9 @@ .. note:: - 保存配置后仍会在 ``WEB-INF/view/虚拟主机名`` 中生成 JSP，但自 |Fess| 15.9 起，搜索界面不再使用这些 JSP。 - 只有登录界面（ ``/login/`` ）仍由它们渲染。 + 自 |Fess| 15.9 起，保存配置后不会再在 ``WEB-INF/view/虚拟主机名`` 中生成 JSP。 + 登录界面（ ``/login/`` ）在所有虚拟主机中都使用同一个界面（ ``WEB-INF/view/admin/login/`` ）显示，无法按虚拟主机更改。 + 按虚拟主机区分的外观，如上所述，通过与虚拟主机名同名的静态主题来更改。 爬取配置 diff --git a/zh-cn/15.9/dev/overview.rst b/zh-cn/15.9/dev/overview.rst index da6390158..3be0d9bd8 100644 --- a/zh-cn/15.9/dev/overview.rst +++ b/zh-cn/15.9/dev/overview.rst @@ -149,7 +149,7 @@ │ ├── fess_config.properties # 配置 │ └── fess_*.xml # DI配置（如app.xml、fess_ds.xml） └── src/main/webapp/ - └── WEB-INF/view/ # JSP模板 + └── WEB-INF/view/ # 管理界面和登录界面的JSP 扩展点 ====== diff --git a/zh-cn/15.9/dev/plugin-architecture.rst b/zh-cn/15.9/dev/plugin-architecture.rst index 7300918df..d69392594 100644 --- a/zh-cn/15.9/dev/plugin-architecture.rst +++ b/zh-cn/15.9/dev/plugin-architecture.rst @@ -34,9 +34,6 @@ * - Ingest - ``fess-ingest-*`` - 索引注册时对文档进行加工处理 - * - 主题 - - ``fess-theme-*`` - - 自定义搜索界面设计 * - 缩略图 - ``fess-thumbnail-*`` - 添加缩略图生成方式 @@ -53,6 +50,11 @@ - ``fess-sso-*`` - 添加由 ``sso.type`` 选择的单点登录认证方式 +.. note:: + + 提供 JSP 的 ``fess-theme-*`` （JAR 主题）种类已在 15.9 中删除。 + 搜索界面的外观不是通过插件，而是通过静态主题来更改（参见 :doc:`theme-development` ）。 + 插件结构 ======== @@ -343,8 +345,6 @@ DI容器注册 - Git 仓库连接器 * - ``fess-llm-openai`` - OpenAI LLM 提供方 - * - ``fess-theme-*`` - - 自定义主题 除此之外，还公开了 ``fess-ds-csv`` / ``fess-ds-db`` / ``fess-ds-json`` / ``fess-ds-microsoft365`` / ``fess-ds-sharepoint`` 等数据存储连接器，以及 diff --git a/zh-cn/15.9/dev/theme-development.rst b/zh-cn/15.9/dev/theme-development.rst index 6a6c062bd..718b0ca6d 100644 --- a/zh-cn/15.9/dev/theme-development.rst +++ b/zh-cn/15.9/dev/theme-development.rst @@ -17,8 +17,8 @@ .. note:: 静态主题可在 |Fess| 15.7 及以上版本中使用，并在 15.9 中成为默认的 - 搜索界面。替换搜索界面 JSP 的 JAR 主题插件在 15.9 中不再改变搜索界面； - 参见 `JAR 主题插件（旧版）`_ 。 + 搜索界面。替换搜索界面 JSP 的 JAR 主题插件已在 15.9 中删除； + 参见 `JAR 主题插件（已在 15.9 中删除）`_ 。 静态主题 ======== @@ -252,120 +252,29 @@ 由于内置主题遵循其所属 |Fess| 版本的 ``/api/v2/*`` API，每次升级 |Fess| 后，请用内置主题的新副本替换原副本，并重新应用您的修改。 -JAR 主题插件（旧版） -==================== - -.. warning:: - - 自 |Fess| 15.9 起，搜索界面始终由静态主题提供，因此 JAR 主题插件不再 - 改变搜索界面。JAR 主题提供的 JSP 中，只有登录界面（ ``/login/`` ）的 - JSP 仍会被使用。请将设计迁移到静态主题；参见 `自定义内置主题`_ 。 - -JAR 主题插件是按主题名称覆盖 |Fess| 本体的 ``view`` / ``css`` / ``js`` / -``images`` 目录的插件。关于插件的一般结构和构建方法，也请参考 -:doc:`plugin-architecture`。 - -结构 ----- - -:: - - fess-theme-example/ - ├── pom.xml - └── src/main/resources/ - ├── view/ # JSP 文件(search.jsp, index.jsp, header.jsp 等) - ├── css/ # CSS 文件(style.css 等) - ├── js/ # JavaScript 文件 - └── images/ # 图片文件(logo.png 等) - -.. note:: - - 视图（模板）为 JSP 格式。资源的顶层目录仅识别 ``view`` / ``css`` / - ``js`` / ``images`` 这 4 个。构件名称必须以 ``fess-theme-`` 开头。 - -pom.xml -------- - -插件以 ``fess-parent`` 作为父 POM，构建为 jar。由于主题仅由资源构成， -通常不需要声明额外的依赖关系。 - -.. code-block:: xml - - - - 4.0.0 - - fess-theme-example - 15.9.0 - jar - - - org.codelibs.fess - fess-parent - 15.9.0 - - - - -CSS 与图片的自定义 ------------------- - -JSP 基于 Bootstrap 构建。可以通过覆盖 CSS 来更改配色和布局，或者替换 -``images/logo.png`` 来更改徽标。自 15.9 起，这只影响登录界面；搜索界面 -是静态主题（参见 `自定义内置主题`_ ）。 - -构建与安装 ----------- - -:: - - mvn clean package - -会在 ``target/`` 目录下生成 JAR 文件（例如：``fess-theme-example-15.9.0.jar``）。 -可以从管理界面的"系统"→"插件"进行安装。安装步骤的详细信息请参考 -:doc:`../admin/plugin-guide`。 - -安装后，JAR 内的各个目录会按主题名称展开到以下位置（主题名称是从构件 -名称中去掉 ``fess-theme-`` 后的部分。在上述示例中为 ``example``）。 +JAR 主题插件（已在 15.9 中删除） +================================== -.. list-table:: - :header-rows: 1 - :widths: 30 70 - - * - JAR 内的目录 - - 展开位置 - * - ``view/`` - - ``WEB-INF/view//`` - * - ``css/`` - - ``css//`` - * - ``js/`` - - ``js//`` - * - ``images/`` - - ``images//`` - -启用 ----- +将 JSP、CSS、图片放入 ``fess-theme-*`` 的 JAR 中，并作为与虚拟主机的键同名的主题来应用的 +JAR 主题插件种类，已在 |Fess| 15.9 中删除。15.9 不会展开 JAR 主题，也不会在任何界面中使用它。 -JAR 主题通过虚拟主机功能来启用。如果使虚拟主机的键与主题名称一致， -则访问该主机时会应用该主题。 +- 即使从管理界面的「系统」→「插件」安装，它也只会作为种类为 ``jar`` 的通用 JAR 放入 + ``app/WEB-INF/plugin/`` ，界面不会有任何变化。从旧版本遗留下来的 ``fess-theme-*.jar`` + 也会以同样的方式显示，可以在该界面或使用 ``bin/fess-setup remove plugin `` 删除。 +- ``bin/fess-setup`` 不会在列表中显示 ``fess-theme-*`` ，也不会安装它。 -1. 在"系统"→"通用"的虚拟主机设置中，按照 ``Host:localhost:8080=example`` - 这样的格式，将请求的 ``Host`` 请求头与主题名称（虚拟主机的键）对应 - 起来。 -2. 根据需要，也在爬取的 Web 设置等虚拟主机中设置相同的名称（``example``）。 +请将在 JAR 主题中所做的修改迁移到静态主题。 -关于虚拟主机的设置方法详情，请参考 :doc:`../admin/general-guide`。 +- 搜索界面的配色、布局和徽标，可以复制内置主题后进行修改（参见 `自定义内置主题`_ ）。 +- 如果曾按虚拟主机更改外观，请安装与虚拟主机名同名的静态主题 + （参见 :doc:`../config/security-virtual-host` ）。 +- 登录界面（``/login/``）是所有虚拟主机共用的界面，无法通过主题更改。 现有主题示例 ============ - `fess-themes `__ - 静态主题集 （收录了 ``codesearch``、``docsearch`` 等多个静态主题） -- `fess-theme-simple `__ - JAR 主题 -- `fess-theme-classic `__ - JAR 主题 参考信息 ======== diff --git a/zh-cn/15.9/dev/webapp-plugin.rst b/zh-cn/15.9/dev/webapp-plugin.rst index 7486f705c..95d6a09e4 100644 --- a/zh-cn/15.9/dev/webapp-plugin.rst +++ b/zh-cn/15.9/dev/webapp-plugin.rst @@ -172,12 +172,12 @@ Web应用插件中最重要的一点，是在 JAR 清单文件中添加 .. warning:: 替换（单个 ``+``）会 **整体** 替换组件定义。因此，替换文件中必须写出 - 核心定义所进行的所有 ````\ 。例如，在替换 - ``systemHelper`` 时，必须将设计 JSP 名称的映射 - （``addDesignJspFileName``）从核心的 ``fess.xml`` 中全部复制过来并 - 写入。这些内容需要随 |Fess| 的每次发布进行同步，一旦有遗漏，部分画面 - （如 ``chat`` / ``login`` 等）将无法解析。这一维护成本，正是相比替换 - 更推荐使用添加方式的原因。 + 核心定义所进行的所有 ````\ （例如 ``app.xml`` 中的 + ``queryHelper``）。这些内容需要随 |Fess| 的每次发布进行同步。如果继续 + 调用已从核心中删除的方法，该组件定义将因 ``BeanMethodNotFoundException`` + 而初始化失败。例如，15.9 删除了 ``systemHelper`` 的 + ``addDesignJspFileName``\ ，因此调用它的替换文件会失败。这一维护成本， + 正是相比替换更推荐使用添加方式的原因。 REST API的添加（fess_api++.xml） --------------------------------- @@ -253,12 +253,8 @@ REST API的添加（fess_api++.xml） Web应用插件无法添加 JSP 视图。这是因为 JSP 视图存放在 |Fess| 本体 WAR 的 ``WEB-INF/view/`` 中，而插件 JAR 是挂载到类路径（``WEB-INF/classes``） -上的。如果需要修改搜索界面的设计，请使用以下方式之一： - -- **主题**：自定义搜索界面的设计（HTML/CSS/JavaScript）。请参考 - :doc:`theme-development`。 -- **替换 systemHelper**：通过上述"核心组件的替换"方式，可以更改设计 - JSP 名称的映射（但 JSP 文件本身仍由 |Fess| 本体提供）。 +上的。如果需要修改搜索界面的设计，请使用静态主题。静态主题用于自定义 +搜索界面的设计（HTML/CSS/JavaScript）。请参考 :doc:`theme-development`。 构建与安装 ========== diff --git a/zh-cn/15.9/install/upgrade.rst b/zh-cn/15.9/install/upgrade.rst index 3536ca6a8..f647d08ed 100644 --- a/zh-cn/15.9/install/upgrade.rst +++ b/zh-cn/15.9/install/upgrade.rst @@ -822,7 +822,23 @@ SMB 爬取一直以 jcifs 的默认值运行。15.9 传递新名称： 不再显示。请在静态主题中进行修改：按照 :ref:`theme-customize-bundled` 的说明复制内置主题并 修改副本，或者从管理界面的「系统」→「主题」或使用 ``bin/fess-setup install theme `` 安装已发布的主题。按虚拟主机区分的外观现在是以虚拟主机命名的静态主题；参阅 -:doc:`../config/security-virtual-host` 。登录界面（ ``/login/`` ）仍然是 JSP。 +:doc:`../config/security-virtual-host` 。 + +以下两项也已不再提供。 + +- 按虚拟主机区分的登录界面。在 15.8 之前，保存「系统」→「常规」时，包括登录界面在内的 JSP + 会被复制到 ``WEB-INF/view/<虚拟主机名>/`` ，可以按虚拟主机分别编辑。15.9 不再创建这些副本。 + 登录界面（ ``/login/`` ）仍然是 JSP，但所有虚拟主机都显示共用的 ``WEB-INF/view/admin/login/`` + 中的界面。以前复制的 JSP 不会被使用。 +- JAR 主题插件（ ``fess-theme-*`` ）。即使安装，它也只会作为种类为 ``jar`` 的通用 JAR 放置， + 界面不会改变。遗留的 JAR 可以在「系统」→「插件」页面或使用 + ``bin/fess-setup remove plugin `` 删除（参见 :doc:`../dev/theme-development` ）。 + +如果在 15.8 中曾在 JSP 的搜索结果中显示自定义字段，除了 ``query.additional.response.fields`` +之外，还请在 ``query.additional.api.response.fields`` 中添加相同的字段。静态主题从 +``/api/v2/search`` 获取搜索结果。 ``query.additional.response.fields`` 只是增加从搜索引擎 +获取的字段，而该 API 在响应中只包含 ``query.additional.api.response.fields`` 中列出的字段 +（参见 :doc:`../config/search-advanced` ）。另外，请修改主题以显示该字段。 客户端看到的变化 ~~~~~~~~~~~~~~~~ diff --git a/zh-cn/15.9/user/role-search.rst b/zh-cn/15.9/user/role-search.rst index 470295eeb..dc7f6b9aa 100644 --- a/zh-cn/15.9/user/role-search.rst +++ b/zh-cn/15.9/user/role-search.rst @@ -34,7 +34,8 @@ |image1| 输入当前密码、新密码以及用于确认的新密码（再次输入），点击更新按钮即可更新密码。 -更改密码后，点击返回按钮即可返回检索界面。 +更改密码后会被注销，请使用新密码重新登录。 +该界面是检索界面主题的 ``/profile`` 页面，密码通过 ``POST /api/v2/auth/password`` 进行更改（参见 :doc:`../api/api-auth` ）。 .. note:: 「更改密码」菜单仅显示给 |Fess| 管理的用户（以及被允许编辑的 LDAP 用户）。通过单点登录认证的用户不会显示该菜单。