Gpc-doc

Download

gpc-doc@gnu.de

December 2000

1 participants
2 discussions

help writing documentation
by Eike Lange 09 Mar '01

09 Mar '01

Hi! I would like to help writing documentation for gpc. My project, writing german documentation for gpc died because nobody was interested helping me and its too much for just one man. I would prefer to discuss documentation-related topics on the gpc-doc-mailinglist (gpc-doc(a)gnu.de) . There are still some questions left: - Is Texinfo 4.0 ok? - Which options do you use to create the diffs - Are there any documentation-standards, I have to recognize? Eike

2 3

Re: A very minor documentation error
by Frank Heckenbach 14 Dec '00

14 Dec '00

Bernard Leak wrote: > Dear Sirs, Mesdames, Unspecified Neuters, and others: > > The heading to the page > http://agnes.dida.physik.uni-essen.de/~gnu-pascal/gpc_4.html#SEC4 > 3.1 General Changes And Possible Incompatibilies To Previous Versions > > and the link to it on the page > http://agnes.dida.physik.uni-essen.de/~gnu-pascal/news.html > > (there may be other links - I haven't searched) > is not in English (not even International English). > > It should read > > "Incompatibilies To" <- "Incompatibilities With" > > Normally, the preposition "With", articles and conjunctions > shouldn't be capitalised either, except at the start of a sentence. > The site is notably inconsistent in its capitalisation style, so > I feel free to suggest a merely local change. > > I propose a squeakily-clean replacement with > > 3.1 General Changes and Possible Incompatibilities with Previous Versions Thanks. These kinds of errors are due to the fact that most of the writers and editors of the documentation are non-native speakers, and I (who wrote this section, AFAIR) have never learnt the rules for capitalizing headlines and such... If you'd like to offer more help in these matters, this would be very welcome. The preferred form for making such changes is to start with the Texinfo files (part of GPC source distributions and available through CVS) and send diffs to the gpc-doc mailing list (to which I'm sending a CC of this mail). Frank -- Frank Heckenbach, frank(a)g-n-u.de, http://fjf.gnu.de/ GPC To-Do list, latest features, fixed bugs: http://agnes.dida.physik.uni-essen.de/~gnu-pascal/todo.html

1 0