Merge pull request #1381 from qdraw/feature/202402-open-native

Feature/202402 open native

documentation/.gitignore

@@ -12,6 +12,9 @@ docs/advanced-options/starsky
 docs/advanced-options/starskydesktop
 docs/advanced-options/starsky-tools
 
+# show desktop folder
+!docs/getting-started/desktop
+
 # the output of the build step
 build
 

documentation/docs/developer-guide/api/readme.md

@@ -30,6 +30,9 @@ This document is auto generated
 | __/api/delete__                                   | DELETE| Remove files from the disk, but the file must contain the !delete! (TrashKeyw...|
 | _Parameters: f (subPaths, separated by dot comma), collections (true is to update files with the same name before                         _ |
 | _ the extenstion)                                                                                                                         _ |
+| __/api/desktop-editor/open__                      | GET   | Open a file in the default editor or a specific editor on the desktop           |
+| _Parameters: f (single or multiple subPaths), collections (to combine files with the same name before the extension)                      _ |
+| __/api/desktop-editor/amount-confirmation__       | GET   | Check the amount of files to open before                                        |
 | __/api/disk/mkdir__                               | POST  | Make a directory (-p)                                                           |
 | __/api/disk/rename__                              | POST  | Rename file/folder and update it in the database                                |
 | _Parameters: f (from subPath), to (to subPath), collections (is collections bool), currentStatus (default is to not                       _ |
@@ -103,7 +106,6 @@ This document is auto generated
 | _ json (text as output), extraLarge (give preference to extraLarge over large image)                                                      _ |
 | __/api/thumbnail/zoom/\{f\}@\{z\}__               | GET   | Get zoomed in image by fileHash.At the moment this is the source image          |
 | __/api/thumbnail-generation__                     | POST  | Create thumbnails for a folder in the background                                |
-| __/api/trash/detect-to-use-system-trash__         | GET   | Is the system trash supported                                                   |
-| __/api/trash/move-to-trash__                      | POST  | (beta) Move a file to the trash                                                 |
+| __/api/trash/move-to-trash__                      | POST  | Move a file to the trash                                                        |
 | __/api/upload__                                   | POST  | Upload to specific folder (does not check if already has been imported)Use th...|
 | __/api/upload-sidecar__                           | POST  | Upload sidecar file to specific folder (does not check if already has been im...|

documentation/docs/features/bulk-editing.md

@@ -1,26 +1,36 @@
 # Bulk editing
 
-Bulk editing is a feature that allows you to edit multiple files at once. 
+Bulk editing is a feature that allows you to edit multiple files at once.
 Is it possible to edit the metadata for multiple images at once.
 You can use it in search and archive. In detail view you can edit the metadata for a single image.
 
 ## 1. Select the images
+
 Via the search or archive you can select multiple images.
 Press select and Labels and select the images you want to update.
 
 ## Update
+
 When you selected an image you can update the metadata.
 You can update the following metadata:
+
 - Tags
 - Info
 - Title
 - ColorClass (the color label of the image)
 
 via the API you could also update other metadata like:
+
 - Location
 - Software
 - etc.
 
 # Replace the metadata in the fields: tags, info or title
+
 You can search and replace the metadata in the fields: tags, info or title.
-Is easy to undo typos or update the metadata.
+Is easy to undo typos or update the metadata.
+
+# Open files
+
+When using the application as desktop mode you can batch open files with your favorite editor.
+See [Desktop Open](../getting-started/configuration/desktop-open.md) for more information.

documentation/docs/features/stacks.md

@@ -2,13 +2,19 @@
 
 Stacks are enabled by default. Stacks are a way to group photos together.
 
-For example, you might have a photo that is associated with both a JPEG and an RAW file. 
-In this case, the Stack organizes these two files together so that they are easier to find, manage and use later on.
+For example, you might have a photo that is associated with both a JPEG and an RAW file.
+In this case, the Stack organizes these two files together so that they are easier to find, manage
+and use later on.
 
 You may come across pictures that are associated with more than one media file.
 
 ## For what reasons can files be stacked?
 
-- Files sharing exactly the same file and folder name will always be stacked together. 
-  - for example `/2018/IMG_1234.jpg` and `/2018/IMG_1234.avi`
+- Files sharing exactly the same file and folder name will always be stacked together.
+    - for example `/2018/IMG_1234.jpg` and `/2018/IMG_1234.avi`
 
+# Open files
+
+When using the application as desktop mode you can batch open files with your favorite editor. It
+will also respect the stack settings.
+See [Desktop Open](../getting-started/configuration/desktop-open.md) for more information.

documentation/docs/getting-started/configuration/_category_.json

@@ -0,0 +1,8 @@
+{
+  "label": "Configuration",
+  "position": 5,
+  "link": {
+    "type": "generated-index",
+    "description": "See configuration options for the application."
+  }
+}

documentation/docs/getting-started/config-options.md → documentation/docs/getting-started/configuration/config-options.md

@@ -1,11 +1,16 @@
-# Config Options
+---
+sidebar_position: 1
+---
 
- Changing values in `docker-compose.yml` or in Advanced Settings always **requires a restart** to take effect. Open a terminal, run `docker compose stop` and then
-  `docker compose up -d` to restart all services.
+# Overview Config Options
 
+Changing values in `docker-compose.yml` or in Advanced Settings always **requires a restart** to
+take effect. Open a terminal, run `docker compose stop` and then
+`docker compose up -d` to restart all services.
 
 ## Web Application
-There are a few options that can be changed in the web application. 
+
+There are a few options that can be changed in the web application.
 
 These options are available though `appsettings.json` and environment variables.
 
@@ -16,13 +21,14 @@ Environment variables are always preferred over `appsettings.json` values.
 and should prefix with `app__` and replace `:` with `__` and `.` with `_`.
 So `app__databaseType` is the same as `"app":{"databaseType":"mysql"}` in `appsettings.json`.
 
-- [See advanced configuration options for the web application](../advanced-options/starsky/starsky/readme.md#recommend-settings)
+- [See advanced configuration options for the web application](../../advanced-options/starsky/starsky/readme.md#recommend-settings)
 
 # Command line options
 
 There are separate command line applications that target the specific needs.
-See the [Advanced options](../advanced-options/starsky/readme.md) for more information.
+See the [Advanced options](../../advanced-options/starsky/readme.md) for more information.
 
 Add the command line argument `--help` option to see all available options.
-The options are configured in `appsettings.json` and environment variables and command line arguments.
+The options are configured in `appsettings.json` and environment variables and command line
+arguments.
 

documentation/docs/getting-started/configuration/desktop-open.md

@@ -0,0 +1,79 @@
+---
+sidebar_position: 5
+---
+
+# Configure Open With
+
+There are two options to use the desktop application
+
+- Remote (So the back-end is not running on your local machine)
+- Local / As Desktop
+
+If you don't know you are using the local one, you can check the settings in the desktop
+application.
+
+When using remote, the application will open the image in the default application.
+Then there are no settings to configure overwrites.
+
+Left: The settings are not available in a remote environment
+Right: To check if using remote or local (using the desktop application)
+
+![Desktop Open](../../assets/getting-started-configuration-desktop-open.jpg)
+
+## Local / As Desktop
+
+The following settings are for Local / As Desktop.
+The UI writes the settings to the `appsettings.patch.json` file.
+
+You can use the `appsettings.patch.json` file to configure the desktop application
+or use the Settings in the web application.
+
+### DefaultDesktopEditor
+
+This setting is done by ImageFormat,
+an imageFormat is defined by the first bytes of the file.
+
+In the UI there is an option to set the default application for a few photo formats.
+
+> Note: If you enter an invalid ApplicationPath location: The application will open the file with
+> the system default application
+
+```json
+{
+    "DefaultDesktopEditor": [
+        {
+            "ApplicationPath": "/Applications/Adobe Photoshop 2020/Adobe Photoshop 2020.app",
+            "ImageFormats": ["jpg", "bmp", "png", "gif", "tiff"]
+        }
+    ]   
+}
+```
+
+### Collections / Stacks
+
+When opening an image from a collection/stack, the desktop application will one of both files
+A collection is for example two files in one folder: `2021-01-01-IMG_1234.jpg`
+and `2021-01-01-IMG_1234.dng`
+The default display is to show the jpeg first.
+
+> Note: The default setting is to open the jpeg file first
+
+### Raw First
+
+So the raw file will be open if available
+
+```json
+{
+    "DesktopCollectionsOpen": "2"
+}
+```
+
+### Jpeg first
+
+If the raw file is available, the jpeg file will be open first
+
+```json
+{
+    "DesktopCollectionsOpen": "1"
+}
+```