We’re launching a new look and feel for the Ignition User Manual next week, on February 15, 2024. This is a project that the IA Docs team has been working hard on for about a year now, and we’re looking forward to hearing your feedback! Here are a few of the features we’re most excited about:
One thing to note is that if you have any bookmarks to specific pages in the manual, those links likely will not work when we launch the new site. The homepage URL (docs.inductiveautomation.com) will remain the same. We apologize for any inconvenience this may cause.
On the user-facing side most of these changes will be purely aesthetic, but behind the scenes the new toolset will help our team collaborate better with the developers and allow us to make even more improvements to the Ignition User Manual in the future. As always, if you have any questions or comments for our team, please feel free to reach out to us at email@example.com or leave a comment in this thread!
Sounds good, look forward to it. Hopefully there are more places where Vision and Perspective features are explicitly differentiated. I don't need it so much now that I know Perspective pretty well, but I wasted hours coming up the curve wasting my time trying Vision-only features that I didn't know weren't in Perspective. Having more of that would make learning the system a lot less frustrating.
I'm a fan of Solarized Light but unfortunately Ignition doesn't have it out of the box.
To get back on the topic: One thing that always annoyed me about the Ignition Manual was that if I end up on a page from an earlier version (usually from Google search), the link to the latest version drops me off on the home page instead of the latest version of the same page.
Contrast with the Python docs, where if my search lands me on Python 3 I can choose Python 2.7 in the dropdown and it will take me to the same manual page if possible.
Is this something implemented in the new update or could it be implemented in the future? It would save me from having to repeat my search, this time in the manual's search bar.
Speaking of the search bar, it was also a bit annoying how the two search bars (sidebar vs upper right) have different behaviors.
For the most part, any system functions and expression functions pages should redirect you to the equivalent page in a different version, assuming that function exists in both 7.9 and 8.1. Other sections may or may not, just based on how different the structure is between the 7.9 manual and the 8.1 manual. I have some ideas on how we might be able to implement this more consistently in other sections, though it'll require a bit more manual tweaking of individual pages.
Good news, there's only one search bar in the new docs, and it behaves better than either of the old ones.
Are there any plans to add context-sensitive help to the designer so that if we're scripting, or on a property of a component that we could hit a help button that would take us to the help for that component/function/etc? So many times I've wanted to just be able to hit F1 and get instant help but have to go to the online manual and search it myself.
This is more of an issue with the "development" side of the house than the "documentation" side of the house. In newer areas of the product, such as most places in Perspective, the extension function descriptions contain a 'Learn More' link that takes you directly to an appropriate manual page:
However, many areas of the product are still missing these, because we haven't gone in and done the legwork to set up the links - it's definitely on our agenda to do so. Adding a hotkey to "click" those links for you would also be quite doable, and is a good idea for an easy enhancement
We're also planning to tie the gateway webpage configuration of things into the designer in a bit more direct way.