documentation question

View: New views
5 Messages — Rating Filter:   Alert me  

documentation question

by Jack Ostroff :: Rate this Message:

Reply to Author | View Threaded | Show Only this Message

As I posted on the forum thread, I've finally got myself set up to do a  
review on the documentation with another set of eyes.  (Yes I know, or  
at least assume, time is getting short to finish this.)

I've attached the first two diff's of the docbook files - made with  
"diff -u file.docbook.orig file.docbook".  If different parameters are  
preferred, just let me know.  This batch is just very minor edits for  
style and consistency.


Jack

------------------------------------------------------------------------------
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

Re: documentation question

by Bugzilla from asoliverez@gmail.com :: Rate this Message:

Reply to Author | View Threaded | Show Only this Message

Hello Jack,
did you attach the files? At least I didn't get them.

Thanks for the contribution.

Regards,
Alvaro

On Tue, Jul 7, 2009 at 6:24 PM, Jack Ostroff <ostroffjh@...> wrote:
As I posted on the forum thread, I've finally got myself set up to do a
review on the documentation with another set of eyes.  (Yes I know, or
at least assume, time is getting short to finish this.)

I've attached the first two diff's of the docbook files - made with
"diff -u file.docbook.orig file.docbook".  If different parameters are
preferred, just let me know.  This batch is just very minor edits for
style and consistency.


Jack

------------------------------------------------------------------------------
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


------------------------------------------------------------------------------
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

Re: documentation question

by Jack Ostroff :: Rate this Message:

Reply to Author | View Threaded | Show Only this Message

Sorry - my problem.  Let's try again.

On 2009.07.07 19:15, Alvaro Soliverez wrote:

> Hello Jack,
> did you attach the files? At least I didn't get them.
>
> Thanks for the contribution.
>
> Regards,
> Alvaro
>
> On Tue, Jul 7, 2009 at 6:24 PM, Jack Ostroff  
> <ostroffjh@...>wrote:
>
> > As I posted on the forum thread, I've finally got myself set up to  
> do a
> > review on the documentation with another set of eyes.  (Yes I know,  
> or
> > at least assume, time is getting short to finish this.)
> >
> > I've attached the first two diff's of the docbook files - made with
> > "diff -u file.docbook.orig file.docbook".  If different parameters  
> are
> > preferred, just let me know.  This batch is just very minor edits  
> for
> > style and consistency.
> >
> >
> > Jack
> >
> >
> >  
> ------------------------------------------------------------------------------
> > 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
> >
>
>
------quoted attachment------

> ------------------------------------------------------------------------------
> 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
>
------quoted attachment------
> _______________________________________________
> KMyMoney2-developer mailing list
> KMyMoney2-developer@...
> https://lists.sourceforge.net/lists/listinfo/kmymoney2-developer
>
>



[makemostof.diff]

--- makemostof.docbook.orig 2009-07-07 16:31:47.000000000 -0400
+++ makemostof.docbook 2009-07-07 17:08:24.000000000 -0400
@@ -31,7 +31,7 @@
     Imagine your money as balls, or beans, and to stop them rolling around you keep them in a box, or pot. Accounting, or Book Keeping, is the process of counting the beans in the pot, or several pots.
 </para>
 <para>
-    You have some money, in the pot marked <quote>Cash</quote>. You buy some goods, so you take some beans out of the cash pot and place them into another pot marked <quote>Supplier</quote>. The supplier gives you some goods in exchange for the cash, so you take the beans out of the  pot marked <quote>Supplier</quote> and put them in the pot marked <quote>Goods</quote>.
+    You have some money in the pot marked <quote>Cash</quote>. You buy some goods, so you take some beans out of the cash pot and place them into another pot marked <quote>Supplier</quote>. The supplier gives you some goods in exchange for the cash, so you take the beans out of the  pot marked <quote>Supplier</quote> and put them in the pot marked <quote>Goods</quote>.
 </para>
 <para>
     The goods have a value (the price you paid) so you still have the same amount of beans, some representing cash and some representing goods.
@@ -56,7 +56,7 @@
     Any pots that cannot be valued are <quote>Income</quote> or <quote>Expense</quote>, such as an unpaid phone bill that would be an expense as we have already made the calls. Although these do not have a value, it is useful to monitor how much is in each.
 </para>
 <para>
-    In some cases a supplier is a Liability, in others it is an Expense. This is something we need to consider and decide for each case. Similarly, you may set up a loan as a Liability, particularly if you transfer the money into your bank account, but it could be an expense if it was to buy some furniture.
+    In some cases a supplier is a <quote>Liability</quote>, in others it is an <quote>Expense</quote>. This is something we need to consider and decide for each case. Similarly, you may set up a loan as a Liability, particularly if you transfer the money into your bank account, but it could be an Expense if it was to buy some furniture.
 </para>
 <para>
     Consider how you want to analyze your income and expenses. This will decide how you set them up.
@@ -70,7 +70,7 @@
 <title>Defining the accounts (business records)</title>
 
 <para>
-    This is similar to setting up for personal use, but needs to follow legal guidelines. You should be aware of what these are.
+    This is similar to setting up for personal use, but needs to follow legal guidelines. We do not discuss them here, but you should be aware of what these are.
 </para>
 </sect2>
 </sect1>
