Merge pull request #1297 from wiktor-obrebski/feat/gui-notes

Feat `gui/notes`

Author: myk002

docs/gui/journal.rst

@@ -8,68 +8,47 @@ gui/journal
 The `gui/journal` interface makes it easy to take notes and document
 important details for the fortresses.
 
-With this multi-line text editor, you can keep track of your fortress's
-background story, goals, notable events, and both short- and long-term plans.
+With this multi-line text editor,
+you can keep track of your fortress's background story, goals, notable events,
+and both short-term and long-term plans.
 
 This is particularly useful when you need to take a longer break from the game.
-Having detailed notes makes it much easier to resume your game after a few
-weeks or months without losing track of your progress and objectives.
+Having detailed notes makes it much easier to resume your game after
+a few weeks or months, without losing track of your progress and objectives.
 
 Supported Features
 ------------------
 
-- Cursor Control: Navigate through text using arrow keys (Left, Right, Up,
-    and Down) for precise cursor placement.
-- Fast Rewind: Use :kbd:`Ctrl` + :kbd:`Left` and :kbd:`Ctrl` + :kbd:`Right` to
-    move the cursor one word back or forward.
-- Longest X Position Memory: The cursor remembers the longest x position when
-    moving up or down, making vertical navigation more intuitive.
-- Mouse Control: Use the mouse to position the cursor within the text,
-    providing an alternative to keyboard navigation.
-- New Lines: Easily insert new lines using the :kbd:`Enter` key, supporting
-    multiline text input.
-- Text Wrapping: Text automatically wraps within the editor, ensuring lines fit
-    within the display without manual adjustments.
-- Backspace Support: Use the backspace key to delete characters to the left of
-    the cursor.
+- Cursor Control: Navigate through text using arrow keys (left, right, up, down) for precise cursor placement.
+- Fast Rewind: Use :kbd:`Ctrl` + :kbd:`Left` / :kbd:`Ctrl` + :kbd:`B` and :kbd:`Ctrl` + :kbd:`Right` / :kbd:`Ctrl` + :kbd:`F` to move the cursor one word back or forward.
+- Longest X Position Memory: The cursor remembers the longest x position when moving up or down, making vertical navigation more intuitive.
+- Mouse Control: Use the mouse to position the cursor within the text, providing an alternative to keyboard navigation.
+- New Lines: Easily insert new lines using the :kbd:`Enter` key, supporting multiline text input.
+- Text Wrapping: Text automatically wraps within the editor, ensuring lines fit within the display without manual adjustments.
+- Backspace Support: Use the backspace key to delete characters to the left of the cursor.
 - Delete Character: :kbd:`Delete` deletes the character under the cursor.
-- Line Navigation: :kbd:`Home` moves the cursor to the beginning of the current
-    line, and :kbd:`End` moves it to the end.
-- Delete Current Line: :kbd:`Ctrl` + :kbd:`U` deletes the entire current line
-    where the cursor is located.
-- Delete Rest of Line: :kbd:`Ctrl` + :kbd:`K` deletes text from the cursor to
-    the end of the line.
-- Delete Last Word: :kbd:`Ctrl` + :kbd:`W` removes the word immediately before
-    the cursor.
-- Text Selection: Select text with the mouse, with support for replacing or
-    removing selected text.
-- Jump to Beginning/End: Quickly move the cursor to the beginning or end of the
-    text using :kbd:`Ctrl` + :kbd:`Home` and :kbd:`Ctrl` + :kbd:`End`.
-- Select Word/Line: Use double click to select current word, or triple click to
-    select current line
+- Line Navigation: :kbd:`Home` moves the cursor to the beginning of the current line, and :kbd:`End` moves it to the end.
+- Delete Current Line: :kbd:`Ctrl` + :kbd:`U` deletes the entire current line where the cursor is located.
+- Delete Rest of Line: :kbd:`Ctrl` + :kbd:`K` deletes text from the cursor to the end of the line.
+- Delete Last Word: :kbd:`Ctrl` + :kbd:`W` removes the word immediately before the cursor.
+- Text Selection: Select text with the mouse, with support for replacing or removing selected text.
+- Jump to Beginning/End: Quickly move the cursor to the beginning or end of the text using :kbd:`Shift` + :kbd:`Up` and :kbd:`Shift` + :kbd:`Down`.
+- Select Word/Line: Use double click to select current word, or triple click to select current line
 - Select All: Select entire text by :kbd:`Ctrl` + :kbd:`A`
