Recommended Change to Author LIsting in Documentation

classic Classic list List threaded Threaded
13 messages Options
Reply | Threaded
Open this post in threaded view
|

Recommended Change to Author LIsting in Documentation

GnuCash - Dev mailing list
Hi,

In response to seeing yet another new user sending a support request directly to one of the people mentioned in the documentation, I created Bug 775919 (https://bugzilla.gnome.org/show_bug.cgi?id=775919 <https://bugzilla.gnome.org/show_bug.cgi?id=775919>) as a proposed change to the way that the docs present the author attributions. In that bug, I state:

I recommend the following:

1) Remove all individual names and email addresses from the documentation title page, and replace them with a general attribution to "The GnuCash Documentation Team." Since the current copyright is to this entity, I think this is not only convenient, but also more accurate than the current list.

2) Place a large note on the title page identifying gnucash-users as the proper location to which to direct help requests. Section 2.4.2 is clearly not prominent enough for new users.

3) Retain the list of contributors that show on the title page verso. I will note that this list omits email addresses. In addition, add a note there about who and what the GnuCash Documentation Team is.

I propose: "The GnuCash Documentation Team is a self-designated group of GnuCash users and developers who have volunteered to write this documentation for the benefit of the broader user base. People who are interested in joining this group are encouraged to express their interest on the GnuCash lists (gnucash-users and gnucash-devel) for further direction.”
John Ralls thought that this change should be run past the Devel list, and so here I am, giving it a run. As one of the named contributors, I personally would prefer that my email not be included in the documentation, but I defer to the general interest of the group.

Cheers,
David T.
_______________________________________________
gnucash-devel mailing list
[hidden email]
https://lists.gnucash.org/mailman/listinfo/gnucash-devel
Reply | Threaded
Open this post in threaded view
|

Re: Recommended Change to Author LIsting in Documentation

Geert Janssens-4
Op zaterdag 10 december 2016 23:49:38 CET schreef David T. via gnucash-devel:

> Hi,
>
> In response to seeing yet another new user sending a support request
> directly to one of the people mentioned in the documentation, I created Bug
> 775919 (https://bugzilla.gnome.org/show_bug.cgi?id=775919
> <https://bugzilla.gnome.org/show_bug.cgi?id=775919>) as a proposed change
> to the way that the docs present the author attributions. In that bug, I
> state:
>
> I recommend the following:
>
> 1) Remove all individual names and email addresses from the documentation
> title page, and replace them with a general attribution to "The GnuCash
> Documentation Team." Since the current copyright is to this entity, I think
> this is not only convenient, but also more accurate than the current list.
>
> 2) Place a large note on the title page identifying gnucash-users as the
> proper location to which to direct help requests. Section 2.4.2 is clearly
> not prominent enough for new users.
>
> 3) Retain the list of contributors that show on the title page verso. I will
> note that this list omits email addresses. In addition, add a note there
> about who and what the GnuCash Documentation Team is.
>
> I propose: "The GnuCash Documentation Team is a self-designated group of
> GnuCash users and developers who have volunteered to write this
> documentation for the benefit of the broader user base. People who are
> interested in joining this group are encouraged to express their interest
> on the GnuCash lists (gnucash-users and gnucash-devel) for further
> direction.” John Ralls thought that this change should be run past the
> Devel list, and so here I am, giving it a run. As one of the named
> contributors, I personally would prefer that my email not be included in
> the documentation, but I defer to the general interest of the group.
>
> Cheers,
> David T.

Good idea! I agree to all your proposals.

Geert

_______________________________________________
gnucash-devel mailing list
[hidden email]
https://lists.gnucash.org/mailman/listinfo/gnucash-devel
Reply | Threaded
Open this post in threaded view
|

Re: Recommended Change to Author LIsting in Documentation

Christian Stimming-4
Am Samstag, 10. Dezember 2016, 22:48:48 schrieb Geert Janssens:
> Op zaterdag 10 december 2016 23:49:38 CET schreef David T. via gnucash-
devel:

