We still need help from native-English users to help us fix the remaining issues in our documentation.

This is your chance to contribute!!!

Another tranch of comments:

Comments on KMyMoney PDF handbook

As the link I was using previously is no longer available, these comments relate to the PDF documentation.

Chapter 14

After 'Taxes', I have:

Budgeting
Forecast
General information
Charts

before 'Favourites' all of which need some explanation.

Working with reports

This needs to rewritten as there are new options, 'Save' has become 'Export' (I assume) and there is no 'Print' option.

I have:

[Chart] Configure New Copy Export Delete Close

[Insert section for 'Chart']

Configuring Reports

I suggest deleting the entire section 'Working with custom reports' and replacing it with the two sentences:

You can configure the default reports or create your own from them by selecting 'New' and then configuring the new report.

When you select 'Configure' you will be presented with the Report Tab.

Report Tab OK

Rows/Columns Tab

This varies between reports; the example shown is a transaction report but the text in this section appears to relate to a type of income and expense report that has been revised.

Other tabs

This paragraph is true of all but Chart which needs an explanation here.

I suggest that there is a clickable reference to the Search Transactions section here and that it comes before Reports in the handbook.

After Reports, there need to be new chapters on

Budget
Forecast

Chapter 15. Importing and Export

I haven't used this facility at all; so I can only comment on the English but I wonder whether this would be better immediately after Chapter 6 Accounts as, logically, new users will want to know this alternative way of starting to use KMyMoney.

GnuCash Importer

Similarities, Differences and Terminology

Accounts

Categories

. . . Category to denote an accounting allocation within an Income or Expense account. Unlike GnuCash, . . . entry of transactions directly into categories is not supported; allocations are made during transaction entry into other account types.

Selecting Importer Options

If the graphic below this heading is still valid, it needs to be resized.

QIF Importer

How to import a QIF file

The last sentence is repeated in the next section; I suggest one is deleted.

Chapter 16. Loans

I think this chapter would be much better before Categories as it is really about a type of account.

Understanding Loans

. . . agreement under which a borrower . . . agrees to repay the money . . . KMyMoney allows you to track loans by which you, as borrower, borrow money from or, as lender, lend money to someone else. Most individuals borrow more than they lend. So you will generally be the borrower and a finance company will generally be the lender. If you lend money to a family member or a friend, you can use KMyMoney to keep track of this loan as well.

. . . from a finance company, but . . . The main difference . . . an expense category is used to . . . an income category is used . . .

Loan Amount. . . . "loan principal".

Term. The period of a loan is called its "term". . . Terms are generally expressed in weeks, months or years. A term can also be expressed by the number of payments. For example, a one year loan with weekly repayments could be described as a one year loan or a loan with 52 repayments.

Payments - change to Repayments

Repayments. The repayment of the principal . . . not made as a lump sum. Instead, a series of repayments each representing a portion of the principal are made. Such repayments are sometimes known as "amortization payments" and in KMyMoney "amortization" is defined as the act of paying off a loan in installments.

Move 'Since these . . .' after 'Interest Rate' and amend as follows:

Since these repayments are generally made on some sort of scheduled basis, such as weekly, monthly, quarterly or yearly, they are referred to as "periodical repayments". The sum of all periodical repayments plus the final repayment will add up to the loan principal plus the interest.

Delete the heading 'Payment Frequency' and amend the resulting sentence as follows:

The frequency of installments is referred to as "Payment Frequency"in KMyMoney.

Interest Rate. . . . fee called the "interest", normally expressed as a percentage of the amount of the principal over a defined period. . . . each periodical repayment.

Fees. . . . required to be paid with every installment. . . . recurring fees include:

Summary; I think this is superfluous and can be deleted.

Example

For example, . . .

In this scenario, . . . one payment per month for 5 years. The repayment frequency is one month since periodical repayments will be made once a month. The periodical repayment, . . ., will be $477.53.

