Bug 478385 - rename non-idiomatic Skrooge terminology: operation -> transaction and pointed -> marked
Summary: rename non-idiomatic Skrooge terminology: operation -> transaction and pointe...
Status: RESOLVED FIXED
Alias: None
Product: skrooge
Classification: Applications
Component: general (show other bugs)
Version: Trunk from git
Platform: Flatpak Linux
: NOR normal
Target Milestone: ---
Assignee: Stephane MANKOWSKI
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2023-12-11 03:57 UTC by skierpage
Modified: 2023-12-17 11:26 UTC (History)
1 user (show)

See Also:
Latest Commit:
Version Fixed In:
Sentry Crash Report:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description skierpage 2023-12-11 03:57:49 UTC
SUMMARY
Some of the terminology used throughoug Skrooge in English is confusing and non-standard.

Skrooge uses the term "operation" a lot, the handbook says

> An operation is either a credit or debit to one of your accounts

But in English, an operation is a complex procedure with a lot of moving parts, such as a lung transplant, a military operation, or moving all your accounts to a new bank. The standard word for a credit or debit is "transaction". Every financial institution I use provides a way to "Download recent transactions" and/or "View your transaction history".

The handbook also says
"During the reconciliation process, you point all operations in Skrooge that appear in the corresponding account position. Such pointed operations display a half-filled square in the Status column of an operations view. A pointed operation is not Checked until you complete reconciliation."

But in English, you point at something with your finger, it's not an intransitive property of an item. I think "Marked" is probably a better word:
"You mark transactions that appear in the financial institution's account record... When you complete reconciliation the status of marked transactions changes to Checked; checked transactions won't appear in Skrooge's default transaction views."