> > Hi,
> >
> > In response to seeing yet another new user sending a support request
> > directly to one of the people mentioned in the documentation, I created
> > Bug
> > 775919 (https://bugzilla.gnome.org/show_bug.cgi?id=775919
> > <https://bugzilla.gnome.org/show_bug.cgi?id=775919>) as a proposed change
> > to the way that the docs present the author attributions. In that bug, I
> > state:
> >
> > I recommend the following:
> >
> > 1) Remove all individual names and email addresses from the documentation
> > title page, and replace them with a general attribution to "The GnuCash
> > Documentation Team." Since the current copyright is to this entity, I
> > think
> > this is not only convenient, but also more accurate than the current list.
> >
> > 2) Place a large note on the title page identifying gnucash-users as the
> > proper location to which to direct help requests. Section 2.4.2 is clearly
> > not prominent enough for new users.
> >
> > 3) Retain the list of contributors that show on the title page verso. I
> > will note that this list omits email addresses. In addition, add a note
> > there about who and what the GnuCash Documentation Team is.
> >
> > I propose: "The GnuCash Documentation Team is a self-designated group of
> > GnuCash users and developers who have volunteered to write this
> > documentation for the benefit of the broader user base. People who are
> > interested in joining this group are encouraged to express their interest
> > on the GnuCash lists (gnucash-users and gnucash-devel) for further
> > direction.” John Ralls thought that this change should be run past the
> > Devel list, and so here I am, giving it a run. As one of the named
> > contributors, I personally would prefer that my email not be included in
> > the documentation, but I defer to the general interest of the group.
> >
> > Cheers,
> > David T.
>
> Good idea! I agree to all your proposals.

Yes, I agree, too. Thanks for changing this!

Regards

Christian

_______________________________________________
gnucash-devel mailing list
[hidden email]
https://lists.gnucash.org/mailman/listinfo/gnucash-devel
Reply | Threaded
Open this post in threaded view
|

Re: Recommended Change to Author LIsting in Documentation

Alex Aycinena-2
In reply to this post by GnuCash - Dev mailing list
>
>
> ---------- Forwarded message ----------
> From: Geert Janssens <[hidden email]>
> To: [hidden email], "David T." <[hidden email]>
> Cc:
> Date: Sat, 10 Dec 2016 22:48:48 +0100
> Subject: Re: Recommended Change to Author LIsting in Documentation
> Op zaterdag 10 december 2016 23:49:38 CET schreef David T. via
> gnucash-devel:
> > Hi,
> >
> > In response to seeing yet another new user sending a support request
> > directly to one of the people mentioned in the documentation, I created
> Bug
> > 775919 (https://bugzilla.gnome.org/show_bug.cgi?id=775919
> > <https://bugzilla.gnome.org/show_bug.cgi?id=775919>) as a proposed
> change
> > to the way that the docs present the author attributions. In that bug, I
> > state:
> >
> > I recommend the following:
> >
> > 1) Remove all individual names and email addresses from the documentation
> > title page, and replace them with a general attribution to "The GnuCash
> > Documentation Team." Since the current copyright is to this entity, I
> think
> > this is not only convenient, but also more accurate than the current
> list.
> >
> > 2) Place a large note on the title page identifying gnucash-users as the
> > proper location to which to direct help requests. Section 2.4.2 is
> clearly
> > not prominent enough for new users.
> >
> > 3) Retain the list of contributors that show on the title page verso. I
> will
> > note that this list omits email addresses. In addition, add a note there
> > about who and what the GnuCash Documentation Team is.
> >
> > I propose: "The GnuCash Documentation Team is a self-designated group of
> > GnuCash users and developers who have volunteered to write this
> > documentation for the benefit of the broader user base. People who are
> > interested in joining this group are encouraged to express their interest
> > on the GnuCash lists (gnucash-users and gnucash-devel) for further
> > direction.” John Ralls thought that this change should be run past the
> > Devel list, and so here I am, giving it a run. As one of the named
> > contributors, I personally would prefer that my email not be included in
> > the documentation, but I defer to the general interest of the group.
> >
> > Cheers,
> > David T.
>
> Good idea! I agree to all your proposals.
>
> Geert
>
>
So do I.

Alex
_______________________________________________
gnucash-devel mailing list
[hidden email]
https://lists.gnucash.org/mailman/listinfo/gnucash-devel
Reply | Threaded
Open this post in threaded view
|

RE: Recommended Change to Author LIsting in Documentation

ChrisGood
In reply to this post by GnuCash - Dev mailing list
> Message: 2

