Bug 379747

Summary: Stable documentation is not up to date
Product: [Applications] kmymoney Reporter: Ralf Habacker <ralf.habacker>
Component: generalAssignee: KMyMoney Devel Mailing List <kmymoney-devel>
Status: CONFIRMED ---    
Severity: normal CC: lueck
Priority: NOR    
Version: 4.8.0   
Target Milestone: ---   
Platform: Other   
OS: All   
Latest Commit: Version Fixed In:
Sentry Crash Report:
Bug Depends on: 381813    
Bug Blocks: 403474    

Description Ralf Habacker 2017-05-12 10:44:01 UTC
The stable documentation is not up to date. The website https://kmymoney.org states version 4.8.0 is the latest version while the KMyMoney onlines docs are older: 

en - version 4.7 - https://docs.kde.org/stable4/en/extragear-office/kmymoney/index.html 
de - version 4.6 - https://docs.kde.org/stable4/de/extragear-office/kmymoney/index.html
es - version 4.6 - https://docs.kde.org/stable4/es/extragear-office/kmymoney/index.html
...
Comment 1 Ralf Habacker 2017-05-31 22:01:36 UTC
More details: The payee default account tab not documentated
Comment 2 Ralf Habacker 2017-11-24 22:33:19 UTC
First I collected all files having release info != 4.8.1, which are

doc/credits.docbook
doc/details-accounts.docbook
doc/credits.docbook
doc/details-budgets.docbook
doc/details-categories.docbook
doc/details-currencies.docbook
doc/details-database.docbook
doc/details-forecast.docbook
doc/details-formats.docbook
doc/details-institutions.docbook
doc/details-investments.docbook
doc/details-ledgers.docbook
doc/details-loans.docbook
doc/details-payees.docbook
doc/details-reconciliation.docbook
doc/details-reports.docbook
doc/details-schedules.docbook
doc/details-search.docbook
doc/details-settings.docbook
doc/details-tags.docbook
doc/details-widgets.docbook
doc/faq.docbook
doc/firsttime.docbook
doc/installation.docbook
doc/makemostof.docbook
doc/reference.docbook

Here are a few notes I found on reviewing the mentioned docbook files:

doc/details-accounts.docbook:details.accounts.edit - image is missing checkbox "opening balance account"
doc/credits.docbook - cannot say if up to date
doc/details-categories.docbook - okay
doc/details-currencies.docbook - image does not have "New currency", "delete currency"
doc/details-reconciliation.docbook - german translation - "Clearing transactions" - not translated image
Comment 3 Jack 2017-11-25 01:12:50 UTC
doc/details-reconciliation.docbook - german translation - "Clearing transactions" - not translated image
I never thought about whether all images in the translated manual are the originals, or if someone has gone to the effort of replicating every image in the appropriate translation.  If this one image is different from the others, then I suppose the German translation team is who should fix it.

doc/details-accounts.docbook:details.accounts.edit - image is missing checkbox "opening balance account"
doc/details-currencies.docbook - image does not have "New currency", "delete currency"
I do not think it is worth replacing the images, especially if it would mean they also need to be replaced in the translated versions, but I will add notes in the text about the new features.
Comment 4 Jack 2017-11-25 23:00:05 UTC
(the following changes are still only in my local repository.  I will defer pushing them until I have done all of them referred to here.)

I have added a general note to the introduction that some chapters of the manual may not be fully up to date.

doc/details-currencies.docbook - image does not have "New currency", "delete currency"
I have updated this chapter to refer to these new buttons.

doc/details-accounts.docbook:details.accounts.edit - image is missing checkbox "opening balance account"
This checkbox only appears when editing an equity account.  Can someone please confirm that this was added to let a user create an account other than the original "Opening Balances" account to hold amounts used as opening balances for other accounts.  To use it, you must first create another equity account, then edit that account, and check the box.
Comment 5 Thomas Baumgart 2017-11-26 10:27:39 UTC
Regarding the opening balances checkbox: it has been added to identify an equity account as the opening balances account for a currency. This was needed to allow the user to change the name of the opening balances account. Otherwise, the application insists of using only "Opening balances" possibly translated but otherwise fix. In various cases, the checkbox is grayed out (disabled). Hovering over it with the mouse will show a tooltip explaining why it is disabled.
Comment 6 Jack 2018-08-30 21:46:52 UTC
Just a status update - about half the manual was updated for 5.0.  New screenshots have been committed for 5.0.2.  We now have three people working on updating the rest of the manual, but it is not likely to be done in time for 5.0.2, hopefully it will be complete for 5.1 (not yet scheduled)
Comment 7 Ralf Habacker 2019-01-26 22:01:47 UTC
With 4.8.3 nothing has been changed in the doc. Will rethink on making release 4.8.4 to update version numbers.
Comment 8 Jack 2023-08-29 21:36:22 UTC
I apparently forgot about this bug, but I can add some information.  At this point, there has not been any further work on anything related to the 4.8 releases in a long time, and I doubt there will be.  The manual in the 5.1 branch of git has been updated in several areas since this bug was filed, and there is a page in the handbook listing which chapters have and have not been updated, but is still not fully updated for 5.x.  While there may be a 5.1.4 release, I do not plan on putting any further effort towards the documentation for 5.1.
I have recently started a complete review of the handbook based on the code in master branch.  I am about 1/3 of the way through a first pass.  This can be viewed in the Handbook-5.2 branch of git.  I am only pushing my updates when I have gone through several additional chapters.  I am not initially pushing this to master branch, so the translators do not have to deal with multiple changes while I continue to make multiple repeat changes to some sections.  The intent is that this will be ready about the same time master branch is ready for a release we have been calling 5.2 - some time later this year.