Home >

Requirements

  • OS X 10.8 or later
    • Developed and tested on Mac OS X 10.11.6
  • HelpBook.osax(Scripting Addition)
    • Required to show a Help Book in Help Viewer from AppleScript.
    • Bundled into the download package.

Download

Version 1.7.1 -- 2017-09-29

Old Versions

AppleScriptDoc

AppleScriptDoc is a generater of a reference manual of AppleScript libraries.

AppleScriptDoc extracts tagged comments in the source code, and output fommated HTML files. The HTML files can be set as a Help Book in the script bundle.

History

  • 1.7.1 -- 2017-09-29
    • Improved script links generated by @example tag.
      • "=" in code will be perscent escaped.
    • Fixed : Cliking a "Edit Scrpt" link and a clipboard icon in a handler page did not work.
    • Updated Spakle framework.
  • 1.7 -- 2017-02-01
    • Added code signing.
    • Added a custom icon.
    • Support multiple @syntax tags
    • Added @example tag.
    • Support nested comments in AppleScriptDoc region.
    • Improved error handlings when recent files don't exist.
    • "Setup Help Book" action will generate a new help book bundle structure which was introduced in Mac OS X 10.6.
    • Many internal changes.
  • 1.6 -- 2016-02-12
    • Mac OS X 10.8 or later is required.
    • Clean up and modernize souce code.
    • Use hiutil command to make a index file of a HelpBook instead of Help Indexer.app.
  • 1.5.1 -- 2013-05-24
    • Fixed : "Export Help Book" did not work.
  • 1.5 -- 2013-04-19
    • Moved to AppleScriptObjC from AppleScript Studio.
    • Mac OS X 10.6 or later is required.
  • 1.4.4 -- 2012-11-28
    • Fixed : orderd list did not converted.
  • 1.4.3 -- 2012-11-20
    • Fixed : "Edit Script" links in handler pages did not work.
  • 1.4.2 -- 2012-11-09
    • Fixed : specifying a target script by dropping to the window did not work.
  • 1.4.1 -- 2012-06-06
    • Imporoved output HTML.
  • 1.4 -- 2012-05-17
    • Added a popup menu to scroll handdings in the index page.
  • 1.3.2 -- 2012-05-01
    • Fixed : "Edit Script" link and copying handler's template does not works in the Help Viewer of Mac OS X 10.6.
    • Some adujustments of output HTML.
    • Other small fixes.
    • HelpBook.osax has been bundled.
  • 1.3.1 -- 2009-12-20
    • If the target bundle's Info.plist does not have the "CFBundleIndentifier" entry, "CFBundleIndentifier" will be automatically added.
      • In Mac OS X 10.6, "CFBundleIndentifier" is required to have a help book.
  • 1.3 -- 2009-11-09
    • Supported Mac OS X 10.6
    • Droped Mac OS X 10.4 from supported platform.
    • The default font size of outputs is 12px.
  • 1.2.3 -- 2009-01-06
    • Add self-updating function using Sparkle Framekwork.
    • Relative references to files in @referneces can be dealt.
      • The relative reference must be a relative path from the index page. The relative path is converted for handler pages.
  • 1.2.2 -- 2008-12-15
    • You can remove recent items in recent popup menus by selecting it with pressing option key.
  • 1.2.1 -- 2008-12-10
    • Add support Mac OS X 10.5.
  • 1.2 -- 2008-11-27
    • Remove dependency on Script Editor.
  • 1.1.2 -- 2008-04-07
    • Add @syntax tag.
    • Add @references tag.
    • "Export Help Book" can be cancled during the processing.
    • ((<keyowrd>)) can be used in the contents of @param tag.
    • URLs and mail addresses enclosed with "((<" and ">))" are converted to hyper links.
    • Miscellaneous fixes.
  • 1.1.1 -- 2008.01.16
    • Fixed "Save to Files" does not work.
    • Fixed "Setup Help Book" does not work, when the script bundle does not have Info.plist.
    • Fixed that the relation between "Help Book Root" and "Export File" is not correctly recognized in some cases.
    • Remember previous "Help Book Root" and "Export File" according to each script files.
  • 1.1 -- 2007.09.05
    • First release with English documents.
  • ...
  • 1.0 -- 2007-02-21
    • First release.