> Date: Sat, 10 Dec 2016 23:49:38 +0500
> From: "David T." <[hidden email]>
> To: "David T. via gnucash-devel" <[hidden email]>
> Subject: Recommended Change to Author LIsting in Documentation
> Message-ID: <[hidden email]>
> Content-Type: text/plain; charset=utf-8
>
> Hi,
>
> In response to seeing yet another new user sending a support request
> directly to one of the people mentioned in the documentation, I created
Bug

> 775919 (https://bugzilla.gnome.org/show_bug.cgi?id=775919
> <https://bugzilla.gnome.org/show_bug.cgi?id=775919>) as a proposed
> change to the way that the docs present the author attributions. In that
> bug,
> I state:
>
> I recommend the following:
>
> 1) Remove all individual names and email addresses from the documentation
> title page, and replace them with a general attribution to "The GnuCash
> Documentation Team." Since the current copyright is to this entity, I
think
> this is not only convenient, but also more accurate than the current list.
>
> 2) Place a large note on the title page identifying gnucash-users as the
> proper
> location to which to direct help requests. Section 2.4.2 is clearly not
> prominent enough for new users.
>
> 3) Retain the list of contributors that show on the title page verso. I
will
> note
> that this list omits email addresses. In addition, add a note there about
> who
> and what the GnuCash Documentation Team is.
>
> I propose: "The GnuCash Documentation Team is a self-designated group of
> GnuCash users and developers who have volunteered to write this
> documentation for the benefit of the broader user base. People who are
> interested in joining this group are encouraged to express their interest
on
> the GnuCash lists (gnucash-users and gnucash-devel) for further
direction.?
> John Ralls thought that this change should be run past the Devel list, and

> so
> here I am, giving it a run. As one of the named contributors, I personally
> would prefer that my email not be included in the documentation, but I
> defer to the general interest of the group.
>
> Cheers,
> David T.

Hi David,

Sounds good to me.
A link to https://wiki.gnucash.org/wiki/Mailing_Lists would be good.

Regards,
Chris Good


_______________________________________________
gnucash-devel mailing list
[hidden email]
https://lists.gnucash.org/mailman/listinfo/gnucash-devel

smime.p7s (6K) Download Attachment
Reply | Threaded
Open this post in threaded view
|

Re: Recommended Change to Author LIsting in Documentation

GnuCash - Dev mailing list
I see that John has already removed the email addresses of individuals listed in gnu cash-guide.xml.

Looking at the other two aspects, I see putting a combined note for both 2 & 3 attached to the releaseinfo tag, which currently says: “This Guide contains a tutorial for using GnuCash and describes the concepts behind GnuCash."

Looking more at what John did and didn’t do, I see that he left the individual copyright statements in the document, but it seems to me that there is a cross up here that could cause problems. Specifically, the copyright is assigned to named individuals and also to the GnuCash Documentation Team, but some of the individual copyright holders are also later identified as members of the GDT, which could lead to questions about who actually holds the copyright. Does Yawar Amin hold copyright, or does the GDT, of which Yawar is a member?

I don’t know what the proper answer to this question is; perhaps someone else does?

Cheers,
David T.

