[GNC-dev] Register Documentation Improvements (was Re: [GNC] Column widths again)

Mon Aug 20 22:05:06 EDT 2018

I will try inline editing, even though it is very difficult in Gmail....

David C

On Mon, Aug 20, 2018 at 7:44 PM, Adrien Monteleone <
adrien.monteleone at lusfiber.net> wrote:

> David C,
>
> So for clarification this is the first link you posted about:
>
> > https://www.gnucash.org/docs/v3/C/gnucash-guide/txns-
> register-oview.html#txns-regstyle1
>
> Notice this is in the folder /docs/v3/C/gnucash-guide/
>
> But the link on the Documentation page and the link you included (both in
> that first post and in the last one) that said how you got there was this:
>
> > https://www.gnucash.org/viewdoc.phtml?rev=3&lang=C&doc=help

When I follow that link the url is not the same as when I go down the tree
through the online help.   That must be why I thought there were aliases
involved and why it appeared to me that you were not seeing the same
material.  It appears that the modifiers doc=help and doc=guide in phtml
point indirectly to the proper directories.  Thus, the correct (at this
time) short names are help and guide.  I would find it easier if they were
changed to something more intuitive such as help and tutorial.  I will
leave that part of the discussion to the other thread.

>
> So yes, that IS version 3 (listed here as ‘rev=3’) but that’s not the same
> link as above. (though it might be the exact same content, I didn’t check)
>
> I can’t find any way, other than typing it in directly, to get to the
> /docs/v3/C/ directory wherein lies the /gnucash-guide/ and /gnucash-help/
> folders and contents. All of the links on the documentation page seem to
> point instead to the /viewdoc.phtml which never changes the URL as you
> navigate the document. (my guess is the viewdoc.phtml template is serving
> the pages physically located in /docs/v3/C/, we just can’t see the real URL)
>
> ------------
>
> And now after I backed up a few directories from the first link above, I
> see regardless, *I* was in the wrong place. I didn’t see a ‘4.3' because I
> was looking at the section numbers which are roman numerals, not the
> chapter numbers. Section IV in the Guide are for the Appendices which are
> organized by letters. The only notation I saw then for 4.3 was in the Help
> Manual, which is where my confusion came from. (but that really is where I
> think this info should be - see my previous comment)
>
> And sure enough there is https://www.gnucash.org/docs/v3/C/gnucash-help/
> which I would have expected to see.
>
> So, we can put aside the naming of the folder since that’s correct. But
> what certainly would be helpful is if the page itself indicated which
> document you were viewing. That bug is still there.
>

Yes, I agree.

> Regards,
> Adrien
>
>
> > On Aug 20, 2018, at 6:52 PM, David Carlson <david.carlson.417 at gmail.com>
> wrote:
> >
> > I too am confused now.  First, I think David <sunfish62 at yahoo.com>
> stated in the other documentation thread that the document names need to be
> clarified, and that may be part of why I am confused.  I think that the
> short names seem to be Guide and Tutorial, which, if they were used
> consistently, would work for me.  I may be wrong about the names.
> >
> > Second, I think that there may be an alias issue, and I am not sure
> where I am sometimes because of that. In my last foray into online
> documentation I was specifically trying to get to the current stable
> (Release 3) version of the documentation, and when I repeat my itinerary as
> I tried to describe in previous posts, I do end up in pages identified as
> ../v3/..  So I am puzzled that Adrien does not seem to get to the same
> place, or how some of my previous attempts to document the trip do not seem
> to be leading to pages identified as ../v3/..
> >
> > Third, I think that document title and chapter numbers do not appear on
> every page in each form of the documentation, and that has not helped me to
> keep track of where I am.
> >
> > Fourth, the label on the link in the tip just below figure 4.3 of the
> help manual is named Tutorial and Concepts Guide and it does seem to point
> to the Tutorial ../v3/..section 4.2, so it seems correct for the current
> document structure.
> >
> > I am not trying to rant, just document my confusion and agreement that
> simplification would be helpful.
> >
> > David C
> >
> > On Mon, Aug 20, 2018 at 4:30 PM, Adrien Monteleone <
> adrien.monteleone at lusfiber.net> wrote:
> > Hmm.. Not sure how I missed that recently. (I’ve read it before)
> >
> > But then if it’s there, I wonder why so many questions still? Perhaps
> the organization or presentation isn’t very discoverable? User laziness?
> >
> > Also, I still don’t think after several years that I’m clear on the
> difference between the Help Manual and the Tutorial & Concepts Guide. I get
> what their names imply and I understand the explanation on the website, but
> here is a case of info that I would expect to find in the other document.
> This is info about the GUI itself, not ‘how to use’ GnuCash to accomplish
> an accounting task. (which the name “Tutorial & Concepts Guide” implies and
> even the website itself defines as the document’s function)
> >
> > Should this be relocated to the Help Manual?
> >
> > Regards,
> > Adrien
> >
> > > On Aug 20, 2018, at 3:44 PM, D <sunfish62 at yahoo.com> wrote:
> > >
> > > And you will find said documentation in the Guide at 2.3.3.
> > >
> > > David
> > >
> > > On August 20, 2018, at 2:32 PM, Derek Atkins <derek at ihtfp.com> wrote:
> > >
> > >
> > > On Mon, August 20, 2018 2:20 pm, Adrien Monteleone wrote:
> > >> Of course, that all makes sense.
> > >>
> > >> The other improvements, specifically how to resize columns,
> particularly
> > >> the Description column I think should be documented. There are enough
> > >> questions on the list about it to address the topic.
> > >
> > > Absolutely!
> > >
> > >> Regards,
> > >> Adrien
> > >
> > >> Please remember to CC this list on all your replies.
> > >> You can do this by using Reply-To-List or Reply-All.
> > >
> > > -derek
> > > --
> > >       Derek Atkins                 617-623-3745
> > >       derek at ihtfp.com             www.ihtfp.com
> > >       Computer and Internet Security Consultant
> >
> > _______________________________________________
> > 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
>