Skip to content

Commit 2237b0c

Browse files
docs: Add "Auto Format Trigger" doc
1 parent 6e23ad8 commit 2237b0c

2 files changed

Lines changed: 16 additions & 0 deletions

File tree

README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -63,8 +63,13 @@ When a text input area loses focus (e.g., by clicking outside or pressing Tab),
6363
Detailed behavior is as follows:
6464
- Automatically adds a comma and space after each tag for proper separation
6565
- Removes extra commas and spaces between tags
66+
- You can manually trigger formatting using the keyboard shortcut `Alt+Shift+F` (keybinding can be customized in ComfyUI settings)
6667
- You can enable/disable this feature in the settings
6768

69+
> [!NOTE]
70+
> Auto-formatting is disabled for certain nodes to prevent errors.
71+
> Example: "Power Puter (rgthree)" `code` field, "LoraLoaderBlockWeight (Inspire)" `block_vector` field
72+
6873
## CSV Data
6974

7075
Two basic CSV data files are required for operation. These are managed on [HuggingFace](https://huggingface.co/datasets/newtextdoc1111/danbooru-tag-csv) and are automatically downloaded when ComfyUI is first launched after installation, so no setup is required.
@@ -179,6 +184,9 @@ For example, by preparing the following CSV, you can quickly insert correspondin
179184
### Auto Formatter
180185

181186
- **Enable Auto Format**: Enable/disable the automatically format prompt text when the textarea loses focus.
187+
- **Auto Format Trigger**: Choose when formatting is applied.
188+
- **Auto**: Format automatically when leaving text field
189+
- **Manual**: Format only via keyboard shortcut (default: `Alt+Shift+F`)
182190

183191
## Advanced Settings
184192

docs/README_jp.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -61,8 +61,13 @@
6161
詳細な動作は以下になります:
6262
- 各タグの後に自動的にカンマとスペースを追加し、適切に区切ります
6363
- タグ間の余分なカンマとスペースを削除します
64+
- キーボードショートカット `Alt+Shift+F` を使って手動でフォーマットすることも出来ます(キーバインドはComfyUIの設定から変更可能です)
6465
- 設定から機能の有効化/無効化を切り替えられます
6566

67+
> [!NOTE]
68+
> 一部のノードはエラーに繋がるため、自動フォーマットは実行されません。
69+
> 例:「Power Puter (rgthree)」の `code` フィールド、「LoraLoaderBlockWeight (Inspire)」の `block_vector` フィールド
70+
6671
## CSV データ
6772

6873
動作には基本となる CSV データが2つ必要です。これらは [HuggingFace](https://huggingface.co/datasets/newtextdoc1111/danbooru-tag-csv) で管理されており、 ComfyUI にインストール後の初回起動時に自動でダウンロードされるのでセットアップは不要です。
@@ -177,6 +182,9 @@ worst_quality,5,9999999,
177182
### 自動フォーマット
178183

179184
- **Enable Auto Format**: テキストエリアがフォーカスを失った際にプロンプトテキストを自動的にフォーマットする機能の有効化/無効化
185+
- **Auto Format Trigger**: フォーマットを適用するタイミングを選択します
186+
- **自動**: テキスト欄からフォーカスが外れた際に自動でフォーマットします
187+
- **手動**: キーボードショートカットでのみフォーマットします(デフォルト: `Alt+Shift+F`
180188

181189
## 上級者向け設定
182190

0 commit comments

Comments
 (0)