I'm thinking that, for the time being at least, concentrating on a glossary would be best. I have one that I put together (several years ago) for my students. It doesn't include all the words and phrases that jumped out during proofreading, and some of those it does include may be moot or redundant. But I think the structure could serve well. I tested it earlier today, and everything works. The only thing would be, of course, that the links from glossary page to individual word, would have to be redone.
Let me know what you think / how you'd like to proceed. On Sat, Jun 10, 2023 at 7:23 PM F Campos Costero <fjcc.apa...@gmail.com> wrote: > Hi Michele, > I think a standalone glossary could be very useful. There is a lot of > jargon and it would not be practical to give an adequate explanation of > terms within the flow of the text.I also suspect that there would be a lot > of overlap in the terms among the various guides, making a standalone > glossary more practical. > > You make a good point about the location of figures. I'm inclined to make > those changes in the next guide to get a major revision, which would be the > Calc Guide. I think Keith is about ready to publish the Writer Guide. > > You are right about some passages being less friendly than they could be. > All of the guides suffer from uneven tone. There have been many authors and > I think some spoke English as a second language.It's probably not > practical, or even desirable, to completely even out the style, but > introducing a bias towards less formal writing is a good idea. > > What would you think of working with me to complete the revision of the > Calc guide? The version in the Git repository has been substantially > revised from the version on the web page but it could use improvements like > the ones you suggest. In relatively little time we could have something to > replace the very old version on the web page. I think that would bring the > biggest improvement to the published documentation for the least effort on > our part. We could then come back to implement your specific suggestions > for the Getting Started guide having acquired some experience on the Calc > guide. > > Thanks for all your effort so far. If you would rather concentrate on the > glossary exclusively or work on any other aspect of the documentation, just > say so! > > > Regards, > Francis > > On Sat, Jun 10, 2023 at 12:34 PM Michele Petrovsky < > petrovskymich...@gmail.com> wrote: > > > Folks, I've finished my proofreading of the Getting Started guide > (version > > 4.1, copyright 2022). > > > > The project is so well done that I have little to suggest in the way of > > improving it. But I did find three contexts in which it might be tweaked > a > > little. > > > > 1. > > > > A glossary, especially of terms (e.g., from pages 11 and 12, odbc; > jdbc, > > GNU, kernel, and glibc; page 114: regular expression; page 158: Bezler > > curves; page 185: database normalization) with which a lot of people > > might > > be unfamiliar, would make *Getting Started* even more useful. > > > > > > 1. > > > > Greater consistency in the presentation of internal links (for > instance, > > some Figures being shown in the text *before**,* rather than after, > the > > link to them – such as, on page 273, the reference to Figure 244, > which > > occurs *after* the Figure itself) would improve workability. > > > > > > 1. > > > > Some more “colloquial” wording might also serve to make less skilled > > users more comfortable. For instance, on page 94, what's shown as > > “provides > > the oportunity” might be better expressed simply as “allows you to”. > > > > I've got lots more individual items, but those are the basic contexts. > Tell > > me how you'd like to proceed. > > > > And thanks again for the opportunity … > > > > > > On Tue, Jun 6, 2023 at 12:57 AM F Campos Costero <fjcc.apa...@gmail.com> > > wrote: > > > > > On Thu, May 4, 2023 at 8:40 AM Keith N. McKenna < > > keith.mcke...@comcast.net > > > > > > > wrote: > > > > > > > F Campos Costero wrote: > > > > > On the Calc Guide, I will first accept or reject all of the changes > > > > > currently shown and push those versions back to the repository. > > Judging > > > > > from the first chapter, all of my and Dick's changes have not yet > > been > > > > > accepted. I hope I will have time after that to do a full review of > > > each > > > > > document. Let me know if that plan isn't good. > > > > > Regards, > > > > > Francis > > > > > > > > > That sounds good Francis. Thanks for moving this along. > > > > > > > > Keith > > > > > > > > > On Tue, May 2, 2023 at 9:08 AM Keith N. McKenna < > > > > keith.mcke...@comcast.net> > > > > > wrote: > > > > > > > > > >> F Campos Costero wrote: > > > > >>> I'll take a look at the Calc changes. > > > > >>> Francis > > > > >>> > > > > >> > > > > >> Thanks Francis. I will finish with the Getting started changes > from > > > > >> Czeslaw morning, and will get back to the Writer Guide this > > afternoon. > > > > >> > > > > >> Regards > > > > >> Keith > > > > >> > > > > >>> On Mon, May 1, 2023 at 1:07 PM Keith N. McKenna < > > > > >> keith.mcke...@comcast.net> > > > > >>> wrote: > > > > >>> > > > > >>>> Digro has had changes for Calc waiting review for some time > could > > > > >>>> another member of the team start reviewing those so that Guide > can > > > > start > > > > >>>> Moving along. > > > > >>>> > > > > >>>> I am still trying to catch up with with the Getting Started > > changes > > > > from > > > > >>>> Czeslaw that Francis made and re publishing them, as well as > > trying > > > to > > > > >>>> work on the Writer Guide. > > > > >>>> > > > > >>>> I have also been spending a lot of time taking my Girlfriend in > > and > > > > out > > > > >>>> of the Veterans Administration Hospital in the Jamaica Plains > > > section > > > > of > > > > >>>> Boston for medical issues. > > > > >>>> > > > > >>>> Thank you all in Advance > > > > >>>> Keith > > > > >>>> > > > > >>>> > > > > >>>> > > > --------------------------------------------------------------------- > > > > >>>> To unsubscribe, e-mail: doc-unsubscr...@openoffice.apache.org > > > > >>>> For additional commands, e-mail: doc-h...@openoffice.apache.org > > > > >>>> > > > > >>>> > > > > >>> > > > > >> > > > > >> > > > > >> > > > > >> > > --------------------------------------------------------------------- > > > > >> To unsubscribe, e-mail: doc-unsubscr...@openoffice.apache.org > > > > >> For additional commands, e-mail: doc-h...@openoffice.apache.org > > > > >> > > > > >> > > > > > > > > > > > > > > > > > > > > > --------------------------------------------------------------------- > > > > To unsubscribe, e-mail: doc-unsubscr...@openoffice.apache.org > > > > For additional commands, e-mail: doc-h...@openoffice.apache.org > > > > > > > > I just pushed new versions of all the Calc Guide chapters. I limited > my > > > changes to formatting and fixing typos. Some sections would benefit > from > > > broader revisions but I did not start that. Michele's input on that > would > > > be very valuable. > > > I did not modify the front matter of any of the chapters and that will > > have > > > to be updated. I assume Keith has text that can be used for that with > > > minimal revisions. > > > > > > Regards, > > > Francis > > > > > >
--------------------------------------------------------------------- To unsubscribe, e-mail: doc-unsubscr...@openoffice.apache.org For additional commands, e-mail: doc-h...@openoffice.apache.org
