Change remaining references to 'help' into 'manual'

In addition, change the prefixes for all documentation related macros: - HL_ ('help link') -> DL_ ('documentation link') - HF_ ('help files') -> DF_ ('documentation files')
Gnucash · Dec 19, 2022 · 2c93c38 · 2c93c38
1 parent b8c0673
commit 2c93c38
Show file tree

Hide file tree

Showing 26 changed files with 67 additions and 67 deletions.
diff --git a/gnucash/gnome-search/dialog-search.c b/gnucash/gnome-search/dialog-search.c
@@ -656,7 +656,7 @@ search_cancel_cb (GtkButton *button, GNCSearchWindow *sw)
 static void
 search_help_cb (GtkButton *button, GNCSearchWindow *sw)
 {
-    gnc_gnome_help (GTK_WINDOW(sw->dialog), HF_HELP, HL_FIND_TRANSACTIONS);
+    gnc_gnome_help (GTK_WINDOW(sw->dialog), DF_MANUAL, DL_FIND_TRANSACTIONS);
 }
 
 static void

diff --git a/gnucash/gnome-utils/dialog-account.c b/gnucash/gnome-utils/dialog-account.c
@@ -1009,11 +1009,11 @@ gnc_account_window_response_cb (GtkDialog *dialog,
         {
         case NEW_ACCOUNT:
             DEBUG("new acct dialog, HELP");
-            gnc_gnome_help (GTK_WINDOW(dialog), HF_HELP, HL_ACC);
+            gnc_gnome_help (GTK_WINDOW(dialog), DF_MANUAL, DL_ACC);
             break;
         case EDIT_ACCOUNT:
             DEBUG("edit acct dialog, HELP");
-            gnc_gnome_help (GTK_WINDOW(dialog), HF_HELP, HL_ACCEDIT);
+            gnc_gnome_help (GTK_WINDOW(dialog), DF_MANUAL, DL_ACCEDIT);
             break;
         default:
             g_assert_not_reached ();

diff --git a/gnucash/gnome-utils/dialog-book-close.c b/gnucash/gnome-utils/dialog-book-close.c
@@ -279,7 +279,7 @@ gnc_book_close_response_cb(GtkDialog *dialog, gint response, GtkDialog *unused)
     switch (response)
     {
     case GTK_RESPONSE_HELP:
-        gnc_gnome_help (GTK_WINDOW(dialog), HF_HELP, HL_CLOSE_BOOK);
+        gnc_gnome_help (GTK_WINDOW(dialog), DF_MANUAL, DL_CLOSE_BOOK);
         break;
     case GTK_RESPONSE_OK:
         cbw->close_date = gnc_date_edit_get_date(GNC_DATE_EDIT(cbw->close_date_widget));

diff --git a/gnucash/gnome-utils/dialog-commodity.c b/gnucash/gnome-utils/dialog-commodity.c
@@ -1140,7 +1140,7 @@ gnc_ui_common_commodity_modal(gnc_commodity *commodity,
             break;
         case GTK_RESPONSE_HELP:
             DEBUG("case HELP");
-            gnc_gnome_help (GTK_WINDOW(win->dialog), HF_HELP, HL_COMMODITY);
+            gnc_gnome_help (GTK_WINDOW(win->dialog), DF_MANUAL, DL_COMMODITY);
             break;
         default:	/* Cancel, Escape, Close, etc. */
             DEBUG("default: %d", value);

diff --git a/gnucash/gnome-utils/dialog-file-access.c b/gnucash/gnome-utils/dialog-file-access.c
@@ -125,7 +125,7 @@ gnc_ui_file_access_response_cb(GtkDialog *dialog, gint response, GtkDialog *unus
     switch ( response )
     {
     case GTK_RESPONSE_HELP:
-        gnc_gnome_help (GTK_WINDOW(dialog), HF_HELP, HL_GLOBPREFS );
+        gnc_gnome_help (GTK_WINDOW(dialog), DF_MANUAL, DL_GLOBPREFS );
         break;
 
     case GTK_RESPONSE_OK:

diff --git a/gnucash/gnome-utils/dialog-options.cpp b/gnucash/gnome-utils/dialog-options.cpp
@@ -42,7 +42,7 @@ extern "C"
 #include "gnc-component-manager.h"
 #include <gnc-prefs.h> // for GNC_PREFS_NUM_SOURCE
 #include "gnc-session.h" // for gnc_get_current_session
-#include "gnc-ui.h" // for HF_HELP
+#include "gnc-ui.h" // for DF_MANUAL
 }
 
 #include <iostream>
@@ -646,7 +646,7 @@ GncOptionsDialog::set_close_cb( GncOptionsDialogCallback cb, gpointer data) noex
 static void
 gnc_book_options_help_cb (GncOptionsDialog *win, gpointer dat)
 {
-    gnc_gnome_help (GTK_WINDOW (win->get_widget()), HF_HELP, HL_BOOK_OPTIONS);
+    gnc_gnome_help (GTK_WINDOW (win->get_widget()), DF_MANUAL, DL_BOOK_OPTIONS);
 }
 
 void
@@ -658,13 +658,13 @@ GncOptionsDialog::set_book_help_cb() noexcept
 static void
 gnc_global_options_help_cb (GncOptionsDialog *win, gpointer dat)
 {
-    gnc_gnome_help (GTK_WINDOW(win->get_widget()), HF_HELP, HL_GLOBPREFS);
+    gnc_gnome_help (GTK_WINDOW(win->get_widget()), DF_MANUAL, DL_GLOBPREFS);
 }
 
 static void
 gnc_style_sheet_options_help_cb (GncOptionsDialog *win, gpointer dat)
 {
-    gnc_gnome_help (GTK_WINDOW(win->get_widget()), HF_HELP, HL_STYLE_SHEET);
+    gnc_gnome_help (GTK_WINDOW(win->get_widget()), DF_MANUAL, DL_STYLE_SHEET);
 }
 
 void

diff --git a/gnucash/gnome-utils/dialog-preferences.c b/gnucash/gnome-utils/dialog-preferences.c
@@ -1202,7 +1202,7 @@ gnc_preferences_response_cb (GtkDialog *dialog, gint response, GtkDialog *unused
     switch (response)
     {
     case GTK_RESPONSE_HELP:
-        gnc_gnome_help (GTK_WINDOW(dialog), HF_HELP, HL_GLOBPREFS);
+        gnc_gnome_help (GTK_WINDOW(dialog), DF_MANUAL, DL_GLOBPREFS);
         break;
 
     case GTK_RESPONSE_DELETE_EVENT:

diff --git a/gnucash/gnome-utils/gnc-main-window.cpp b/gnucash/gnome-utils/gnc-main-window.cpp
@@ -4746,13 +4746,13 @@ gnc_main_window_cmd_window_raise (GtkAction *action,
 static void
 gnc_main_window_cmd_help_tutorial (GtkAction *action, GncMainWindow *window)
 {
-    gnc_gnome_help (GTK_WINDOW(window), HF_GUIDE, NULL);
+    gnc_gnome_help (GTK_WINDOW(window), DF_GUIDE, NULL);
 }
 
 static void
 gnc_main_window_cmd_help_contents (GtkAction *action, GncMainWindow *window)
 {
-    gnc_gnome_help (GTK_WINDOW(window), HF_HELP, NULL);
+    gnc_gnome_help (GTK_WINDOW(window), DF_MANUAL, NULL);
 }
 
 /** This is a helper function to find a data file and suck it into

diff --git a/gnucash/gnome-utils/gnc-ui.h b/gnucash/gnome-utils/gnc-ui.h
@@ -23,7 +23,7 @@
     @{ */
 
 /** @defgroup Dialogs Dialogs */
-/** @defgroup Druids Druids */
+/** @defgroup Assistants Assistants */
 
 /** @} */
 
@@ -38,45 +38,45 @@
 #include <gtk/gtk.h>
 
 
-/** Help Files ******************************************************/
+/** Documentation references ****************************************/
 #ifdef G_OS_WIN32
-#    define HF_GUIDE         "gnucash-guide.chm"
-#    define HF_HELP          "gnucash-manual.chm"
+#    define DF_GUIDE         "gnucash-guide.chm"
+#    define DF_MANUAL        "gnucash-manual.chm"
 #elif defined MAC_INTEGRATION
-#    define HF_GUIDE         "GnuCash Guide"
-#    define HF_HELP          "GnuCash Manual"
+#    define DF_GUIDE         "GnuCash Guide"
+#    define DF_MANUAL        "GnuCash Manual"
 #else
-#    define HF_GUIDE         "gnucash-guide"
-#    define HF_HELP          "gnucash-manual"
+#    define DF_GUIDE         "gnucash-guide"
+#    define DF_MANUAL        "gnucash-manual"
 #endif
 
-/** Links in the Help Files *****************************************/
-#define HL_USAGE_BSNSS       "busnss-ar-setup1"
-#define HL_USAGE_INVOICE     "busnss-ar-invoices1"
-#define HL_USAGE_VOUCHER     "busnss-emply-newvchr"
-#define HL_USAGE_BILL        "busnss-ap-bills1"
-#define HL_USAGE_CUSTOMER    "busnss-ar-customers1"
-#define HL_USAGE_VENDOR      "busnss-ap-vendors1"
-#define HL_USAGE_EMPLOYEE    "busnss-emply"
-#define HL_USAGE_JOB         "busnss-ar-jobs1"
-#define HL_ACC               "acct-create"
-#define HL_ACCEDIT           "acct-edit"
-#define HL_COMMODITY         "tool-commodity"
-#define HL_FIND_TRANSACTIONS "tool-find"
-#define HL_FIN_CALC          "tool-calc"
-#define HL_PRICE_DB          "tool-price"
-#define HL_PRICE_EDIT        "tool-price-manual"
-#define HL_GLOBPREFS         "set-prefs"
-#define HL_PRINTCHECK        "print-check"
-#define HL_RECNWIN           "acct-reconcile"
-#define HL_SXEDITOR          "trans-sched"
-#define HL_SX_SLR            "trans-sched-slr"
-#define HL_BOOK_OPTIONS      "book-options"
-#define HL_STYLE_SHEET       "change-style"
-#define HL_CLOSE_BOOK        "tool-close-book"
-#define HL_USAGE_CUSTOMREP   "report-saving"
-#define HL_IMPORT_BC         "busnss-imp-bills-invoices"
-#define HL_IMPORT_CUST       "busnss-imp-customer-vendor"
+/** Links in the Manual *********************************************/
+#define DL_USAGE_BSNSS       "busnss-ar-setup1"
+#define DL_USAGE_INVOICE     "busnss-ar-invoices1"
+#define DL_USAGE_VOUCHER     "busnss-emply-newvchr"
+#define DL_USAGE_BILL        "busnss-ap-bills1"
+#define DL_USAGE_CUSTOMER    "busnss-ar-customers1"
+#define DL_USAGE_VENDOR      "busnss-ap-vendors1"
+#define DL_USAGE_EMPLOYEE    "busnss-emply"
+#define DL_USAGE_JOB         "busnss-ar-jobs1"
+#define DL_ACC               "acct-create"
+#define DL_ACCEDIT           "acct-edit"
+#define DL_COMMODITY         "tool-commodity"
+#define DL_FIND_TRANSACTIONS "tool-find"
+#define DL_FIN_CALC          "tool-calc"
+#define DL_PRICE_DB          "tool-price"
+#define DL_PRICE_EDIT        "tool-price-manual"
+#define DL_GLOBPREFS         "set-prefs"
+#define DL_PRINTCHECK        "print-check"
+#define DL_RECNWIN           "acct-reconcile"
+#define DL_SXEDITOR          "trans-sched"
+#define DL_SX_SLR            "trans-sched-slr"
+#define DL_BOOK_OPTIONS      "book-options"
+#define DL_STYLE_SHEET       "change-style"
+#define DL_CLOSE_BOOK        "tool-close-book"
+#define DL_USAGE_CUSTOMREP   "report-saving"
+#define DL_IMPORT_BC         "busnss-imp-bills-invoices"
+#define DL_IMPORT_CUST       "busnss-imp-customer-vendor"
 
 /* GTK Windows - Common Response Codes */
 

diff --git a/gnucash/gnome/dialog-custom-report.c b/gnucash/gnome/dialog-custom-report.c
@@ -131,7 +131,7 @@ void
 custom_report_help_cb (GtkWidget *widget, gpointer data)
 {
     CustomReportDialog *crd = data;
-    gnc_gnome_help (GTK_WINDOW(crd->dialog), HF_HELP, HL_USAGE_CUSTOMREP);
+    gnc_gnome_help (GTK_WINDOW(crd->dialog), DF_MANUAL, DL_USAGE_CUSTOMREP);
 }
 
 void

diff --git a/gnucash/gnome/dialog-customer.c b/gnucash/gnome/dialog-customer.c
@@ -368,7 +368,7 @@ void
 gnc_customer_window_help_cb (GtkWidget *widget, gpointer data)
 {
     CustomerWindow *cw = data;
-    gnc_gnome_help (GTK_WINDOW(cw->dialog), HF_HELP, HL_USAGE_CUSTOMER);
+    gnc_gnome_help (GTK_WINDOW(cw->dialog), DF_MANUAL, DL_USAGE_CUSTOMER);
 }
 
 void

diff --git a/gnucash/gnome/dialog-employee.c b/gnucash/gnome/dialog-employee.c
@@ -250,7 +250,7 @@ void
 gnc_employee_window_help_cb (GtkWidget *widget, gpointer data)
 {
     EmployeeWindow *ew = data;
-    gnc_gnome_help (GTK_WINDOW(ew->dialog), HF_HELP, HL_USAGE_EMPLOYEE);
+    gnc_gnome_help (GTK_WINDOW(ew->dialog), DF_MANUAL, DL_USAGE_EMPLOYEE);
 }
 
 void

diff --git a/gnucash/gnome/dialog-fincalc.c b/gnucash/gnome/dialog-fincalc.c
@@ -497,7 +497,7 @@ void fincalc_response_cb (GtkDialog *dialog,
     switch (response)
     {
     case GTK_RESPONSE_HELP:
-        gnc_gnome_help (GTK_WINDOW(dialog), HF_HELP, HL_FIN_CALC);
+        gnc_gnome_help (GTK_WINDOW(dialog), DF_MANUAL, DL_FIN_CALC);
         return;
 
     case GTK_RESPONSE_OK:

diff --git a/gnucash/gnome/dialog-invoice.c b/gnucash/gnome/dialog-invoice.c
@@ -549,13 +549,13 @@ gnc_invoice_window_help_cb (GtkWidget *widget, gpointer data)
     switch(owner_type)
     {
         case GNC_OWNER_CUSTOMER:
-           gnc_gnome_help (GTK_WINDOW(iw->dialog), HF_HELP, HL_USAGE_INVOICE);
+           gnc_gnome_help (GTK_WINDOW(iw->dialog), DF_MANUAL, DL_USAGE_INVOICE);
            break;
         case GNC_OWNER_VENDOR:
-           gnc_gnome_help (GTK_WINDOW(iw->dialog), HF_HELP, HL_USAGE_BILL);
+           gnc_gnome_help (GTK_WINDOW(iw->dialog), DF_MANUAL, DL_USAGE_BILL);
            break;
         default:
-           gnc_gnome_help (GTK_WINDOW(iw->dialog), HF_HELP, HL_USAGE_VOUCHER);
+           gnc_gnome_help (GTK_WINDOW(iw->dialog), DF_MANUAL, DL_USAGE_VOUCHER);
            break;
     }
 }

diff --git a/gnucash/gnome/dialog-job.c b/gnucash/gnome/dialog-job.c
@@ -208,7 +208,7 @@ void
 gnc_job_window_help_cb (GtkWidget *widget, gpointer data)
 {
     JobWindow *jw = data;
-    gnc_gnome_help (GTK_WINDOW(jw->dialog), HF_HELP, HL_USAGE_JOB);
+    gnc_gnome_help (GTK_WINDOW(jw->dialog), DF_MANUAL, DL_USAGE_JOB);
 }
 
 

diff --git a/gnucash/gnome/dialog-new-user.c b/gnucash/gnome/dialog-new-user.c
@@ -122,7 +122,7 @@ gnc_ui_new_user_ok_cb (GtkWidget * widget, gpointer data)
     }
     else if (gtk_toggle_button_get_active (GTK_TOGGLE_BUTTON (new_user->tutorial_button)))
     {
-        gnc_gnome_help (GTK_WINDOW(new_user->window), HF_GUIDE, NULL);
+        gnc_gnome_help (GTK_WINDOW(new_user->window), DF_GUIDE, NULL);
     }
     gtk_widget_destroy (new_user->window);
 }

diff --git a/gnucash/gnome/dialog-order.c b/gnucash/gnome/dialog-order.c
@@ -231,7 +231,7 @@ void
 gnc_order_window_help_cb (GtkWidget *widget, gpointer data)
 {
     OrderWindow *ow = data;
-    gnc_gnome_help (GTK_WINDOW(ow->dialog), HF_HELP, HL_USAGE_BILL);
+    gnc_gnome_help (GTK_WINDOW(ow->dialog), DF_MANUAL, DL_USAGE_BILL);
 }
 
 void

diff --git a/gnucash/gnome/dialog-price-edit-db.cpp b/gnucash/gnome/dialog-price-edit-db.cpp
@@ -141,7 +141,7 @@ gnc_prices_dialog_help_cb (GtkDialog *dialog, gpointer data)
 {
     auto pdb_dialog{static_cast<PricesDialog*>(data)};
 
-    gnc_gnome_help (GTK_WINDOW (pdb_dialog->window), HF_HELP, HL_PRICE_DB);
+    gnc_gnome_help (GTK_WINDOW (pdb_dialog->window), DF_MANUAL, DL_PRICE_DB);
 }
 
 

diff --git a/gnucash/gnome/dialog-price-editor.c b/gnucash/gnome/dialog-price-editor.c
@@ -374,7 +374,7 @@ pedit_dialog_response_cb (GtkDialog *dialog, gint response, gpointer data)
     }
     else if (response == GTK_RESPONSE_HELP)
     {
-        gnc_gnome_help (GTK_WINDOW (pedit_dialog->dialog), HF_HELP, HL_PRICE_EDIT);
+        gnc_gnome_help (GTK_WINDOW (pedit_dialog->dialog), DF_MANUAL, DL_PRICE_EDIT);
     }
     else
     {

diff --git a/gnucash/gnome/dialog-print-check.c b/gnucash/gnome/dialog-print-check.c
@@ -2676,7 +2676,7 @@ gnc_ui_print_check_response_cb(GtkDialog *dialog,
     switch (response)
     {
     case GTK_RESPONSE_HELP:
-        gnc_gnome_help (GTK_WINDOW(dialog), HF_HELP, HL_PRINTCHECK);
+        gnc_gnome_help (GTK_WINDOW(dialog), DF_MANUAL, DL_PRINTCHECK);
         return;
 
     case GTK_RESPONSE_OK:

diff --git a/gnucash/gnome/dialog-sx-editor.c b/gnucash/gnome/dialog-sx-editor.c
@@ -230,7 +230,7 @@ editor_cancel_button_clicked_cb (GtkButton *b, GncSxEditorDialog *sxed)
 static void
 editor_help_button_clicked_cb (GtkButton *b, GncSxEditorDialog *sxed)
 {
-    gnc_gnome_help (GTK_WINDOW (sxed->dialog), HF_HELP, HL_SXEDITOR);
+    gnc_gnome_help (GTK_WINDOW (sxed->dialog), DF_MANUAL, DL_SXEDITOR);
 }
 
 

diff --git a/gnucash/gnome/dialog-sx-since-last-run.c b/gnucash/gnome/dialog-sx-since-last-run.c
@@ -1127,7 +1127,7 @@ dialog_response_cb (GtkDialog *dialog, gint response_id, GncSxSinceLastRunDialog
     switch (response_id)
     {
     case GTK_RESPONSE_HELP:
-        gnc_gnome_help (GTK_WINDOW(dialog), HF_HELP, HL_SX_SLR);
+        gnc_gnome_help (GTK_WINDOW(dialog), DF_MANUAL, DL_SX_SLR);
         break;
 
     case GTK_RESPONSE_OK:

diff --git a/gnucash/gnome/dialog-vendor.c b/gnucash/gnome/dialog-vendor.c
@@ -239,7 +239,7 @@ void
 gnc_vendor_window_help_cb (GtkWidget *widget, gpointer data)
 {
     VendorWindow *vw = data;
-    gnc_gnome_help (GTK_WINDOW(vw->dialog), HF_HELP, HL_USAGE_VENDOR);
+    gnc_gnome_help (GTK_WINDOW(vw->dialog), DF_MANUAL, DL_USAGE_VENDOR);
 }
 
 void

diff --git a/gnucash/gnome/window-reconcile.c b/gnucash/gnome/window-reconcile.c
@@ -1199,7 +1199,7 @@ static void
 gnc_ui_reconcile_window_help_cb(GtkWidget *widget, gpointer data)
 {
     RecnWindow *recnData = data;
-    gnc_gnome_help (GTK_WINDOW(recnData->window), HF_HELP, HL_RECNWIN);
+    gnc_gnome_help (GTK_WINDOW(recnData->window), DF_MANUAL, DL_RECNWIN);
 }
 
 

diff --git a/gnucash/import-export/bi-import/dialog-bi-import-gui.c b/gnucash/import-export/bi-import/dialog-bi-import-gui.c
@@ -249,7 +249,7 @@ void
 gnc_bi_import_gui_help_cb (GtkWidget *widget, gpointer data)
 {
     BillImportGui *gui = data;
-    gnc_gnome_help (GTK_WINDOW(gui->dialog), HF_GUIDE, HL_IMPORT_BC);
+    gnc_gnome_help (GTK_WINDOW(gui->dialog), DF_GUIDE, DL_IMPORT_BC);
 }
 
 static void

diff --git a/gnucash/import-export/customer-import/dialog-customer-import-gui.c b/gnucash/import-export/customer-import/dialog-customer-import-gui.c
@@ -225,7 +225,7 @@ void
 gnc_customer_import_gui_help_cb (GtkWidget *widget, gpointer data)
 {
     CustomerImportGui *gui = data;
-    gnc_gnome_help (GTK_WINDOW(gui->dialog), HF_GUIDE, HL_IMPORT_CUST);
+    gnc_gnome_help (GTK_WINDOW(gui->dialog), DF_GUIDE, DL_IMPORT_CUST);
 }
 
 static void