Suggested updates for Help - comments ?

Derek Atkins warlord at MIT.EDU
Thu Apr 19 10:41:50 EDT 2007


Or you would "svn mv" the file..  But that requires SVN commit access.

-derek

Chris Lyttle <chris at wilddev.net> writes:

> Dave,
>
> I dont know if I've said this before to you, but THANKS. Updating the 
> help is a long job and its a lot of work as you have found out. I'll try 
> to get to looking this over this weekend.
> As to putting the files in svn, normally if they are being renamed as 
> you are doing you rm the files locally and on the svn then add your 
> files to the svn.
>
> Chris
>
> Dave Herman wrote:
>> Chris et al,
>>
>> I have been "working" on updating the Help documentation for some time,
>> the task just seems to keep getting longer and longer.
>>
>> I have reached the stage that I would like some feedback on the
>> structure and contents of the document.  And encourage any one so
>> inclined for assistance.
>>
>> I have broken the document into a number of files, in general there is
>> one for each chapter.  The files are now named "Help_ch_XXXX.xml" where
>> is XXXX is the chapter identification.  The FIGURES files also were
>> renamed.  The motivation for the name changes is that apparently both
>> the Help and T & C Guide files are placed in the same directory.
>>
>> The document is now structured in two dimensions; 1) to assist
>> navigation though the GUI options, and 2) by description of various
>> actions (i.e. a chapter on operations related to accounts, a separate
>> chapter on transactions orientated operations).  Additional links
>> between sections were also added.  Created an appendix "tips & tidbits"
>> (sorry Beth Leonard I haven't added your PayPal discussion ... yet.)
>>
>> There are still many areas that need updating - On-line banking,
>> Importing QIF/OFX files, Report printing and Custom reports to name a
>> few.  The Business facilities documentation also needs to be enhanced or
>> did I miss some things?
>>
>> I'm attaching a tar of the Help files - unpack into a folder and open
>> "gnucash-help.xml" with yelp.
>>
>> There are two tags in gnc-ui.h that will need to be updated, HL_USAGE
>> ("usage") should point to the Business facilities chapter and
>> HL_SXEDITOR (tool-sched) should change to "trans-sched".
>>
>> How should this be handled in svn? 
>>
>> Comments & Feedback ?
>>
>> Dave
>>
>>
>>
>>
>>
>>
>>   
>> ------------------------------------------------------------------------
>>
>> _______________________________________________
>> gnucash-devel mailing list
>> gnucash-devel at gnucash.org
>> https://lists.gnucash.org/mailman/listinfo/gnucash-devel
>>   
>
> _______________________________________________
> gnucash-devel mailing list
> gnucash-devel at gnucash.org
> https://lists.gnucash.org/mailman/listinfo/gnucash-devel
>
>

-- 
       Derek Atkins, SB '93 MIT EE, SM '95 MIT Media Laboratory
       Member, MIT Student Information Processing Board  (SIPB)
       URL: http://web.mit.edu/warlord/    PP-ASEL-IA     N1NWH
       warlord at MIT.EDU                        PGP key available


More information about the gnucash-devel mailing list