> On Dec 12, 2016, at 10:48 AM, Chris Good <[hidden email]> wrote:
>
>> Message: 2
>> Date: Sat, 10 Dec 2016 23:49:38 +0500
>> From: "David T." <[hidden email]>
>> To: "David T. via gnucash-devel" <[hidden email]>
>> Subject: Recommended Change to Author LIsting in Documentation
>> Message-ID: <[hidden email]>
>> Content-Type: text/plain; charset=utf-8
>>
>> Hi,
>>
>> In response to seeing yet another new user sending a support request
>> directly to one of the people mentioned in the documentation, I created
> Bug
>> 775919 (https://bugzilla.gnome.org/show_bug.cgi?id=775919
>> <https://bugzilla.gnome.org/show_bug.cgi?id=775919>) as a proposed
>> change to the way that the docs present the author attributions. In that
>> bug,
>> I state:
>>
>> I recommend the following:
>>
>> 1) Remove all individual names and email addresses from the documentation
>> title page, and replace them with a general attribution to "The GnuCash
>> Documentation Team." Since the current copyright is to this entity, I
> think
>> this is not only convenient, but also more accurate than the current list.
>>
>> 2) Place a large note on the title page identifying gnucash-users as the
>> proper
>> location to which to direct help requests. Section 2.4.2 is clearly not
>> prominent enough for new users.
>>
>> 3) Retain the list of contributors that show on the title page verso. I
> will
>> note
>> that this list omits email addresses. In addition, add a note there about
>> who
>> and what the GnuCash Documentation Team is.
>>
>> I propose: "The GnuCash Documentation Team is a self-designated group of
>> GnuCash users and developers who have volunteered to write this
>> documentation for the benefit of the broader user base. People who are
>> interested in joining this group are encouraged to express their interest
> on
>> the GnuCash lists (gnucash-users and gnucash-devel) for further
> direction.?
>> John Ralls thought that this change should be run past the Devel list, and
>
>> so
>> here I am, giving it a run. As one of the named contributors, I personally
>> would prefer that my email not be included in the documentation, but I
>> defer to the general interest of the group.
>>
>> Cheers,
>> David T.
>
> Hi David,
>
> Sounds good to me.
> A link to https://wiki.gnucash.org/wiki/Mailing_Lists would be good.
>
> Regards,
> Chris Good
>

_______________________________________________
gnucash-devel mailing list
[hidden email]
https://lists.gnucash.org/mailman/listinfo/gnucash-devel
Reply | Threaded
Open this post in threaded view
|

Re: Recommended Change to Author LIsting in Documentation

John Ralls-2

> On Dec 12, 2016, at 4:17 AM, David T. via gnucash-devel <[hidden email]> wrote:
>
> I see that John has already removed the email addresses of individuals listed in gnu cash-guide.xml.
>
> Looking at the other two aspects, I see putting a combined note for both 2 & 3 attached to the releaseinfo tag, which currently says: “This Guide contains a tutorial for using GnuCash and describes the concepts behind GnuCash."
>
> Looking more at what John did and didn’t do, I see that he left the individual copyright statements in the document, but it seems to me that there is a cross up here that could cause problems. Specifically, the copyright is assigned to named individuals and also to the GnuCash Documentation Team, but some of the individual copyright holders are also later identified as members of the GDT, which could lead to questions about who actually holds the copyright. Does Yawar Amin hold copyright, or does the GDT, of which Yawar is a member?
>
> I don’t know what the proper answer to this question is; perhaps someone else does?
>

Copyright belongs to the author unless he legally assigns it to another person (natural or corporate). The GnuCash Documentation Team isn't a corporation and so isn't a person and so can't be assigned copyright. Copyright statements assert copyright, they don't assign it. While protected speech, the assertion of copyright by the GnuCash Documentation Team is legally meaningless since there's no legal entity behind the assertion.

There's a nice general discussion of copyright in open source at http://producingoss.com/en/copyright-assignment.html <http://producingoss.com/en/copyright-assignment.html>, and the FSF (which requires copyright assignment on its core projects) has quite a lot on their website as well.

Regards,
John Ralls
_______________________________________________
gnucash-devel mailing list
[hidden email]
https://lists.gnucash.org/mailman/listinfo/gnucash-devel
Reply | Threaded
Open this post in threaded view
|

Re: Recommended Change to Author LIsting in Documentation

John Ralls-2
In reply to this post by GnuCash - Dev mailing list

> On Dec 10, 2016, at 10:49 AM, David T. via gnucash-devel <[hidden email]> wrote:
>
> Hi,
>
> In response to seeing yet another new user sending a support request directly to one of the people mentioned in the documentation, I created Bug 775919 (https://bugzilla.gnome.org/show_bug.cgi?id=775919 <https://bugzilla.gnome.org/show_bug.cgi?id=775919>) as a proposed change to the way that the docs present the author attributions. In that bug, I state:
>
> I recommend the following:
>
> 1) Remove all individual names and email addresses from the documentation title page, and replace them with a general attribution to "The GnuCash Documentation Team." Since the current copyright is to this entity, I think this is not only convenient, but also more accurate than the current list.
>
> 2) Place a large note on the title page identifying gnucash-users as the proper location to which to direct help requests. Section 2.4.2 is clearly not prominent enough for new users.
>
> 3) Retain the list of contributors that show on the title page verso. I will note that this list omits email addresses. In addition, add a note there about who and what the GnuCash Documentation Team is.
>
> I propose: "The GnuCash Documentation Team is a self-designated group of GnuCash users and developers who have volunteered to write this documentation for the benefit of the broader user base. People who are interested in joining this group are encouraged to express their interest on the GnuCash lists (gnucash-users and gnucash-devel) for further direction.”
> John Ralls thought that this change should be run past the Devel list, and so here I am, giving it a run. As one of the named contributors, I personally would prefer that my email not be included in the documentation, but I defer to the general interest of the group.

