Possible to access 17.1 class reference some other way than inside FlexSim?

Question

question

Axel Kohonen asked Apr 12, '17 Axel Kohonen commented Mar 22, '19

Possible to access 17.1 class reference some other way than inside FlexSim?

Hi,

I generally check the documentation of the commands in FlexSim by having the commands reference open in the browser. For FlexSim 17.1 you can do this for the normal commands reference like outlined in this post.

However, with the introduction of the dot syntax I now frequently need to access the Class Reference documentation which is not a part of the commands reference.

Currently the only way I know how to find the commands reference is through the user manual in an instance of FlexSim. As I do not want to have the user manual open in the FlexSim instance I am working in (as the user manual uses a lot of space from the screen) I now use a separate FlexSim instance where I have the manual open.

I tried to open the class reference html files in the browser (found in C:\Program Files\FlexSim 2017 Update 1\help\FlexScriptAPI), but they do not work properly.

Is there some way of accessing the class reference online or to get the class reference to work in the browser?

Thank you!

Kind regards,

Axel

Software Version:

FlexSim 17.1.0

class reference

· 2

Jeff Nordgren commented · Apr 12, 2017 at 04:16 PM

@Paul Toone, @Ben Wilson

0 ·

Ben Wilson ♦♦ commented · Apr 12, 2017 at 04:30 PM

As I'm sure most people have noticed, we do have some of the older user manuals posted here at Answers, but this has been problematic on several fronts. Trying to upload the manual, building a proper table of contents, fighting with formatting issues, and other problems all conspire to tell us hosting the manual here within Answers is a bad idea. This Q&A platform just fights us all the way, and was not built for that use-case.

So, in the future we hope to have a different solution for hosting the user manual online.

As for whether a user manual that shipped with the software can somehow be opened external from FlexSim using a web browser, I've poked around a bit in the code and it seems that the user manual dynamically loads an iframe with the requested content, in connection with the quick properties panel where the TOC lives.

I haven't figured it out yet. It may not be possible/practical. We'll ask the dev team to help us out.

@Matt Long, @anthony.johnson

0 ·

Answer 1 · 2017-04-12T16:59:09Z

Phil BoBo answered Apr 12, '17 Axel Kohonen commented Mar 22, '19

FlexSim itself generates the Class Reference documentation dynamically based on the files in FlexSim/help/FlexScriptAPI.

It is not currently possible to access this documentation directly in its nice HTML format outside of the FlexSim software itself.

I'll add a note to the dev list to make this documentation accessible elsewhere in the future.

· 3

Axel Kohonen commented · Apr 13, 2017 at 06:49 AM

Hi Phil,

Thank you for the explanation! Hopefully it would be possible to get the manual outside FlexSim somehow at some stage.

Axel

0 ·

Phil BoBo ♦♦ Axel Kohonen commented · Mar 21, 2019 at 04:24 PM

The user manual is now available online at https://docs.flexsim.com, including the FlexScript API Class Reference documentation.

Starting in 19.1, the FlexScript API Class Reference documentation is also embedded within the User Manual in the software and can be opened in a separate browser like the other User Manual pages.

3 ·

open-in-browser.png (91.4 KiB)

Axel Kohonen Phil BoBo ♦♦ commented · Mar 22, 2019 at 05:03 AM

Hi @phil.bobo

Thank you! I noticed that through the information on answers.flexsim.com. Great to have the manual online as well.

1 ·

question