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

On Mon, 27 Aug 2018 11:14:28 -0500 Rob Gowin wrote: > On Mon, Aug 27, 2018 at 7:50 AM, Mike Evans wrote: > > > > Hi Rob > > > > Referring to your mail of 2015-09-01 you "put the XSL file and a python > > script to run the conversion process in a repository at > >

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

On Mon, Aug 27, 2018 at 7:50 AM, Mike Evans wrote: > > Hi Rob > > Referring to your mail of 2015-09-01 you "put the XSL file and a python > script to run the conversion process in a repository at > https://github.com/codesmythe/asciidoc-conversion.; > > This no longer exists, can you make it

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

On Thu, 23 Aug 2018 12:25:51 -0500 Rob Gowin wrote: > On Thu, Aug 23, 2018 at 11:40 AM, John Ralls wrote: > > > > > > > So a new thought: One of the core devs use pandoc to convert the DocBook > > source to one of the markup/markdown variants, do the necessary manual > > fixups and commit the

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

> On Aug 23, 2018, at 12:45 AM, Geert Janssens > wrote: > > It would be nice if our html version of the docs would get some css love in > that case though. Wading through plain rendered html is an equally 2000'ish > experience. I just had a look at

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

> On Aug 23, 2018, at 3:00 AM, Geert Janssens > wrote: > > Op dinsdag 21 augustus 2018 21:36:58 CEST schreef John Ralls: >>> On Aug 21, 2018, at 11:50 AM, Geert Janssens >>> wrote: >>> Aside from that they also expect there writers to work with git. >> >> Version control is an obvious hard

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

> So does GitHub (it’s the pencil icon to the right of Raw/Blame/History), > which also has a desktop front-end, https://desktop.github.com/ > and a button on a file’s webpage that opens the > file in Github Desktop. > I haven’t tried any of them, but perhaps David

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

