Add documentation for new Scintilla feature "Change history"

geany · Oct 19, 2023 · 80fec37 · 80fec37
1 parent 514adec
commit 80fec37
Show file tree

Hide file tree

Showing 4 changed files with 34 additions and 0 deletions.
diff --git a/doc/Makefile.am b/doc/Makefile.am
@@ -4,6 +4,7 @@ if INSTALL_HTML_DOCS
 htmldocimagesdir = $(docdir)/html/images
 dist_htmldocimages_DATA = \
 	images/build_menu_commands_dialog.png \
+	images/edit_change_history.png \
 	images/find_dialog.png \
 	images/find_in_files_dialog.png \
 	images/main_window.png \

diff --git a/doc/geany.txt b/doc/geany.txt
@@ -2419,6 +2419,38 @@ Always
     Always show virtual spaces beyond the end of lines
 
 
+Change History
+``````````````
+
+The *change history* feature enables changed text in a document to be shown in the markers margin or by underlining the text.
+By default, the *change history* feature is disabled.
+
+Newly added, modified and removed lines or words are highlighted to easily track changes to the opened
+document. The changes can be shown as vertical bars in the markers margin and/or as underlines in
+the text directly.
+
+.. note::
+    This feature may use a moderate amount of memory, especially if there are many or big changes in the document.
+    Also, modification information is not kept when re-opening a document - all change markers will be lost.
+
+
+.. image:: ./images/edit_change_history.png
+
+The image shows the default visuals:
+
+* inserted characters appear with coloured underlines
+* points where characters were deleted are shown with small triangles
+* the margin shows a block indicating the overall state of the line, prioritizing the more consequential modified states
+* the states are modified (orange), saved (green), saved then reverted to modified (green-yellow), and
+  saved then reverted to original (cyan).
+
+Show in markers margin
+    Changes are shown in the markers margin as vertical bars
+
+Show as underline indicators
+    Changes are shown as underlines in the text directly
+
+
 Files preferences
 ^^^^^^^^^^^^^^^^^
 

diff --git a/doc/images/edit_change_history.png b/doc/images/edit_change_history.png
diff --git a/doc/meson.build b/doc/meson.build
@@ -19,6 +19,7 @@ tarball = run_command('test', '-f', 'geany.html', check: false)
 if tarball.returncode() == 0 or rst2html.found()
 	install_data(
 		'images/build_menu_commands_dialog.png',
+		'images/edit_change_history.png',
 		'images/find_dialog.png',
 		'images/find_in_files_dialog.png',
 		'images/main_window.png',