New Help Format

New Help Format

ekinsb
Alumni Alumni
671 Views
2 Replies
Message 1 of 3

New Help Format

ekinsb
Alumni
Alumni

With the latest release of Fusion, we introduced a new help format.  Because Fusion and Inventor are both using the same help system it's possible to do the same thing in Inventor for the next major release.  You can learn more about the changes here: http://modthemachine.typepad.com/my_weblog/2015/07/new-api-help-format.html

 

I would appreciate any feedback.


Brian Ekins
Inventor and Fusion 360 API Expert
Mod the Machine blog
0 Likes
672 Views
2 Replies
Replies (2)
Message 2 of 3

MechMachineMan
Advisor
Advisor
I commented in your blog already, but wanted to add that anything that could be added for included more parent objects of properties could be a big help!

ie; knowing PropertySets belongs to the Document object + whatever else it belongs to.

--------------------------------------
Did you find this reply helpful ? If so please use the 'Accept as Solution' or 'Like' button below.

Justin K
Inventor 2018.2.3, Build 227 | Excel 2013+ VBA
ERP/CAD Communication | Custom Scripting
Machine Design | Process Optimization


iLogic/Inventor API: Autodesk Online Help | API Shortcut In Google Chrome | iLogic API Documentation
Vb.Net/VBA Programming: MSDN | Stackoverflow | Excel Object Model
Inventor API/VBA/Vb.Net Learning Resources: Forum Thread

Sample Solutions:Debugging in iLogic ( and Batch PDF Export Sample ) | API HasSaveCopyAs Issues |
BOM Export & Column Reorder | Reorient Skewed Part | Add Internal Profile Dogbones |
Run iLogic From VBA | Batch File Renaming| Continuous Pick/Rename Objects

Local Help: %PUBLIC%\Documents\Autodesk\Inventor 2018\Local Help

Ideas: Dockable/Customizable Property Browser | Section Line API/Thread Feature in Assembly/PartsList API Static Cells | Fourth BOM Type
0 Likes
Message 3 of 3

MegaJerk
Collaborator
Collaborator

As an avid user of the 2012 api reverence manual, using the newer api help files has been nothing short of maddening. The switch from an organized structure of having the Methods and Properties in their own separate trees is particularly bothersome. In addition, removing the description icons (Method, Property, and Property Read-Only) seems like a step backwards. The list of objects that inherit the current object (if any), as well as the objects that the current object is reachable from were also removed!

Looking at this current incarnation of the web-based api manual, I see that it too suffers from all of the above problems, but also has the additional issue of being extremely compact due to the insufferably large header / footer located on the page.

So no. I do not think that this current web-accessible version of the api manual is better than what we have (had, really). But I do think that it has a lot of potential (to be even better than what we have), if the presentation and organization was put back in to serve as a foundation to build the content / tutorials upon.

-----

TL/DR;

1) The page Header & Footer should either be removed completely, or should collapse into nothing once the page becomes half the width of the device, or under a certain amount width.

2) Objects should tell you where they can be accessed from, and which Objects inherit them.

3) Methods and Properties should be either separately categorized, given back their icons, OR styled appropriately so that they can be easily differentiated visually. In addition, Properties that are writable should be styled differently than properties that are read-only.

4) Objects, Methods, and Properties should have Notes (reattached) that include contextual information that may be helpful in determining future / current problems. This should include a flag and information for things that are in a broken state (and possibly which versions of Inventor are affected by it!). For instance, for the .FlangeDirection property (which should be both read / write), you might include the ticket that was made (http://forums.autodesk.com/t5/inventor-customization/change-flange-direction-via-api/m-p/5245537#M51...) as well as the date and whether or not older (or which) versions are still affected by the issue.



If my solution worked or helped you out, please don't forget to hit the kudos button 🙂
iLogicCode Injector: goo.gl/uTT1IB

GitHub