I couldn't get anything beyond the author on either side of the title page, so I've reduced the author list to "The GnuCash Documentation Team" and added a preface block titled "About the Author" with David's proposed paragraph and then "Contributors to the team so far have been:" followed by a list of authors and translators for the document in question.

Note to Frank, Mechtilde, and Pedro: I did this in English on the German and Portuguese translations. If you can get this translated by Saturday for the release that would be great. I'd rather not use Google Translate.

I've also cleaned up the "More Help" section and applied it to the Guide as well as the Help. It's at the end of the first chapter (Overview) in the Guide and the second (Using this Document and Getting Help) in Help. Would it be better to make it preface material to make it more prominent?

The changes should show up in tomorrow's docs nightlies, http://code.gnucash.org/docs/. The "C" directory has the English version. I didn't copy the updated "More Help" into the German or Portuguese translations; Italian is generated so it will be there too, but in English.

Regards,
John Ralls
_______________________________________________
gnucash-devel mailing list
[hidden email]
https://lists.gnucash.org/mailman/listinfo/gnucash-devel
Reply | Threaded
Open this post in threaded view
|

Re: Recommended Change to Author LIsting in Documentation

GnuCash - Dev mailing list
Thanks John. That looks pretty good, although I think we should continue to look for ways to bring the lists to new users’ attention.

David

P.S., Thanks  for the leads on the copyright question. I read a bit of that, and see how involved it can get.
 

> On Dec 14, 2016, at 5:37 AM, John Ralls <[hidden email]> wrote:
>
>
>> On Dec 10, 2016, at 10:49 AM, David T. via gnucash-devel <[hidden email]> wrote:
>>
>> Hi,
>>
>> In response to seeing yet another new user sending a support request directly to one of the people mentioned in the documentation, I created Bug 775919 (https://bugzilla.gnome.org/show_bug.cgi?id=775919 <https://bugzilla.gnome.org/show_bug.cgi?id=775919>) as a proposed change to the way that the docs present the author attributions. In that bug, I state:
>>
>> I recommend the following:
>>
>> 1) Remove all individual names and email addresses from the documentation title page, and replace them with a general attribution to "The GnuCash Documentation Team." Since the current copyright is to this entity, I think this is not only convenient, but also more accurate than the current list.
>>
>> 2) Place a large note on the title page identifying gnucash-users as the proper location to which to direct help requests. Section 2.4.2 is clearly not prominent enough for new users.
>>
>> 3) Retain the list of contributors that show on the title page verso. I will note that this list omits email addresses. In addition, add a note there about who and what the GnuCash Documentation Team is.
>>
>> I propose: "The GnuCash Documentation Team is a self-designated group of GnuCash users and developers who have volunteered to write this documentation for the benefit of the broader user base. People who are interested in joining this group are encouraged to express their interest on the GnuCash lists (gnucash-users and gnucash-devel) for further direction.”
>> John Ralls thought that this change should be run past the Devel list, and so here I am, giving it a run. As one of the named contributors, I personally would prefer that my email not be included in the documentation, but I defer to the general interest of the group.
>
> I couldn't get anything beyond the author on either side of the title page, so I've reduced the author list to "The GnuCash Documentation Team" and added a preface block titled "About the Author" with David's proposed paragraph and then "Contributors to the team so far have been:" followed by a list of authors and translators for the document in question.
>
> Note to Frank, Mechtilde, and Pedro: I did this in English on the German and Portuguese translations. If you can get this translated by Saturday for the release that would be great. I'd rather not use Google Translate.
>
> I've also cleaned up the "More Help" section and applied it to the Guide as well as the Help. It's at the end of the first chapter (Overview) in the Guide and the second (Using this Document and Getting Help) in Help. Would it be better to make it preface material to make it more prominent?
>
> The changes should show up in tomorrow's docs nightlies, http://code.gnucash.org/docs/. The "C" directory has the English version. I didn't copy the updated "More Help" into the German or Portuguese translations; Italian is generated so it will be there too, but in English.
>
> Regards,
> John Ralls


