You are right. I will change the other ones to the dd/mm/yyyy format. Sorry I missed that.

Hei Ku wrote:You are right. I will change the other ones to the dd/mm/yyyy format. Sorry I missed that.

The date format - one of my favorite subjects - as chosen above is ambiguous. Usually, the delimiter / is used in the US where the format is mm/dd/yyyy. In Europe we use the dot as delimiter and it is dd.mm.yyyy. Using the proposed European placement together with the US delimiter is misleading and you cannot tell if 08/05/xx is the "8th of May" or the "5th of August". Although, I just noticed that dd/mm/yyyy is used in Brazil. Very confusing. :-S

I suggest to stick with yyyy-mm-dd which is non-ambiguous as it is the ISO 8601 specified format.

More info can be found here:

http://en.wikipedia.org/wiki/ISO_8601
http://en.wikipedia.org/wiki/Date_format#Date_format

The dd/mm/yyyy is used in Argentina and I think all other Spanish-speaking countries too.

I agree that the yyyy-mm-dd is the most non-ambiguous format. Should we change all the docs to that format?

In KMyMoney itself, I have dd/mm/yyyy which may have been set by my choice of locale as I cannot see anywhere within the KMyMoney settings to change it.

But if that is the standard KMyMoney format, I suggest the docs should follow it.

The date format in KMyMoney follows the KDE locale settings.

Here's another batch of suggested documentation updates.

Chapter 7
- Images not current.
- Creating categories - Amend to "To create a new category, either select Category->New category in the menu, or in the Categories view, select a parent in the tree and right click to bring up the popup menu, then select the New Category option. Either way will open the Create new categories wizard. Enter the new category name, then in the Hierarchy tab, ensure the required parent account is selected. Finally, the Tax tab enables VAT support (See following section)."
- Editing a Category - Amend to "To edit a category, right-click on a category name, and choose "Edit category". A window comes up, with three tabs, "General", "Hierarchy" and "Tax". The General tab allows you to edit the name of the category and the Hierarchy tab enables changing its parent category. Changing the parent category is also possible from the main category page by dragging the category to a different parent. The Tax tab enables automatic VAT assignment (See following section)."
- Deleting categories - Amend to "To delete a category select it in the tree and right click to bring up the popup menu and select Delete category. Deleting is only possible if there are no transactions under that category. If there are any dependent items, a popup will allow these to be moved to another parent category. If you try to delete a parent category, a dialog allows the choice of either having the sub-categories moved up one level or alternatively having them all deleted at the same time."

Chapter 8
- Images not current.
- Amend second paragraph to "The Payees screen allows for viewing the transactions for the selected payee, updating personal information associated with a particular payee or payer, and specifying transaction matching criteria.
- Adding a Payee or Payer - Amend to read "To add a payee or payer, right-click on any payee name and choose 'New payee'. This creates a new payee called 'New Payee.' Right-click on this payee and select 'Rename payee' to enter the name of the new payee or payer.
-Renaming a Payee or Payer - Amend to read "To rename a payee or payer, simply right-click on the name and the name becomes editable. Changing the name will affect the name in all the transactions in which it appears."
- Deleting a Payee or Payer - Add as final sentence "You will be presented with a dialog to allow reassignment of transactions to a different payee", and also a check box to enable a deleted name to be added to the new payee's matching list.
- Personal Information - Image not current.
- Amend first sentence to "To view and edit the personal information associated with a particular payee, select the payee from the list and select the Address tab."
- Transaction Matching Settings - Setting up - Amend first sentence to "From the Matching tab, you can set the Transaction Matching Settings. You have 3 major options:"
- Viewing Transaction History - Image not current.

