Re: sdef etiquette
Re: sdef etiquette
- Subject: Re: sdef etiquette
- From: Bill Cheeseman <email@hidden>
- Date: Sun, 28 Jun 2015 10:40:25 -0400
In the sdef(5) man page there is the diktat that:
Bear in mind that an sdef is intended to be a reference, not a tutorial. If you want to include any lengthy material, consider using a link to an external resource.
Personally, I don't see why an AppleScript dictionary can't be more ambitious, and as a end-user myself, that's certainly what I'd like to see more of in other developer's dictionaries.
Several years ago, terminology dictionaries acquired the ability to include general text passages, script statement examples, links and other explanatory elements to expand upon the traditional, more limited information. The caveat that you cited from the documentation should be interpreted in light of this new and very helpful capability. Read it as a warning not to go overboard. The example you gave in your message is well within expectations as I understand them.
My UI Actions application was the first third-party scriptable application to take advantage of this capability. You can download a 30-day free trial at < http://pfiddlesoft.com/uiactions/downloads/UIActions230.dmg>to see what its dictionary looks like. I promoted it at the time as an example of how do this, and many other scriptable applications have been released since then by Apple and others that take a similar approach. |
_______________________________________________
Do not post admin requests to the list. They will be ignored.
AppleScript-Users mailing list (email@hidden)
Help/Unsubscribe/Update your Subscription:
Archives: http://lists.apple.com/archives/applescript-users
This email sent to email@hidden