4

Is there any documentation that discribes all the available functions and objects in shoe?

update: 2008.01.21 I am looking for a list of all the methods that can be called against an animate object.

For example I only figured out how to pause an animation using the toggle() method by reading source code from the shoebox (http://the-shoebox.org/).

Argalatyr
  • 4,639
  • 3
  • 36
  • 62
  • This is an extremely confusing question. Perhaps you could be more descriptive in the future - this question almost looks like a case of abuse due to its ambiguity. – Sampson Jan 20 '09 at 21:53
  • 2
    I don't see anything particularly egregious about it. It might have been nice to explain what shoes is for those who are not sufficiently oriented to the subject matter, but then those people are not likely to answer the question anyway. – dreftymac Jan 20 '09 at 22:04
  • 1
    My point is "Do you have documentation on functions in shoe" is too ambiguous. "Do you have documentation on functions available in the Shoe GUI Toolkit" is much more descriptive, and will match up to searches better. If I search "Ruby GUI Toolkits," I should be able to find this post. But I can't. – Sampson Jan 20 '09 at 22:14
  • 1
    dreftymac, thanks. Jonathan Sampson, excelent sugestion. though I did find your initial comment un-helpfull. This is how we learn. –  Jan 21 '09 at 15:45

5 Answers5

3

If you run 

shoes -m

in a console (command prompt) window, shoes will run in Help/Manual mode.

In this mode it displays the shoes manual, complete with runnable examples (the manual is a shoes application) This mode has a built-in search feature which jumps straight to the relevant section of the docs and is very handy for reference.

Most of this info is reformatted as html in the help.shoooes.net site mentioned above.

As most open source projects go it's well documented. And _why seems to have actually shown restraint in the documentation (he obviously worked out his cartoony madness in the nobody knows shoes manual!).

jfs
  • 399,953
  • 195
  • 994
  • 1,670
pauliephonic
  • 2,127
  • 1
  • 13
  • 9
1

Shoes Help seems to have all kinds of reference documentation.

mlibby
  • 6,567
  • 1
  • 32
  • 41
0

I have never seen such thing for Shoes. It seems Why prefers to document his stuff with cartoons and collages.

Have you read Nobody Knows Shoes?

mookid8000
  • 18,258
  • 2
  • 39
  • 63
  • It was just too "My first programming book" at first glance, I'll take another look at it. –  Jan 16 '09 at 17:04
  • True. But I think the purpose of Shoes is to have an unusually low barrier to entry (like in the old C64 Basic days), allowing kids to start programming and be able to create graphics in a few lines of code. I don't know if there is more to Shoes than being "My first programming framework". – mookid8000 Jan 16 '09 at 18:09
0

Animation objects inherit from TimerBase (as do Every objects and Timer objects), and as such have the methods draw, remove, start, stop, and toggle. I don't know too much more... this is from my notes I took while digging through the shoes source. But those would be a good place to start.

0

It appears that there is no real documentation, as such--you just have to glean it from examples [?] An attempt at rdoc failed pretty well [just ran rdoc from within the github repo] http://roger.doachristianturndaily.info/ruby/shoes/doc/ you can look into the C code to try to discover them :)

rogerdpack
  • 62,887
  • 36
  • 269
  • 388