_______________________________________________
gnucash-devel mailing list
[hidden email]
https://lists.gnucash.org/mailman/listinfo/gnucash-devel
Reply | Threaded
Open this post in threaded view
|

Re: Recommended Change to Author LIsting in Documentation

John Ralls-2

> On Dec 14, 2016, at 8:01 AM, David T. <[hidden email]> wrote:
>
> Thanks John. That looks pretty good, although I think we should continue to look for ways to bring the lists to new users’ attention.
>
> David
>
> P.S., Thanks  for the leads on the copyright question. I read a bit of that, and see how involved it can get.
>
>> On Dec 14, 2016, at 5:37 AM, John Ralls <[hidden email]> wrote:
>>
>>
>>> On Dec 10, 2016, at 10:49 AM, David T. via gnucash-devel <[hidden email]> wrote:
>>>
>>> Hi,
>>>
>>> In response to seeing yet another new user sending a support request directly to one of the people mentioned in the documentation, I created Bug 775919 (https://bugzilla.gnome.org/show_bug.cgi?id=775919 <https://bugzilla.gnome.org/show_bug.cgi?id=775919>) as a proposed change to the way that the docs present the author attributions. In that bug, I state:
>>>
>>> I recommend the following:
>>>
>>> 1) Remove all individual names and email addresses from the documentation title page, and replace them with a general attribution to "The GnuCash Documentation Team." Since the current copyright is to this entity, I think this is not only convenient, but also more accurate than the current list.
>>>
>>> 2) Place a large note on the title page identifying gnucash-users as the proper location to which to direct help requests. Section 2.4.2 is clearly not prominent enough for new users.
>>>
>>> 3) Retain the list of contributors that show on the title page verso. I will note that this list omits email addresses. In addition, add a note there about who and what the GnuCash Documentation Team is.
>>>
>>> I propose: "The GnuCash Documentation Team is a self-designated group of GnuCash users and developers who have volunteered to write this documentation for the benefit of the broader user base. People who are interested in joining this group are encouraged to express their interest on the GnuCash lists (gnucash-users and gnucash-devel) for further direction.”
>>> John Ralls thought that this change should be run past the Devel list, and so here I am, giving it a run. As one of the named contributors, I personally would prefer that my email not be included in the documentation, but I defer to the general interest of the group.
>>
>> I couldn't get anything beyond the author on either side of the title page, so I've reduced the author list to "The GnuCash Documentation Team" and added a preface block titled "About the Author" with David's proposed paragraph and then "Contributors to the team so far have been:" followed by a list of authors and translators for the document in question.
>>
>> Note to Frank, Mechtilde, and Pedro: I did this in English on the German and Portuguese translations. If you can get this translated by Saturday for the release that would be great. I'd rather not use Google Translate.
>>
>> I've also cleaned up the "More Help" section and applied it to the Guide as well as the Help. It's at the end of the first chapter (Overview) in the Guide and the second (Using this Document and Getting Help) in Help. Would it be better to make it preface material to make it more prominent?
>>
>> The changes should show up in tomorrow's docs nightlies, http://code.gnucash.org/docs/. The "C" directory has the English version. I didn't copy the updated "More Help" into the German or Portuguese translations; Italian is generated so it will be there too, but in English.

David,

Do you think making the support page "Preface" material--so that it comes either just before or just after "About the Author" might make it more prominent?

As for the copyright stuff, yeah, it gets pretty involved. I know a bit about it only because it's a frequently-beaten drum in genealogy circles.

Regards,
John Ralls


_______________________________________________
gnucash-devel mailing list
[hidden email]
https://lists.gnucash.org/mailman/listinfo/gnucash-devel
Reply | Threaded
Open this post in threaded view
|

Re: Recommended Change to Author LIsting in Documentation

GnuCash - Dev mailing list