Chapter 9
- Schedules - Introduction - Add to fourth paragraph "Scheduling a payment can also provide a useful reminder that you need to make a payment."
- The types of schedules - Swap positions of Transfers and Loans (twice), to reflect the current appearance.
- The schedule view - Image not current.
- The new schedule dialog - Image not current. {{New write-up will then be needed to correspond to revised section identifiers (A/B/C etc.)
- The calendar view - Image not current.
- Entering scheduled transactions - Image not current.
- In parapraph between images, last sentence reads "If you have changed any of the transaction data a further confirmation of what you intend will be displayed." {{ For me, any amendment is accepted without confirmation.}}

Chapter 10
-Ledgers - The Ledger View - Image not current.
-The view has three elements - Amend C to 'The transaction input form, which may or may not appear, depending upon Settings/Configure KMyMoney/Register/Show Transaction Form.'
- The transaction list - The first sentence suggests that transactions are displayed when you have entered "some". Suggest instead 'When a transaction is entered, it is displayed in the transaction list.'
- Using the transaction input form - Image not current.
- The Amount - Amend the second sentence to read 'Note that a simple calculator can be displayed, either by clicking the icon to the right of the amount field, or by entering the %...'
- Split Transactions - Image not current.
- Starting the edit - Amend first sentence to 'To enter a new transaction into the register you can now either click on an empty entry or press Ctrl+Ins, or click New at the foot of the window.
- Deleting transactions - Amend to read ' To delete a transaction select it in the list view and right click on the entry, selecting Delete from the popup menu when it appears, or click Delete on the transaction form.
- Split Transactions - Image not current.
- In the last paragraph, amend the second sentence to read 'After entering all the splits, press the OK button to save the entire transaction.
- Matching Transactions - Add new opening paragraph....'Generally, when importing transactions, either via QIF, OFX or HBCI, KMyMoney will attempt automatically to match them against existing transactions. To allow for differences in the dates, there is a default setting of 4 days, which may be changed in the settings - Register/Import. Any so matched will be highlighted in green. On completion of the import, you should review these and either accept or unmatch them.
- Replace original opening sentence with 'If you should find that an imported transaction was not automatically matched with an existing transaction when it should have matched, then it is possible to match them manually. However, with OFX or HBCI, it is as well not just to delete the imported transaction, because...' then continue with '...you will find that the next time you import your transactions....'.
- Replace the next three paragraphs with "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. To do so, right-click on one of the transactions to be matched, then Ctrl-right click on the other, then select Match from the context menu. This changes the background color to a nice pale green. This will match and combine the two transactions together. The values of both transactions must be the same for the match to work. If you are happy with the result, right click it again, then select Accept.
- Understanding the Cleared State - The opening paragraph refers to non-reconciled (N), cleared (C) and reconciled (R). While (C) and (R) do actually appear, (N) does not, so I suggest removing the (N) references.
- Changing Transaction Settings - Images not current.
- Other Functionality - Image not current.
- Change first sentence to 'Additional options are available from the Transaction Options menu, accessed by right-clicking a transaction in the list.

Chapter 11
- Investments (to follow)

aga wrote:Here's another batch of suggested documentation updates.
.....

Just to draw your attention to the fact that I have just edited the Chapter 10 - Matching Transactions section above, in case you have already done it!!

aga

aga wrote:Just to draw your attention to the fact that I have just edited the Chapter 10 - Matching Transactions section above, in case you have already done it!!

aga

There have been several contributions to editing the documentation and it takes time to go through things; I'm sure your contributions will be merged in due course.

Updated chapters 7, 8, 9 and 10.

Hei Ku wrote:Updated chapters 7, 8, 9 and 10.

Can't see them on http://kmymoney2.sourceforge.net/index-gen.html. Should I expect to see them there? If not, where?

aga

It takes a while for the web page to update, but yes, that's where you'll see the changes.

Here are Chapters 11 to 15.

Chapter 11
*** I've had to re-hack this section quite a bit and I'm not sure how it will look. I may need to have a second go. ***
- Investments - Creating an Investment Account - Amend second sentence to 'Choose Account->New account... to begin the process of adding a new account.'
- Adding Investments to Your Account - In the first paragraph, delete last sentence. In the second paragraph, amend the third sentence to 'Choose New Investment from this menu.'
- New Investment Wizard - Add after 'Trading currency:' a new bullet 'Price entry', where you may set whether the price will be entered as an individual price, or as the total for all shares.
- Investment Summary Information - Replace this section with new 'Editing an Investment' section as follows- 'The Investment view window lists your current holdings in this account, along with their price and value and symbol. If you right-click on an account, you have the option to add, edit or delete individual investments from this account. Also, you can update the price of your investments here either manually or via their online source. In addition, it is possible to close an empty account, or to reopen a closed account.' ***Also, on the first page, rename 'Investment Summary Information' to 'Editing an Investment'.***
- Investment Transactions - Image not current.
- Replace first paragraph with 'Investments are entered and edited in the Ledger view, as with other kinds of accounts. However, the fields are different, and vary depending on the investment transaction type or activity. The fields are as follows:-
Security - A drop-down box to select the security.
Detail - Activity (Buy, Sell, etc.)
- Buy/Sell. Use to record purchases or sales of individual investments. This action requires an account to transfer the funds from/to.
- Dividend/Yield. Also known as a "Cash Dividend", this action is used for when you receive an interest or dividend disbursement from your investment. This action requires an account to transfer the funds from/to.
- Reinvest Dividend. This is a dividend where the proceeds are re-invested back into the investment.
- Add/Remove Shares. A simple increase or decrease in your balance. This should be used very rarely, because it's uncommon for shares to just show up in your account (or disappear) unless it's a purchase or a sale.
- Split Shares. Used when the stock is split. Enter the ratio of the split in the "Split Ratio" field. For example, in a 3:2 split, enter 1.5
- Account - For any transactions which generate or require money, you must enter the account where the money is transferred from/to. If your investment account has an associated brokerage account, it's usually best to transfer the funds there.
- Interest category
- Fees - With many investment transactions you can include the fees (or commission) you paid the broker. There is a space for the amount of the fee and the category to which you wish to assign it.
- Memo - Use as you wish.
Quantity)- Which of these appear depends on the above selections.
Price )- For buy, sell, and cash dividend transactions, the number Value )- of shares, the price, and the total amount of the transaction must be established. You can enter any two of these, and KMyMoney will calculate the third. It's usually best to enter just the total amount and the shares, because these are the known facts of the transaction. The price can be calculated from these.'
- Working With Foreign Investments *** As I've no experience of working with multiple currencies, perhaps someone more qualified should check this section. ***
- Amend first sentence to 'KMyMoney supports multiple currencies and investments, and you may want to combine the two.'
- Online Price Quotes - Assigning a Quote Source - Amend second paragraph to
'To assign a quote source to an investment, navigate to the investment view for the account in which the security is held. Edit the security by right-clicking it and selecting Edit. In the Investment Detail Wizard, click Next twice, for the Online Update section. In the Online source drop-down box, select your required source.'

