New API doc - typos and questions

Dan Rathbun

@dan rathbun said:

@unknownuser said:

If anyone nows how to solve this let me know

You really should have started a new topic for your issue. (This topic about errors in the online API Dictionary.)

Don't worry about that now (this topic is so long and cluttered it does not matter much. And likely will be locked when the next version of the online API Dictionary is updated.)

@dan rathbun said:

You need to learn to read Exception messages. The full message will have a line number in your file where the error happen.

Move your file (and all your authored scripts,) into a "Renderiza" subdir of the Plugins dir.

When debugging.. start Sketchup, then open the Ruby Console.

Enter load("Renderiza/myfile.rb")

You'll see a more complete Exception message output to the console.

renderiza

Thanks Dan Rathbun for teaching me how to debug inside Ruby Console.
I forgor to post the topic link I was referring to…
http://forums.sketchucation.com/viewtopic.php?f=180&t=25498

I still can’t find a way to load the jumper.rb and animate the object when active but I will sonn figure it out. And I promise that for next time I will make a new topic for my issues.

Thanks

wood_galaxy

Hi !
I haven't seen if it had benn reported but :
In Attribute reporting Tutorial in the function :

def clean_for_xml(value)
    value = value.to_s
    value = value.gsub(/\</,'<')
    value = value.gsub(/\>/,'>')
    value = value.gsub(/\"/,'"')
    value = value.gsub(/\'/,''')
    return value
  end

The last gsub make that the rest of code is a comment...

TIG

@wood_galaxy

???
.gsub(/\'/,''')
should be
.gsub(/\'/,"'")
to 'wrap' the lone ' properly...

I'm unclear what you put in and what you expect to come out here
The
value = value.gsub(/\</,'<')
could be made as
value.gsub**!**(/\</,'<')
changing 'value' rather than reassigning it to a modified version of itself.
You could also 'string' the gsub changes into one line...
return value.to_s.gsub(/\</,'<').gsub(/\>/,'>').gsub(/\"/,'"').gsub(/\'/,"'")
Although it's easier to read what you are doing your way.
It'd probably be slightly faster - but relatively unnoticeable if only a few values are processed...
Can you clarify?

wood_galaxy

I thought this topic was used to identify inconsistencies in the API doc.
I had just noticed that the code of the tutorial was a mistake.
I started in ruby but I think the line "value = value.gsub(/'/,''')" contains an error.
Maybe I'm wrong and that it is normal that the two following functions can be found commented.
So TIG you say it should be .gsub(/'/,"'"). That's what I wanted to know and get noticed.
Sorry for the inconvenience.

TIG

@wood_galaxy

Now I understand you.
It is indeed a typo in that example code and it should be "'" NOT ''' - the first two '' are taken as an empty string and the third one as a start of a new string - so it's not really a 'rem' - a # or =begin...=end does that in Ruby - it's simply made all of the following code into a string until it reaches the next ' which happens to be inside a comment "can**'**t", thereafter the code resumes again, but of course at that point it's garbled and will return errors and not work...
This type of error is sometimes hard to find but if you are using Notepad++ it'd be obvious, as the syntax highlighting would should a massive block of 'string' text where it shouldn't be, so looking at it's start/end delimiters ['] tells us what's up and what needs fixing...
See the original and the correction [the rest of the code - with the exception of the unnecessary $ variable in the menu setup seems OK]
I thought you were using some of it for your own ends and having problems...
There are MANY errors in the API examples - it's been discussed, and indeed the main API docs used to have a user comments section at the end of each page where we pointed out the mistakes.
When Google moved the content these were 'lost'.
SketchUp still have the text but it's the way of including it that is lacking.
Various ways of introducing a 'wiki-like' system have been mooted, but nothing to date...

honkinberry

I finally tracked down a bug that popped up with 7.1, but not sure if this is the best place to note it.

But for Transformation.scaling, both (scale) and (pt, scale) have a bug.
One instead needs to use (xscale, yscale, zscale), even though all 3 parameters will be the same.

thomthom

Yea, that's a nasty one. It used to be in the comments of the API docs, but it disappeared some time ago.

mptak

Is anyone else having a hard time accessing the Sketchup Ruby API today?

thomthom

Yeah, the URLs got messed up when they launched the new site. Hope the fix the forwarding soon. You find working links at the bottom of sketchup.com

Sent from my LT25i using Tapatalk 2

Aerilius

For now, you can add ".php" in the address bar.

thomthom

XorUnison

I would assume typos can still be posted here? If so, here's one:
http://www.sketchup.com/intl/en/developer/docs/ourdoc/tool#onKeyDown

Tool.onKeyDown SketchUp 6.0+

The onKeyDown method is called by SketchUp when the user presses a key on the keyboard. If you want to get input from the VCB, you should implement onUserText rather than this method.

This method is can be used for special keys such as the Shift key

TommyK

Model Observer:
onAfterComponentSaveAs(model)
and
onBeforeComponentSaveAs(model)

The "model" parameter is actually a ComponentInstance object - the one currently selected. This is the case at least in Sketchup 2015.

Talha222

Yeah! really great information about documentation about API .
Thank You so much i will be helpful for me