['Period' is normally used in England as a synonym for 'term' - I hope my suggestions don't confuse others]

. . . date that a repayment should . . . each periodical repayment. Often, these schedules break the periodical payment down into its constituent parts: the principal repayment, the interest . . .

Creating a New Loan OK

Making Extra Principal Repayments On Loans [note changes]

. . . extra principal repayment, you can do so. . . . extra repayment of principal will be taken into account for the interest calculation that
happens at the next installment.

Examples of extra principal repayments include:

. . .
• Doubling the periodical principal repayment for every period. (The principal repayment in any installment can be found by referring . . .
• Making a 13th principal repayment every year (This assumes a loan that is repaid in monthly installments.)

Note: . . . principal repaid with each installment, you will need to recalculate the loan schedule for each installment. This will allow there to be an accurate value for the required principal repayment with each installment.

Chapter 17. KMyMoney Settings

General

Delete 'These options allows you to modify the general options.'

Global Tab [new subheading]

Startup page options

Replace subheading 'Equity/Currency/Value options' with 'Precision settings'

Autosave options [new subheading]

Autosave periodically Check this box if you wish KMyMoney to autosave your files periodically

Fiscal year [new subheading]

Enter the starting day and month of your fiscal year

Views Tab [new subheading]

[I don't know enough about the purpose of these options to offer a suggested text]

Filter Tab [new subheading]

Replace 'Account options' with 'Accounts/Categories'

Don’t show unused categories
Check box to hide unused categories.

Don’t show closed accounts
Check box to hide closed accounts.

Schedules [new subheading]

Don’t show finished schedules
Check box to hide finished schedules.

Transactions [new subheading]

Don’t show transactions prior to
Enter the date after which you wish transactions to be displayed.

Don’t show reconciled transactions
Check box to hide reconciled transactions.

Register

Delete 'These options allow you to modify the behaviour of the transaction registers.'

Replace 'General Tab' with 'Display Tab'

Show a grid in the register OK
Use the ledger lens OK

Show transaction form
. . . you edit the transaction within the register itself.

Always show a No. field [note changed entry]

Show group header between transactions [new entry]

[Description required]

Show header for the previous and current fiscal year [new entry]

[Description required]

Sorting Tab [new subheading]

Normal View Tab [new subheading]

Reconciliation View Tab [new subheading]

Search View Tab [new subheading]

[Descriptions required]

Data entry Tab [new subheading]

Insert transaction type into No. field for new transactions OK
Auto increment check number OK
Keep changes when selecting a different transaction/split OK

Use Enter to move between fields [new entry]

[Description required]

Default reconciliation state [new entry]

[Description required]

Autofill [new subheading]

'Auto fill with previous transaction data' needs rewriting to reflect the three options now available.

Matching Tab [new subheading]

[Description required]

Delete 'Filter tab' section as now covered above under 'Accounts/Categories'

Home

[Descriptions required of the options on this page]

Schedules

Delete 'These options allow you to modify the behaviour of the scheduling features.'

Startup options [note change]

Check schedules upon startup OK
Enter transactions this number of days in advance OK

Number of days to previous schedules in ledger [new subheading]

[Description required]

Encryption

Delete 'These options allow you to modify the data encryption settings.'

Use GPG encryption [note change - otherwise OK

GPG Encryption [new subheading]

[Description required]

Delete 'User identification' section and move 'Recovery encryption' contents within new 'GPG Encryption' section

Colors [note spelling for consistency with interface]

Delete 'List colours' section

Foreground Tab [new subheading]

[Description required]

Background Tab [new subheading]

[Description required]

Fonts

Delete 'These options allow you to modify the fonts.'

Use system fonts OK

Individual font settings [new subheading]

Reverse the entries for 'Header font' and 'Cell font'

Online Quotes

Delete 'These settings modify how online quotes are retrieved from different online sources.'

Delete subheading 'Details' but leave the text of this section.

Forecast [new page]

[Description required]

Plugins

This page shows if you have the OFX plugin installed.

The online help has been fixed. Thanks to Thomas.

I will work on adding your suggestions. Thanks!

I was trying to figure out a way to read the docbook files directly, uncluttered by all the tags. Supposedly, OpenOffice has a docbook filter that can import/export docbook XML, but when I import these docbook files, they still come in with all of the tags instead of formatting.

At http://kmymoney2.sourceforge.net/index-gen.html... for some reason, the HTML manual is for 0.9 but the PDF manual is for 0.8. Is there a way to get a PDF manual for 0.9?

I was referring to the manual to try to figure out how transaction matching works. I have some credit card payments that appear in the imported credit card QIF and also in my imported bank statement QIF. They are separated a couple days from each other. As far as I can figure out these still need to be matched by hand.

I would like to propose an improvement to Matching Transactions...

Note

The matching interface will not allow you to match two transactions which have both been imported or which have both been entered manually. [s]Likewise, it won't allow matching between two transactions which have both been entered by hand.[/s] Matching is only possible between one imported transaction and one manually entered (non-imported) transaction.

playing a bit more with the matching, I found....
My imported bank statements/ledger did not have payee or category information. (The Memo field contained the imported text notes.) After I set the Pay to (credit card payee) and Transfer to (my credit card category), this transaction appeared in my credit card ledger. So then, when I switched to the credit card ledger, two transactions were listed. Apparently, one of these was then considered non-imported because I was allowed to select the two transactions and select Match.

When I duplicate a transaction, then edit the date (to try to make it appear "hand-entered"), I am still not allowed to perform a match between the duplicate and the original. If I set the From or To field, I am still not allowed to match.

I believe the important thing in order to allow a transaction match is to assign a category in one of the transactions. Once I do this, I am able to perform matching with it, even if the From or To field is empty.

So, I think this is incorrect...

The solution is to tell KMyMoney that the transactions are the same, using the manual matching interface. This allows you to match an imported transaction with a hand-entered (non-imported) transaction.

[s]To do so, right-click on one of the transactions to be matched. Choose Match Transactions... from the context menu. This flags the selected transaction, and changes the background color to a nice pale green.

Next, right-click on the other transaction to be matched. Choose Match with this Transaction. This will match the two transactions together. The values of both transactions must be the same for the match to work.[/s]

For me it is working more like this....

To match two transactions, select both of the transactions to be matched. Then right-click on one of them and select Match.

Transaction matching requires all of the following to be true:

• One transaction must be imported
• One transaction must be manually entered (non-imported). If you manually select a category in a transaction KMyMoney recognizes it as manually entered.
• The values of the two transactions must be equal.

Note

In the future, matching will be made more automatic. The importer will automatically match transactions which look like the same, and give you the option to un-match them.

[s]Note

The matching interface will not allow you to match two transactions which have both been imported. Likewise, it won't allow matching between two transactions which have both been entered by hand.[/s]

Can you post this in a separate thread, where we can follow the problem you are having in a more ordered way, please? Since you are learning to use the transaction matching, it can become quite lengthy, and this thread is only for the documentation update.

Here is the final tranche; it's nice to see how well things are shaping up in the HTML version.

Comments on KMyMoney HTML handbook

Chapter 17. Budgets OK

[I have not used this facility yet but the text seems OK]

Chapter 18. Forecast

What is a Forecast?

. . . a Forecast is a prediction . . .

Viewing Forecasts OK

Chapter 19. KMyMoney Settings [changes already submitted from the PDF version]

Chapter 20. Search Transactions

[This is accessed by Edit>Find transaction; so I would suggest this heading be changed to 'Find transactions' - entailing consequent changes elsewhere in the handbook.]

General

[Needs to be re-written as the interface has changed]

Criteria Tab [new subheading]

Text [note change]
Account [note change]
Date [note change]
Amount [note change]
Category [note change]

[For the five sections above, the graphic is incorrect but the text is OK]

Payee [note change]

[The graphic is incorrect and is also the Category graphic; the text is OK]

Details [note change]

[The graphic is incorrect but the text is OK]

Results Tab [new subheading]

The results tab displays the Date, Account, Details, Reconciliation status, Payment and Deposit for each transaction that matches the search criteria you have entered.

[There may be other things you want to say about this as I have only done a simple search in order to write the above.]

Chapter 21. File Formats

. . . the user's storage device. [rather than 'disk' as flash drives may become more popular as storage devices - perhaps a change on which you might need to do a search and replace]

Plain text file

. . . It is not intended for normal use but is provided to support debugging and the capability . . .

GZIP-compressed file OK

GPG-encrypted file

. . . method of storing . . . your storage device. . . . actually storing it. . . .

GPG-Keys

[The URL is invalid but the text is OK]

Setting the keys in KMyMoney

. . . identification as the value for this field. . . .

Caution

. . . have both the public . . . [no comma]


The KMyMoney recover key

. . . the choice of selecting . . . even if you lose . . .

[Is there any change in those who can access this facility?]

Anonymous file

. . . method of supplying . . . as the file extension . . .

Chapter 22. Database Usage

Database usage [delete second occurence of this heading]

Introduction

. . . export data to an external program, for example, a budgeting application. [though I cannot see any use for that when KMyMoney has such a good budgeting module]

Preparation OK

Administration

. . . tasks such as creating databases, . . .

Initialisation [rather than Initial usage; text is OK]

Accessing your data OK

Encryption

. . . data in your . . .


Chapter 23. Reference

Menus

File>Open database [new entry after 'Open recent']

File>Personal Data
File>File-Information [new entries after 'Backup']

Delete all of 'Go Menu'

View Menu [new subheading]

Show transaction detail (Ctrl-T) [n.b. why are the 't' and 'd' upper case on the interface?]

Hide reconciled transactions (Ctrl-R)

Hide unused categories (Ctrl-U)

Show all accounts (Ctrl-Shift-A)

Institution Menu

Institution->New institution...
Add a new institution.

Institution->Edit institution...
Edit an institution.

Institution->Delete institution...
Delete an institution.

Account Menu

Account->New account
Add a new account

Account->Edit account
Edit an account

Account->Delete account
Delete an account

N.B. You cannot delete an account which has any links with transactions in another account

Account->Open Ledger
[Description required]

Account->Reconcile (Ctrl-Shift-R)
Reconcile an account through the reconciliation wizard.

[Delete 'Account->Find transaction... (Ctrl-f)
Find a transaction']

Account->Postpone
Postpone a reconciliation

Account->Finish
Finish a reconciliation

Account->Transaction Report
Account->Close account
Account->Reopen account
Account->Unmap account
Account->Map to online account
Account->Update account
Account->Update all accounts
[Descriptions for seven above required]

Account Menu

Category->New category
Add a new category

Category->Edit category
Edit a category

Category->Delete category
Delete a category

N.B. You cannot delete a category whose value is non-zero [I think]

Category->Open Ledger
[Description required]

Transaction->New
Enter a new transaction

Transaction->Edit
Edit a transaction

Transaction->Edit splits
Edit a split transaction

Transaction->Delete
Delete a transaction

Transaction->Duplicate
[Description required]

Transaction->Mark transaction as

Mark transaction

Not reconciled
Cleared (Alt-Ctrl-Space)
Reconciled (Ctrl-Shift-Space)

[Descriptions required - not sure of the best style here]

Transaction->Go to account
Transaction->Go to payee
Transaction->Create schedule
Transaction->Match
Transaction->Accept
Transaction->Combine
Transaction->Select all
[Descriptions required for seven above - not sure of any subtleties]

Tools Menu

[Add entries and descriptions after existing entries for:]
Tools->Consistency Check
Tools->Performance-Check
Tools->Debug Traces
Tools->Debug Timers

Settings Menu

[Replace existing entries with:]

Settings->Hide toolbar
Toggles toolbar off or on

Settings->Hide statusbar
Toggles bottom status bar off or on

Settings->Enable all messages
Re-enables any messages you may have turned off by checking Don't tell me about this again in a dialog box.

Settings->KDE Language settings
[Description required]

Settings->Configure Shortcuts
Configure custom shortcuts

Settings->Configure Toolbars
Customize toolbars

Settings->Configure KMyMoney
Configure KMyMoney settings

Help Menu

[After 'Report Bug' insert:]

Help->Switch application language
[Description required]

Widgets

Date entry widget

. . . of a transaction or the opening date . . . it offers the user . . .

. . . Clicking on the day, month or year field . . .

Value entry

. . . pop up and allow you . . .

Payee/Payer entry

. . . additionally requires you to select . . .

Category/account entry

. . . requested to enter . . . requires you to select . . .

Chapter 24. Credits OK

Sorry to intervene in an 'inner' subject, but shouldn't be referenced also Alvaro Soliverez (who has done a huge work at the reports) at the last page of the Documentation (at least at the 'Special Thanks' sector)?
And, is the date "16/07/2005" the right one to be referenced after 'Revision 0.9' at the start?

Chapters Reports, Import and Export, Loans, Settings and Forecast have been updated.
I also changed some of the order of the chapter to better suit the expected workflow.
I left the import and export chapter in the middle, but I think a user has to know about accounts and categories before going for an import, otherwise it will be a mess.

Going through the rest of the changes now.

Finished with the reviews. Updated the Formats, Index, Introduction, Credits, Database, and Reference chapters.

Thomas, please check the Credits chapter for any other missing contributors. I added those I could remember, but that's not always fair.

I think the documentation will be in a much better shape. It is still in need of love, but it is workable now.

Hei Ku wrote:Finished with the reviews. Updated the Formats, Index, Introduction, Credits, Database, and Reference chapters.

Thomas, please check the Credits chapter for any other missing contributors. I added those I could remember, but that's not always fair.

I think the documentation will be in a much better shape. It is still in need of love, but it is workable now.

Hi Alvaro

Would it help if I were to 'proof read'? Are we talking about the html Users' Manual on Sourceforge? I think I've spotted one or two points there.

Allan

Sure, help is always welcome. Check the latest version, because it has been updated today.

Hei Ku wrote:Sure, help is always welcome. Check the latest version, because it has been updated today.

Hi Alvaro

Here's the first part. Hope I'm not undoing any of John's work!

First page
- Revision 0.9 (08/05/2009) - Date format not consistent with other docs.
List of Tables
- Should 15.1 align with other chapters, with colour blue.
Chapter 2
- What's new - Wondering if this should be renamed (e.g. Functionality) as most links do not go to new functionality. e.g. Investments links to Revision 0.8 (2005-07-20) i.e. not new. Ditto for Multiple Currencies.
- GnuCash - Not dated.
- OFX - Not dated.
- etc.
Chapter 3
- Para beginning 'You could go ahead...' - change to 'Whilst you could go ahead, click some buttons and fill in some data, after a time you might decide you have done it wrongly and start again, even though you might have read the documentation on each part of KMyMoney....'
- Useful Tips - After sentence beginning 'When you make a payment, KMyMoney will work out what the next cheque number should be;..' add 'Alternatively, it is possible to switch off auto-increment of cheque numbers.'
Chapter 4
- Creating accounts - Using the menu. Amend to 'To create an account using the menu select Account->New account. Last line, Ledger should be Ledgers.
- Searching for transactions - '....or by selecting Find Transaction from the Account menu'. I don't have this option in the Account menu. I have a separate Edit->Find.. menu item, which perhaps might better be named Find rather than Edit?
- Reconciliation - Amend second paragraph to 'To reconcile an account, first select the account, either from Accounts view or from Ledgers view. Then, either click on the Reconcile icon in the Toolbar, or click on Reconcile in the Account menu.'
- Backing up - First line should be '...it's a good idea to perform a backup (apostrophe).'
- Contacting the developers / Reporting Bugs - Include specific steps - The example is referring to tabs. Perhaps instead, something like 'Using the transaction form, I entered a new transaction in my Credit Card account, entered the date and payee, went back to amend the date, and KMyMoney crashed. This bug is fully reproducible for me.'
Chapter 5
- Second paragraph - The Institutions screen also shows the value of each account and the total number of transactions in each account. I don't see the number of transactions in each account.
- Institution Options - The image format has been changed.
- Account Options - The image format has been changed.
Chapter 6
- Second paragraph - List view shows the name, number of transactions, and balance or value of each account. I don't see the number of transactions.
- Creating an Account - Amend 'To create a new account, you can either select Account->New from the menu or choose the New icon from the toolbar.' to '...Account->New account'.
- The institution (Bank) name - 'The first step involves setting an institution for the account. If this is not a bank account, or if you do not want to use online banking, this step can optionally be skipped; just click Next.' Not sure if online banking is still relevant here? Ditto for third paragraph.
- Opening / viewing accounts - Add as second sentence 'Alternatively, in the Accounts view, either double-click the account entry or right click and select Open ledger'.
- Editing Account Information - End of first sentence, amend to 'Edit account' Also, the image has changed. Is the last sentence still relevant? I don't understand it.
- Deleting accounts - Amend in second paragraph 'See Settings->Configure->Register->Filter. ... ' to 'See Settings->Configure KMyMoney->General->Filter.'

aga

What's new has to be updated with the latest features. I have to go through the 0.9.x releases and collect all those into a single document.

The date has the dd/mm/yyyy format.

I updated most of the other stuff.

Thanks a lot, Allan!

Hei Ku wrote:What's new has to be updated with the latest features. I have to go through the 0.9.x releases and collect all those into a single document.

The date has the dd/mm/yyyy format.

I updated most of the other stuff.

Thanks a lot, Allan!

I think I was unclear when I said "compared with other docs." What I meant was other pages within the Help Manual, as shown in my quote:-

Revision 0.9 (08/05/2009) - Date format not consistent with other docs.
List of Tables
- Should 15.1 align with other chapters, with colour blue.
Chapter 2
- What's new - Wondering if this should be renamed (e.g. Functionality) as most links do not go to new functionality. e.g. Investments links to Revision 0.8 (2005-07-20)

I'll continue when I'm able.

aga