Chapter 12
- Currencies - Base currency - Image not current.

Chapter 13
- What is reconciliation? - In the last sentence of the first paragraph, change 'have' to 'has'. - Amend the last paragraph to 'To reconcile an account, choose your account from the drop down list and click on the (icon) Reconcile icon, select Account->Reconcile... or use the key combination Ctl+Shift+R.
- The reconciliation wizard - Statement details - Image not current. (No currency warning and missing last reconciliation date, and help button.)
- Interest - Image not current. - Also, in the current image, in the second sentence the word 'cleares' should be 'clear'.
- Clearing transactions - Image not current.

Chapter 14
- Available Reports - Image not current.
- Income and Expenses - Add final sentence 'Graphs and Pie Charts also may be produceed.'
- Net Worth - Add after first sentence 'In addition, there is a 7-day Cash Flow Forecast, and a Net Worth Graph.'
- Investments - Add additional bullet 'Also, there are graphs for Investment Prices and Investment Worth.'
- Taxes - Add full stop/period after second sentence. - Add final sentence 'They may be listed either by Category or by Payee, and for the last fiscal year.'
- Configuring Reports - Image not current? (button position) - Rows/Columns Tab - @Rob: Screenshot of rows/columns tab from an income/expense report - For transaction reports - Image not current. - Add fifth bullet 'Include only Loan Accounts: Only show transactions from loan accounts.
- Chart Tab - @Rob: Screenshot of chart tab
- Graphs & Charts - Enabling Charts - *** Is this section still needed? *** - Viewing as a Chart - Re-order second paragraph to 'Care should be taken to limit the amount of data you choose to display on a chart. If you are not careful, using the same configuration for both textual and graphical forms means it's possible to configure a chart in a visually cluttered and unappealing way. KMyMoney will not force you to keep your charts readable and useful! - Available Chart Types - Several '@Rob: Screenshot of a simple xxx' are needed.

Chapter 15
- GnuCash Importer - Categories - In the second sentence, correct spelling of 'eentry'. *** I'm not able to say if this section reflects the current version. ***
- QIF Importer - How to import a QIF file - Below the statement import statistics window, in the last sentence of the second paragraph, the word 'in' is missing after 'It is outlined..'. - Writing an import filter - There is a sample CSV conversion script called csv2qif.awk. I suspect this would not be suitable as it stands for imports of historic data?
- QIF Exporter - Add new opening paragraph as 'At the moment, QIF Exporter does not handle export of investments.' - In the image, the last sentence indicates that a status box appears at the conclusion of the export. This does not happen for me.
- Web Connect - After the first sentence, add the following 'I found that the following worked on openSuse 11.1. Open Konqueror, then Settings/Configure Konqueror/File Management/File Associations then click application, then Add. Then in Group, select 'application', and in name enter 'OFX', then OK. Now, under application you should find 'OFX', so click it. Under File name patterns, click Add, then enter '*.ofx', and under Application Preference Order click add, and enter the name kmymoney2 then OK. Click Apply, system settings will be updated, then click OK. Now, still in Konqueror, visit...'. Remove 'Visit' from the start of the next sentence.
- Direct Connect - At the end of the fourth paragraph, add an additional sentence 'Should you find that your bank is not listed, then it may still be possible to use the manual option. You bank may be able to provide the required parameters, or you may have to do some research to find them.' - In the last sentence of paragraph five, change 'you' to 'your'.

Chapter 16
- Loans (to follow)


aga

Updated. Thanks a lot, Allan.

Hei Ku wrote:Updated. Thanks a lot, Allan.

Version on KMyMoney web-site also updated. Thanks also from my end.

I've finally got time and am setting myself up to help with the documentation - hopefully I can make a useful contribution to a great program. What's the best way to see the latest version of the docs? I've checked out the cvs and compiled, but the html doesn't seem to have been produced by the docbook sources. Have I missed something? Should I just read the .docbook directly? Also, would you prefer edits as others have done in this thread, as diff patches to the .docbook, or something else?

Jack