From 79fb35ff8ce35ae4cd79337e1cbf5dd6c3107d48 Mon Sep 17 00:00:00 2001 From: newtextdoc1111 Date: Thu, 20 Nov 2025 17:05:03 +0900 Subject: [PATCH] docs: Add Auto Formatter feature documentation --- README.md | 14 ++++++++++++++ docs/README_jp.md | 14 ++++++++++++++ 2 files changed, 28 insertions(+) diff --git a/README.md b/README.md index f632368..cf96338 100644 --- a/README.md +++ b/README.md @@ -13,6 +13,7 @@ - **:zap:No setup required**: Automatically downloads CSV data optimized for Danbooru tags. - **:mag:Autocomplete**: Displays tag suggestions in real-time based on your input as you type. - **:file_cabinet:Related Tags Display**: Shows a list of tags highly related to the selected tag. +- **:triangular_ruler:Auto Formatter**: Automatically formats prompt text when the textarea loses focus, cleaning up extra spaces and commas. - **:earth_asia:Multilingual Support**: Supports input completion in Japanese, Chinese, and Korean. - **:computer_mouse:Intuitive Operation**: - Supports both mouse and keyboard operations. @@ -55,6 +56,15 @@ When you select any tag in a text input area, a list of highly related tags is d - Tags that have already been entered are displayed grayed out. If you try to insert a grayed-out tag, the already entered tag will instead be selected. - You can display related tags for the cursor position by pressing `Ctrl+Shift+Space`. +## Auto Formatter + +When a text input area loses focus (e.g., by clicking outside or pressing Tab), the prompt text is automatically formatted. This feature improves readability when editing large amounts of text. + +Detailed behavior is as follows: +- Automatically adds a comma and space after each tag for proper separation +- Removes extra commas and spaces between tags +- You can enable/disable this feature in the settings + ## CSV Data 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. @@ -166,6 +176,10 @@ For example, by preparing the following CSV, you can quickly insert correspondin - **Hide Alias**: Hide/show the Alias ​​column in autocomplete and related tags (default is show) +### Auto Formatter + +- **Enable Auto Format**: Enable/disable the automatically format prompt text when the textarea loses focus. + ## Advanced Settings ### Disabling CSV Update Check on Startup diff --git a/docs/README_jp.md b/docs/README_jp.md index 8c1bc10..8228b7a 100644 --- a/docs/README_jp.md +++ b/docs/README_jp.md @@ -11,6 +11,7 @@ - **:zap:セットアップ不要**: Danbooruタグに最適化された CSV データを自動でダウンロード - **:mag:オートコンプリート**: テキスト入力中に、入力内容に基づいてタグ候補をリアルタイムで表示 - **:file_cabinet:関連タグ表示機能**: 選択したタグと関連性の高いタグを一覧表示 +- **:triangular_ruler:自動フォーマット**: テキストエリアがフォーカスを失った際に、プロンプトテキストを自動的にフォーマットし、余分なスペースやカンマを整理 - **:earth_asia:多言語対応**: 日本語、中国語、韓国語での入力補完をサポート - **:computer_mouse:直感的な操作**: - マウスとキーボードどちらの操作にも対応 @@ -53,6 +54,15 @@ - 入力済みのタグはグレーアウトで表示されます。グレーアウトしたタグを挿入しようとした場合、代わりに入力済みのタグを選択状態にします - `Ctrl+Shift+Space` キーでカーソル位置の関連タグを表示できます +## 自動フォーマット + +テキスト入力エリアがフォーカスを失った際（例：外側をクリック、Tabキーを押す）、プロンプトテキストを自動的にフォーマットする機能です。大量のテキストを編集する際に可読性を向上させる事が出来ます。 + +詳細な動作は以下になります： +- 各タグの後に自動的にカンマとスペースを追加し、適切に区切ります +- タグ間の余分なカンマとスペースを削除します +- 設定から機能の有効化/無効化を切り替えられます + ## CSV データ 動作には基本となる CSV データが2つ必要です。これらは [HuggingFace](https://huggingface.co/datasets/newtextdoc1111/danbooru-tag-csv) で管理されており、 ComfyUI にインストール後の初回起動時に自動でダウンロードされるのでセットアップは不要です。 @@ -164,6 +174,10 @@ worst_quality,5,9999999, - **Hide Alias**: オートコンプリートと関連タグで表示されるエイリアス列の非表示/表示を切り替え（デフォルトは表示です） +### 自動フォーマット + +- **Enable Auto Format**: テキストエリアがフォーカスを失った際にプロンプトテキストを自動的にフォーマットする機能の有効化/無効化 + ## 上級者向け設定 ### 起動時のCSV更新チェックを無効化する