@@ -102,7 +102,7 @@
 <term>Checking</term>
 <listitem>
 <para>
-Standard bank trading account.
+Standard bank checking account.
 </para>
 </listitem>
 </varlistentry>
@@ -129,7 +129,7 @@
 <term>Loan</term>
 <listitem>
 <para>
-Loans made by you, etc.
+Loans you make to someone else.
 </para>
 </listitem>
 </varlistentry>
@@ -138,7 +138,7 @@
 <term>Investment</term>
 <listitem>
 <para>
-Investments made.
+Money you invest.
 </para>
 </listitem>
 </varlistentry>
@@ -186,7 +186,7 @@
 <term>Liability</term>
 <listitem>
 <para>
-Anything you owe that is not a loan.
+Anything else you owe that is not a loan.
 </para>
 </listitem>
 </varlistentry>



[whatsnew.diff]

--- whatsnew.docbook.orig 2009-07-07 16:18:16.000000000 -0400
+++ whatsnew.docbook 2009-07-07 16:18:22.000000000 -0400
@@ -12,7 +12,7 @@
 <listitem><para><link linkend="details.impexp.gnucash">GnuCash File Converter</link></para></listitem>
 <listitem><para><link linkend="details.impexp.ofx">OFX Import</link></para></listitem>
 <listitem><para><link linkend="details.impexp.webconnect">Web Connect</link></para></listitem>
-<listitem><para><link linkend="firsttime.mainwindow">An improved look and feel -including a new icon set</link></para></listitem>
+<listitem><para><link linkend="firsttime.mainwindow">An improved look and feel - including a new icon set</link></para></listitem>
 <listitem><para><link linkend="details.formats.encrypted">Encryption of the Data File</link></para></listitem>
 <listitem><para><link linkend="reference.widgets">Widgets for entering dates, values, payees & categories</link></para></listitem>
 <listitem><para><link linkend="details.investments.onlinequotes">Online Quotes for Stocks & Currencies</link></para></listitem>



------------------------------------------------------------------------------
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

Re: documentation question

by Thomas Baumgart :: Rate this Message:

Reply to Author | View Threaded | Show Only this Message

On Tuesday 07 July 2009 23:24:15 Jack Ostroff wrote:

> As I posted on the forum thread, I've finally got myself set up to do a
> review on the documentation with another set of eyes.  (Yes I know, or
> at least assume, time is getting short to finish this.)
>
> I've attached the first two diff's of the docbook files - made with
> "diff -u file.docbook.orig file.docbook".  If different parameters are
> preferred, just let me know.

An even easier method to get a delta is to run

   cvs diff -u > what-ever-you-want-it-to-be.patch

Just make sure to have a recent (updated) sandbox before you do that.


--

Regards

Thomas Baumgart

GPG-FP: E55E D592 F45F 116B 8429   4F99 9C59 DB40 B75D D3BA
-------------------------------------------------------------
GDB has a 'break' feature; why doesn't it have 'fix' too?
-------------------------------------------------------------


------------------------------------------------------------------------------
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

signature.asc (232 bytes) Download Attachment

Re: documentation question

by Thomas Baumgart :: Rate this Message:

Reply to Author | View Threaded | Show Only this Message

On Wednesday 08 July 2009 05:30:01 Jack wrote:
> Sorry - my problem.  Let's try again.

Thanks. Added to CVS HEAD. Online version (HTML and PDF) updated.

> On 2009.07.07 19:15, Alvaro Soliverez wrote:
> > Hello Jack,
> > did you attach the files? At least I didn't get them.
> >
> > Thanks for the contribution.
> >
> > Regards,
> > Alvaro
> >
> > On Tue, Jul 7, 2009 at 6:24 PM, Jack Ostroff
> >
> > <ostroffjh@...>wrote:
> > > As I posted on the forum thread, I've finally got myself set up to
> >
> > do a
> >
> > > review on the documentation with another set of eyes.  (Yes I know,
> >
> > or
> >
> > > at least assume, time is getting short to finish this.)
> > >
> > > I've attached the first two diff's of the docbook files - made with
> > > "diff -u file.docbook.orig file.docbook".  If different parameters
> >
> > are
> >
> > > preferred, just let me know.  This batch is just very minor edits
> >
> > for
> >
> > > style and consistency.
> > >
> > >
> > > Jack
> >
> > -------------------------------------------------------------------------
> >-----
> >
> > > 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
>
> ------quoted attachment------
>
> > -------------------------------------------------------------------------
> >----- 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
>
> ------quoted attachment------
>
> > _______________________________________________
> > KMyMoney2-developer mailing list
> > KMyMoney2-developer@...
> > https://lists.sourceforge.net/lists/listinfo/kmymoney2-developer


--

Regards

Thomas Baumgart

GPG-FP: E55E D592 F45F 116B 8429   4F99 9C59 DB40 B75D D3BA
-------------------------------------------------------------
If it's there and you can see it, it's real.
If it's there and you can't see it, it's transparent.
If it's not there and you can see it, it's virtual.
If it's not there and you can't see it, it's gone.
-------------------------------------------------------------


------------------------------------------------------------------------------
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

signature.asc (232 bytes) Download Attachment