So. I just tried this out on bug 791169. I believe it worked? On August 23, 2018, at 11:47 PM, John Ralls wrote: David, It’s git. It’s never difficult to remove stuff, but on the website there’s no reflow to get back what you’ve deleted, so take a  little more care than usual. (Well, there

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

David, It’s git. It’s never difficult to remove stuff, but on the website there’s no reflow to get back what you’ve deleted, so take a little more care than usual. (Well, there is, but not from the web interface: https://medium.com/git-tips/githubs-reflog-a9ff21ff765f

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

Hmm. Let me see if I understand this correctly. You’re saying that I could make edits on my own forked copy of gnucash-docs, save those changes, and get them to the official gnucash-docs *all from the github website*? *If* I understand it correctly, then this would be a big improvement from my

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

> On Aug 23, 2018, at 10:25 AM, Rob Gowin wrote: > > > On Thu, Aug 23, 2018 at 11:40 AM, John Ralls wrote: > > > So a new thought: One of the core devs use pandoc to convert the DocBook > source to one of the markup/markdown variants, do the necessary manual fixups > and commit the

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

On Thu, Aug 23, 2018 at 11:40 AM, John Ralls wrote: > > > So a new thought: One of the core devs use pandoc to convert the DocBook > source to one of the markup/markdown variants, do the necessary manual > fixups and commit the result. If we want DocBook for some reason the build > process would

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

> On Aug 23, 2018, at 12:37 AM, Geert Janssens > wrote: > > Op dinsdag 21 augustus 2018 20:50:38 CEST schreef Geert Janssens: >> Op dinsdag 21 augustus 2018 17:49:57 CEST schreef Adrien Monteleone: >>> but is there a list of ’needs’ of the >>> developers to use when evaluating methods? >> >>

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

> On Aug 23, 2018, at 12:45 AM, Geert Janssens > wrote: > > Op dinsdag 21 augustus 2018 21:24:25 CEST schreef John Ralls: >>> On Aug 21, 2018, at 11:50 AM, Geert Janssens >>> wrote: - it should allow multiple output formats. A few the come to mind: >>> html, pdf, epub, mobi, windows

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

> On Aug 23, 2018, at 6:37 AM, Geert Janssens > wrote: > > Op donderdag 23 augustus 2018 15:08:54 CEST schreef Derek Atkins: >> Geert Janssens writes: >> >> [snip] >> >>> So I'm open for alternatives that would equally handle version >>> control, but is easier for documentation writers to

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

Op donderdag 23 augustus 2018 15:08:54 CEST schreef Derek Atkins: > Geert Janssens writes: > > [snip] > > > So I'm open for alternatives that would equally handle version > > control, but is easier for documentation writers to cope with. > > > > This can be a completely different tool that

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

Geert Janssens writes: [snip] > So I'm open for alternatives that would equally handle version > control, but is easier for documentation writers to cope with. > > This can be a completely different tool that feels more intuitive or > it can be a system layered on top of git which would hide

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

Op dinsdag 21 augustus 2018 21:36:58 CEST schreef John Ralls: > > On Aug 21, 2018, at 11:50 AM, Geert Janssens > > wrote: > > Aside from that they also expect there writers to work with git. > > Version control is an obvious hard requirement. I don't know if it > completely fulfills your

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

Op dinsdag 21 augustus 2018 21:24:25 CEST schreef John Ralls: > > On Aug 21, 2018, at 11:50 AM, Geert Janssens > > wrote: - it should allow multiple output formats. A few the come to mind: > > html, pdf, epub, mobi, windows compressed help, xml for yelp,... > > We don't need a single tool to do

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

Op dinsdag 21 augustus 2018 20:50:38 CEST schreef Geert Janssens: > Op dinsdag 21 augustus 2018 17:49:57 CEST schreef Adrien Monteleone: > > but is there a list of ’needs’ of the > > developers to use when evaluating methods? > > I don't think it's ever been formally written down. But here is a

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

> On Aug 21, 2018, at 11:50 AM, Geert Janssens > wrote: > > > I believe the gnome project is using Mallard (http://projectmallard.org/). That depends. The Gnome applications that have help at all use mallard (which is a Docbook dialect) on which they apply yelp-tools and itstool to

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

Adrien, If you mean https://help.gnome.org , those docs are built using Yelp tools, see https://gitlab.gnome.org/GNOME?utf8=%E2%9C%93=yelp . Most of that documentation seems pretty cursory, even for largish apps like

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

> On Aug 21, 2018, at 11:50 AM, Geert Janssens > wrote: > - it should allow multiple output formats. A few the come to mind: > html, pdf, epub, mobi, windows compressed help, xml for yelp,... We don't need a single tool to do that; in fact we don't use a single tool now. We create Windows

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

Op dinsdag 21 augustus 2018 17:49:57 CEST schreef Adrien Monteleone: > Thanks for the background info Geert, > > I recall a discussion some time ago about the tools and methods used to > generate the documentation, and I think based on that thread and the info > you’ve just provided that the

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

> On Aug 21, 2018, at 7:12 AM, David T. wrote: > > David, > > I haven’t advocated for renaming the documents. I changed a couple of > headings on the main wiki page. > > There are two documents, > > 1) the Help Manual > and > 2) the Tutorial and Concepts Guide > > as outlined at

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

Thanks for the background info Geert, I recall a discussion some time ago about the tools and methods used to generate the documentation, and I think based on that thread and the info you’ve just provided that the solution lies in a new method entirely. (frames aren’t really the best option as

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

David, I haven’t advocated for renaming the documents. I changed a couple of headings on the main wiki page. There are two documents, 1) the Help Manual and 2) the Tutorial and Concepts Guide as outlined at gnucash.org . One might refer to them respectively as the

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

Op dinsdag 21 augustus 2018 02:44:59 CEST schreef Adrien Monteleone: > 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#t > > xns-regstyle1 > Notice this is in the folder

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

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.montele...@lusfiber.net> wrote: > David C, > > So for clarification this is the first link you posted about: > > >

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

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

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

I too am confused now. First, I think David > 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

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

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

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

Strange, I followed that path and I still only get /viewdoc links. I can’t seem to hit the /docs/v3 section of the site. (notice your link is also to the /viewdoc URL, not /docs/v3) Anyway, as for Gmail, it’s there, you have to click in the reply box to start your reply for it to appear. (I

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

OK. For my complete itinerary, I started at the GnuCash home page https://www.gnucash.org/. Clicked on Downloads > Documentation in the left column https://www.gnucash.org/docs.phtml from there I scrolled down the right to GnuCash v3 (current stable release) then I selected Download Stable Help

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

I just filed: https://bugs.gnucash.org/show_bug.cgi?id=796823 On the title issue as that’s a basic website usability bug. I’ll wait for someone else to chime in on the case of the gnucash-guide folder. Regards, Adrien > On Aug 20, 2018, at 1:06 PM, Adrien Monteleone > wrote: > > David, > >

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

David, The confusion as to which document you were in I think is that the link text says ‘gnucash-guide’. There are also several references scattered on the website/wiki that refer to the ‘Help Guide’ though it appears the Documentation page calls it the ‘Help Manual’. That folder name I