A few descriptions missing from the documentation

Help & Support
1

I'm currently working on an updated dopus.d.ts flie to use intellisense in VSCode.
Doing so, I noticed the following things missing in the docs:

  • DOpusFactory is missing method EverythingInterface
  • Tab object declares two object types (returned by unresolved and unsorted properties) that are not described within the documentation

And the following ones are not yet described (but that may be due to the fact that they are related to the latest betas, and have not met a stable version yet - I never really looked into the moment when you update the docs between beta and stable releases):

  • Dialog.Request : new last optional parameter (icon letter) : not yet described
  • DOpus.Request : mentioned in 13.22.1 release notes, but not in documentation
  • FSUtil.Run : flags do not mention the "a" value introduced in 13.22.1

For the second part, if it has to wait for 13.23, of course no problem.
For the first ones, it is obviously low priority.

2

Thanks for that, the first two have been added. We don't normally update the docs for betas since things are still subject to change, so the others won't be done until after the next stable release.

3

Hi @Jon , would you have an approximate ETA for the (scripting) documentation update to align with 13.23?
Btw, I noticed in the 13.22.1 release notes mention a new optional parameter to Dialog.Request and DOpus.Request methods (4th or 5th argument). The DOpus.Request method does not seem to be in the documentation.

4

They've all been updated now I think (let me know if something is missing).

5

Many thanks @Jon.
From a quick look, this seems complete.

Just a minor remark: The new third parameter to Dialog.AddHotKey (bool global) seems to be optional according to the release note. This is not clear in the documentation (maybe [<bool:global>] in the argument column or "If the optional global parameter" in the description).

6

Sorry, I missed another one: Dialog.LoadPosition does not mention the new authorized values (fix and nofix) for the type parameter that allows to override the position_fix property.

7

Hey, documentation maniac back again :slight_smile:

Following my project on the TS typings, I found some other issues in the doc.
All this is obviously low priority, but I'll list them here for reference and so you can have a look when there's time:

  • "External" script configuration management (introduced in 13.17) is missing parts in the docs:
    • OnAddConfigPages and OnConfigureScript events appear but without any information
    • Their associated objects (parameters) AddConfigPagesData and ConfigureScriptData are missing
    • Method Dialog.AddConfigPages (which is supposed to be called from OnAddConfigPages) is also missing on the Dialog object.
  • OnOpenTab event page : The first line is mispelling the event function name: "The On event" => "The OnOpenTab event"
  • OnScriptCommand: According to the description, the function either return True or 1 depending on what the user wants then to happen. But the return type is only bool (should be int or bool if I understood correctly the description).

All in all, very minor (even if the script configuration part is quite hard to figure out from the docs only at this point, one would have to revert to the release notes to understand).