Re: [Qscada-developers] R: Document templates

[wireless <wir...@ta...>]

Iain Buchanan wrote:
> Hi again, its the occasion-poster here :)
>=20
> On Wed, 2006-12-13 at 04:22 -0800, Paolo Sereno wrote:
>=20
>>Hi all,
>>
>>thank you for your effort and your ideas. I=B4m honoured to work with
>>you all.
>>
>>Talking about coding convention, I=B4d like to invite you to consider
>>something like this
>>http://www.cs.rice.edu/~dwallach/CPlusPlusStyle.html
>=20
>=20
> Hmm, personally I don't like _some_ of the ideas here - such as its...,
> their..., the...
>=20
> at work, we use a similar style, with the type of variable / object
> preceding it's name, like:
>=20
> unsigned short usSomeVar;
> int iSomeVar;
>=20
> class CoolClass;
>=20
> CoolClass oInstance; // o is for object!
>=20
> and function names are FirstLetterCapitals or name_with_underscore.
>=20
> I personally believe coding styles should be specific in some areas, bu=
t
> general in others.  Specifics include tab widths, or "no tabs"; loop
> structure, names, etc, but with a general neatness in layout.
>=20
> Making the code easy to read and look "nice" can sometimes override the
> coding style.
>=20

Well, as I stated, I'm flexible, and maybe we should look, as a group
at some more specific examples?

Maybe Paolo could offer up some exiting code that he plans to use with
Qscada, and we can all hash this out until we are agreeable?


>=20
>=20
>>Documents:
>=20
>=20
> Making templates can be tricky, given different fonts, sizes, programs,
> etc.  Perhaps we could provide a latex template for people to edit, and
> just some font names and sizes to use for *-office programs.  Maybe we
> give an example front page, and table of contents, then after that it's
> up to the author...


Agreed. But, I for one am going to look at some of the
existing/earliest documents and try to conform as much as possible
to what the most prolific author(s) create.

That said, does the form of the documents affect how we will publish
the docs on the web (Doxygen, XML, etc etc) or will these just be
a collection of pdf/doc/ascii files that are downloaded? No hart_burn
either way, just curious.


thoughts?


James