IntenseFinance/gnucash
3
0
Fork 0
mirror of https://github.com/Gnucash/gnucash.git synced 2025-02-25 18:55:30 -06:00
Code Issues Packages Projects Releases Wiki Activity

Change remaining references to 'help' into 'manual'

Browse Source 
In addition, change the prefixes for all documentation related macros:
- HL_ ('help link') -> DL_ ('documentation link')
- HF_ ('help files') -> DF_ ('documentation files')
This commit is contained in:
Geert Janssens 2022-10-20 14:19:24 +02:00
parent b8c0673526
commit 2c93c383ac
26 changed files with 67 additions and 67 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
gnucash/gnome-search/dialog-search.c
View File

@ -656,7 +656,7 @@ search_cancel_cb (GtkButton *button, GNCSearchWindow *sw)
static void static void
search_help_cb (GtkButton *button, GNCSearchWindow *sw) 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 static void

4
gnucash/gnome-utils/dialog-account.c
View File

@ -1009,11 +1009,11 @@ gnc_account_window_response_cb (GtkDialog *dialog,
{ {
case NEW_ACCOUNT: case NEW_ACCOUNT:
DEBUG("new acct dialog, HELP"); 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; break;
case EDIT_ACCOUNT: case EDIT_ACCOUNT:
DEBUG("edit acct dialog, HELP"); 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; break;
default: default:
g_assert_not_reached (); g_assert_not_reached ();

2
gnucash/gnome-utils/dialog-book-close.c
View File

@ -279,7 +279,7 @@ gnc_book_close_response_cb(GtkDialog *dialog, gint response, GtkDialog *unused)
switch (response) switch (response)
{ {
case GTK_RESPONSE_HELP: 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; break;
case GTK_RESPONSE_OK: case GTK_RESPONSE_OK:
cbw->close_date = gnc_date_edit_get_date(GNC_DATE_EDIT(cbw->close_date_widget)); cbw->close_date = gnc_date_edit_get_date(GNC_DATE_EDIT(cbw->close_date_widget));

2
gnucash/gnome-utils/dialog-commodity.c
View File

@ -1140,7 +1140,7 @@ gnc_ui_common_commodity_modal(gnc_commodity *commodity,
break; break;
case GTK_RESPONSE_HELP: case GTK_RESPONSE_HELP:
DEBUG("case 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; break;
default: /* Cancel, Escape, Close, etc. */ default: /* Cancel, Escape, Close, etc. */
DEBUG("default: %d", value); DEBUG("default: %d", value);

2
gnucash/gnome-utils/dialog-file-access.c
View File

@ -125,7 +125,7 @@ gnc_ui_file_access_response_cb(GtkDialog *dialog, gint response, GtkDialog *unus
switch ( response ) switch ( response )
{ {
case GTK_RESPONSE_HELP: 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; break;
case GTK_RESPONSE_OK: case GTK_RESPONSE_OK:

8
gnucash/gnome-utils/dialog-options.cpp
View File

@ -42,7 +42,7 @@ extern "C"
#include "gnc-component-manager.h" #include "gnc-component-manager.h"
#include <gnc-prefs.h> // for GNC_PREFS_NUM_SOURCE #include <gnc-prefs.h> // for GNC_PREFS_NUM_SOURCE
#include "gnc-session.h" // for gnc_get_current_session #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> #include <iostream>
@ -646,7 +646,7 @@ GncOptionsDialog::set_close_cb( GncOptionsDialogCallback cb, gpointer data) noex
static void static void
gnc_book_options_help_cb (GncOptionsDialog *win, gpointer dat) 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 void
@ -658,13 +658,13 @@ GncOptionsDialog::set_book_help_cb() noexcept
static void static void
gnc_global_options_help_cb (GncOptionsDialog *win, gpointer dat) 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 static void
gnc_style_sheet_options_help_cb (GncOptionsDialog *win, gpointer dat) 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 void

2
gnucash/gnome-utils/dialog-preferences.c
View File

@ -1202,7 +1202,7 @@ gnc_preferences_response_cb (GtkDialog *dialog, gint response, GtkDialog *unused
switch (response) switch (response)
{ {
case GTK_RESPONSE_HELP: 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; break;
case GTK_RESPONSE_DELETE_EVENT: case GTK_RESPONSE_DELETE_EVENT:

4
gnucash/gnome-utils/gnc-main-window.cpp
View File

@ -4746,13 +4746,13 @@ gnc_main_window_cmd_window_raise (GtkAction *action,
static void static void
gnc_main_window_cmd_help_tutorial (GtkAction *action, GncMainWindow *window) 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 static void
gnc_main_window_cmd_help_contents (GtkAction *action, GncMainWindow *window) 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 /** This is a helper function to find a data file and suck it into

70
gnucash/gnome-utils/gnc-ui.h
View File

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

2
gnucash/gnome/dialog-custom-report.c
View File

@ -131,7 +131,7 @@ void
custom_report_help_cb (GtkWidget *widget, gpointer data) custom_report_help_cb (GtkWidget *widget, gpointer data)
{ {
CustomReportDialog *crd = 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 void

2
gnucash/gnome/dialog-customer.c
View File

@ -368,7 +368,7 @@ void
gnc_customer_window_help_cb (GtkWidget *widget, gpointer data) gnc_customer_window_help_cb (GtkWidget *widget, gpointer data)
{ {
CustomerWindow *cw = 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 void

2
gnucash/gnome/dialog-employee.c
View File

@ -250,7 +250,7 @@ void
gnc_employee_window_help_cb (GtkWidget *widget, gpointer data) gnc_employee_window_help_cb (GtkWidget *widget, gpointer data)
{ {
EmployeeWindow *ew = 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 void

2
gnucash/gnome/dialog-fincalc.c
View File

@ -497,7 +497,7 @@ void fincalc_response_cb (GtkDialog *dialog,
switch (response) switch (response)
{ {
case GTK_RESPONSE_HELP: 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; return;
case GTK_RESPONSE_OK: case GTK_RESPONSE_OK:

6
gnucash/gnome/dialog-invoice.c
View File

@ -549,13 +549,13 @@ gnc_invoice_window_help_cb (GtkWidget *widget, gpointer data)
switch(owner_type) switch(owner_type)
{ {
case GNC_OWNER_CUSTOMER: 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; break;
case GNC_OWNER_VENDOR: 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; break;
default: 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; break;
} }
} }

2
gnucash/gnome/dialog-job.c
View File

@ -208,7 +208,7 @@ void
gnc_job_window_help_cb (GtkWidget *widget, gpointer data) gnc_job_window_help_cb (GtkWidget *widget, gpointer data)
{ {
JobWindow *jw = 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);
} }

2
gnucash/gnome/dialog-new-user.c
View File

@ -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))) 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); gtk_widget_destroy (new_user->window);
} }

2
gnucash/gnome/dialog-order.c
View File

@ -231,7 +231,7 @@ void
gnc_order_window_help_cb (GtkWidget *widget, gpointer data) gnc_order_window_help_cb (GtkWidget *widget, gpointer data)
{ {
OrderWindow *ow = 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 void

2
gnucash/gnome/dialog-price-edit-db.cpp
View File

@ -141,7 +141,7 @@ gnc_prices_dialog_help_cb (GtkDialog *dialog, gpointer data)
{ {
auto pdb_dialog{static_cast<PricesDialog*>(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);
} }

2
gnucash/gnome/dialog-price-editor.c
View File

@ -374,7 +374,7 @@ pedit_dialog_response_cb (GtkDialog *dialog, gint response, gpointer data)
} }
else if (response == GTK_RESPONSE_HELP) 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 else
{ {

2
gnucash/gnome/dialog-print-check.c
View File

@ -2676,7 +2676,7 @@ gnc_ui_print_check_response_cb(GtkDialog *dialog,
switch (response) switch (response)
{ {
case GTK_RESPONSE_HELP: 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; return;
case GTK_RESPONSE_OK: case GTK_RESPONSE_OK:

2
gnucash/gnome/dialog-sx-editor.c
View File

@ -230,7 +230,7 @@ editor_cancel_button_clicked_cb (GtkButton *b, GncSxEditorDialog *sxed)
static void static void
editor_help_button_clicked_cb (GtkButton *b, GncSxEditorDialog *sxed) 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);
} }

2
gnucash/gnome/dialog-sx-since-last-run.c
View File

@ -1127,7 +1127,7 @@ dialog_response_cb (GtkDialog *dialog, gint response_id, GncSxSinceLastRunDialog
switch (response_id) switch (response_id)
{ {
case GTK_RESPONSE_HELP: 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; break;
case GTK_RESPONSE_OK: case GTK_RESPONSE_OK:

2
gnucash/gnome/dialog-vendor.c
View File

@ -239,7 +239,7 @@ void
gnc_vendor_window_help_cb (GtkWidget *widget, gpointer data) gnc_vendor_window_help_cb (GtkWidget *widget, gpointer data)
{ {
VendorWindow *vw = 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 void

2
gnucash/gnome/window-reconcile.c
View File

@ -1199,7 +1199,7 @@ static void
gnc_ui_reconcile_window_help_cb(GtkWidget *widget, gpointer data) gnc_ui_reconcile_window_help_cb(GtkWidget *widget, gpointer data)
{ {
RecnWindow *recnData = 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);
} }

2
gnucash/import-export/bi-import/dialog-bi-import-gui.c
View File

@ -249,7 +249,7 @@ void
gnc_bi_import_gui_help_cb (GtkWidget *widget, gpointer data) gnc_bi_import_gui_help_cb (GtkWidget *widget, gpointer data)
{ {
BillImportGui *gui = 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 static void

2
gnucash/import-export/customer-import/dialog-customer-import-gui.c
View File

@ -225,7 +225,7 @@ void
gnc_customer_import_gui_help_cb (GtkWidget *widget, gpointer data) gnc_customer_import_gui_help_cb (GtkWidget *widget, gpointer data)
{ {
CustomerImportGui *gui = 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 static void