Skip to content

Commit

Permalink
Update Preferences
Browse files Browse the repository at this point in the history
  • Loading branch information
lukadh committed Nov 22, 2023
1 parent 3f06510 commit 2175ee7
Show file tree
Hide file tree
Showing 7 changed files with 14 additions and 68 deletions.
7 changes: 3 additions & 4 deletions content/preferences-settings/_index.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,18 @@
---
title: Preferences & Settings
date: 2022-12-04T02:19:02+01:00
lastmod: 2023-11-22
id: preferences-settings
weight: 90
draft: false
author: "people"
---


Ansel comes with a number of user-configurable preferences. These can be adjusted in the preferences dialog, which can be reached by clicking the gear icon on the right of the [top panel](../overview/user-interface/top-panel.md). Preferences are separated into tabs, each of which is described in more detail in the following sections.

When opened from within the lighttable or darkroom views, the appropriate tab will be loaded by default to allow you to modify that view's settings.
Ansel comes with a number of user-configurable preferences. These can be adjusted in the preferences dialog, which can be reached via *Edit > Preferences* in the global menu. Preferences are separated into tabs, each of which is described in more detail in the following sections.

Any altered settings (i.e. those that differ from their default state) are highlighted with a bullet beside them. If you change a setting that needs a restart to take effect, a message will appear as a reminder after you exit the preferences dialog.

Double click on a setting's label to reset to its default value.

The preferences dialog can be closed by clicking on the close button in your window manager or pressing the Escape key.
The preferences dialog can be closed by clicking on the close button in your window manager or pressing the Escape key.
31 changes: 2 additions & 29 deletions content/preferences-settings/darkroom.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: darkroom
date: 2022-12-04T02:19:02+01:00
lastmod: 2023-11-22
id: darkroom
weight: 50
draft: false
Expand Down Expand Up @@ -28,19 +29,6 @@ position of the image information line
border around image in darkroom mode
: Display the center image in darkroom mode with an outside border of the given number of pixels (default 20).

show scrollbars for center view
: Choose whether to show scrollbars in the center view of the darkroom (default off).

demosaicing for zoomed out darkroom mode
: Choose how to demosaic images in the darkroom view when not viewing the image at 1:1 zoom scale. Note: this setting is only used for interactive work and does not affect exported images.
: - _always bilinear (fast)_ is fastest, but not as sharp
: - _at most RCD (reasonable)_ uses RCD + interpolation modes. X-Trans sensors will use VNG as the middle-ground setting.
: - _full (possibly slow)_ will use the settings from the [_demosaic_](../modules/processing-modules/demosaic.md) module.
: (default "_at most RCD (reasonable)_").

reduce resolution of preview image
: Reduce the resolution of the [navigation preview](../modules/utility-modules/darkroom/navigation.md) image (choose from "original", "1/2", "1/3" or "1/4" size). This may improve the speed of the rendering but take care as it can also hinder accurate color picking and masking (default "original").

show loading screen between images
: Show gray loading screen when navigating between images in the darkroom. Switch this option off to just show a simple toast message and leave the previous image in place until the next image is loaded. Note that switching this option off can be very useful to quickly compare duplicate images, however, there might be issues with long loading times (leading you to think the next image has already loaded) and you may observe visual artifacts while the next image is loading (default on).

