SRL Archive - General

SCAR Online Manual

Freddy1990

2011-06-27 05:54:21

I've decided to move back to an online manual for SCAR using a MediaWiki installation, as this eases the work quite a bit. Unlike before I will, at least for now, not be looking for people to assist in writing the manual. This being to ensure the quality and accuracy of the content. With some luck I'll be adding 10 or more pages a day to it, I'm currently porting the previous manual which is included with SCAR 3.25+ to his online one, though many function that were not documented in there or even never documented up until now have already been added as well. I can only ensure the manual is 100% accurate for SCAR distributions 3.25 and above, but I try to add in details regarding older versions where possible.

You can find the manual here: http://www.scar-divi.com/

Some examples of the pages in there:

I hope this manual can sort out some vague details about some functions and help people to understand how each function works better.

~Freddy

nielsie95

2011-06-27 06:04:35

Looking good. :)

Coh3n

2011-06-27 08:02:19

I love the detail. :) I'm sure it will be extremely useful for a lot of people when it's finished.

Freddy1990

2011-06-27 10:15:18

The previous manual as many/most before made a point out of documenting the parameter of each function individually, however imo it offers little added value to the documentation. I think by integrating each parameter properly in a detailed description it will offer a lot moer detail without cluttering everything up and/or be repetitive. It also makes it somewhat less of a burden to write. I might (initially) refer to the Embarcadero Delphi documentation for a lot of the classes documentation (except for my own classes), to ensure people can get access to documentation for them before I get a chance to write it myself.

Coh3n

2011-06-27 23:07:11

From: Freddy1990
The previous manual as many/most before made a point out of documenting the parameter of each function individually, however imo it offers little added value to the documentation. I think by integrating each parameter properly in a detailed description it will offer a lot moer detail without cluttering everything up and/or be repetitive. It also makes it somewhat less of a burden to write. I might (initially) refer to the Embarcadero Delphi documentation for a lot of the classes documentation (except for my own classes), to ensure people can get access to documentation for them before I get a chance to write it myself.
Oh for sure. Definitely finish the documentation for your methods (ones you can't find documentation elsewhere).

Also, integrating the parameters into the description is definitely better IMO, that's exactly what we did with MSI.

Freddy1990

2011-06-28 04:39:20

Well, I'm certainly making some progress, there's over 100 functions documented, I think that's a personal record :p Also added some more source code for several math functions, I think it helps clear them up better since it's math, which makes it harder to give an accurate informal description of it. http://wiki.scar-divi.com/index.php?title=FixD

Coh3n

2011-06-28 04:54:12

From: Freddy1990
Well, I'm certainly making some progress, there's over 100 functions documented, I think that's a personal record :p Also added some more source code for several math functions, I think it helps clear them up better since it's math, which makes it harder to give an accurate informal description of it. http://wiki.scar-divi.com/index.php?title=FixD
Haha nice. :) I like the layout of the Wiki. Clean and organized. :) Looks professional.

nielsie95

2011-06-28 05:06:09

Will you also be adding the source for the tolerance functions? That would definitely clarify the working of it ;)

Freddy1990

2011-06-28 05:08:19

From: nielsie95
Will you also be adding the source for the tolerance functions? That would definitely clarify the working of it ;)


Only the default tolerance function, it's still a closed source application.