docs(dev): correct 15.8 theme development guide against implementation#450
Open
marevol wants to merge 1 commit into
Open
docs(dev): correct 15.8 theme development guide against implementation#450marevol wants to merge 1 commit into
marevol wants to merge 1 commit into
Conversation
Verified the developer theme-development guide against the current source and rewrote it to match the actual implementation, then propagated the changes to all languages (ja, en, de, fr, es, ko, zh-cn). - Document the two real theming mechanisms: the static theme system (Fess 15.7+, theme.yml manifest and an SPA served under /themes/<name>/, uploaded and activated via System > Theme) and the legacy JAR theme plugin (view/css/js/images overrides installed via System > Plugin) - Describe the theme.yml manifest fields, packaging with fess-themes/scripts/package.sh, and activation via the theme.default system property or virtual host binding - Correct the JAR theme structure (view/css/js/images, JSP) with its ThemeHelper deployment targets and virtual-host activation - Remove fabricated content: theme.properties, the theme/<name> resource layout, templates/search.html, the bin/fess-plugin CLI, the "Design page selects a theme" claim, and the nonexistent fess-theme-minimal example
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
1 participant
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
Reviewed the developer theme development guide (
dev/theme-development.rst) against the current Fess source and rewrote it to match the actual implementation, then propagated the changes to all languages (ja, en, de, fr, es, ko, zh-cn).The previous page described a theming model that does not exist in the code (e.g. a
theme.propertiesfile, atheme/<name>resource layout, abin/fess-pluginCLI, and a Design-page theme selector). This rewrite documents the two real mechanisms.Changes
theme.ymlmanifest (apiVersion/kind/name/displayName/versionplus optional fields), anindex.htmlSPA that uses/api/v2/*, served under/themes/<name>/; packaged withfess-themes/scripts/package.sh; uploaded and activated from System > Theme (/admin/theme/) via thetheme.defaultsystem property or virtual-host binding.view/css/js/images, JSP templates), afess-parent-basedpom.xml,ThemeHelperdeployment targets (WEB-INF/view/<theme>/,css/<theme>/,js/<theme>/,images/<theme>/), and virtual-host activation.theme.properties, thetheme/<name>resource layout,templates/search.html, thebin/fess-pluginCLI, the "Design page selects a theme" claim, and the nonexistentfess-theme-minimalexample.Verification
org.codelibs.fess.theme.*,ThemeHelper,AdminThemeAction,fess_config.properties, and thefess-themes/fess-theme-simplerepositories).fess_label_*.properties; docutils parses each file cleanly (only the usual Sphinx:doc:role and CJK title-underline notices remain).