Merge pull request #22 from AlpacaInTheNight/development

Development

Author: AlpacaInTheNight

README.md

@@ -1,4 +1,4 @@
-# Prompts Browser Extension 1.1.0
+# Prompts Browser Extension 1.2.0
 Prompts Browser Extension for the [AUTOMATIC1111/stable-diffusion-webui](https://github.com/AUTOMATIC1111/stable-diffusion-webui).
 
 1. [Installation](#installation)
@@ -10,22 +10,42 @@ Prompts Browser Extension for the [AUTOMATIC1111/stable-diffusion-webui](https:/
 1. [Styles](#styles)
 1. [Collection editor](#collection-editor)
 1. [Prompt editor](#prompt-editor)
-1. [Setup window](#setup-window)
+1. [New Collection window](#new-collection-window)
 1. [Autocomplete](#autocomplete)
 1. [Normalize](#normalize)
+1. [Setup window](#setup-window)
 1. [Collections database](#collections-database)
 1. [Credits](#credits)
 
 ![](img/preview.jpg)
 
-### Changes in 1.1.0
-⚠️ Previous versions stored collections in the root of the application. Since version 1.1.0 they are now stored in the extension directory. If you used previous versions, you will need to move your collections there. ⚠️
+### Changes in 1.2.0
+⚠️ The extension configuration used to be in a separate window and stored on the client. As of 1.2.0, the extension settings are now stored in the WebUI settings in the "Prompts Browser" category.
+
+The old extension settings will need to be set again. In addition, a number of new settings are available in version 1.2.0. ⚠️
+
+- The size of the thumbnail on the client can now be customized. It is also possible to specify the maximum number of prompts to be displayed in the prompt list.
+
+- It is possible to specify how many maximum rows of prompts can be displayed in the list of prompts (now it is easier to adapt the extension to different screen/window resolutions).
+
+- The size and format of preview images in collections on disk can now be customized.
+
+- Prompt tools have been updated and made more convenient. Possible prompts for replacement/addition are now sorted by similarity. It is possible to switch between replacement and addition modes of the selected prompt. It is also possible to open prompts for editing and delete prompts from the list of current prompts in the standard way.
+
+- Prompts saved in collections will not be normalized to avoid unwanted changes to the prompt text required for LORAs triggering.
+
+- The Styles window is divided into Save and Load Styles windows.
+
+- Having positive prompts is no longer necessary to create styles. For example, you can now create styles for negative parameters or image quality/size settings.
+
+- The styles loading window has been updated. Now updating styles works identically to saving styles and you can override what information should be stored in a style.
+
+- The style can now be renamed.
 
-As of version 1.1.0, the extension now works via FastAPI and no longer depends on an additional local server or extension installation location. This will cover more use cases and customizations of the application.
 
 ## Installation:
 
-1. Make sure you have the latest AUTOMATIC1111/stable-diffusion-webui version instaled. Prompt Browser 1.1.0 was tested and adapted for WebUI versions 1.6.0.
+1. Make sure you have the latest AUTOMATIC1111/stable-diffusion-webui version instaled. Prompt Browser 1.2.0 was tested and adapted for WebUI versions 1.8.0.
 
 2. Unzip/clone the plugin into the extensions directory. Or install it using WebUI Extensions -> Install from URL tab.
 
@@ -69,6 +89,8 @@ This extension modifies the DOM directly, without working through any API for su
 
 5. `Double click`: opens the Prompt Tools.
 
+6. `shift` + click: opens Prompt Editor.
+
 
 ### Adding new prompts to the collection
 
@@ -78,6 +100,7 @@ This extension modifies the DOM directly, without working through any API for su
 2. The `Add unknown` button above the Prompts entry field opens a window for adding new prompts. In this window you can select new prompts and a collection of prompts, where you can add them with the `Add new prompts` button. The `Toggle all` button selects or deselects all new proppts. The `All collections` toggle switches on or off the check for all possible collections (by default, it is on and only those prompts that are not in any of the possible collections will be displayed).
 ![](img/addNew.jpg)
 
+3. You can add a new prompt to the desired collection by copying it or moving it from another collection. A collection is a directory that can be moved between installations, thus presenting the possibility of sharing prompts and styles.
 
 ### Generating previews for prompts
 
@@ -88,7 +111,7 @@ This extension modifies the DOM directly, without working through any API for su
 3. You can select additional styles to be used during autogeneration.
 
 	1. `Prompt only` - only prompt itself will be used for generating preview.
-	1. `With current prompt` - target prompt will be added to the current prompts in the positive prompts textbox..
+	1. `With current prompt` - target prompt will be added to the current prompts in the positive prompts textbox.
 	1. `With prompt autogen style` - If a prompt has a style assigned for autogeneration, it will use that prompt and the assigned style. If the prompt does not have an autogenerate-style, only the prompt itself will be used.
 	1. `With selected autogen style` - the currently selected style in the `Autogenerate style` field will be used as the style for autogeneration.
 
@@ -105,23 +128,27 @@ This extension modifies the DOM directly, without working through any API for su
 
 4. Prompts will be sorted by their similarity to the selected prompt according to the selected parameters (tags, categories and name).
 
-5. Clicking on a promt from the list of similar promts will replace the selected promt with the target one.
+5. If `Replace mode` is active, than clicking on a prompt from the list of similar prompts will replace the selected prompt with the target one. If it is not active - will add the target prompt to the active promts (keeping the selected prompt).
 
-6. `Shift + click` on a promt from the list will add the target promt to the active promts (keeping the selected promt).
+6. `Shift + click`: opens prompt edition window.
 
 
 ### Styles
 
-![](img/styles.jpg)
+![](img/saveStyle.jpg)
 
-1. Above the text box there is a `styles` button which opens the Styles window.
+1. Above the text box there is a `Save style` button which opens the Save Style window.
 
 1. A list of active prompts will be displayed at the top.
 
 1. The current prompts can be saved as a style by typing in the text box above the name of the style and clicking the `Save as style` button next to it.
 
 1. In the list of style collections, you can select the collection where the style will be saved. You can also select the current generation parameters that will be saved along with the style's prompts (such as negative prompts, size, sampler, etc).
 
+![](img/styles.jpg)
+
+1. Above the text box there is a `styles` button which opens the Styles window.
+
 1. "Simple mode" switch changes styles view mode from the simple to the detailed mode.
 
 1. In simple mode you need to select a prompt and then press a needed button at the bottom of the window.
@@ -132,10 +159,14 @@ This extension modifies the DOM directly, without working through any API for su
 
 1. The `update` button will replace the style's prompts with the current active prompts.
 
+1. Like with saving of a style you can choose what meta information must be stored in the updated style.
+
 1. The `Update preview` button will add/replace preview for the style using the currently generated and selected image.
 
 1. In simple mode you can also click with `shift` key to add style. You can click and hold `ctrl/meta` key to delete style.
 
+1. To rename a style, select it and enter the desired new name in the bottom panel of the window, then click `Rename`. The name of the style must be unique in the collection.
+
 
 ### Collection editor
 
@@ -196,11 +227,13 @@ This extension modifies the DOM directly, without working through any API for su
 1. Press `Save` to save your changes and close window or `cancel` to close window without saving.
 
 
-### Setup window
+### New Collection window
 
 ![](img/setup.jpg)
 
-1. Click on `Setup` button at the top menu to open Setup window.
+1. Click on `New Collection` button at the top menu to open New Collection window.
+
+1. Previously, the extension settings window was also located here. But now all extension settings are located in the `Prompts Browser` category of WebUI settings.
 
 1. `New prompts collections` - will open creation of the new prompts collection.
 
@@ -210,6 +243,30 @@ This extension modifies the DOM directly, without working through any API for su
 
 1. `Store format` - the way prompts/styles are stored. In the `short` format all prompts/styles data will be saved in the file `data.json`. In the `expanded` format a directory `prompts`/`styles` will be added to the collection directory and every prompt/style will be stored as a separate file. The expanded format makes it easier to work with the collection when using version control systems like Git.
 
+### Autocomplete
+
+1. When you manually type prompts, a menu with similar prompts from the database of known prompts will be displayed. You can finish a prompt from the autocomplete menu by clicking on it or by selecting it with the up and down arrows and pressing Enter.
+
+1. You can also enter style names to quickly add them. Since styles do not necessarily have to consist of positive prompts, you can use this to quickly switch between a set of negative prompts, change the resolution or generation quality settings.
+
+1. Autocomplete can be turned off in the settings. It can also be enabled only for prompts or only for styles.
+
+### Normalize
+
+1. The `normalize` button is displayed above the positive prompt field. It activates the function of normalization of the entered prompts according to the settings of normalization of prompts set in the [Setup window](#setup-window). Useful when inserting prompts from external sources.
+
+1. If the prompt in its current form is already known and stored in the collection in the same form, it will not be changed even if it does not satisfy the normalization settings.
+
+### Setup window
+
+1. You can customize the extension by going to the `Settings` section of the WebUI. The extension settings are located in the `Prompts Browser` section.
+
+1. `Autocomplete mode` - defines the behavior of the autocomplete function.
+
+1. `Show prompt index in database` - will display the ordinal id of the prompt in the collection if the collection is selected in the collection filter. Useful when manually sorting prompts within a collection.
+
+1. `Extended syntax support` - enables support for displaying some extended syntax elements for prompts that can be used by some other extensions. 
+
 1. `Below 1 scroll weight` - how much weight one mouse wheel movement will change when below weight 1.
 
 1. `Above 1 scroll weight` - how much weight one mouse wheel movement will change when above weight 1.
@@ -218,15 +275,25 @@ This extension modifies the DOM directly, without working through any API for su
 
 1. `Spaces in prompts transform` - changes the handling of spaces in multiword prompts. Can be `Do nothing`, `To space` and `To underscore`.
 
-1. `Show prompt index in database` - will display the ordinal id of the prompt in the collection if the collection is selected in the collection filter. Useful when manually sorting prompts within a collection.
+1. `Card width` - small card preview width.
 
-### Autocomplete
+1. `Card height` - small card preview height.
 
-1. When you manually type prompts, a menu with similar prompts from the database of known prompts will be displayed. You can finish a prompt from the autocomplete menu by clicking on it or by selecting it with the up and down arrows and pressing Enter.
+1. `Splash card width` - large card preview width.
 
-### Normalize
+1. `Splash card height` - large card preview height.
 
-1. The `normalize` button is displayed above the positive prompt field. It activates the function of normalization of the entered prompts according to the settings of normalization of prompts set in the [Setup window](#setup-window). Useful when inserting prompts from external sources.
+1. `Rows in cards list` - number of displayed rows in the list of known prompts. The size of the known prompts area will be adjusted to display no more than this number of rows. The height of the known prompts area will be calculated based on this parameter and the height of the small card.
+
+1. `Max shown cards in a list` - when displaying a list of prompts, this will be the maximum ceiling above which prompts will no longer be displayed. It may be useful when working with very large collections, so as not to overload the page with a large number of elements.
+
+1. `Resize thumbnails` - if this option is enabled, when you save the preview, it will be resized to the desired size and format. The size of the resized image will not exceed the specified maximum height or width ceiling with preserved aspect ratio.
+
+1. `Resize thumbnails: max width` - maximum width of the resized image.
+
+1. `Resize thumbnails: max height` - maximum height of the resized image.
+
+1. `Resize thumbnails: file format` - resized image format.
 
 ### Collections database