Expand All @@ -55,18 +43,6 @@ hide built-in presets for processing modules
show the guides widget in modules UI
: Enable this to show the local [guides & overlays](../modules/utility-modules/darkroom/guides-overlays.md#local-guides) interface directly within the UI of the modules that support it (default on).

expand a single processing module at a time
: Control how [processing modules](../modules/processing-modules/_index.md) are expanded in the darkroom. If this option is enabled, expanding a module by clicking collapses any currently expanded module. If you want to expand a module without collapsing the others you can do so with Shift+click. Disabling this option inverts the meaning of click and Shift+click (default on).

only collapse modules in current group
: When choosing to expand a single processing module at a time (using the logic defined in the previous setting), only collapse other modules that appear in the current visible group. Disable this option to ensure that modules in non-visible groups are also collapsed (default on).

expand the module when it is activated, and collapse it when disabled
: Select this option for the darkroom to automatically expand or collapse [processing modules](../modules/processing-modules/_index.md) when they are enabled or disabled. (default off)

scroll to processing modules when expanded/collapsed
: With this option enabled [processing modules](../modules/processing-modules/_index.md) are scrolled to the top of the right-hand panel when expanded or collapsed (default on).

show right-side buttons in processing module headers
: Choose whether to show the four buttons (mask indicator, multi-instance menu, reset, presets menu) on the right-hand-side of the [module header](../views/darkroom/processing-modules/module-header.md) for processing modules. These buttons will always appear when the mouse is over the module. At other times they will be shown or hidden according to this preference selection:
: - _always_: always show all buttons
Expand All @@ -79,8 +55,5 @@ show right-side buttons in processing module headers
: - _glide_: gradually hide individual buttons as needed
: (default _always_)

show mask indicator in module headers
: If enabled, an icon will be shown in the header of any processing modules that have a [mask](../views/darkroom/masking-and-blending/masks/_index.md) applied (default on).

prompt for name on addition of new instance
: If enabled, when creating a new instance of a processing module, a prompt will be immediately displayed allowing you to set a name for the new instance (default off).
: If enabled, when creating a new instance of a processing module, a prompt will be immediately displayed allowing you to set a name for the new instance (default on).
7 changes: 4 additions & 3 deletions content/preferences-settings/general.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: general
date: 2022-12-04T02:19:02+01:00
lastmod: 2023-11-22
id: general
weight: 20
draft: false
Expand Down Expand Up @@ -49,16 +50,16 @@ create theme tweaks

### understanding Ansel's themes

All of Ansel's pre-built themes are provided as CSS files in `$Ansel/share/Ansel/themes/` (where `$Ansel` is Ansel's installation directory). The default theme is `Ansel.css` and this contains the bulk of the code used to control the look-and-feel of Ansel. A number of other themes are also provided but most of them use `Ansel.css` as a base (by importing `Ansel.css` using the `@import url` directive).
All of Ansel's pre-built themes are provided as CSS files in `$Ansel/share/Ansel/themes/` (where `$Ansel` is Ansel's installation directory). The default theme is `Ansel.css` and this contains the bulk of the code used to control the look-and-feel of Ansel.

If you choose to create your own custom theme file you are advised to follow a similar approach -- import one of Ansel's existing theme files using `@import url` (this directive expects relative paths) and then apply your own customisations on top. You do not need to do this when using the CSS text box in the preferences dialog -- attempting to use `@import url` in the CSS tweaks text box will not work correctly.
If you choose to create your own custom theme file you are advised to import Ansel's existing theme files using `@import url` (this directive expects relative paths) and then apply your own customisations on top. You do not need to do this when using the CSS text box in the preferences dialog -- attempting to use `@import url` in the CSS tweaks text box will not work correctly.

