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

[John Ralls]

> On Aug 21, 2018, at 11:50 AM, Geert Janssens <geert.gnucash at kobaltwit.be> 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 create documentation. The libraries use gtk-doc to extract specially formatted comments and convert that to a form of Docbook to feed to yelp tools and itstool. In general those documents are published only on the web. The application docs are very simple, no more than a few pages.

> 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 "manageability" requirement, but it's crucial in a collaborative environment to be able to track who-did-what-when and to be able to restore an earlier version if something goes awry.

That said I'm perfectly happy to copy a rewritten section of a document into my working directory and create a commit out of it on behalf of a non-technical author who can't get their head around git.

Regards,
John Ralls