Difference between revisions of "Addon:ThemePreferences"

From Gramps
(Created page with "{{Third-party plugin}} {{languages|Addon:Themes}} 300px|right|thumb The Themes addon adds a small set of configuration settings to the...")
 
(Settings)
 
(58 intermediate revisions by 8 users not shown)
Line 1: Line 1:
{{Third-party plugin}}
+
{{languages|Addon:ThemePreferences}}
 +
{{Third-party addon}}
 +
[[File:Preferences-addon-Themes-tab-default-60.png|450px|right|thumb|Theme tab in Preferences (Gramps 6.0.x + version)]]
 +
[[File:Preferences-Themes-addon.png|450px|right|thumb|Theme tab in Preferences (Gramps 5.2.x and older version)]]
  
{{languages|Addon:Themes}}
+
The {{man label|Theme Preferences}} addon adds a small set of configuration settings to the Preferences dialog related to Gramps appearance, that appear on a new {{man label|Theme}} tab.
 +
== Settings ==
  
[[File:Preferences-Themes-addon.png|300px|right|thumb]]
+
The new settings are:
  
The Themes addon adds a small set of configuration settings to the Preferences dialogThe original 'Colors' panel is renamed to 'Theme' and the new settings added at the top of the panel.
+
* {{man label|Theme:}} - setting allows the user to select from the installed themes on their machine.  A few of the themes will come standard with the system library GTK.  Others may be part of the Operating System, particularly in Linux based systems.  ''{{man menu|Note that not all themes are fully compatible with GTK and Gramps; if the theme selected doesn't look right, with missing elements or other issues, select another theme.}}''
 +
** ''win32''
 +
** ''HighContrast''
 +
** ''HighContrastInverse''
 +
** '''Adwaita''' (default) - [https://wikipedia.org/wiki/Adwaita_(design_language) Adwaita is the default theme of Gtk]
  
There are three settings;
 
  
{{man label|Theme:}}{{man button|Adwaita}} setting allows the user to select from the installed themes on their machine.  A few of the themes will come standard with the system library GtkOthers may be part of the Operating System, particularly in Linux based systems.
+
* {{checkbox|0}} {{man label|Dark Variant}} If the current theme includes a dark version of the theme as a subset, selecting will activate the dark version. (Also called Dark Mode) The Dark Mode is deselected by default.
  
Note that not all themes are fully compatible with Gtk and Gramps; if the theme selected doesn't look right, with missing elements or other issues, select another theme.
+
* {{man label|Font:}}{{man button|font family   point size}} Brings up a selector which allows the user to pick a Font family to be used throughout the Gramps interface, and/or change the font size.  The fonts presented are those found on the system. After making a font change, restart Gramps.
 +
** {{man label|Pick a Font}} dialog selector.
  
{{checkbox|1}} {{man label|Dark Variant:}}  If the selected theme includes a dark version of the theme as a subset, then this will activate the dark version.
 
  
{{man button|Font}}  This brings up a selector which allows the user to pick a Font, and/or change the font size.  The fonts presented are those found on the system.
+
* {{checkbox|0}} {{man label|Toolbar Text}}  Enables text below the main Gramps toolbar icons. Toolbar labels are deselected by default.  {{man menu|(No longer available in Gramps 6.0.x + version as Toolbar Text is on by default and controlled by the {{man label|Toolbar Style:}} option on the {{man menu|Edit > Preferences}} '''General''' tab where you can ''{{man tooltip|[[Gramps_{{man version}}_Wiki_Manual_-_Settings#General|Display text, icons or both on the toolbar buttons.]]'')}}}}
  
{{man button|Default}}  This returns Gramps theme settings to their default values, as if no changes were made with these settings.  Note that the graph colors below are independent, they have their own 'Default' button to return them to the Gramps defaults.
 
  
The remainder of the dialog is described in [[Gramps_5.0_Wiki_Manual_-_Settings#Colors]].
+
* {{checkbox|0}} {{man label|Fixed Scrollbar (requires restart)}}  This overrides the Gramps scrollbars to be a bit more 'classic' in behavior and appearance. Fixed Scrollbar is deselected by default. 
 +
: This option toggles between the default and these overrides:
 +
:* Scrollbars remain visible rather than disappearing when not in focus
 +
:* Arrow button (up/down) are shown at scrollbar ends
 +
:* clicking in the empty space above and below the slider acts as page up or page down instead of 'Warp to position' 
 +
: ''Note that changing the scrollbars setting requires restarting Gramps, and may require restarting your session (Log off and log back on to Windows), particularly when disabling the setting.''
 +
 
 +
 
 +
* {{man button|Restore to Defaults}}  This returns Gramps theme settings to their default values, as if no changes were made with these settings.
 +
 
 
== Installing your own theme ==
 
== Installing your own theme ==
 +
Themes (correctly copied into the appropriate OS folder and with the correct subfolders) will simply appear as new pull-down menu options in the Themes tab that appears in Preferences after the Theme Preferences addon has been installed.
 +
 
=== Windows ===
 
=== Windows ===
 
It is possible to change the Gramps theme on the Windows AIO.
 
It is possible to change the Gramps theme on the Windows AIO.
Line 26: Line 43:
 
The Gramps AIO version 5.0.x uses Gtk 3.18 or higher, so a theme MUST be selected that supports that version (themes that are designed for a later version may not work).  The current Gtk version is reported in the [[Addon:Prerequisites_Checker_Gramplet]].
 
The Gramps AIO version 5.0.x uses Gtk 3.18 or higher, so a theme MUST be selected that supports that version (themes that are designed for a later version may not work).  The current Gtk version is reported in the [[Addon:Prerequisites_Checker_Gramplet]].
  
Suitable themes might be found in [https://www.gnome-look.org/].
+
Suitable alternate themes may be found at the [https://www.gnome-look.org/ gnome-look.org] website.
  
Download the theme file (often a tar.gz) and if necessary decompress it using 7-zip of similar.
+
Download the theme file (often a tar.gz) and, if necessary, decompress it using 7-zip or similar.
  
The decompressed files should be stored in "C:\Users\you\.themes" (replacing 'you' with your user name) so that the final directory structure looks like:
+
The decompressed files should be stored within a folder in "<code>C:\Users\</code>''<username>''<code>\.themes</code>" (Substitute ''<username>'' with your login name under Windows. Less ambiguously, you could take advantage of the <code>%USERPROFILE%</code> [https://wikipedia.org/wiki/Environment_variable#Windows Windows environment variable] and the destination folder is: <code>%USERPROFILE%\.themes</code>)
C:\Users\you\.themes\YourThemeName
+
 
 +
The folder <code>.themes</code> can be manually created if it does not already exist.
 +
 
 +
So, the final directory structure for a theme named "MyAwesomeTheme" looks like:
 +
  <code>C:\Users\</code>''<username>''<code>\.themes\MyAwesomeTheme</code>
 +
or
 +
  <code>%USERPROFILE%\.themes\MyAwesomeTheme</code>
  
 
=== Linux ===
 
=== Linux ===
 
You should follow instructions for your distribution.  Some other information that could help is provided [[GEPS_029:_GTK3-GObject_introspection_Conversion#GTK_3_theme]].
 
You should follow instructions for your distribution.  Some other information that could help is provided [[GEPS_029:_GTK3-GObject_introspection_Conversion#GTK_3_theme]].
  
 +
== See also ==
 +
* [[Addon:ThemePreferences|Theme Preferences Third party addon]] ([https://github.com/gramps-project/addons-source/blob/ddb32eb151794e5b156aeace00a43bd9d6db57cc/Themes/themes_load.py#L72 addon source code on GitHub])
 +
** [https://gramps-project.org/wiki/index.php/File:Gramps-gtk3-raleigh.png Raleigh] and High Contrast (not pretty... but a good accessibility theme)
 +
* [[Windows AIO themes]] : Install downloadable themes ([https://gramps.discourse.group/t/themes-for-the-themes-addons/1408 screen captures]):
 +
** [https://www.gnome-look.org/p/1014510/ Greybird-Modv2] : a darker gray (no dark theme)
 +
** [https://www.gnome-look.org/p/1249341/ Victory] : Another gray with no dark theme.
 +
** [https://www.gnome-look.org/find?search=Yaru Yaru themes] Some might find more to their liking. There are many other colors and dark themes.
 +
* [https://gramps.discourse.group/t/modifying-themes/1938 Modifying Themes] discussion on Discourse
 +
 +
[[Category:Addons]]
 
[[Category:Plugins]]
 
[[Category:Plugins]]
 
[[Category:Developers/General]]
 
[[Category:Developers/General]]

Latest revision as of 01:49, 26 October 2025

Gramps-notes.png
This is a Third-party Addon. The Addon/Plugin system is controlled by the Plugin Manager.

Please use carefully on data that is backed up, and help make it better by reporting any issues to the bug tracker.
Unless otherwise stated on this page, you can download this addon by following these instructions.
Please note that some Addons have prerequisites that need to be installed before they can be used.

Theme tab in Preferences (Gramps 6.0.x + version)
Theme tab in Preferences (Gramps 5.2.x and older version)

The Theme Preferences addon adds a small set of configuration settings to the Preferences dialog related to Gramps appearance, that appear on a new Theme tab.

Settings

The new settings are:

  • Theme: - setting allows the user to select from the installed themes on their machine. A few of the themes will come standard with the system library GTK. Others may be part of the Operating System, particularly in Linux based systems. Note that not all themes are fully compatible with GTK and Gramps; if the theme selected doesn't look right, with missing elements or other issues, select another theme.


  • Dark Variant If the current theme includes a dark version of the theme as a subset, selecting will activate the dark version. (Also called Dark Mode) The Dark Mode is deselected by default.
  • Font:font family   point size Brings up a selector which allows the user to pick a Font family to be used throughout the Gramps interface, and/or change the font size. The fonts presented are those found on the system. After making a font change, restart Gramps.
    • Pick a Font dialog selector.


  • Toolbar Text Enables text below the main Gramps toolbar icons. Toolbar labels are deselected by default. (No longer available in Gramps 6.0.x + version as Toolbar Text is on by default and controlled by the Toolbar Style: option on the Edit > Preferences General tab where you can Display text, icons or both on the toolbar buttons.)


  • Fixed Scrollbar (requires restart) This overrides the Gramps scrollbars to be a bit more 'classic' in behavior and appearance. Fixed Scrollbar is deselected by default.
This option toggles between the default and these overrides:
  • Scrollbars remain visible rather than disappearing when not in focus
  • Arrow button (up/down) are shown at scrollbar ends
  • clicking in the empty space above and below the slider acts as page up or page down instead of 'Warp to position'
Note that changing the scrollbars setting requires restarting Gramps, and may require restarting your session (Log off and log back on to Windows), particularly when disabling the setting.


  • Restore to Defaults This returns Gramps theme settings to their default values, as if no changes were made with these settings.

Installing your own theme

Themes (correctly copied into the appropriate OS folder and with the correct subfolders) will simply appear as new pull-down menu options in the Themes tab that appears in Preferences after the Theme Preferences addon has been installed.

Windows

It is possible to change the Gramps theme on the Windows AIO.

The Gramps AIO version 5.0.x uses Gtk 3.18 or higher, so a theme MUST be selected that supports that version (themes that are designed for a later version may not work). The current Gtk version is reported in the Addon:Prerequisites_Checker_Gramplet.

Suitable alternate themes may be found at the gnome-look.org website.

Download the theme file (often a tar.gz) and, if necessary, decompress it using 7-zip or similar.

The decompressed files should be stored within a folder in "C:\Users\<username>\.themes" (Substitute <username> with your login name under Windows. Less ambiguously, you could take advantage of the %USERPROFILE% Windows environment variable and the destination folder is: %USERPROFILE%\.themes)

The folder .themes can be manually created if it does not already exist.

So, the final directory structure for a theme named "MyAwesomeTheme" looks like:

 C:\Users\<username>\.themes\MyAwesomeTheme

or

 %USERPROFILE%\.themes\MyAwesomeTheme

Linux

You should follow instructions for your distribution. Some other information that could help is provided GEPS_029:_GTK3-GObject_introspection_Conversion#GTK_3_theme.

See also