("Marked" is synonymous with one meaning of "Checked", but since Checked operations/transactions appear with an actual checkmark in views, I think it's OK to keep Checked.)

SOFTWARE/OS VERSIONS
Linux/KDE Plasma:
KDE Plasma Version:  5.27.9
KDE Frameworks Version: 5.112.0
Qt Version: 5.15.10 on Wayland

ADDITIONAL INFORMATION

Do other English users share this confusion? I *think* it makes it harder for new users to use Skrooge. It would be a big change to the UI and the documentation, and unless dozens of variables are renamed, Skrooge's source code wouldn't match the terminology.

To see what others think I posted on KDE Discuss in Brainstorming  Skrooge 'Are other users confused by Skrooge's "operations" and "pointed"?'
Comment 1 Stephane MANKOWSKI 2023-12-14 20:36:33 UTC
Git commit e330b9d303aab29edbc13d49d6d82e3d424b0197 by Stephane MANKOWSKI.
Committed on 14/12/2023 at 21:36.
Pushed by smankowski into branch 'master'.

rename non-idiomatic Skrooge terminology: operation -> transaction and pointed -> marked

This is a fist commit.

M  +1    -1    .devcontainer/Dockerfile
M  +4    -4    README.md
M  +244  -244  doc/index.docbook
M  +2    -2    plugins/generic/skg_file/metadata.json
M  +1    -1    plugins/generic/skg_monthly/skgmonthlyplugin.cpp
M  +2    -2    plugins/generic/skg_undoredo/metadata.json
M  +2    -2    plugins/generic/skg_undoredo/skgundoredoplugin.cpp
M  +3    -3    plugins/import/skrooge_import_afb120/skgimportpluginafb120.cpp
M  +7    -7    plugins/import/skrooge_import_backend/backends/org.kde.skrooge-import-backend-weboob.desktop
M  +4    -4    plugins/import/skrooge_import_backend/backends/org.kde.skrooge-import-backend-weboob_coming.desktop
M  +7    -7    plugins/import/skrooge_import_backend/backends/org.kde.skrooge-import-backend-woob-ofx.desktop
M  +7    -7    plugins/import/skrooge_import_backend/backends/org.kde.skrooge-import-backend-woob.desktop
M  +4    -4    plugins/import/skrooge_import_backend/backends/org.kde.skrooge-import-backend-woob_coming.desktop
M  +2    -2    plugins/import/skrooge_import_backend/skgimportpluginbackend.cpp
M  +16   -16   plugins/import/skrooge_import_csv/skgimportplugincsv.cpp
M  +2    -2    plugins/import/skrooge_import_csv/skgimportplugincsv.h
M  +8    -8    plugins/import/skrooge_import_gnc/skgimportplugingnc.cpp
M  +3    -3    plugins/import/skrooge_import_gsb/skgimportplugingsb.cpp
M  +8    -8    plugins/import/skrooge_import_iif/skgimportpluginiif.cpp
M  +13   -13   plugins/import/skrooge_import_kmy/skgimportpluginkmy.cpp
M  +14   -14   plugins/import/skrooge_import_ledger/skgimportpluginledger.cpp
M  +2    -2    plugins/import/skrooge_import_mmb/skgimportpluginmmb.cpp
M  +8    -8    plugins/import/skrooge_import_mny/skgimportpluginmny.cpp
M  +2    -2    plugins/import/skrooge_import_mt940/skgimportpluginmt940.cpp
M  +6    -6    plugins/import/skrooge_import_ofx/skgimportpluginofx.cpp
M  +23   -23   plugins/import/skrooge_import_qif/skgimportpluginqif.cpp
M  +4    -4    plugins/import/skrooge_import_skg/skgimportpluginskg.cpp
M  +3    -3    plugins/import/skrooge_import_xhb/skgimportpluginxhb.cpp
M  +4    -4    plugins/krunner/skrooge_add_operation/metadata.json
M  +1    -1    plugins/krunner/skrooge_add_operation/skgaddoperation.cpp
M  +1    -1    plugins/skrooge/default/portfolio.html
M  +1    -1    plugins/skrooge/default/portfolio.qml
M  +1    -1    plugins/skrooge/default/unit_table.html
M  +1    -1    plugins/skrooge/detailed.txt
M  +2    -2    plugins/skrooge/skrooge_bank/skgaccountboardwidget.cpp
M  +4    -4    plugins/skrooge/skrooge_bank/skgbankplugin.cpp
M  +1    -1    plugins/skrooge/skrooge_bank/skgbankpluginwidget.cpp
M  +1    -1    plugins/skrooge/skrooge_budget/skgbudgetplugin.cpp
M  +2    -2    plugins/skrooge/skrooge_budget/skgbudgetpluginwidget.cpp
M  +4    -4    plugins/skrooge/skrooge_budget/skgbudgetpluginwidget_base.ui
M  +6    -6    plugins/skrooge/skrooge_categories/skgcategoriesplugin.cpp
M  +2    -2    plugins/skrooge/skrooge_importexport/metadata.json
M  +3    -3    plugins/skrooge/skrooge_importexport/skgimportexport_settings.kcfg
M  +31   -31   plugins/skrooge/skrooge_importexport/skgimportexportplugin.cpp
M  +1    -1    plugins/skrooge/skrooge_importexport/skgimportexportplugin.h
M  +15   -15   plugins/skrooge/skrooge_importexport/skgimportexportpluginwidget_pref.ui
M  +2    -2    plugins/skrooge/skrooge_operation/metadata.json
M  +4    -4    plugins/skrooge/skrooge_operation/skgoperation_settings.kcfg
M  +5    -5    plugins/skrooge/skrooge_operation/skgoperationboardwidgetqml.cpp
M  +2    -2    plugins/skrooge/skrooge_operation/skgoperationboardwidgetqml.h
M  +105  -105  plugins/skrooge/skrooge_operation/skgoperationplugin.cpp
M  +3    -3    plugins/skrooge/skrooge_operation/skgoperationplugin.h
M  +69   -69   plugins/skrooge/skrooge_operation/skgoperationpluginwidget.cpp
M  +2    -2    plugins/skrooge/skrooge_operation/skgoperationpluginwidget.h
M  +16   -16   plugins/skrooge/skrooge_operation/skgoperationpluginwidget_base.ui
M  +8    -8    plugins/skrooge/skrooge_operation/skgoperationpluginwidget_pref.ui
M  +1    -1    plugins/skrooge/skrooge_operation/skgsplittabledelegate.cpp
M  +1    -1    plugins/skrooge/skrooge_operation/skgsplittabledelegate.h
M  +1    -1    plugins/skrooge/skrooge_operation/skrooge_operation.rc
M  +2    -2    plugins/skrooge/skrooge_payee/skgpayeeplugin.cpp
M  +2    -2    plugins/skrooge/skrooge_payee/skgpayeeplugin.h
M  +1    -1    plugins/skrooge/skrooge_payee/skgpayeepluginwidget.cpp
M  +2    -2    plugins/skrooge/skrooge_payee/skgpayeepluginwidget.h
M  +1    -1    plugins/skrooge/skrooge_report/skgreport_settings.kcfg
M  +17   -17   plugins/skrooge/skrooge_report/skgreportplugin.cpp
M  +13   -13   plugins/skrooge/skrooge_report/skgreportpluginwidget.cpp
M  +6    -6    plugins/skrooge/skrooge_report/skgreportpluginwidget_base.ui
M  +1    -1    plugins/skrooge/skrooge_report/skgreportpluginwidget_pref.ui
M  +2    -2    plugins/skrooge/skrooge_scheduled/metadata.json
M  +2    -2    plugins/skrooge/skrooge_scheduled/skgscheduled_settings.kcfg
M  +2    -2    plugins/skrooge/skrooge_scheduled/skgscheduledboardwidget.cpp
M  +2    -2    plugins/skrooge/skrooge_scheduled/skgscheduledboardwidget.h
M  +33   -33   plugins/skrooge/skrooge_scheduled/skgscheduledplugin.cpp
M  +2    -2    plugins/skrooge/skrooge_scheduled/skgscheduledplugin.h
M  +13   -13   plugins/skrooge/skrooge_scheduled/skgscheduledpluginwidget.cpp
M  +2    -2    plugins/skrooge/skrooge_scheduled/skgscheduledpluginwidget.h
M  +7    -7    plugins/skrooge/skrooge_scheduled/skgscheduledpluginwidget_base.ui
M  +3    -3    plugins/skrooge/skrooge_scheduled/skgscheduledpluginwidget_pref.ui
M  +2    -2    plugins/skrooge/skrooge_search/metadata.json
M  +7    -7    plugins/skrooge/skrooge_search/skgsearchplugin.cpp
M  +2    -2    plugins/skrooge/skrooge_search/skgsearchplugin.h
M  +6    -6    plugins/skrooge/skrooge_search/skgsearchpluginwidget.cpp
M  +3    -3    plugins/skrooge/skrooge_search/skgsearchpluginwidget.h
M  +2    -2    plugins/skrooge/skrooge_search/skgsearchpluginwidget_base.ui
M  +2    -2    plugins/skrooge/skrooge_tracker/skgtrackerplugin.cpp
M  +2    -2    plugins/skrooge/skrooge_tracker/skgtrackerplugin.h
M  +1    -1    plugins/skrooge/skrooge_tracker/skgtrackerpluginwidget.cpp
M  +2    -2    plugins/skrooge/skrooge_tracker/skgtrackerpluginwidget.h
M  +1    -1    plugins/skrooge/skrooge_unit/skgunitboardwidget.cpp
M  +2    -2    plugins/skrooge/skrooge_unit/skgunitplugin.cpp
M  +16   -16   skgbankgui/skgobjectmodel.cpp
M  +2    -2    skgbankgui/skgobjectmodel.h
M  +32   -32   skgbankmodeler/skgaccountobject.cpp
M  +12   -12   skgbankmodeler/skgaccountobject.h
M  +3    -3    skgbankmodeler/skgbudgetobject.h
M  +3    -3    skgbankmodeler/skgcategoryobject.h
M  +19   -19   skgbankmodeler/skgdocumentbank.cpp
M  +22   -22   skgbankmodeler/skgimportexportmanager.cpp
M  +10   -10   skgbankmodeler/skgimportexportmanager.h
M  +18   -18   skgbankmodeler/skgoperationobject.cpp
M  +30   -30   skgbankmodeler/skgoperationobject.h
M  +3    -3    skgbankmodeler/skgpayeeobject.h
M  +8    -8    skgbankmodeler/skgrecurrentoperationobject.cpp
M  +10   -10   skgbankmodeler/skgrecurrentoperationobject.h
M  +5    -5    skgbankmodeler/skgreportbank.cpp
M  +8    -8    skgbankmodeler/skgreportbank.h
M  +13   -13   skgbankmodeler/skgruleobject.cpp
M  +1    -1    skgbankmodeler/skgruleobject.h
M  +2    -2    skgbankmodeler/skgsuboperationobject.cpp
M  +3    -3    skgbankmodeler/skgtrackerobject.h
M  +4    -4    skgbankmodeler/skgunitobject.h
M  +2    -2    skgbasegui/skgmainpanel.cpp
M  +2    -2    skgbasegui/skgobjectmodelbase.h
M  +4    -4    skgbasegui/skgperiodedit.cpp
M  +1    -1    skgbasemodeler/skgdocument.cpp
M  +1    -1    skgbasemodeler/skgdocument.h
M  +4    -4    skgbasemodeler/skgobjectbase.cpp
M  +1    -1    skgbasemodeler/skgobjectbase.h
M  +12   -11   skrooge/org.kde.skrooge.appdata.xml
M  +2    -2    tests/skgbankguitest/skgtestactions.cpp
M  +1    -1    tests/skgbankmodelertest/skgtestbigdocument.cpp
M  +6    -6    tests/skgbankmodelertest/skgtestimportcsv.cpp
M  +8    -8    tests/skgbankmodelertest/skgtestimportgsb.cpp
M  +2    -2    tests/skgbankmodelertest/skgtestimportkmy1.cpp
M  +1    -1    tests/skgbankmodelertest/skgtestimportkmy4.cpp
M  +1    -1    tests/skgbankmodelertest/skgtestimportkmy5.cpp
M  +3    -3    tests/skgbankmodelertest/skgtestimportofx.cpp
M  +1    -1    tests/skgbankmodelertest/skgtestinterest.cpp
M  +1    -1    tests/skgbankmodelertest/skgtestobjects.cpp
M  +4    -4    tests/skgbankmodelertest/skgtestoperation.cpp
M  +8    -8    tests/skgbankmodelertest/skgtestrecurrent.cpp
M  +1    -1    tests/skgbasemodelertest/skgtesttransaction.cpp

https://invent.kde.org/office/skrooge/-/commit/e330b9d303aab29edbc13d49d6d82e3d424b0197
Comment 2 Stephane MANKOWSKI 2023-12-17 11:26:37 UTC
Git commit 8020af88a2466d3df933d6be3ac71acbd38214cc by Stephane MANKOWSKI.
Committed on 17/12/2023 at 12:26.
Pushed by smankowski into branch 'master'.

rename non-idiomatic Skrooge terminology: operation -> transaction and pointed -> marked

M  +1    -1    plugins/import/skrooge_import_gnc/skgimportplugingnc.cpp
M  +2    -2    plugins/import/skrooge_import_gsb/skgimportplugingsb.cpp
M  +4    -4    plugins/import/skrooge_import_ledger/skgimportpluginledger.cpp
M  +1    -1    plugins/import/skrooge_import_pdf/skgimportpluginpdf.cpp
M  +3    -3    plugins/import/skrooge_import_qif/skgimportpluginqif.cpp
M  +2    -2    plugins/import/skrooge_import_xhb/skgimportpluginxhb.cpp
M  +2    -2    plugins/krunner/skrooge_add_operation/skgaddoperation.cpp
M  +1    -1    plugins/krunner/skrooge_add_operation/skgaddoperation.h
M  +3    -3    plugins/skrooge/skrooge_bank/skgbankplugin.cpp
M  +1    -1    plugins/skrooge/skrooge_bank/skgbankpluginwidget.cpp
M  +1    -1    plugins/skrooge/skrooge_bank/skgbankpluginwidget_base.ui
M  +1    -1    plugins/skrooge/skrooge_categories/skgcategoriespluginwidget.cpp
M  +3    -3    plugins/skrooge/skrooge_importexport/skgimportexportplugin.cpp
M  +25   -25   plugins/skrooge/skrooge_importexport/skgimportexportpluginwidget_pref.ui
M  +8    -8    plugins/skrooge/skrooge_operation/skgoperation_settings.kcfg
M  +14   -14   plugins/skrooge/skrooge_operation/skgoperationplugin.cpp
M  +2    -2    plugins/skrooge/skrooge_operation/skgoperationpluginwidget.cpp
M  +19   -19   plugins/skrooge/skrooge_operation/skgoperationpluginwidget_base.ui
M  +1    -1    plugins/skrooge/skrooge_payee/skgpayeepluginwidget.cpp
M  +2    -2    plugins/skrooge/skrooge_payee/skgpayeepluginwidget_base.ui
M  +6    -6    plugins/skrooge/skrooge_scheduled/skgscheduledplugin.cpp
M  +1    -1    plugins/skrooge/skrooge_scheduled/skgscheduledpluginwidget.cpp
M  +1    -1    plugins/skrooge/skrooge_search/skgsearchplugin.cpp
M  +1    -1    plugins/skrooge/skrooge_tracker/skgtrackerplugin.cpp
M  +1    -1    plugins/skrooge/skrooge_unit/skgunitpluginwidget.cpp
M  +1    -1    skgbankmodeler/skgaccountobject.cpp
M  +2    -2    skgbankmodeler/skgdocumentbank.cpp
M  +1    -1    skgbankmodeler/skgdocumentbank.h
M  +3    -3    skgbankmodeler/skgimportexportmanager.cpp
M  +1    -1    skgbankmodeler/skgimportexportmanager.h
M  +1    -1    skgbankmodeler/skgoperationobject.cpp
M  +14   -14   skgbankmodeler/skgoperationobject.h
M  +6    -6    skgbankmodeler/skgsuboperationobject.h
M  +1    -1    skgbankmodeler/skgtrackerobject.h
M  +1    -1    skgbasegui/skgdateedit.cpp

https://invent.kde.org/office/skrooge/-/commit/8020af88a2466d3df933d6be3ac71acbd38214cc