Re: Standard Additions documentation
Re: Standard Additions documentation
- Subject: Re: Standard Additions documentation
- From: Bill Cheeseman <email@hidden>
- Date: Sat, 20 Dec 2008 06:43:13 -0500
- Thread-topic: Standard Additions documentation
on 2008-12-20 4:58 AM, Chris Page at email@hidden wrote:
> The ³do shell script² dictionary entry points at a web page with a
> detailed discussion of the command, with examples.
>
> I suppose we should think about updating the Standard Additions
> dictionary to pick up the revised reference documentation from the
> ASLG, but I'm hesitant to attempt to fill dictionaries with more than
> quick-reference information.
>
> If we added links within the dictionary to the ASLG, would that help?
> Would anybody notice and follow them? (Has anybody noticed and
> followed the one for ³do shell script²?)
I think a link to the ASLG would be great. I also think you should take
better advantage of the HTML capabilities of sdef files everywhere you can.
But yes, keep it short.
I believe the first scriptable application to include HTML in its
terminology dictionary was my PreFab UI Actions. I tried to find the right
balance between providing useful information and keeping it short. Now that
you point out the link in Standard Additions, that's only the second one
I've noticed -- and it's way too short. Is anybody aware of other
applications with HTML in the dictionary?
Ah. Now that I look around, I see that several developers have done this.
For example, the latest version of Mark Alldritt's XSLT Tools.osax includes
some HTML usage examples in its dictionary, and Satimage.osax has some HTML
documentation in its dictionary. Everybody who writes scriptable apps and
scripting additions should be doing this.
--
Bill Cheeseman - email@hidden
Quechee Software, Quechee, Vermont, USA
www.quecheesoftware.com
PreFab Software - www.prefabsoftware.com
_______________________________________________
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