Skip to content

Commit

Permalink
Polishing notes documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
wiktor-obrebski committed Sep 5, 2024
1 parent 0f5ab80 commit cc223f1
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions docs/notes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ notes
=====

.. dfhack-tool::
:summary: Manage map-specific notes
:summary: Manage map-specific notes.
:tags: fort interface map

The `notes` tool enables players to annotate specific tiles
Expand All @@ -25,18 +25,18 @@ Usage
Add new note in the current position of the keyboard cursor.

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.

Editing or Deleting a Note
~~~~~~~~~~~~~~~~~~~~~~~~~~
--------------------------
- Click on the green pin representing the note directly on the map.
- A dialog will appear, offering options to edit the title or comment, or to delete the note entirely.

Managing Notes Visibility
~~~~~~~~~~~~~~~~~~~~~~~~~
- Access the ``DFHack Control Panel`` / ``UI Overlays`` tab.
-------------------------
- Access the `gui/control-panel` / ``UI Overlays`` tab.
- Toggle the ``notes.map-notes`` overlay to show or hide the notes on the map.

0 comments on commit cc223f1

Please sign in to comment.