Themes use the same basic CSS principles as in html browsers (with some minor exceptions -- see the [Gtk documentation](https://developer-old.gnome.org/gtk3/stable/chap-css-overview.html) for details):

- The majority of the style properties are assigned to broad groups of UI elements, for example, Gtk buttons and text entry fields
- Next, related groups of Ansel-specific UI elements are given _class names_ allowing them to be styled as a group
- Finally, some unique UI elements are assigned a CSS _id_ so that they can be styled independently

You are encouraged to explore the existing themes (`Ansel.css` in particular is very well commented) and to make use of the [Gtk Inspector](https://wiki.gnome.org/Projects/GTK/Inspector) tool to figure out how to select the specific UI element (or class of elements) you wish to modify. Some experimentation will be required.
You are encouraged to explore the existing theme and to make use of the [Gtk Inspector](https://wiki.gnome.org/Projects/GTK/Inspector) tool to figure out how to select the specific UI element (or class of elements) you wish to modify. Some experimentation will be required.

Please note that Ansel themes are grayscale by default in order that users not be distracted by strong colors while editing images. You are advised to retain this practice in your own themes and to keep the average shade as close to middle-gray as possible. In addition you are advised to review your custom CSS each time Ansel is updated, to ensure that changes to the application have not adversely affected your tweaks.
16 changes: 1 addition & 15 deletions content/preferences-settings/lighttable.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: lighttable
date: 2022-12-04T02:19:02+01:00
lastmod: 2023-11-22
id: lighttable
weight: 40
draft: false
Expand All @@ -13,21 +14,6 @@ Control functionality in the [lighttable](../lighttable/_index.md) view and modu
hide built-in presets for utility modules
: If enabled, only user-defined presets will be shown in presets menu for utility modules -- built-in presets will be hidden (default off).

use single-click in the collections module
: Enable "single click" mode in the [collections](../modules/utility-modules/shared/collections.md) module, which allows ranges to be selected (default off).

expand a single utility module at a time
: Controls how utility modules are expanded. If this option is enabled, expanding a module by clicking collapses any other currently expanded panel. If you want to expand a panel without collapsing the others you can do so with Shift+click. Disabling this option inverts the meaning of click and Shift+click (default off).

scroll to utility modules when expanded/collapsed
: With this option enabled the side panels will scroll a utility module to the top of the panel when it is expanded or collapsed (default off).

rating an image one star twice will not zero out the rating
: Normally clicking a one star rating twice will set a zero star rating to that image. Check this option to disable this functionality (default off).

show scrollbars for center view
: Choose whether to show scrollbars in the center view of the lighttable (default on).

show image time with milliseconds
: Choose whether to include milliseconds when displaying time values (default off). If set, milliseconds are shown in the [image information](../../modules/utility-modules/shared/image-information.md) module and can also be used in the [geotagging](../../modules/utility-modules/shared/geotagging.md) module.

Expand Down
7 changes: 1 addition & 6 deletions content/preferences-settings/miscellaneous.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: miscellaneous
date: 2022-12-04T02:19:02+01:00
lastmod: 2023-11-22
id: miscellaneous
weight: 110
draft: false
Expand All @@ -17,15 +18,9 @@ scale slider step with min/max
sort built-in presets first
: Choose how the presets menu is sorted. If this option is enabled, built-in presets are shown first. If the option is disabled, user presets are shown first (default on).

mouse wheel scrolls modules side panel by default
: When enabled, the mouse wheel scrolls side panels by default and Ctrl+Alt+wheel scrolls data entry fields. When disabled, this behavior is reversed (default off).

always show panels' scrollbars
: Defines whether the panel scrollbars should be always visible or activated only depending on the panel content (default on). (needs a restart)

duration of the ui transitions in ms
: Defines how long modules and other ui elements will take to transition between states (expand/collapse). Set to 0 to disable animation (default 250ms).

position of the scopes module
: Choose whether to show the [scopes](../modules/utility-modules/shared/scopes.md) module in the left or right panel (default right). (needs a restart)

Expand Down
4 changes: 2 additions & 2 deletions content/preferences-settings/other-views.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Other views
date: 2023-01-21
lastmod: 2023-10-11
lastmod: 2023-11-22
id: processing
weight: 60
draft: false
Expand All @@ -13,6 +13,6 @@ Enable optional views:
* [slideshow](../views/slideshow/)
* [print](../views/print/)

Once you restart Ansel the enabled view(s) will be available in the Ateliers menu.
Once you restart Ansel the enabled view(s) will be available in the *Ateliers* menu.

These views are all hidden by default to spare some computing resources.
10 changes: 1 addition & 9 deletions content/preferences-settings/processing.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: processing
date: 2022-12-04T02:19:02+01:00
lastmod: 2023-11-22
id: processing
weight: 70
draft: false
Expand Down Expand Up @@ -28,12 +29,6 @@ pixel interpolator (scaling)
3D lut root folder
: Define the root folder (and sub-folders) containing Lut files used by the [_lut 3D_](../modules/processing-modules/lut-3D.md) module

auto-apply chromatic adaptation defaults
: Choose which module is responsible for performing white balance adjustments (chromatic adaptation) by default. Select "legacy" (default) to perform basic chromatic adaptation within the [_white balance_](../modules/processing-modules/white-balance.md) module only. Select "modern" to use a combination of the _white balance_ and [_color calibration_](../modules/processing-modules/color-calibration.md) modules to perform modern chromatic adaptation with improved color science. These settings are applied by default to new edits and will not impact old edits.

auto-apply per camera basecurve presets
: Use a per-camera base curve by default (if available) instead of the generic manufacturer one. This should only be used in conjunction with the _display-referred_ workflow defined above (default off).

detect monochrome previews
: Enable this option to analyse images during import and tag them with the `darkroom|mode|monochrome` tag if they are found to be monochrome. The analysis is based on the preview image embedded within the imported file. This makes for a more convenient workflow when working with monochrome images, but it slows down the import, so this setting is disabled by default.

Expand All @@ -50,9 +45,6 @@ Ansel resources
: - _unrestricted_ is not generally recommended. In this mode Ansel may attempt to use more memory than your system has available. This might be _possible_ if your system uses swapping when all of its system memory is taken, but it could lead to system instability. Use this mode with care, only when exporting very large images that Ansel cannot otherwise handle.
: See the [memory & performance tuning](../performance/mem-performance.md#ansel-resources) section for more information.

prefer performance over quality
: Enable this option to render thumbnails and previews at a lower quality. This increases the rendering speed by a factor of 4, and is useful when working on slower computers (default off). This also improves the performance of slideshow image rendering.

enable disk backend for thumbnail cache
: If activated, Ansel stores all thumbnails on disk as a secondary cache, and thereby keeps thumbnails accessible if they are dropped from the primary cache. This needs more disk space but speeds up the [lighttable](../lighttable/_index.md) view as it avoids the reprocessing of thumbnails (default on).

Expand Down

0 comments on commit 2175ee7

Please sign in to comment.