> On Dec 15, 2016, at 9:18 AM, John Ralls <[hidden email]> wrote:
>
> David,
>
> Do you think making the support page "Preface" material--so that it comes either just before or just after "About the Author" might make it more prominent?
>
> As for the copyright stuff, yeah, it gets pretty involved. I know a bit about it only becaus

John,

The About the Author page, when rendered in print, appears after the table of contents (all 8 pages of it). When rendered online, it gets buried in “About this document”.

Neither of these solutions is all that likely to be seen by the panicked new user who needs a desperate question answered quickly. However, I see that there are numerous spots both online and in the docs that point people to the lists, so it is clear that those who have made these misguided cries for help have done so despite the many recommendations to the contrary. Given all that, perhaps it is enough to have removed the email addresses for the doc contributors. Without those prominent points of contact, users will (one hopes) avail themselves of the lists, as instructed on the main gnucash.org  page, and in the Guide.

I am open to other ideas…

David
_______________________________________________
gnucash-devel mailing list
[hidden email]
https://lists.gnucash.org/mailman/listinfo/gnucash-devel
Reply | Threaded
Open this post in threaded view
|

Re: Recommended Change to Author LIsting in Documentation

John Ralls-2

> On Dec 15, 2016, at 5:38 AM, David T. <[hidden email]> wrote:
>
>
>> On Dec 15, 2016, at 9:18 AM, John Ralls <[hidden email]> wrote:
>>
>> David,
>>
>> Do you think making the support page "Preface" material--so that it comes either just before or just after "About the Author" might make it more prominent?
>>
>> As for the copyright stuff, yeah, it gets pretty involved. I know a bit about it only becaus
>
> John,
>
> The About the Author page, when rendered in print, appears after the table of contents (all 8 pages of it). When rendered online, it gets buried in “About this document”.
>
> Neither of these solutions is all that likely to be seen by the panicked new user who needs a desperate question answered quickly. However, I see that there are numerous spots both online and in the docs that point people to the lists, so it is clear that those who have made these misguided cries for help have done so despite the many recommendations to the contrary. Given all that, perhaps it is enough to have removed the email addresses for the doc contributors. Without those prominent points of contact, users will (one hopes) avail themselves of the lists, as instructed on the main gnucash.org  page, and in the Guide.
>
> I am open to other ideas…

David,

You're right about it being after the TOC in a PDF/e-book, but in html "About the Author" is the second link in the index page after "About this Document" and the "Next>>>" link in the upper right-hand corner skips "About this Document" and goes straight to "About the Author". Changing either of those requires changing the XSL stylesheets that compose the DocBook markup into documents and there isn't time for me to learn that before this weekend's release.

Since I still get Google search results that point to the 2.4 version of the manual I suppose I should back-port the changes there.

OTOH, none of this is going to have any impact on the users who push F1 on an older release because they'll get the version of the docs that corresponds to the version of GnuCash they have installed, complete with all of the emails on the title page.

Regards,
John Ralls


_______________________________________________
gnucash-devel mailing list
[hidden email]
https://lists.gnucash.org/mailman/listinfo/gnucash-devel
Reply | Threaded
Open this post in threaded view
|

Re: Recommended Change to Author LIsting in Documentation

GnuCash - Dev mailing list

> On Dec 15, 2016, at 9:42 PM, John Ralls <[hidden email]> wrote:
>
> David,
>
> You're right about it being after the TOC in a PDF/e-book, but in html "About the Author" is the second link in the index page after "About this Document" and the "Next>>>" link in the upper right-hand corner skips "About this Document" and goes straight to "About the Author". Changing either of those requires changing the XSL stylesheets that compose the DocBook markup into documents and there isn't time for me to learn that before this weekend's release.
>
> Since I still get Google search results that point to the 2.4 version of the manual I suppose I should back-port the changes there.
>
> OTOH, none of this is going to have any impact on the users who push F1 on an older release because they'll get the version of the docs that corresponds to the version of GnuCash they have installed, complete with all of the emails on the title page.
>
> Regards,
> John Ralls
>

Sorry, I was looking at the current release online, rather than the nightly build. I think your current solution looks fine, and we can see how it shakes out.

David


_______________________________________________
gnucash-devel mailing list
[hidden email]
https://lists.gnucash.org/mailman/listinfo/gnucash-devel