docs(dev): correct and expand 15.8 Ingest plugin guide against implementation#452
Open
marevol wants to merge 1 commit into
Open
docs(dev): correct and expand 15.8 Ingest plugin guide against implementation#452marevol wants to merge 1 commit into
marevol wants to merge 1 commit into
Conversation
…entation The Ingest plugin guide described an API that does not exist in the source. Rewrite it to match the actual implementation and apply the fix to all languages. - Replace the non-existent ``IngestHandler`` interface with the real ``org.codelibs.fess.ingest.Ingester`` abstract class and its four ``process`` overloads (Map, Map+DataStoreParams, Map+AccessResult, ResultData+ResponseData), noting which one to override. - Correct registration to ``fess_ingest++.xml`` (DI merge convention) with ``<postConstruct name="register"/>`` calling ``Ingester#register()``. - Remove the fabricated ``ingest.handler.example.enabled`` property; there are no ingest-related ``fess_config.properties`` settings. - Document ``priority``-based execution order (default 99, ascending), the three invocation points in the crawl/index pipeline, the null-return caveat, and reference implementations (fess-ingest-example, fess-webapp-multimodal). - Update ja and re-translate en/de/fr/es/ko/zh-cn (diacritics preserved).
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
The 15.8 Ingest plugin developer guide (
dev/ingest-plugin.rst) documented an API that does not exist in the Fess source. This PR rewrites it to match the actual implementation and applies the correction to all seven languages.What was wrong
IngestHandlerinterface with a singleprocess(Map)method.fess_ingest.xmlcomponent.ingest.handler.example.enabledproperty.What it says now (verified against source)
org.codelibs.fess.ingest.Ingesterabstract class, which provides fourprocessoverloads (Map,Map+DataStoreParams,Map+AccessResult, andResultData+ResponseData); the guide explains which one to override.fess_ingest++.xml(the DI merge convention) with<postConstruct name="register"/>callingIngester#register(), which adds the ingester toingestFactory.fess_config.propertiessettings; enablement is by plugin presence and ordering is controlled by thepriorityfield (default99, ascending).nullfails index registration, and reference implementations (fess-ingest-example,fess-webapp-multimodal).Languages
ja(source of truth) and re-translateden,de,fr,es,ko,zh-cn.//comments are localized. Diacritics restored inde/fr/es.