Re: [GNC-dev] Main WIki Page edit

2018-08-20 Thread Adrien Monteleone
Thanks John,

That makes things very clear.

Regards,
Adrien

> On Aug 20, 2018, at 10:39 PM, John Ralls  wrote:
> 
> Adrien,
> 
> I’ve redone the descriptions of the help manual and T to be more correct 
> and I hope clearer. See what you think.
> 
> Regards,
> John Ralls
> 
>> On Aug 20, 2018, at 7:50 PM, John Ralls  wrote:
>> 
>> Adrien,
>> 
>> Neither “clarification” is correct.
>> 
>> The “Tutorial and Concepts Guide” contains a *very* basic introduction to 
>> double-entry accounting, enough to get a new user going if all they have is 
>> a simple bank account and credit card. The rest of it is “how-to” on using 
>> GnuCash to perform some more complex tasks like managing capital gains and 
>> the business module. The emphasis is on using GnuCash and understanding its 
>> quirks. Mostly GnuCash tutorial with an introduction to concepts. 
>> 
>> The “Help Manual” is called that because it’s the document underneath the 
>> context-sensitive help; it has detailed explanations of some of GnuCash’s 
>> windows and dialogs, on the “this button activates foo, the buttons on this 
>> radio control selects which sort of bar you want” level. It’s strung 
>> together to form a document, but it’s not the sort of thing one would want 
>> to read like a book. There’s nothing at all about accounting in it.
>> 
>> Regards,
>> John Ralls
>> 
>>> On Aug 20, 2018, at 5:55 PM, Adrien Monteleone 
>>>  wrote:
>>> 
>>> Nice.
>>> 
>>> How about this for a tad more clarity on the two official documentation 
>>> items:
>>> 
>>> * [http://www.gnucash.org/viewdoc.phtml?doc=help The Help Manual] - a quick 
>>> reference manual for ~~specific~~ _basic accounting_ tasks, and
>>> * [http://www.gnucash.org/viewdoc.phtml?doc=guide The Tutorial and Concepts 
>>> Guide] - an in-depth guide ~~to the concepts~~ _on using GnuCash to 
>>> implement specific accounting concepts_. It is highly recommended to read 
>>> at least the ~~first chapters~~ _Getting Started section_ of the guide.
>>> 
>>> That last edit of course could be more specific with a number of chapters, 
>>> especially if the recommendation is beyond Section I. My point is just that 
>>> ‘first chapters’ is a bit vague. (ideally, users should read it all of 
>>> course, save maybe the business or investing sections if they aren’t 
>>> applicable.)
>>> 
>>> Regards,
>>> Adrien
>>> 
>>> 
 On Aug 20, 2018, at 7:30 PM, John Ralls  wrote:
 
 
 
> On Aug 20, 2018, at 6:57 AM, David T. via gnucash-devel 
>  wrote:
> 
> OK. I have looked over this issue with an eye to clarifying the text, and 
> I believe that the User Documentation section should be simplified. As 
> currently written, as you all have noted, the User Documentation section 
> includes different layers of content, presented at the same tier of 
> coverage. Thus, the Help and Tutorial are presented alongside two wiki 
> pages and two glossaries. That’s inconsistent. 
> 
> So, first up is to level things off. That means eliminating the separate 
> headings for the Glossaries, the FAQ and Using Gnucash, and changing the 
> main section to refer to the wiki at the same level as the Help and 
> Tutorial. In the interest of helping people in dire need, I choose to 
> retain the references to the FAQ and Using GnuCash pages, but as a 
> descriptive list under the wiki in general (I will note that I also 
> changed the Getting Help page to parallel this approach). As suggested, 
> mention of the Glossaries isn’t particularly appropriate here, so I 
> remove it altogether. [FWIW, I think the proper approach would be to make 
> sure that all uses of special terminology in the wiki and the 
> documentation receive reference to their glossary definitions, ideally as 
> tool tips—but that solution is beyond my ability]
> 
> I also don’t like “User Documentation” since we aren’t documenting users, 
> so I prefer “Documentation for Users”, which requires the following 
> heading to be changed to “Documentation for Developers”
> 
> Here is my final suggestion for the section in question:
> 
> === Documentation for Users ===
> GnuCash offers two major pieces of documentation: 
> * [http://www.gnucash.org/viewdoc.phtml?doc=help The Help Manual] - a 
> quick reference manual for specific tasks, and
> * [http://www.gnucash.org/viewdoc.phtml?doc=guide The Tutorial and 
> Concepts Guide] - an in-depth guide to the concepts. It is highly 
> recommended to read at least the first chapters of the guide.
> The [http://www.gnucash.org/docs.phtml Documentation page on the 
> gnucash.org ''website''] also contains these documents in
> * '''other languages:''' de, it, ja, pt; 
> * '''other formats:''' ''PDF'', ''ePub'' or ''mobi''; as well as
> * '''other releases:''' nightly (unstable),  previous and earlier stable 
> releases.
> The GnuCash wiki includes 

Re: [GNC-dev] Main WIki Page edit

2018-08-20 Thread John Ralls
Adrien,

I’ve redone the descriptions of the help manual and T to be more correct and 
I hope clearer. See what you think.

Regards,
John Ralls

> On Aug 20, 2018, at 7:50 PM, John Ralls  wrote:
> 
> Adrien,
> 
> Neither “clarification” is correct.
> 
> The “Tutorial and Concepts Guide” contains a *very* basic introduction to 
> double-entry accounting, enough to get a new user going if all they have is a 
> simple bank account and credit card. The rest of it is “how-to” on using 
> GnuCash to perform some more complex tasks like managing capital gains and 
> the business module. The emphasis is on using GnuCash and understanding its 
> quirks. Mostly GnuCash tutorial with an introduction to concepts. 
> 
> The “Help Manual” is called that because it’s the document underneath the 
> context-sensitive help; it has detailed explanations of some of GnuCash’s 
> windows and dialogs, on the “this button activates foo, the buttons on this 
> radio control selects which sort of bar you want” level. It’s strung together 
> to form a document, but it’s not the sort of thing one would want to read 
> like a book. There’s nothing at all about accounting in it.
> 
> Regards,
> John Ralls
> 
>> On Aug 20, 2018, at 5:55 PM, Adrien Monteleone 
>>  wrote:
>> 
>> Nice.
>> 
>> How about this for a tad more clarity on the two official documentation 
>> items:
>> 
>> * [http://www.gnucash.org/viewdoc.phtml?doc=help The Help Manual] - a quick 
>> reference manual for ~~specific~~ _basic accounting_ tasks, and
>> * [http://www.gnucash.org/viewdoc.phtml?doc=guide The Tutorial and Concepts 
>> Guide] - an in-depth guide ~~to the concepts~~ _on using GnuCash to 
>> implement specific accounting concepts_. It is highly recommended to read at 
>> least the ~~first chapters~~ _Getting Started section_ of the guide.
>> 
>> That last edit of course could be more specific with a number of chapters, 
>> especially if the recommendation is beyond Section I. My point is just that 
>> ‘first chapters’ is a bit vague. (ideally, users should read it all of 
>> course, save maybe the business or investing sections if they aren’t 
>> applicable.)
>> 
>> Regards,
>> Adrien
>> 
>> 
>>> On Aug 20, 2018, at 7:30 PM, John Ralls  wrote:
>>> 
>>> 
>>> 
 On Aug 20, 2018, at 6:57 AM, David T. via gnucash-devel 
  wrote:
 
 OK. I have looked over this issue with an eye to clarifying the text, and 
 I believe that the User Documentation section should be simplified. As 
 currently written, as you all have noted, the User Documentation section 
 includes different layers of content, presented at the same tier of 
 coverage. Thus, the Help and Tutorial are presented alongside two wiki 
 pages and two glossaries. That’s inconsistent. 
 
 So, first up is to level things off. That means eliminating the separate 
 headings for the Glossaries, the FAQ and Using Gnucash, and changing the 
 main section to refer to the wiki at the same level as the Help and 
 Tutorial. In the interest of helping people in dire need, I choose to 
 retain the references to the FAQ and Using GnuCash pages, but as a 
 descriptive list under the wiki in general (I will note that I also 
 changed the Getting Help page to parallel this approach). As suggested, 
 mention of the Glossaries isn’t particularly appropriate here, so I remove 
 it altogether. [FWIW, I think the proper approach would be to make sure 
 that all uses of special terminology in the wiki and the documentation 
 receive reference to their glossary definitions, ideally as tool tips—but 
 that solution is beyond my ability]
 
 I also don’t like “User Documentation” since we aren’t documenting users, 
 so I prefer “Documentation for Users”, which requires the following 
 heading to be changed to “Documentation for Developers”
 
 Here is my final suggestion for the section in question:
 
 === Documentation for Users ===
 GnuCash offers two major pieces of documentation: 
 * [http://www.gnucash.org/viewdoc.phtml?doc=help The Help Manual] - a 
 quick reference manual for specific tasks, and
 * [http://www.gnucash.org/viewdoc.phtml?doc=guide The Tutorial and 
 Concepts Guide] - an in-depth guide to the concepts. It is highly 
 recommended to read at least the first chapters of the guide.
 The [http://www.gnucash.org/docs.phtml Documentation page on the 
 gnucash.org ''website''] also contains these documents in
 * '''other languages:''' de, it, ja, pt; 
 * '''other formats:''' ''PDF'', ''ePub'' or ''mobi''; as well as
 * '''other releases:''' nightly (unstable),  previous and earlier stable 
 releases.
 The GnuCash wiki includes extensive information regarding all aspects of 
 GnuCash, contributed by the developers and users of GnuCash. Information 
 in the wiki covers a broad variety of topics, and includes detailed 
 technical information, 

Re: [GNC-dev] Main WIki Page edit

2018-08-20 Thread John Ralls
Adrien,

Neither “clarification” is correct.

The “Tutorial and Concepts Guide” contains a *very* basic introduction to 
double-entry accounting, enough to get a new user going if all they have is a 
simple bank account and credit card. The rest of it is “how-to” on using 
GnuCash to perform some more complex tasks like managing capital gains and the 
business module. The emphasis is on using GnuCash and understanding its quirks. 
Mostly GnuCash tutorial with an introduction to concepts. 

The “Help Manual” is called that because it’s the document underneath the 
context-sensitive help; it has detailed explanations of some of GnuCash’s 
windows and dialogs, on the “this button activates foo, the buttons on this 
radio control selects which sort of bar you want” level. It’s strung together 
to form a document, but it’s not the sort of thing one would want to read like 
a book. There’s nothing at all about accounting in it.

Regards,
John Ralls

> On Aug 20, 2018, at 5:55 PM, Adrien Monteleone 
>  wrote:
> 
> Nice.
> 
> How about this for a tad more clarity on the two official documentation items:
> 
> * [http://www.gnucash.org/viewdoc.phtml?doc=help The Help Manual] - a quick 
> reference manual for ~~specific~~ _basic accounting_ tasks, and
> * [http://www.gnucash.org/viewdoc.phtml?doc=guide The Tutorial and Concepts 
> Guide] - an in-depth guide ~~to the concepts~~ _on using GnuCash to implement 
> specific accounting concepts_. It is highly recommended to read at least the 
> ~~first chapters~~ _Getting Started section_ of the guide.
> 
> That last edit of course could be more specific with a number of chapters, 
> especially if the recommendation is beyond Section I. My point is just that 
> ‘first chapters’ is a bit vague. (ideally, users should read it all of 
> course, save maybe the business or investing sections if they aren’t 
> applicable.)
> 
> Regards,
> Adrien
> 
> 
>> On Aug 20, 2018, at 7:30 PM, John Ralls  wrote:
>> 
>> 
>> 
>>> On Aug 20, 2018, at 6:57 AM, David T. via gnucash-devel 
>>>  wrote:
>>> 
>>> OK. I have looked over this issue with an eye to clarifying the text, and I 
>>> believe that the User Documentation section should be simplified. As 
>>> currently written, as you all have noted, the User Documentation section 
>>> includes different layers of content, presented at the same tier of 
>>> coverage. Thus, the Help and Tutorial are presented alongside two wiki 
>>> pages and two glossaries. That’s inconsistent. 
>>> 
>>> So, first up is to level things off. That means eliminating the separate 
>>> headings for the Glossaries, the FAQ and Using Gnucash, and changing the 
>>> main section to refer to the wiki at the same level as the Help and 
>>> Tutorial. In the interest of helping people in dire need, I choose to 
>>> retain the references to the FAQ and Using GnuCash pages, but as a 
>>> descriptive list under the wiki in general (I will note that I also changed 
>>> the Getting Help page to parallel this approach). As suggested, mention of 
>>> the Glossaries isn’t particularly appropriate here, so I remove it 
>>> altogether. [FWIW, I think the proper approach would be to make sure that 
>>> all uses of special terminology in the wiki and the documentation receive 
>>> reference to their glossary definitions, ideally as tool tips—but that 
>>> solution is beyond my ability]
>>> 
>>> I also don’t like “User Documentation” since we aren’t documenting users, 
>>> so I prefer “Documentation for Users”, which requires the following heading 
>>> to be changed to “Documentation for Developers”
>>> 
>>> Here is my final suggestion for the section in question:
>>> 
>>> === Documentation for Users ===
>>> GnuCash offers two major pieces of documentation: 
>>> * [http://www.gnucash.org/viewdoc.phtml?doc=help The Help Manual] - a quick 
>>> reference manual for specific tasks, and
>>> * [http://www.gnucash.org/viewdoc.phtml?doc=guide The Tutorial and Concepts 
>>> Guide] - an in-depth guide to the concepts. It is highly recommended to 
>>> read at least the first chapters of the guide.
>>> The [http://www.gnucash.org/docs.phtml Documentation page on the 
>>> gnucash.org ''website''] also contains these documents in
>>> * '''other languages:''' de, it, ja, pt; 
>>> * '''other formats:''' ''PDF'', ''ePub'' or ''mobi''; as well as
>>> * '''other releases:''' nightly (unstable),  previous and earlier stable 
>>> releases.
>>> The GnuCash wiki includes extensive information regarding all aspects of 
>>> GnuCash, contributed by the developers and users of GnuCash. Information in 
>>> the wiki covers a broad variety of topics, and includes detailed technical 
>>> information, as well as information that applies to specific use cases. Of 
>>> particular interest on the wiki are: 
>>> * The [[FAQ|GnuCash FAQ]], which contains a collection of frequently asked 
>>> questions about GnuCash, including administration, accounting, and glossary 
>>> questions, and
>>> * [[Using GnuCash]], which 

Re: [GNC-dev] Main WIki Page edit

2018-08-20 Thread Adrien Monteleone
Nice.

How about this for a tad more clarity on the two official documentation items:

* [http://www.gnucash.org/viewdoc.phtml?doc=help The Help Manual] - a quick 
reference manual for ~~specific~~ _basic accounting_ tasks, and
* [http://www.gnucash.org/viewdoc.phtml?doc=guide The Tutorial and Concepts 
Guide] - an in-depth guide ~~to the concepts~~ _on using GnuCash to implement 
specific accounting concepts_. It is highly recommended to read at least the 
~~first chapters~~ _Getting Started section_ of the guide.

That last edit of course could be more specific with a number of chapters, 
especially if the recommendation is beyond Section I. My point is just that 
‘first chapters’ is a bit vague. (ideally, users should read it all of course, 
save maybe the business or investing sections if they aren’t applicable.)

Regards,
Adrien


> On Aug 20, 2018, at 7:30 PM, John Ralls  wrote:
> 
> 
> 
>> On Aug 20, 2018, at 6:57 AM, David T. via gnucash-devel 
>>  wrote:
>> 
>> OK. I have looked over this issue with an eye to clarifying the text, and I 
>> believe that the User Documentation section should be simplified. As 
>> currently written, as you all have noted, the User Documentation section 
>> includes different layers of content, presented at the same tier of 
>> coverage. Thus, the Help and Tutorial are presented alongside two wiki pages 
>> and two glossaries. That’s inconsistent. 
>> 
>> So, first up is to level things off. That means eliminating the separate 
>> headings for the Glossaries, the FAQ and Using Gnucash, and changing the 
>> main section to refer to the wiki at the same level as the Help and 
>> Tutorial. In the interest of helping people in dire need, I choose to retain 
>> the references to the FAQ and Using GnuCash pages, but as a descriptive list 
>> under the wiki in general (I will note that I also changed the Getting Help 
>> page to parallel this approach). As suggested, mention of the Glossaries 
>> isn’t particularly appropriate here, so I remove it altogether. [FWIW, I 
>> think the proper approach would be to make sure that all uses of special 
>> terminology in the wiki and the documentation receive reference to their 
>> glossary definitions, ideally as tool tips—but that solution is beyond my 
>> ability]
>> 
>> I also don’t like “User Documentation” since we aren’t documenting users, so 
>> I prefer “Documentation for Users”, which requires the following heading to 
>> be changed to “Documentation for Developers”
>> 
>> Here is my final suggestion for the section in question:
>> 
>> === Documentation for Users ===
>> GnuCash offers two major pieces of documentation: 
>> * [http://www.gnucash.org/viewdoc.phtml?doc=help The Help Manual] - a quick 
>> reference manual for specific tasks, and
>> * [http://www.gnucash.org/viewdoc.phtml?doc=guide The Tutorial and Concepts 
>> Guide] - an in-depth guide to the concepts. It is highly recommended to read 
>> at least the first chapters of the guide.
>> The [http://www.gnucash.org/docs.phtml Documentation page on the gnucash.org 
>> ''website''] also contains these documents in
>> * '''other languages:''' de, it, ja, pt; 
>> * '''other formats:''' ''PDF'', ''ePub'' or ''mobi''; as well as
>> * '''other releases:''' nightly (unstable),  previous and earlier stable 
>> releases.
>> The GnuCash wiki includes extensive information regarding all aspects of 
>> GnuCash, contributed by the developers and users of GnuCash. Information in 
>> the wiki covers a broad variety of topics, and includes detailed technical 
>> information, as well as information that applies to specific use cases. Of 
>> particular interest on the wiki are: 
>> * The [[FAQ|GnuCash FAQ]], which contains a collection of frequently asked 
>> questions about GnuCash, including administration, accounting, and glossary 
>> questions, and
>> * [[Using GnuCash]], which collects real life experiences using GnuCash. You 
>> may find (user) solutions here that are not covered by the documentation.
> 
> An excellent start, but I find the “Documentation for Users” section to be a 
> bit stilted, so I’ve changed it to
> 
>> === Documentation for Users ===
>> GnuCash offers two primary instructional documents: 
>> * [http://www.gnucash.org/viewdoc.phtml?doc=help ''The Help Manual''] - a 
>> quick reference manual for specific tasks, and
>> * [http://www.gnucash.org/viewdoc.phtml?doc=guide ''The Tutorial and 
>> Concepts Guide''] - an in-depth guide to the concepts. It is highly 
>> recommended that new users read at least the first chapters of the ''Guide''.
>> These are accessible via the '''Help''' menu in the program (if you've 
>> installed via a package manager you may need to install an additional 
>> package called something like "gnucash-docs") and from the 
>> [http://www.gnucash.org/docs.phtml Documentation page on the gnucash.org 
>> ''website''].
>> The ''Help Manual'' is available in English, German, Italian, and Japanese; 
>> the ''Guide'' in English, Italian, 

Re: [GNC-dev] Main WIki Page edit

2018-08-20 Thread John Ralls


> On Aug 20, 2018, at 6:57 AM, David T. via gnucash-devel 
>  wrote:
> 
> OK. I have looked over this issue with an eye to clarifying the text, and I 
> believe that the User Documentation section should be simplified. As 
> currently written, as you all have noted, the User Documentation section 
> includes different layers of content, presented at the same tier of coverage. 
> Thus, the Help and Tutorial are presented alongside two wiki pages and two 
> glossaries. That’s inconsistent. 
> 
> So, first up is to level things off. That means eliminating the separate 
> headings for the Glossaries, the FAQ and Using Gnucash, and changing the main 
> section to refer to the wiki at the same level as the Help and Tutorial. In 
> the interest of helping people in dire need, I choose to retain the 
> references to the FAQ and Using GnuCash pages, but as a descriptive list 
> under the wiki in general (I will note that I also changed the Getting Help 
> page to parallel this approach). As suggested, mention of the Glossaries 
> isn’t particularly appropriate here, so I remove it altogether. [FWIW, I 
> think the proper approach would be to make sure that all uses of special 
> terminology in the wiki and the documentation receive reference to their 
> glossary definitions, ideally as tool tips—but that solution is beyond my 
> ability]
> 
> I also don’t like “User Documentation” since we aren’t documenting users, so 
> I prefer “Documentation for Users”, which requires the following heading to 
> be changed to “Documentation for Developers”
> 
> Here is my final suggestion for the section in question:
> 
> === Documentation for Users ===
> GnuCash offers two major pieces of documentation: 
> * [http://www.gnucash.org/viewdoc.phtml?doc=help The Help Manual] - a quick 
> reference manual for specific tasks, and
> * [http://www.gnucash.org/viewdoc.phtml?doc=guide The Tutorial and Concepts 
> Guide] - an in-depth guide to the concepts. It is highly recommended to read 
> at least the first chapters of the guide.
> The [http://www.gnucash.org/docs.phtml Documentation page on the gnucash.org 
> ''website''] also contains these documents in
> * '''other languages:''' de, it, ja, pt; 
> * '''other formats:''' ''PDF'', ''ePub'' or ''mobi''; as well as
> * '''other releases:''' nightly (unstable),  previous and earlier stable 
> releases.
> The GnuCash wiki includes extensive information regarding all aspects of 
> GnuCash, contributed by the developers and users of GnuCash. Information in 
> the wiki covers a broad variety of topics, and includes detailed technical 
> information, as well as information that applies to specific use cases. Of 
> particular interest on the wiki are: 
> * The [[FAQ|GnuCash FAQ]], which contains a collection of frequently asked 
> questions about GnuCash, including administration, accounting, and glossary 
> questions, and
> * [[Using GnuCash]], which collects real life experiences using GnuCash. You 
> may find (user) solutions here that are not covered by the documentation.

An excellent start, but I find the “Documentation for Users” section to be a 
bit stilted, so I’ve changed it to

> === Documentation for Users ===
> GnuCash offers two primary instructional documents: 
> * [http://www.gnucash.org/viewdoc.phtml?doc=help ''The Help Manual''] - a 
> quick reference manual for specific tasks, and
> * [http://www.gnucash.org/viewdoc.phtml?doc=guide ''The Tutorial and Concepts 
> Guide''] - an in-depth guide to the concepts. It is highly recommended that 
> new users read at least the first chapters of the ''Guide''.
> These are accessible via the '''Help''' menu in the program (if you've 
> installed via a package manager you may need to install an additional package 
> called something like "gnucash-docs") and from the 
> [http://www.gnucash.org/docs.phtml Documentation page on the gnucash.org 
> ''website''].
> The ''Help Manual'' is available in English, German, Italian, and Japanese; 
> the ''Guide'' in English, Italian, Japanese, Portuguese, and Russian.
> 
> ''PDF'', ''ePub'', and ''mobi'' formats may be downloaded from the 
> [http://www.gnucash.org/docs.phtml Documentation page] where you will also 
> find the documentation for earlier releases and a nightly build of changes 
> made since the last release.

This also adds information about where to find it (it’s included in the program 
with all of the transalations) and ditches the overly technical use of the 
language codes in favor of writing out the names of the translation languages.

The Russian translation is partial and the translator seems to have run out of 
steam on proceeding, but it includes the first few chapters so I’ve included 
it. I’d forgotten to ensure that the built docs actually got uploaded and to 
add the links to the website; I’ve just done that now.

Regards,
John Ralls

___
gnucash-devel mailing list
gnucash-devel@gnucash.org

Re: [GNC-dev] Main WIki Page edit

2018-08-20 Thread D via gnucash-devel
Frank,

Thank you for implementing the changes.

WRT removing the references to the glossaries, it *was* my intention to remove 
them, for a few reasons. First, the glossaries are sections of either the Guide 
or of the wiki. Thus, like the FAQ and the Using Gnucash links, it doesn't 
merit top level mention. 

As I considered it further, it seemed to me that a glossary isn't really 
something that someone seeks out for itself; they will only seek it when they 
don't understand a term they find elsewhere. Thus, my suggestion that these 
terms, when used, should receive proper linking in the source. Moreover, given 
that the Guide is separately released and published, I felt that mention of the 
Guide Glossary in the wiki was truly superfluous--akin to making note that the 
Guide includes screenshots. Therefore, mention of the Guide Glossary was out.

As to the Wiki Glossary, I rather liked Adrien's suggestion that such mention 
might go with developer info later on the page. Since I wasn't focused on those 
other sections, I set aside that change, and then I later decided that inline 
citations would be the better solution. Thus, no more mention of that glossary 
from my corner.

On the subject of the different sources for information:
It may be advisable to put a note about differences between the documents. 
However, any discussion about the information on the wiki versus the 
documentation needs to be couched in terms that explain the differences 
clearly, fully, unambiguously, and without bias. IOW, the wiki might be more 
recent, but that information is more likely subject to change, since it may not 
be fully accurate. The Help and Guide have been edited for accuracy.

David

On August 20, 2018, at 10:38 AM, "Frank H. Ellenberger" 
 wrote:

Hi David,

I have applied it, but have 2 questions:
Was it intended to remove the reference to the glossary completely?
Should we somehow note, that in doubt the wiki might be more recent than
the official docs?

Regards
Frank

Am 20.08.2018 um 15:57 schrieb David T. via gnucash-devel:
> OK. I have looked over this issue with an eye to clarifying the text, and I 
> believe that the User Documentation section should be simplified. As 
> currently written, as you all have noted, the User Documentation section 
> includes different layers of content, presented at the same tier of coverage. 
> Thus, the Help and Tutorial are presented alongside two wiki pages and two 
> glossaries. That’s inconsistent. 
> 
> So, first up is to level things off. That means eliminating the separate 
> headings for the Glossaries, the FAQ and Using Gnucash, and changing the main 
> section to refer to the wiki at the same level as the Help and Tutorial. In 
> the interest of helping people in dire need, I choose to retain the 
> references to the FAQ and Using GnuCash pages, but as a descriptive list 
> under the wiki in general (I will note that I also changed the Getting Help 
> page to parallel this approach). As suggested, mention of the Glossaries 
> isn’t particularly appropriate here, so I remove it altogether. [FWIW, I 
> think the proper approach would be to make sure that all uses of special 
> terminology in the wiki and the documentation receive reference to their 
> glossary definitions, ideally as tool tips—but that solution is beyond my 
> ability]
> 
> I also don’t like “User Documentation” since we aren’t documenting users, so 
> I prefer “Documentation for Users”, which requires the following heading to 
> be changed to “Documentation for Developers”
> 
> Here is my final suggestion for the section in question:
> 
> === Documentation for Users ===
> GnuCash offers two major pieces of documentation: 
> * [http://www.gnucash.org/viewdoc.phtml?doc=help The Help Manual] - a quick 
> reference manual for specific tasks, and
> * [http://www.gnucash.org/viewdoc.phtml?doc=guide The Tutorial and Concepts 
> Guide] - an in-depth guide to the concepts. It is highly recommended to read 
> at least the first chapters of the guide.
> The [http://www.gnucash.org/docs.phtml Documentation page on the gnucash.org 
> ''website''] also contains these documents in
> * '''other languages:''' de, it, ja, pt; 
> * '''other formats:''' ''PDF'', ''ePub'' or ''mobi''; as well as
> * '''other releases:''' nightly (unstable),  previous and earlier stable 
> releases.
> The GnuCash wiki includes extensive information regarding all aspects of 
> GnuCash, contributed by the developers and users of GnuCash. Information in 
> the wiki covers a broad variety of topics, and includes detailed technical 
> information, as well as information that applies to specific use cases. Of 
> particular interest on the wiki are: 
> * The [[FAQ|GnuCash FAQ]], which contains a collection of frequently asked 
> questions about GnuCash, including administration, accounting, and glossary 
> questions, and
> * [[Using GnuCash]], which collects real life experiences using GnuCash. You 
> may find (user) solutions here that 

Re: [GNC-dev] Main WIki Page edit

2018-08-20 Thread Frank H. Ellenberger
Hi David,

I have applied it, but have 2 questions:
Was it intended to remove the reference to the glossary completely?
Should we somehow note, that in doubt the wiki might be more recent than
the official docs?

Regards
Frank

Am 20.08.2018 um 15:57 schrieb David T. via gnucash-devel:
> OK. I have looked over this issue with an eye to clarifying the text, and I 
> believe that the User Documentation section should be simplified. As 
> currently written, as you all have noted, the User Documentation section 
> includes different layers of content, presented at the same tier of coverage. 
> Thus, the Help and Tutorial are presented alongside two wiki pages and two 
> glossaries. That’s inconsistent. 
> 
> So, first up is to level things off. That means eliminating the separate 
> headings for the Glossaries, the FAQ and Using Gnucash, and changing the main 
> section to refer to the wiki at the same level as the Help and Tutorial. In 
> the interest of helping people in dire need, I choose to retain the 
> references to the FAQ and Using GnuCash pages, but as a descriptive list 
> under the wiki in general (I will note that I also changed the Getting Help 
> page to parallel this approach). As suggested, mention of the Glossaries 
> isn’t particularly appropriate here, so I remove it altogether. [FWIW, I 
> think the proper approach would be to make sure that all uses of special 
> terminology in the wiki and the documentation receive reference to their 
> glossary definitions, ideally as tool tips—but that solution is beyond my 
> ability]
> 
> I also don’t like “User Documentation” since we aren’t documenting users, so 
> I prefer “Documentation for Users”, which requires the following heading to 
> be changed to “Documentation for Developers”
> 
> Here is my final suggestion for the section in question:
> 
> === Documentation for Users ===
> GnuCash offers two major pieces of documentation: 
> * [http://www.gnucash.org/viewdoc.phtml?doc=help The Help Manual] - a quick 
> reference manual for specific tasks, and
> * [http://www.gnucash.org/viewdoc.phtml?doc=guide The Tutorial and Concepts 
> Guide] - an in-depth guide to the concepts. It is highly recommended to read 
> at least the first chapters of the guide.
> The [http://www.gnucash.org/docs.phtml Documentation page on the gnucash.org 
> ''website''] also contains these documents in
> * '''other languages:''' de, it, ja, pt; 
> * '''other formats:''' ''PDF'', ''ePub'' or ''mobi''; as well as
> * '''other releases:''' nightly (unstable),  previous and earlier stable 
> releases.
> The GnuCash wiki includes extensive information regarding all aspects of 
> GnuCash, contributed by the developers and users of GnuCash. Information in 
> the wiki covers a broad variety of topics, and includes detailed technical 
> information, as well as information that applies to specific use cases. Of 
> particular interest on the wiki are: 
> * The [[FAQ|GnuCash FAQ]], which contains a collection of frequently asked 
> questions about GnuCash, including administration, accounting, and glossary 
> questions, and
> * [[Using GnuCash]], which collects real life experiences using GnuCash. You 
> may find (user) solutions here that are not covered by the documentation.
> 
> === Documentation for Developers ===

___
gnucash-devel mailing list
gnucash-devel@gnucash.org
https://lists.gnucash.org/mailman/listinfo/gnucash-devel


Re: [GNC-dev] Main WIki Page edit

2018-08-20 Thread Adrien Monteleone
Much better.

Regards,
Adrien

> On Aug 20, 2018, at 8:57 AM, David T.  wrote:
> 
> OK. I have looked over this issue with an eye to clarifying the text, and I 
> believe that the User Documentation section should be simplified. As 
> currently written, as you all have noted, the User Documentation section 
> includes different layers of content, presented at the same tier of coverage. 
> Thus, the Help and Tutorial are presented alongside two wiki pages and two 
> glossaries. That’s inconsistent. 
> 
> So, first up is to level things off. That means eliminating the separate 
> headings for the Glossaries, the FAQ and Using Gnucash, and changing the main 
> section to refer to the wiki at the same level as the Help and Tutorial. In 
> the interest of helping people in dire need, I choose to retain the 
> references to the FAQ and Using GnuCash pages, but as a descriptive list 
> under the wiki in general (I will note that I also changed the Getting Help 
> page to parallel this approach). As suggested, mention of the Glossaries 
> isn’t particularly appropriate here, so I remove it altogether. [FWIW, I 
> think the proper approach would be to make sure that all uses of special 
> terminology in the wiki and the documentation receive reference to their 
> glossary definitions, ideally as tool tips—but that solution is beyond my 
> ability]
> 
> I also don’t like “User Documentation” since we aren’t documenting users, so 
> I prefer “Documentation for Users”, which requires the following heading to 
> be changed to “Documentation for Developers”
> 
> Here is my final suggestion for the section in question:
> 
> === Documentation for Users ===
> GnuCash offers two major pieces of documentation: 
> * [http://www.gnucash.org/viewdoc.phtml?doc=help The Help Manual] - a quick 
> reference manual for specific tasks, and
> * [http://www.gnucash.org/viewdoc.phtml?doc=guide The Tutorial and Concepts 
> Guide] - an in-depth guide to the concepts. It is highly recommended to read 
> at least the first chapters of the guide.
> The [http://www.gnucash.org/docs.phtml Documentation page on the gnucash.org 
> ''website''] also contains these documents in
> * '''other languages:''' de, it, ja, pt; 
> * '''other formats:''' ''PDF'', ''ePub'' or ''mobi''; as well as
> * '''other releases:''' nightly (unstable),  previous and earlier stable 
> releases.
> The GnuCash wiki includes extensive information regarding all aspects of 
> GnuCash, contributed by the developers and users of GnuCash. Information in 
> the wiki covers a broad variety of topics, and includes detailed technical 
> information, as well as information that applies to specific use cases. Of 
> particular interest on the wiki are: 
> * The [[FAQ|GnuCash FAQ]], which contains a collection of frequently asked 
> questions about GnuCash, including administration, accounting, and glossary 
> questions, and
> * [[Using GnuCash]], which collects real life experiences using GnuCash. You 
> may find (user) solutions here that are not covered by the documentation.
> 
> === Documentation for Developers ===
> 
> 
>> On Aug 18, 2018, at 8:53 AM, D via gnucash-devel  
>> wrote:
>> 
>> The glossary entry has historically been included separately on this page. 
>> When I last suggested changes for the page, it didn't occur to me to remove 
>> that separate section and incorporate references to them (there are two 
>> glossaries: one in the Guide, and the one on the wiki, each with slightly 
>> didn't vintage) in other locations.
>> 
>> Incorporating these references into other sections makes sense to me. It 
>> simplifies the main page structure a little, and reflects the fact that the 
>> glossaries are part of the Guide and wiki, respectively.
>> 
>> I'll look into a rewrite, and send it in for adjustment in the next few days.
>> 
>> David T.
>> 
>> On August 18, 2018, at 7:15 AM, Adrien Monteleone 
>>  wrote:
>> 
>> In combination with making the T glossary sentence a part the Official 
>> documentation paragraph, I think the second sentence should be moved down to 
>> the Developer Documentation paragraph.
>> 
>> Also, the following line needs a number correction:
>> 
>> "The Documentation page on the gnucash.org website also contains ~~this~~ 
>> _these_ documents in”
>> 
>> I’d do either myself, but I see the main page is above my pay grade. (I’m 
>> sure for very good reason)
>> 
>> Regards,
>> Adrien
>> 
>>> On Aug 18, 2018, at 8:53 AM, John Ralls  wrote:
>>> 
>>> 
>>> 
 On Aug 17, 2018, at 11:45 PM, David T. via gnucash-devel 
  wrote:
 
 
 
> On Aug 17, 2018, at 11:29 AM, Frank H. Ellenberger 
>  wrote:
> 
> Am 16.08.2018 um 20:37 schrieb David T. via gnucash-devel:
>> Hello,
>> 
>> I was reviewing the Wiki today to try to figure out where a page on the 
>> SQL formats might get attached, and I noticed a change to the Glossary 
>> section that makes for awkward English.
>> 
>> As currently entered, the 

Re: [GNC-dev] Main WIki Page edit

2018-08-20 Thread David T. via gnucash-devel
OK. I have looked over this issue with an eye to clarifying the text, and I 
believe that the User Documentation section should be simplified. As currently 
written, as you all have noted, the User Documentation section includes 
different layers of content, presented at the same tier of coverage. Thus, the 
Help and Tutorial are presented alongside two wiki pages and two glossaries. 
That’s inconsistent. 

So, first up is to level things off. That means eliminating the separate 
headings for the Glossaries, the FAQ and Using Gnucash, and changing the main 
section to refer to the wiki at the same level as the Help and Tutorial. In the 
interest of helping people in dire need, I choose to retain the references to 
the FAQ and Using GnuCash pages, but as a descriptive list under the wiki in 
general (I will note that I also changed the Getting Help page to parallel this 
approach). As suggested, mention of the Glossaries isn’t particularly 
appropriate here, so I remove it altogether. [FWIW, I think the proper approach 
would be to make sure that all uses of special terminology in the wiki and the 
documentation receive reference to their glossary definitions, ideally as tool 
tips—but that solution is beyond my ability]

I also don’t like “User Documentation” since we aren’t documenting users, so I 
prefer “Documentation for Users”, which requires the following heading to be 
changed to “Documentation for Developers”

Here is my final suggestion for the section in question:

=== Documentation for Users ===
GnuCash offers two major pieces of documentation: 
* [http://www.gnucash.org/viewdoc.phtml?doc=help The Help Manual] - a quick 
reference manual for specific tasks, and
* [http://www.gnucash.org/viewdoc.phtml?doc=guide The Tutorial and Concepts 
Guide] - an in-depth guide to the concepts. It is highly recommended to read at 
least the first chapters of the guide.
The [http://www.gnucash.org/docs.phtml Documentation page on the gnucash.org 
''website''] also contains these documents in
* '''other languages:''' de, it, ja, pt; 
* '''other formats:''' ''PDF'', ''ePub'' or ''mobi''; as well as
* '''other releases:''' nightly (unstable),  previous and earlier stable 
releases.
The GnuCash wiki includes extensive information regarding all aspects of 
GnuCash, contributed by the developers and users of GnuCash. Information in the 
wiki covers a broad variety of topics, and includes detailed technical 
information, as well as information that applies to specific use cases. Of 
particular interest on the wiki are: 
* The [[FAQ|GnuCash FAQ]], which contains a collection of frequently asked 
questions about GnuCash, including administration, accounting, and glossary 
questions, and
* [[Using GnuCash]], which collects real life experiences using GnuCash. You 
may find (user) solutions here that are not covered by the documentation.

=== Documentation for Developers ===


> On Aug 18, 2018, at 8:53 AM, D via gnucash-devel  
> wrote:
> 
> The glossary entry has historically been included separately on this page. 
> When I last suggested changes for the page, it didn't occur to me to remove 
> that separate section and incorporate references to them (there are two 
> glossaries: one in the Guide, and the one on the wiki, each with slightly 
> didn't vintage) in other locations.
> 
> Incorporating these references into other sections makes sense to me. It 
> simplifies the main page structure a little, and reflects the fact that the 
> glossaries are part of the Guide and wiki, respectively.
> 
> I'll look into a rewrite, and send it in for adjustment in the next few days.
> 
> David T.
> 
> On August 18, 2018, at 7:15 AM, Adrien Monteleone 
>  wrote:
> 
> In combination with making the T glossary sentence a part the Official 
> documentation paragraph, I think the second sentence should be moved down to 
> the Developer Documentation paragraph.
> 
> Also, the following line needs a number correction:
> 
> "The Documentation page on the gnucash.org website also contains ~~this~~ 
> _these_ documents in”
> 
> I’d do either myself, but I see the main page is above my pay grade. (I’m 
> sure for very good reason)
> 
> Regards,
> Adrien
> 
>> On Aug 18, 2018, at 8:53 AM, John Ralls  wrote:
>> 
>> 
>> 
>>> On Aug 17, 2018, at 11:45 PM, David T. via gnucash-devel 
>>>  wrote:
>>> 
>>> 
>>> 
 On Aug 17, 2018, at 11:29 AM, Frank H. Ellenberger 
  wrote:
 
 Am 16.08.2018 um 20:37 schrieb David T. via gnucash-devel:
> Hello,
> 
> I was reviewing the Wiki today to try to figure out where a page on the 
> SQL formats might get attached, and I noticed a change to the Glossary 
> section that makes for awkward English.
> 
> As currently entered, the section reads:
> 
> Above GnuCash Tutorial and Concepts Guide includes a comprehensive 
> Glossary: 
> [https://www.gnucash.org/docs/v2.6/C/gnucash-guide/gnc-gloss.html 
> Released] or 
> 

Re: [GNC-dev] Main WIki Page edit

2018-08-18 Thread D via gnucash-devel
The glossary entry has historically been included separately on this page. When 
I last suggested changes for the page, it didn't occur to me to remove that 
separate section and incorporate references to them (there are two glossaries: 
one in the Guide, and the one on the wiki, each with slightly didn't vintage) 
in other locations.

Incorporating these references into other sections makes sense to me. It 
simplifies the main page structure a little, and reflects the fact that the 
glossaries are part of the Guide and wiki, respectively.

I'll look into a rewrite, and send it in for adjustment in the next few days.

David T.

On August 18, 2018, at 7:15 AM, Adrien Monteleone 
 wrote:

In combination with making the T glossary sentence a part the Official 
documentation paragraph, I think the second sentence should be moved down to 
the Developer Documentation paragraph.

Also, the following line needs a number correction:

"The Documentation page on the gnucash.org website also contains ~~this~~ 
_these_ documents in”

I’d do either myself, but I see the main page is above my pay grade. (I’m sure 
for very good reason)

Regards,
Adrien

> On Aug 18, 2018, at 8:53 AM, John Ralls  wrote:
> 
> 
> 
>> On Aug 17, 2018, at 11:45 PM, David T. via gnucash-devel 
>>  wrote:
>> 
>> 
>> 
>>> On Aug 17, 2018, at 11:29 AM, Frank H. Ellenberger 
>>>  wrote:
>>> 
>>> Am 16.08.2018 um 20:37 schrieb David T. via gnucash-devel:
 Hello,
 
 I was reviewing the Wiki today to try to figure out where a page on the 
 SQL formats might get attached, and I noticed a change to the Glossary 
 section that makes for awkward English.
 
 As currently entered, the section reads:
 
 Above GnuCash Tutorial and Concepts Guide includes a comprehensive 
 Glossary: 
 [https://www.gnucash.org/docs/v2.6/C/gnucash-guide/gnc-gloss.html 
 Released] or [https://code.gnucash.org/docs/C/gnucash-guide/gnc-gloss.html 
 Maintainer] version.
 
 However, it used to say:
 
 The GnuCash Tutorial and Concepts Guide includes a comprehensive Glossary: 
 [https://www.gnucash.org/docs/v2.6/C/gnucash-guide/gnc-gloss.html 
 Released] or [https://code.gnucash.org/docs/C/gnucash-guide/gnc-gloss.html 
 Maintainer] version.
 
 I would like to ask that someone with edit permissions on the wiki home 
 page to please change the word “Above” back to “The” to make the section 
 read more idiomatically.
 
 David T.
>>> 
>>> IMHO it is also bad style to have:
>>> The Tutorial and Concepts Guide - an in-depth guide to the concepts.
>>> :
>>> The GnuCash Tutorial and Concepts Guide includes a comprehensive
>>> Glossary: Released or Maintainer version.
>>> 
>> 
>> We differ in our opinion here. I stand by my recommendation.
> 
> And you’re both right, it needs a more thorough rewrite to flow better. Since 
> the glossary isn’t a stand-alone document it shouldn’t have its own level-two 
> header. An additional sentence in the T paragraph under Official 
> Documentation would be better. On the other hand the wiki needs more 
> prominence, there’s a whole lot more information there than just the FAQ and 
> technical glossary.
> 
> Regards,
> John Ralls
> 
> ___
> gnucash-devel mailing list
> gnucash-devel@gnucash.org
> https://lists.gnucash.org/mailman/listinfo/gnucash-devel


___
gnucash-devel mailing list
gnucash-devel@gnucash.org
https://lists.gnucash.org/mailman/listinfo/gnucash-devel
___
gnucash-devel mailing list
gnucash-devel@gnucash.org
https://lists.gnucash.org/mailman/listinfo/gnucash-devel


Re: [GNC-dev] Main WIki Page edit

2018-08-18 Thread Adrien Monteleone
In combination with making the T glossary sentence a part the Official 
documentation paragraph, I think the second sentence should be moved down to 
the Developer Documentation paragraph.

Also, the following line needs a number correction:

"The Documentation page on the gnucash.org website also contains ~~this~~ 
_these_ documents in”

I’d do either myself, but I see the main page is above my pay grade. (I’m sure 
for very good reason)

Regards,
Adrien

> On Aug 18, 2018, at 8:53 AM, John Ralls  wrote:
> 
> 
> 
>> On Aug 17, 2018, at 11:45 PM, David T. via gnucash-devel 
>>  wrote:
>> 
>> 
>> 
>>> On Aug 17, 2018, at 11:29 AM, Frank H. Ellenberger 
>>>  wrote:
>>> 
>>> Am 16.08.2018 um 20:37 schrieb David T. via gnucash-devel:
 Hello,
 
 I was reviewing the Wiki today to try to figure out where a page on the 
 SQL formats might get attached, and I noticed a change to the Glossary 
 section that makes for awkward English.
 
 As currently entered, the section reads:
 
 Above GnuCash Tutorial and Concepts Guide includes a comprehensive 
 Glossary: 
 [https://www.gnucash.org/docs/v2.6/C/gnucash-guide/gnc-gloss.html 
 Released] or [https://code.gnucash.org/docs/C/gnucash-guide/gnc-gloss.html 
 Maintainer] version.
 
 However, it used to say:
 
 The GnuCash Tutorial and Concepts Guide includes a comprehensive Glossary: 
 [https://www.gnucash.org/docs/v2.6/C/gnucash-guide/gnc-gloss.html 
 Released] or [https://code.gnucash.org/docs/C/gnucash-guide/gnc-gloss.html 
 Maintainer] version.
 
 I would like to ask that someone with edit permissions on the wiki home 
 page to please change the word “Above” back to “The” to make the section 
 read more idiomatically.
 
 David T.
>>> 
>>> IMHO it is also bad style to have:
>>> The Tutorial and Concepts Guide - an in-depth guide to the concepts.
>>> :
>>> The GnuCash Tutorial and Concepts Guide includes a comprehensive
>>> Glossary: Released or Maintainer version.
>>> 
>> 
>> We differ in our opinion here. I stand by my recommendation.
> 
> And you’re both right, it needs a more thorough rewrite to flow better. Since 
> the glossary isn’t a stand-alone document it shouldn’t have its own level-two 
> header. An additional sentence in the T paragraph under Official 
> Documentation would be better. On the other hand the wiki needs more 
> prominence, there’s a whole lot more information there than just the FAQ and 
> technical glossary.
> 
> Regards,
> John Ralls
> 
> ___
> gnucash-devel mailing list
> gnucash-devel@gnucash.org
> https://lists.gnucash.org/mailman/listinfo/gnucash-devel


___
gnucash-devel mailing list
gnucash-devel@gnucash.org
https://lists.gnucash.org/mailman/listinfo/gnucash-devel


Re: [GNC-dev] Main WIki Page edit

2018-08-18 Thread John Ralls


> On Aug 17, 2018, at 11:45 PM, David T. via gnucash-devel 
>  wrote:
> 
> 
> 
>> On Aug 17, 2018, at 11:29 AM, Frank H. Ellenberger 
>>  wrote:
>> 
>> Am 16.08.2018 um 20:37 schrieb David T. via gnucash-devel:
>>> Hello,
>>> 
>>> I was reviewing the Wiki today to try to figure out where a page on the SQL 
>>> formats might get attached, and I noticed a change to the Glossary section 
>>> that makes for awkward English.
>>> 
>>> As currently entered, the section reads:
>>> 
>>> Above GnuCash Tutorial and Concepts Guide includes a comprehensive 
>>> Glossary: [https://www.gnucash.org/docs/v2.6/C/gnucash-guide/gnc-gloss.html 
>>> Released] or [https://code.gnucash.org/docs/C/gnucash-guide/gnc-gloss.html 
>>> Maintainer] version.
>>> 
>>> However, it used to say:
>>> 
>>> The GnuCash Tutorial and Concepts Guide includes a comprehensive Glossary: 
>>> [https://www.gnucash.org/docs/v2.6/C/gnucash-guide/gnc-gloss.html Released] 
>>> or [https://code.gnucash.org/docs/C/gnucash-guide/gnc-gloss.html 
>>> Maintainer] version.
>>> 
>>> I would like to ask that someone with edit permissions on the wiki home 
>>> page to please change the word “Above” back to “The” to make the section 
>>> read more idiomatically.
>>> 
>>> David T.
>> 
>> IMHO it is also bad style to have:
>> The Tutorial and Concepts Guide - an in-depth guide to the concepts.
>> :
>> The GnuCash Tutorial and Concepts Guide includes a comprehensive
>> Glossary: Released or Maintainer version.
>> 
> 
> We differ in our opinion here. I stand by my recommendation.

And you’re both right, it needs a more thorough rewrite to flow better. Since 
the glossary isn’t a stand-alone document it shouldn’t have its own level-two 
header. An additional sentence in the T paragraph under Official 
Documentation would be better. On the other hand the wiki needs more 
prominence, there’s a whole lot more information there than just the FAQ and 
technical glossary.

Regards,
John Ralls

___
gnucash-devel mailing list
gnucash-devel@gnucash.org
https://lists.gnucash.org/mailman/listinfo/gnucash-devel


Re: [GNC-dev] Main WIki Page edit

2018-08-18 Thread David T. via gnucash-devel


> On Aug 17, 2018, at 11:29 AM, Frank H. Ellenberger 
>  wrote:
> 
> Am 16.08.2018 um 20:37 schrieb David T. via gnucash-devel:
>> Hello,
>> 
>> I was reviewing the Wiki today to try to figure out where a page on the SQL 
>> formats might get attached, and I noticed a change to the Glossary section 
>> that makes for awkward English.
>> 
>> As currently entered, the section reads:
>> 
>> Above GnuCash Tutorial and Concepts Guide includes a comprehensive Glossary: 
>> [https://www.gnucash.org/docs/v2.6/C/gnucash-guide/gnc-gloss.html Released] 
>> or [https://code.gnucash.org/docs/C/gnucash-guide/gnc-gloss.html Maintainer] 
>> version.
>> 
>> However, it used to say:
>> 
>> The GnuCash Tutorial and Concepts Guide includes a comprehensive Glossary: 
>> [https://www.gnucash.org/docs/v2.6/C/gnucash-guide/gnc-gloss.html Released] 
>> or [https://code.gnucash.org/docs/C/gnucash-guide/gnc-gloss.html Maintainer] 
>> version.
>> 
>> I would like to ask that someone with edit permissions on the wiki home page 
>> to please change the word “Above” back to “The” to make the section read 
>> more idiomatically.
>> 
>> David T.
> 
> IMHO it is also bad style to have:
> The Tutorial and Concepts Guide - an in-depth guide to the concepts.
> :
> The GnuCash Tutorial and Concepts Guide includes a comprehensive
> Glossary: Released or Maintainer version.
> 

We differ in our opinion here. I stand by my recommendation.

David

> ~Frank
> 

___
gnucash-devel mailing list
gnucash-devel@gnucash.org
https://lists.gnucash.org/mailman/listinfo/gnucash-devel


Re: [GNC-dev] Main WIki Page edit

2018-08-17 Thread Frank H. Ellenberger
Am 16.08.2018 um 20:37 schrieb David T. via gnucash-devel:
> Hello,
> 
> I was reviewing the Wiki today to try to figure out where a page on the SQL 
> formats might get attached, and I noticed a change to the Glossary section 
> that makes for awkward English.
> 
> As currently entered, the section reads:
> 
> Above GnuCash Tutorial and Concepts Guide includes a comprehensive Glossary: 
> [https://www.gnucash.org/docs/v2.6/C/gnucash-guide/gnc-gloss.html Released] 
> or [https://code.gnucash.org/docs/C/gnucash-guide/gnc-gloss.html Maintainer] 
> version.
> 
> However, it used to say:
> 
> The GnuCash Tutorial and Concepts Guide includes a comprehensive Glossary: 
> [https://www.gnucash.org/docs/v2.6/C/gnucash-guide/gnc-gloss.html Released] 
> or [https://code.gnucash.org/docs/C/gnucash-guide/gnc-gloss.html Maintainer] 
> version.
> 
> I would like to ask that someone with edit permissions on the wiki home page 
> to please change the word “Above” back to “The” to make the section read more 
> idiomatically.
> 
> David T.

IMHO it is also bad style to have:
The Tutorial and Concepts Guide - an in-depth guide to the concepts.
:
The GnuCash Tutorial and Concepts Guide includes a comprehensive
Glossary: Released or Maintainer version.

~Frank


pEpkey.asc
Description: application/pgp-keys
___
gnucash-devel mailing list
gnucash-devel@gnucash.org
https://lists.gnucash.org/mailman/listinfo/gnucash-devel


Re: [GNC-dev] Main WIki Page edit

2018-08-17 Thread Geert Janssens
Done.

Thanks for pointing this out.

Geert

Op donderdag 16 augustus 2018 20:37:26 CEST schreef David T. via gnucash-
devel:
> Hello,
> 
> I was reviewing the Wiki today to try to figure out where a page on the SQL
> formats might get attached, and I noticed a change to the Glossary section
> that makes for awkward English.
> 
> As currently entered, the section reads:
> 
> Above GnuCash Tutorial and Concepts Guide includes a comprehensive Glossary:
> [https://www.gnucash.org/docs/v2.6/C/gnucash-guide/gnc-gloss.html Released]
> or [https://code.gnucash.org/docs/C/gnucash-guide/gnc-gloss.html
> Maintainer] version.
> 
> However, it used to say:
> 
> The GnuCash Tutorial and Concepts Guide includes a comprehensive Glossary:
> [https://www.gnucash.org/docs/v2.6/C/gnucash-guide/gnc-gloss.html Released]
> or [https://code.gnucash.org/docs/C/gnucash-guide/gnc-gloss.html
> Maintainer] version.
> 
> I would like to ask that someone with edit permissions on the wiki home page
> to please change the word “Above” back to “The” to make the section read
> more idiomatically.
> 
> David T.
> 
> ___
> gnucash-devel mailing list
> gnucash-devel@gnucash.org
> https://lists.gnucash.org/mailman/listinfo/gnucash-devel




___
gnucash-devel mailing list
gnucash-devel@gnucash.org
https://lists.gnucash.org/mailman/listinfo/gnucash-devel


[GNC-dev] Main WIki Page edit

2018-08-16 Thread David T. via gnucash-devel
Hello,

I was reviewing the Wiki today to try to figure out where a page on the SQL 
formats might get attached, and I noticed a change to the Glossary section that 
makes for awkward English.

As currently entered, the section reads:

Above GnuCash Tutorial and Concepts Guide includes a comprehensive Glossary: 
[https://www.gnucash.org/docs/v2.6/C/gnucash-guide/gnc-gloss.html Released] or 
[https://code.gnucash.org/docs/C/gnucash-guide/gnc-gloss.html Maintainer] 
version.

However, it used to say:

The GnuCash Tutorial and Concepts Guide includes a comprehensive Glossary: 
[https://www.gnucash.org/docs/v2.6/C/gnucash-guide/gnc-gloss.html Released] or 
[https://code.gnucash.org/docs/C/gnucash-guide/gnc-gloss.html Maintainer] 
version.

I would like to ask that someone with edit permissions on the wiki home page to 
please change the word “Above” back to “The” to make the section read more 
idiomatically.

David T.

___
gnucash-devel mailing list
gnucash-devel@gnucash.org
https://lists.gnucash.org/mailman/listinfo/gnucash-devel