Merge pull request #3593 from eht16/release_2_0_documentation

Release 2.0 documentation
geany · Oct 19, 2023 · e9af6b5 · e9af6b5
2 parents 5f992d0 + 93070a5
commit e9af6b5
Show file tree

Hide file tree

Showing 26 changed files with 93 additions and 0 deletions.
diff --git a/NEWS b/NEWS
@@ -1,12 +1,67 @@
 Geany 2.0 (unreleased)
+
+    General
+    * Split "session data" into session.conf, preferences are written to
+      and read from geany.conf (PR#2776, PR#2779, PR#3014, PR#3125 and more).
+    * Add new build system Meson (experimental) (PR#2761).
+    * Require GTK 3.24 (#3580).
+
+    Bug fixes
+    * (Re-)Add ability to scroll over document tabs (Luke Horwell, PR#3134).
+    * Fix keyword colorization on filetype change (PR#3553).
+    * Fix startup files order when placing tabs next to the current one
+      (PR#3611).
+
     Interface
     * The document list in the sidebar has a new tree view. This mode is the
       new default and existing installations automatically use it (PR#1813).
+    * Use dark-theme friendly colors for compiler messages (PR#3013).
+    * Add a confirmation dialog on search & replace for the whole session
+      (PR#3033).
+    * Filter entry for symbol tree (PR#3055).
+    * Simplify project creation from existing directories with sources
+      (PR#3042).
+    * Add option to show symbols in symbol tree without category groups
+      (PR#3172).
+    * Add option to only show line endings if they differ from file default
+      (PR#3287).
+    * Make tab label length and window title length configurable
+      (Abdul Rafey, #3365).
+    * Make Go to Symbol commands show signature list (PR#3475).
+
+    Editor
+    * Update Scintilla to 5.3.7 and Lexilla to 5.2.7 (PR#2867, PR#3551).
+    * Add "Change history" feature (disabled by default) (PR#3551).
+
+    Filetypes
+    * Sync many parsers from the Universal Ctags project, this leads to
+      updated symbol parsers (PR#2990, PR#2991, PR#3032).
+    * Improved support for the ctags file format, which is now the
+      recommended format for tags files (PR#3049).
+    * Update Kotlin filetype config (PR#3456).
+    * Apply Markdown header style to the complete header
+      (Robert Di Pardo, PR#3602).
+    * Update Nim filetype config (Zoom, PR#2988).
+    * Update PHP filetype config (PR#3488).
+    * Update Python filetype config (PR#3039).
+    * Add AutoIt filetype (Skif-off, PR#1752).
+    * Add GDScript filetype (David Yang, PR#3012).
+    * Remove Ferite filetype (PR#3075).
+    * Enable local variables and improve autocompletion for C/C++ and
+      some other languages (PR#3185, PR#3275).
+
+    Windows
+    * Remove native file and color dialogs on Windows, GTK dialogs will
+      be used instead (#3219).
+    * Use "Prof-Gnome" GTK theme by default (same theme as used on macOS)
+      for a better experience, the "Adwaita" theme can still be activated
+      (PR#3129).
 
     Internationalization
     * Updated translations: cz, da, de, fr, es, kk, lv, it, nl, pt, sk, ru, ua
     * Added translations: si
 
+
 Geany 1.38 (October 09, 2021)
 
     General

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
@@ -223,6 +223,10 @@ The Geany window is shown in the following figure:
 
 .. image:: ./images/main_window.png
 
+.. note::
+    Screenshots in this document are taken with the default GTK Adwaita
+    theme, but Geany will adapt to the desktop GTK theme that is set.
+
 The workspace has the following parts:
 
 * The menu.
@@ -2419,6 +2423,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/build_menu_commands_dialog.png b/doc/images/build_menu_commands_dialog.png
diff --git a/doc/images/edit_change_history.png b/doc/images/edit_change_history.png
diff --git a/doc/images/find_dialog.png b/doc/images/find_dialog.png
diff --git a/doc/images/find_in_files_dialog.png b/doc/images/find_in_files_dialog.png
diff --git a/doc/images/main_window.png b/doc/images/main_window.png
diff --git a/doc/images/pref_dialog_edit_completions.png b/doc/images/pref_dialog_edit_completions.png
diff --git a/doc/images/pref_dialog_edit_display.png b/doc/images/pref_dialog_edit_display.png
diff --git a/doc/images/pref_dialog_edit_features.png b/doc/images/pref_dialog_edit_features.png
diff --git a/doc/images/pref_dialog_edit_indentation.png b/doc/images/pref_dialog_edit_indentation.png
diff --git a/doc/images/pref_dialog_files.png b/doc/images/pref_dialog_files.png
diff --git a/doc/images/pref_dialog_gen_misc.png b/doc/images/pref_dialog_gen_misc.png
diff --git a/doc/images/pref_dialog_gen_startup.png b/doc/images/pref_dialog_gen_startup.png
diff --git a/doc/images/pref_dialog_interface_interface.png b/doc/images/pref_dialog_interface_interface.png
diff --git a/doc/images/pref_dialog_interface_notebook.png b/doc/images/pref_dialog_interface_notebook.png
diff --git a/doc/images/pref_dialog_interface_toolbar.png b/doc/images/pref_dialog_interface_toolbar.png
diff --git a/doc/images/pref_dialog_keys.png b/doc/images/pref_dialog_keys.png
diff --git a/doc/images/pref_dialog_printing.png b/doc/images/pref_dialog_printing.png
diff --git a/doc/images/pref_dialog_templ.png b/doc/images/pref_dialog_templ.png
diff --git a/doc/images/pref_dialog_tools.png b/doc/images/pref_dialog_tools.png
diff --git a/doc/images/pref_dialog_various.png b/doc/images/pref_dialog_various.png
diff --git a/doc/images/pref_dialog_vte.png b/doc/images/pref_dialog_vte.png
diff --git a/doc/images/replace_dialog.png b/doc/images/replace_dialog.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',