Grammar questions for documentation

[Yawar Amin]

Hi Cristian,

On 2010-12-01, at 14:04, Cristian Marchi wrote:

> I'm working on some sed [1] commands that do automatically some grammar corrections to xml file (for documentation). For example I've a command that checks (and if false corrects it) if after a period there are two spaces, one removes the white spaces at the end of a line, one checks and corrects for uppercase char after a period and so on….

Nice! A policy checker. Similar to the tools that re-format C source code to look pretty.

> […]
> 
> - after a full stop (period) in the text there are always two spaces before the following words (this is valid for english and not for other languages i.e. Italian). [2]

Well, this was done in the days of yore but I think you can safely go ahead and s/\.  /. / The XML processors that turn the DocBook sources collapse extra whitespace into a single space anyway, and it’s easier to enforce the single-space policy in an automated way than it is to enforce a double-space policy.

> - after a , ; : punctuation there is only a space before the following word.

Correct.

> - toolbar, titlebar, menubar, summarybar, statusbar and not tool bar, title bar etc... [3]

Sure.

> - the period after a phrase beetween parenthesis is inside or outside the parenthesis?

Inside if the phrase is a full sentence but outside if it’s just part of the sentence. E.g.:

	I did it. (But you don’t have to.)

	It was a cold night (and rainy, too).

> […]
> 
> All this command could be collected in a little script that runs from time to time in the documentation for cleaning purposes.

Sounds good.

> Sorry if this topic is not really accounting or GnuCash related…

I think it’s very GnuCash-related … these are the GnuCash docs :-)

Best,

Yawar

-------------- next part --------------
A non-text attachment was scrubbed...
Name: PGP.sig
Type: application/pgp-signature
Size: 194 bytes
Desc: This is a digitally signed message part
URL: <http://lists.gnucash.org/pipermail/gnucash-devel/attachments/20101201/42a7a7a6/attachment.bin>