« Return to Thread: Next doc update
Next doc update
by Jack Ostroff
::
Rate this Message:
Attached is the diff with my edits to Chapter 4. Some of the changes I
made I think need to be considered before just being accepted.
First is a question of style - for the list of icons in the view
selector, I have modified each line to start with the name of the
icon. The names are listed under the icons in the application, and I
think it will help orient a new user if they are also listed in the
documentation.
In addition, I have modified the statement for the first icon (Home) to
say "...situation (or an introduction page when no data file is open)."
instead of simply "... when no data exists."
In the next section on "Creating a new file" I have added an
introduction: "KMyMoney keeps all the data about your finances in a
file. As was mentioned in (refer to the section on "defining the
accounts")you can keep data more than one set of accounts, but the data
for each will be kept in a separate file, but KMM can only have one
file open at a time. See (refer to Chapter 21) for more details about
KMyMoney's data files."
Dates - I know there has been discussion about date formats - but in
the new file section, under creating the first account, the text uses
the sample date of "2008-01-01" but the screenshot shows it as
"01.01.2009" My version shows 01/01/2009 - so I assume this actually
depends on local settings. Is this the place to mention that date
formats depend on KDE settings, or is it already mentioned somewhere
else (I haven't seen it yet, but I haven't gotten through all the docs
yet.)
Jack
[firsttime.diff]
Index: firsttime.docbook
===================================================================
RCS file: /cvsroot/kmymoney2/kmymoney2/doc/en/firsttime.docbook,v
retrieving revision 1.19
diff -u -r1.19 firsttime.docbook
--- firsttime.docbook 28 Jun 2009 08:47:35 -0000 1.19
+++ firsttime.docbook 8 Jul 2009 16:55:26 -0000
@@ -41,7 +41,7 @@
</para>
<para>
-Once you have read the tips the window can be closed and will re-open each time &kappname; is started. To stop this default behavior uncheck the appropriate option on the Tip of the Day window.
+Once you have read the tips the window can be closed; it will re-open each time &kappname; is started. To stop this default behavior, uncheck the appropriate option on the Tip of the Day window.
</para>
<note><para>
@@ -111,7 +111,7 @@
</textobject>
</inlinemediaobject>
</guiicon>
- A configurable overview of your current financial situation (or an introduction page when no data exists).
+ Home: A configurable overview of your current financial situation (or an introduction page when no data file is open).
</para>
</listitem>
@@ -127,7 +127,7 @@
</textobject>
</inlinemediaobject>
</guiicon>
- All of your institutions and accounts displayed in a hierarchy.
+ Institutions: All of your institutions and accounts displayed in a hierarchy.
</para>
</listitem>
@@ -143,7 +143,7 @@
</textobject>
</inlinemediaobject>
</guiicon>
- All of your accounts displayed in a hierarchy.
+ Accounts: All of your accounts displayed in a hierarchy.
</para>
</listitem>
@@ -159,7 +159,7 @@
</textobject>
</inlinemediaobject>
</guiicon>
- Your recurring bills and deposits.
+ Schedule: Your recurring bills and deposits.
</para>
</listitem>
@@ -175,7 +175,7 @@
</textobject>
</inlinemediaobject>
</guiicon>
- Special accounts that provide a means for you to group associated transactions.
+ Categories: Special accounts that provide a means for you to group associated transactions.
</para>
</listitem>
@@ -191,7 +191,7 @@
</textobject>
</inlinemediaobject>
</guiicon>
- All Payees used by &kappname;.
+ Payees: All Payees used by &kappname;.
</para>
</listitem>
@@ -207,7 +207,7 @@
</textobject>
</inlinemediaobject>
</guiicon>
- Your account transactions.
+ Ledgers: Your account transactions.
</para>
</listitem>
@@ -223,7 +223,7 @@
</textobject>
</inlinemediaobject>
</guiicon>
- Your portfolio summary.
+ Investments: Your portfolio summary.
</para>
</listitem>
@@ -239,7 +239,7 @@
</textobject>
</inlinemediaobject>
</guiicon>
- A collection of useful reports, providing alternate views of your financial data.
+ Reports: A collection of useful reports, providing alternate views of your financial data.
</para>
</listitem>
<listitem>
@@ -254,7 +254,7 @@
</textobject>
</inlinemediaobject>
</guiicon>
- Your budgets
+ Budgets: bYour budgets
</para>
</listitem>
@@ -270,7 +270,7 @@
</textobject>
</inlinemediaobject>
</guiicon>
- This view provides a forecast of your accounts and categories
+ Forecast: This view provides a forecast of your accounts and categories
</para>
</listitem>
@@ -296,6 +296,10 @@
<title>Creating a new file</title>
<para>
+ &kappname; keeps all the data about your finances in a file. As was stated in <link linkend="makingmostof.basicaccounting.personalaccounts">Defining the accounts (personal records)</link>, you can keep more than one set of accounts, but the data for each will be kept in a separate file, and &kappname; can only have one file open at a time. See the chapter on <link linkend="details.formats">File Formats</link> or more deatils about &kappname;'s data files.
+</para>
+
+<para>
To create a new file you can either select <menuchoice><guimenu>File</guimenu><guimenuitem>New</guimenuitem></menuchoice> from the menu or choose the <inlinemediaobject><imageobject><imagedata fileref="new.png"/></imageobject><textobject><phrase>New</phrase></textobject></inlinemediaobject> icon from the toolbar.
</para>
@@ -330,7 +334,7 @@
</para>
<para>
- &kappname; supports multiple currencies. To set your base currency, (the currency you use day to day and which will be used for your reports), select the appropriate entry from the list provided and press <guibutton>Next</guibutton>. A default will be selected from &kappname; based upon your locale settings.
+ &kappname; supports multiple currencies. To set your base currency (the currency you use day to day and which will be used for your reports), select the appropriate entry from the list provided and press <guibutton>Next</guibutton>. A default will be selected from &kappname; based upon your locale settings.
</para>
<para>
@@ -437,7 +441,7 @@
</para>
<para>
-Now you have collected all relevant information to create the file. Press <guibutton>Finish</guibutton> and &kappname; will create the file for you and open it.
+Now you have entered all relevant information to create the file. Press <guibutton>Finish</guibutton> and &kappname; will create the file for you and open it.
</para>
<!--
@@ -477,7 +481,7 @@
</para>
<para>
- Now that one or more accounts exist in &kappname; your account summary is shown in the Home view. You can create transactions manually in the <link linkend="details.ledgers">Ledgers</link> view, or set up automatic transactions through the <link linkend="details.schedules">Schedule</link> view.
+ Now that one or more accounts exist in &kappname;, your account summary is shown in the Home view. You can create transactions manually in the <link linkend="details.ledgers">Ledgers</link> view, or set up automatic transactions through the <link linkend="details.schedules">Schedule</link> view.
</para>
</sect1>
@@ -485,7 +489,10 @@
<sect1 id="firsttime.schedules">
<title>Schedules</title>
<para>
- A <link linkend="details.schedules">Schedule</link> is a transaction that occurs one or more times over a certain period of time. Sometimes called recurring transactions a typical example is your pay check that you receive every month or week. Rather than have to enter the transaction details each time you get paid, you can instruct &kappname; to create a schedule that will enter a transaction for you when you get paid.
+ Sometimes called a recurring transaction, a <link linkend="details.schedules">Schedule</link> is a transaction that occurs one or more times over a certain period of time. A typical example is your pay check that you receive every month or week. Rather than have to enter the transaction details each time you get paid, you can instruct &kappname; to create a schedule that will enter a transaction for you when you get paid.
+</para>
+<para>
+ To maintain <link linkend="details.schedules">schedules</link> click on the <guiicon><inlinemediaobject><imageobject><imagedata fileref="schedule_view.png"/></imageobject></inlinemediaobject>Schedules</guiicon> icon in the view selector.
</para>
</sect1>
@@ -494,6 +501,9 @@
<para>
To maintain <link linkend="details.categories">categories</link> click on the <guiicon><inlinemediaobject><imageobject><imagedata fileref="categories_view.png"/></imageobject></inlinemediaobject>Categories</guiicon> icon in the view selector.
</para>
+<para>
+A full description of this topic can be found in the <link linkend="details.categories">Categories</link> section.
+</para>
</sect1>
<sect1 id="firsttime.payees">
@@ -510,7 +520,7 @@
<sect1 id="firsttime-import">
<title>Quicken Interchange Format (QIF) Import</title>
<para>
-If you currently use a financial manager application &kappname; can then import an account's transactions as long as they are in the Quicken Interchange Format (QIF). Most financial programs can export this format and the different applications methods of exporting QIF is not discussed here for brevity.
+If you currently use a financial manager application, &kappname; can import an account's transactions as long as they are in the Quicken Interchange Format (QIF). Most financial programs can export this format and the different applications methods of exporting QIF is not discussed here for brevity.
</para>
<para>
@@ -539,7 +549,7 @@
<title>Reconciliation</title>
<para>
-At some point you will want to reconcile the transactions you have entered with the transactions listed in a statement, be it a bank statement, credit card statement, loan statement or any other statement. Reconciliation involves matching what you have entered with what the statement lists. If any discrepancies are found then either you or the person who created the statement have made a mistake.
+At some point you will want to reconcile the transactions you have entered with the transactions listed in a statement, be it a bank statement, credit card statement, loan statement, or any other statement. Reconciliation involves matching what you have entered with what the statement lists. If any discrepancies are found then either you or the person who created the statement have made a mistake.
</para>
<para>
@@ -609,7 +619,7 @@
<formalpara><title>Include specific steps</title><para>This is a bad bug report: "I entered a transaction, and &kappname; crashed." A much better bug report is: "Using the transaction form, I entered a new transaction in my Credit Card account. I selected the Transfer tab, entered in an amount, then changed to the Deposit tab, and back to the Transfer tab. When I returned to the Transfer tab, &kappname; crashed. This bug is fully reproducible for me."</para>
</formalpara>
-<formalpara><title>Tell us what you expected to happen</title><para>In crashes this is obvious, but in more subtle bugs, sometimes you'll see a bug report where it is not obvious what the reporter expected to happen. Always tell us what you think should have happened.</para>
+<formalpara><title>Tell us what you expected to happen</title><para>In some cases, this is obvious, but in more subtle bugs, sometimes you'll see a bug report where it is not obvious what the reporter expected to happen. Always tell us what you think should have happened.</para>
</formalpara>
<formalpara><title>Consider running with debugging enabled</title><para>By compiling a version configured with --enable-debug=full you can ensure that the best possible backtraces are generated. If you encounter a crash, run &kappname; again from within gdb, and reproduce the crash. When it crashes, type "bt" to generate a backtrace.</para>
------------------------------------------------------------------------------
Enter the BlackBerry Developer Challenge
This is your chance to win up to $100,000 in prizes! For a limited time,
vendors submitting new applications to BlackBerry App World(TM) will have
the opportunity to enter the BlackBerry Developer Challenge. See full prize
details at: http://p.sf.net/sfu/Challenge
_______________________________________________
KMyMoney2-developer mailing list
KMyMoney2-developer@...
https://lists.sourceforge.net/lists/listinfo/kmymoney2-developer
made I think need to be considered before just being accepted.
First is a question of style - for the list of icons in the view
selector, I have modified each line to start with the name of the
icon. The names are listed under the icons in the application, and I
think it will help orient a new user if they are also listed in the
documentation.
In addition, I have modified the statement for the first icon (Home) to
say "...situation (or an introduction page when no data file is open)."
instead of simply "... when no data exists."
In the next section on "Creating a new file" I have added an
introduction: "KMyMoney keeps all the data about your finances in a
file. As was mentioned in (refer to the section on "defining the
accounts")you can keep data more than one set of accounts, but the data
for each will be kept in a separate file, but KMM can only have one
file open at a time. See (refer to Chapter 21) for more details about
KMyMoney's data files."
Dates - I know there has been discussion about date formats - but in
the new file section, under creating the first account, the text uses
the sample date of "2008-01-01" but the screenshot shows it as
"01.01.2009" My version shows 01/01/2009 - so I assume this actually
depends on local settings. Is this the place to mention that date
formats depend on KDE settings, or is it already mentioned somewhere
else (I haven't seen it yet, but I haven't gotten through all the docs
yet.)
Jack
[firsttime.diff]
Index: firsttime.docbook
===================================================================
RCS file: /cvsroot/kmymoney2/kmymoney2/doc/en/firsttime.docbook,v
retrieving revision 1.19
diff -u -r1.19 firsttime.docbook
--- firsttime.docbook 28 Jun 2009 08:47:35 -0000 1.19
+++ firsttime.docbook 8 Jul 2009 16:55:26 -0000
@@ -41,7 +41,7 @@
</para>
<para>
-Once you have read the tips the window can be closed and will re-open each time &kappname; is started. To stop this default behavior uncheck the appropriate option on the Tip of the Day window.
+Once you have read the tips the window can be closed; it will re-open each time &kappname; is started. To stop this default behavior, uncheck the appropriate option on the Tip of the Day window.
</para>
<note><para>
@@ -111,7 +111,7 @@
</textobject>
</inlinemediaobject>
</guiicon>
- A configurable overview of your current financial situation (or an introduction page when no data exists).
+ Home: A configurable overview of your current financial situation (or an introduction page when no data file is open).
</para>
</listitem>
@@ -127,7 +127,7 @@
</textobject>
</inlinemediaobject>
</guiicon>
- All of your institutions and accounts displayed in a hierarchy.
+ Institutions: All of your institutions and accounts displayed in a hierarchy.
</para>
</listitem>
@@ -143,7 +143,7 @@
</textobject>
</inlinemediaobject>
</guiicon>
- All of your accounts displayed in a hierarchy.
+ Accounts: All of your accounts displayed in a hierarchy.
</para>
</listitem>
@@ -159,7 +159,7 @@
</textobject>
</inlinemediaobject>
</guiicon>
- Your recurring bills and deposits.
+ Schedule: Your recurring bills and deposits.
</para>
</listitem>
@@ -175,7 +175,7 @@
</textobject>
</inlinemediaobject>
</guiicon>
- Special accounts that provide a means for you to group associated transactions.
+ Categories: Special accounts that provide a means for you to group associated transactions.
</para>
</listitem>
@@ -191,7 +191,7 @@
</textobject>
</inlinemediaobject>
</guiicon>
- All Payees used by &kappname;.
+ Payees: All Payees used by &kappname;.
</para>
</listitem>
@@ -207,7 +207,7 @@
</textobject>
</inlinemediaobject>
</guiicon>
- Your account transactions.
+ Ledgers: Your account transactions.
</para>
</listitem>
@@ -223,7 +223,7 @@
</textobject>
</inlinemediaobject>
</guiicon>
- Your portfolio summary.
+ Investments: Your portfolio summary.
</para>
</listitem>
@@ -239,7 +239,7 @@
</textobject>
</inlinemediaobject>
</guiicon>
- A collection of useful reports, providing alternate views of your financial data.
+ Reports: A collection of useful reports, providing alternate views of your financial data.
</para>
</listitem>
<listitem>
@@ -254,7 +254,7 @@
</textobject>
</inlinemediaobject>
</guiicon>
- Your budgets
+ Budgets: bYour budgets
</para>
</listitem>
@@ -270,7 +270,7 @@
</textobject>
</inlinemediaobject>
</guiicon>
- This view provides a forecast of your accounts and categories
+ Forecast: This view provides a forecast of your accounts and categories
</para>
</listitem>
@@ -296,6 +296,10 @@
<title>Creating a new file</title>
<para>
+ &kappname; keeps all the data about your finances in a file. As was stated in <link linkend="makingmostof.basicaccounting.personalaccounts">Defining the accounts (personal records)</link>, you can keep more than one set of accounts, but the data for each will be kept in a separate file, and &kappname; can only have one file open at a time. See the chapter on <link linkend="details.formats">File Formats</link> or more deatils about &kappname;'s data files.
+</para>
+
+<para>
To create a new file you can either select <menuchoice><guimenu>File</guimenu><guimenuitem>New</guimenuitem></menuchoice> from the menu or choose the <inlinemediaobject><imageobject><imagedata fileref="new.png"/></imageobject><textobject><phrase>New</phrase></textobject></inlinemediaobject> icon from the toolbar.
</para>
@@ -330,7 +334,7 @@
</para>
<para>
- &kappname; supports multiple currencies. To set your base currency, (the currency you use day to day and which will be used for your reports), select the appropriate entry from the list provided and press <guibutton>Next</guibutton>. A default will be selected from &kappname; based upon your locale settings.
+ &kappname; supports multiple currencies. To set your base currency (the currency you use day to day and which will be used for your reports), select the appropriate entry from the list provided and press <guibutton>Next</guibutton>. A default will be selected from &kappname; based upon your locale settings.
</para>
<para>
@@ -437,7 +441,7 @@
</para>
<para>
-Now you have collected all relevant information to create the file. Press <guibutton>Finish</guibutton> and &kappname; will create the file for you and open it.
+Now you have entered all relevant information to create the file. Press <guibutton>Finish</guibutton> and &kappname; will create the file for you and open it.
</para>
<!--
@@ -477,7 +481,7 @@
</para>
<para>
- Now that one or more accounts exist in &kappname; your account summary is shown in the Home view. You can create transactions manually in the <link linkend="details.ledgers">Ledgers</link> view, or set up automatic transactions through the <link linkend="details.schedules">Schedule</link> view.
+ Now that one or more accounts exist in &kappname;, your account summary is shown in the Home view. You can create transactions manually in the <link linkend="details.ledgers">Ledgers</link> view, or set up automatic transactions through the <link linkend="details.schedules">Schedule</link> view.
</para>
</sect1>
@@ -485,7 +489,10 @@
<sect1 id="firsttime.schedules">
<title>Schedules</title>
<para>
- A <link linkend="details.schedules">Schedule</link> is a transaction that occurs one or more times over a certain period of time. Sometimes called recurring transactions a typical example is your pay check that you receive every month or week. Rather than have to enter the transaction details each time you get paid, you can instruct &kappname; to create a schedule that will enter a transaction for you when you get paid.
+ Sometimes called a recurring transaction, a <link linkend="details.schedules">Schedule</link> is a transaction that occurs one or more times over a certain period of time. A typical example is your pay check that you receive every month or week. Rather than have to enter the transaction details each time you get paid, you can instruct &kappname; to create a schedule that will enter a transaction for you when you get paid.
+</para>
+<para>
+ To maintain <link linkend="details.schedules">schedules</link> click on the <guiicon><inlinemediaobject><imageobject><imagedata fileref="schedule_view.png"/></imageobject></inlinemediaobject>Schedules</guiicon> icon in the view selector.
</para>
</sect1>
@@ -494,6 +501,9 @@
<para>
To maintain <link linkend="details.categories">categories</link> click on the <guiicon><inlinemediaobject><imageobject><imagedata fileref="categories_view.png"/></imageobject></inlinemediaobject>Categories</guiicon> icon in the view selector.
</para>
+<para>
+A full description of this topic can be found in the <link linkend="details.categories">Categories</link> section.
+</para>
</sect1>
<sect1 id="firsttime.payees">
@@ -510,7 +520,7 @@
<sect1 id="firsttime-import">
<title>Quicken Interchange Format (QIF) Import</title>
<para>
-If you currently use a financial manager application &kappname; can then import an account's transactions as long as they are in the Quicken Interchange Format (QIF). Most financial programs can export this format and the different applications methods of exporting QIF is not discussed here for brevity.
+If you currently use a financial manager application, &kappname; can import an account's transactions as long as they are in the Quicken Interchange Format (QIF). Most financial programs can export this format and the different applications methods of exporting QIF is not discussed here for brevity.
</para>
<para>
@@ -539,7 +549,7 @@
<title>Reconciliation</title>
<para>
-At some point you will want to reconcile the transactions you have entered with the transactions listed in a statement, be it a bank statement, credit card statement, loan statement or any other statement. Reconciliation involves matching what you have entered with what the statement lists. If any discrepancies are found then either you or the person who created the statement have made a mistake.
+At some point you will want to reconcile the transactions you have entered with the transactions listed in a statement, be it a bank statement, credit card statement, loan statement, or any other statement. Reconciliation involves matching what you have entered with what the statement lists. If any discrepancies are found then either you or the person who created the statement have made a mistake.
</para>
<para>
@@ -609,7 +619,7 @@
<formalpara><title>Include specific steps</title><para>This is a bad bug report: "I entered a transaction, and &kappname; crashed." A much better bug report is: "Using the transaction form, I entered a new transaction in my Credit Card account. I selected the Transfer tab, entered in an amount, then changed to the Deposit tab, and back to the Transfer tab. When I returned to the Transfer tab, &kappname; crashed. This bug is fully reproducible for me."</para>
</formalpara>
-<formalpara><title>Tell us what you expected to happen</title><para>In crashes this is obvious, but in more subtle bugs, sometimes you'll see a bug report where it is not obvious what the reporter expected to happen. Always tell us what you think should have happened.</para>
+<formalpara><title>Tell us what you expected to happen</title><para>In some cases, this is obvious, but in more subtle bugs, sometimes you'll see a bug report where it is not obvious what the reporter expected to happen. Always tell us what you think should have happened.</para>
</formalpara>
<formalpara><title>Consider running with debugging enabled</title><para>By compiling a version configured with --enable-debug=full you can ensure that the best possible backtraces are generated. If you encounter a crash, run &kappname; again from within gdb, and reproduce the crash. When it crashes, type "bt" to generate a backtrace.</para>
------------------------------------------------------------------------------
Enter the BlackBerry Developer Challenge
This is your chance to win up to $100,000 in prizes! For a limited time,
vendors submitting new applications to BlackBerry App World(TM) will have
the opportunity to enter the BlackBerry Developer Challenge. See full prize
details at: http://p.sf.net/sfu/Challenge
_______________________________________________
KMyMoney2-developer mailing list
KMyMoney2-developer@...
https://lists.sourceforge.net/lists/listinfo/kmymoney2-developer
« Return to Thread: Next doc update
| Free embeddable forum powered by Nabble | Forum Help |
