SRL Archive - Commits

Documentation


Wizzup?

2010-09-02 18:58:12

Although most of the Simba functions are pretty obvious to advanced scripters, I think it is very important we document all the functions so new scripters can learn how all the Simba functions work as well.

I just ``completed'' the Colour Finding page: http://wizzup.org/simbadoc/scriptref/colourfinding.html

It would be nice if someone else could write (a part of) one of the following pages:
  • DTM
  • Bitmaps
  • OCR (Only clean it up + examples, may be easier?)
  • Files
  • Internet functions

Or extend the troubleshooting page; or perhaps write a small tutorial on how to use TPA's, etc. I know some of these tutorials are available on the forums, but I thought it would be nice to also ship some offline documentation with Simba. (/simbadoc would be included in the installer, so one can view it offline)

So some (small) tutorial would be cool too.

This is the TODO list but it probably slightly outdated: http://wizzup.org/simbadoc/todo.html

Documentation on how to write documentation can be found here: http://wizzup.org/simbadoc/docdoc.html

Bebe

2010-09-03 01:20:14

I will see what I can do to help you out in the morning (since you have been bugging me on irc :p)

R0b0t1

2010-09-03 17:26:28

Color*

holic

2010-09-03 20:01:29

From: R0b0t1
Color*

Only Americans spell it 'color', 'colour' is the proper way of spelling it.

Nava2

2010-09-03 22:58:47

http://en.wikipedia.org/wiki/American_and_British_English_spelling_differences#-our.2C_-or

Bebe

2010-09-03 23:59:12

How about you take the debate elsewhere and help with documentation as that is what this thread is about.

TomTuff

2010-09-04 03:54:05

are the commands in simba the same as the ones in the help manual (brought up by pressing F1) in scar?

Wizzup?

2010-09-04 04:46:27

From: TomTuff
are the commands in simba the same as the ones in the help manual (brought up by pressing F1) in scar?


They are similar at times, yes. We aimed to preserve some compatibility with SCAR.

Wizzup?

2010-09-05 18:26:30

Kind of finished the OCR Documentation; although it will still need some examples. ( http://wizzup.org/simbadoc/scriptref/ocr.html )

And it will be even more complete when the Bitmap / TPA sections are written.

/me looks around…

mastaraymond

2010-09-05 18:28:56

From: Wizzup?
Kind of finished the OCR Documentation; although it will still need some examples. ( http://wizzup.org/simbadoc/scriptref/ocr.html )

And it will be even more complete when the Bitmap / TPA sections are written.

/me looks around…

Dude.. Looking around won't get those sections finished, get to work!

R0b0t1

2010-09-06 14:51:53

From: holic
Only Americans spell it 'color', 'colour' is the proper way of spelling it.


No, colour has an extra 'u'. Sad to say.

The irregularities are pretty fucking annoying, SCAR used color, practically every program I can name uses "color" (disregarding menus, even then, you usually have to switch to UK or British English). So why does Simba not use color? Wizzup is a thick headed faggot with no sense of continuity. I'm not going to write any more documentation until this is sorted out, and I sure hope to GOD that the functions are still FindColor*…

That is all.

Bebe

2010-09-06 18:32:57

From: R0b0t1
No, colour has an extra 'u'. Sad to say.

The irregularities are pretty fucking annoying, SCAR used color, practically every program I can name uses "color" (disregarding menus, even then, you usually have to switch to UK or British English). So why does Simba not use color? Wizzup is a thick headed faggot with no sense of continuity. I'm not going to write any more documentation until this is sorted out, and I sure hope to GOD that the functions are still FindColor*…

That is all.

Don't overstep your boundaries, this is not #SRL ;)

Shuttleu

2010-09-06 18:45:25

From: Wizzup?
Kind of finished the OCR Documentation; although it will still need some examples. ( http://wizzup.org/simbadoc/scriptref/ocr.html )

And it will be even more complete when the Bitmap / TPA sections are written.

/me looks around…


i will do examples if you want :)

~shut

EDIT: also at the top you have OCR (Optical Text Recognition) but instead of Text it should say Character

holic

2010-09-06 18:49:00

Thank you for this by the way Wizzup?, it's very much appreciated as I'm just learning to script for Simba. It'll be nice to have explanations for everything, not just SRL.
From: R0b0t1
No, colour has an extra 'u'. Sad to say.

The irregularities are pretty fucking annoying, SCAR used color, practically every program I can name uses "color" (disregarding menus, even then, you usually have to switch to UK or British English). So why does Simba not use color? Wizzup is a thick headed faggot with no sense of continuity. I'm not going to write any more documentation until this is sorted out, and I sure hope to GOD that the functions are still FindColor*…

That is all.

Not everyone caters to Americans, get used to it. Americans use 'color' as that is how it is spelt in Latin, but in English it is proper as 'colour'.

HyperSecret

2010-09-07 10:13:02

"Algorithm on how to write algorithms efficiently." – That gave me a little laugh.

I would really like to help with this but I keep finding myself bombarded with homework of some sort.

Wizzup?

2010-09-09 10:55:01

Added "dtm.rst" and "files.rst". They contain all the functions and their definition, but no actual comments as to what they do yet.

E: Added a few more skeletons.

moparisthebest

2010-09-10 18:45:01

From: Wizzup?
Added "dtm.rst" and "files.rst". They contain all the functions and their definition, but no actual comments as to what they do yet.

E: Added a few more skeletons.


What are the .rst files? I was under the impression the compiler creates them so I delete them all under the 'clean' target in the makefile, should that not be done? :confused:

Wizzup?

2010-09-10 18:48:51

From: moparisthebest
What are the .rst files? I was under the impression the compiler creates them so I delete them all under the 'clean' target in the makefile, should that not be done? :confused:


The .rst stands for "Restructured text": http://docutils.sourceforge.net/docs/user/rst/quickstart.html :)

Wizzup?

2010-09-14 14:38:53

From: R0b0t1
Color*


… Allow me to retort.





Wizzup?

2010-09-14 15:15:35

Really though… You've already said this too many times. You're just exaggerating now. We know you prefer color and consistency. You don't want to write documentation if the documentation uses colour? Come on now. Perhaps, if you really wrote documentation, we could consider switching to just using ``color''. But quite frankly, you haven't really written documentation, except for a few ``spelling'' fixes.

Wizzup?

2011-01-09 07:20:56

Nearly done with Bitmap and Files. Updated list to reflect changes.