Bug 494077

Summary: document History panel and better document viewing transactions modified by an action
Product: [Applications] skrooge Reporter: skierpage <info>
Component: generalAssignee: Stephane MANKOWSKI <stephane>
Status: RESOLVED FIXED    
Severity: normal    
Priority: NOR    
Version: Trunk from git   
Target Milestone: 25.1.0   
Platform: unspecified   
OS: All   
Latest Commit: Version Fixed In:
Sentry Crash Report:

Description skierpage 2024-10-04 01:24:39 UTC
SUMMARY
Skrooge has powerful actions like Tools > Find and group transfers. After you run them it's hard to tell what they changed. Skrooge provides two ways to view the affected transactions, Go > Open last modified... and the History panel's context menu, but only the first is documented and its use isn't motivated.

STEPS TO REPRODUCE
1. Run File Import or one of the commands in the Tools menu.

OBSERVED RESULT
It's not clear how to tell what's been altered by the action.


EXPECTED RESULT
The  feature should be documented better. The History panel doesn't seem to be mentioned anywhere in the Skrooge Handbook and there's no Panels section. Here's one approach to adding it.

In 2.15 Undo / Redo, add:
Many actions in Skrooge, including import and commands in the Tools menu, create or affect many transactions. Instead of undoing the entire action, you can use Go > Open last modified... or the History panel (see XXX) to view the transactions modified by it and edit particular transactions.

In 3.4 Transactions, add:

3.4.11 Viewing Modified Transactions
You can use Go > Open last modified... to view the transactions modified by your last action. Furthermore, Skrooge keeps a record of all changes to transactions in its History panel. To see this panel, choose View > Panels > History. You can then right-click on any action in the History list and choose Open transactions modified by this transaction...

(I notice there's no help on panels in the handbook where the History panel could be documented. If there was documentation for the various actions in the Tools menu, it could link to this new "Viewing Modified Transactions" subsection.

SOFTWARE/OS VERSIONS
all

ADDITIONAL INFORMATION

I got the tip from https://discuss.kde.org/t/how-to-find-out-what-find-and-group-transfers-did/16628

The command in the history panel's menu (in 
plugins/skrooge/skrooge_operation/skgoperationplugin.cpp should be "Open transactions modified by this action" instead of repeating "transaction" twice. (Fix this first!)

There's no documentation of Panels, but there are references to the Editing panel at the bottom of most views (slightly confusing because it isn't in the View > Panels list) and the Search plug-in's "Process definition panel". This is slightly confusing, maybe call the thing in views a "subpanel"?
Comment 1 Stephane MANKOWSKI 2024-12-28 12:52:36 UTC
Git commit d8bb72801086c3ba7b1d3331ff90f5044c61f0eb by Stéphane MANKOWSKI.
Committed on 28/12/2024 at 12:52.
Pushed by smankowski into branch 'master'.

document History panel and better document viewing transactions modified by an action

M  +9    -21   doc/index.docbook
M  +3    -1    doc/kde_docbook
D  +-    --    doc/settings_dashboard.png

https://invent.kde.org/office/skrooge/-/commit/d8bb72801086c3ba7b1d3331ff90f5044c61f0eb