Merge "Remove remnants of project-specific themes support"

This commit is contained in:
David Pursehouse
2019-03-08 23:59:56 +00:00
committed by Gerrit Code Review
9 changed files with 8 additions and 137 deletions

View File

@@ -4,34 +4,28 @@ Gerrit supports some customization of the HTML it sends to
the browser, allowing organizations to alter the look and
feel of the application to fit with their general scheme.
Configuration can either be sitewide or per-project. Projects without a
specified theme inherit from their parents, or from the sitewide theme
for `All-Projects`.
== HTML Header/Footer and CSS
Sitewide themes are stored in `'$site_path'/etc`, and per-project
themes are stored in `'$site_path'/themes/{project-name}`. Files are
only served from a single theme directory; if you want to modify or
extend an inherited theme, you must copy it into the appropriate
per-project directory.
== HTML Header/Footer
The HTML header, footer and CSS may be customized for login
screens (LDAP, OAuth, OpenId) and the internally managed
Gitweb servlet.
At startup Gerrit reads the following files (if they exist) and
uses them to customize the HTML page it sends to clients:
* `<theme-dir>/GerritSiteHeader.html`
* `etc/GerritSiteHeader.html`
+
HTML is inserted below the menu bar, but above any page content.
This is a good location for an organizational logo, or links to
other systems like bug tracking.
* `<theme-dir>/GerritSiteFooter.html`
* `etc/GerritSiteFooter.html`
+
HTML is inserted at the bottom of the page, below all other content,
but just above the footer rule and the "Powered by Gerrit Code
Review (v....)" message shown at the extreme bottom.
* `<theme-dir>/GerritSite.css`
* `etc/GerritSite.css`
+
The CSS rules are inlined into the top of the HTML page, inside
of a `<style>` tag. These rules can be used to support styling

View File

@@ -614,18 +614,6 @@ Project-specific download commands that are defined on a parent project
are inherited by the child projects. A child project can overwrite an
inherited download command, or remove it by assigning no value to it.
[[theme]]
== Theme
Gerrit supports project-specific themes for customizing the appearance
of the change screen and the diff screens. It is possible to define an
HTML header and footer and to adapt Gerrit's CSS. Details about themes
are explained in the link:config-themes.html[Themes] section.
Project-specific themes can only be installed by Gerrit administrators
since the theme files must be copied into the Gerrit installation
folder.
[[tool-integration]]
== Integration with other tools

View File

@@ -3135,9 +3135,6 @@ Not set if the project state is `ACTIVE`.
Map with the comment link configurations of the project. The name of
the comment link configuration is mapped to a link:#commentlink-info[
CommentlinkInfo] entity.
|`theme` |optional|
The theme that is configured for the project as a link:#theme-info[
ThemeInfo] entity.
|`plugin_config` |optional|
Plugin configuration as map which maps the plugin name to a map of
parameter names to link:#config-parameter-info[ConfigParameterInfo]
@@ -3689,21 +3686,6 @@ as an annotated tag.
|=========================
[[theme-info]]
=== ThemeInfo
The `ThemeInfo` entity describes a theme.
[options="header",cols="1,^2,4"]
|=============================
|Field Name ||Description
|`css` |optional|
The path to the `GerritSite.css` file.
|`header` |optional|
The path to the `GerritSiteHeader.html` file.
|`footer` |optional|
The path to the `GerritSiteFooter.html` file.
|=============================
GERRIT
------
Part of link:index.html[Gerrit Code Review]