-- Undo/Redo: Undo/Redo changes by :kbd:`Ctrl` + :kbd:`Z` / :kbd:`Ctrl` +
-    :kbd:`Y`
-- Clipboard Operations: Perform OS clipboard cut, copy, and paste operations on
-    selected text, allowing you to paste the copied content into other
-    applications.
+- Undo/Redo: Undo/Redo changes by :kbd:`Ctrl` + :kbd:`Z` / :kbd:`Ctrl` + :kbd:`Y`
+- Clipboard Operations: Perform OS clipboard cut, copy, and paste operations on selected text, allowing you to paste the copied content into other applications.
 - Copy Text: Use :kbd:`Ctrl` + :kbd:`C` to copy selected text.
-    - copy selected text, if available
-    - If no text is selected it copy the entire current line, including the
-      terminating newline if present.
+  - copy selected text, if available
+  - If no text is selected it copy the entire current line, including the terminating newline if present.
 - Cut Text: Use :kbd:`Ctrl` + :kbd:`X` to cut selected text.
-    - cut selected text, if available
-    - If no text is selected it will cut the entire current line, including the
-      terminating newline if present
-- Paste Text: Use :kbd:`Ctrl` + :kbd:`V` to paste text from the clipboard into
-    the editor.
-    - replace selected text, if available
-    - If no text is selected, paste text in the cursor position
+  - cut selected text, if available
+  - If no text is selected it will cut the entire current line, including the terminating newline if present
+- Paste Text: Use :kbd:`Ctrl` + :kbd:`V` to paste text from the clipboard into the editor.
+  - replace selected text, if available
+  - If no text is selected, paste text in the cursor position
 - Scrolling behaviour for long text build-in
-- Table of contents (:kbd:`Ctrl` + :kbd:`O`), with headers line prefixed by
-    ``#``, e.g. ``# Fort history``, ``## Year 1``
-- Table of contents navigation: jump to previous/next section by :kbd:`Ctrl` +
-    :kbd:`Up` / :kbd:`Ctrl` + :kbd:`Down`
+- Table of contents (:kbd:`Ctrl` + :kbd:`O`), with headers line prefixed by '#', e.g. '# Fort history', '## Year 1'
+- Table of contents navigation: jump to previous/next section by :kbd:`Ctrl` + :kbd:`Up` / :kbd:`Ctrl` + :kbd:`Down`
 
 Usage
 -----

docs/gui/notes.rst

@@ -0,0 +1,33 @@
+gui/notes
+=========
+
+.. dfhack-tool::
+    :summary: Interactive panel for managing map-specific notes.
+    :tags: fort interface map
+
+The `gui/notes` tool provides a comprehensive interface for interacting
+with map-specific notes. It is designed to streamline the process
+of note management in Dwarf Fortress, making it simpler
+and more intuitive to keep track of important map-specific information.
+
+This tool builds upon the functionality of the `notes` tool,
+enhancing it by providing a user-friendly panel for easier management
+and visibility of notes across the Dwarf Fortress game map.
+
+Usage
+-----
+
+::
+
+    gui/notes
+
+Launch the notes management panel.
+
+Supported Features
+------------------
+
+- Interactive Panel: Manage all aspects of notes through a centralized graphical interface.
+- Search (:kbd:`Alt` + :kbd:`S`): Quickly find notes
+- Direct Map Interaction (:kbd:`Alt` + :kbd:`N`): Add new notes by clicking on the map.
+- Edit (:kbd:`Alt` + :kbd:`U`): Easily modify existing notes.
+- Delete (:kbd:`Alt` + :kbd:`D`): Easily remove existing notes.

docs/notes.rst

@@ -29,7 +29,7 @@ Creating a Note
 1. Use the keyboard cursor to select the desired map tile where you want to place a note.
 2. Execute ``notes add`` via the DFHack console.
 3. In the pop-up dialog, fill in the note's title and detailed comment.
-4. Press :kbd:`Alt` + :kbd:`S` to create the note.
+4. Press :kbd:`Ctrl` + :kbd:`Enter` to create the note.
 
 Editing or Deleting a Note
 --------------------------