Skip to content

Commit

Permalink
Links to ExtendScript SDK, fixes #2
Browse files Browse the repository at this point in the history
  • Loading branch information
Klustre committed Feb 1, 2022
1 parent 46b5820 commit 9454baf
Show file tree
Hide file tree
Showing 10 changed files with 90 additions and 97 deletions.
2 changes: 1 addition & 1 deletion docs/integrating-external-libraries/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ All Adobe Creative Suite 4 applications support this feature.
Example code
++++++++++++

The sample code distributed with the Adobe ExtendScript SDK includes an example that demonstrates
The sample code distributed with the `Adobe ExtendScript SDK <https://github.com/Adobe-CEP/CEP-Resources/tree/master/ExtendScript-Toolkit>`_ includes an example that demonstrates
how write a C/C++ shared library to be integrated with JavaScript. It is in the directory::

sdkInstall/sdksamples/cpp/
Expand Down
13 changes: 7 additions & 6 deletions docs/interapplication-communication/cross-dom-functions.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,14 +17,15 @@ startup script (14 is the version number of the installed application). See :ref

**Example code**

The sample code distributed with the Adobe ExtendScript SDK includes these code examples that
The sample code distributed with the `Adobe ExtendScript SDK <https://github.com/Adobe-CEP/CEP-Resources/tree/master/ExtendScript-Toolkit>`_ includes these code examples that
specifically demonstrate the use of cross-DOM functions:

.. list-table::

======================== ==========================================================
**Cross-DOM calls**
======================== ==========================================================
OpenImageInPhotoshop.jsx Shows how to send an image file to be opened in Photoshop.
======================== ==========================================================
* - **Cross-DOM calls**
-
* - `OpenImageInPhotoshop.jsx <https://github.com/Adobe-CEP/CEP-Resources/blob/master/ExtendScript-Toolkit/Samples/javascript/OpenImageInPhotoshop.jsx>`_
- Shows how to send an image file to be opened in Photoshop.

--------------------------------------------------------------------------------

Expand Down
2 changes: 1 addition & 1 deletion docs/interapplication-communication/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,6 @@ The Adobe scripting environment provides an interapplication messaging framework
and receive information and scripts from one Adobe application to another. An application that supports
the messaging framework is said to be message enabled.

Code samples that demonstrate various techniques are provided with the Adobe ExtendScript SDK, and
Code samples that demonstrate various techniques are provided with the `Adobe ExtendScript SDK <https://github.com/Adobe-CEP/CEP-Resources/tree/master/ExtendScript-Toolkit>`_, and
referenced by name in the relevant sections.

Original file line number Diff line number Diff line change
Expand Up @@ -14,26 +14,27 @@ The messaging API defines the BridgeTalk class. Static properties and methods of
access to environmental information relevant for communication between applications. Instantiate the
class to create a BridgeTalk message object, which encapsulates the message itself. For discussion and
examples, see :ref:`communicating-through-messages`, and the example code provided with the
Adobe ExtendScript SDK.
`Adobe ExtendScript SDK <https://github.com/Adobe-CEP/CEP-Resources/tree/master/ExtendScript-Toolkit>`_.

Example code
************

The sample code distributed with the Adobe ExtendScript SDK includes these code examples that
The sample code distributed with the `Adobe ExtendScript SDK <https://github.com/Adobe-CEP/CEP-Resources/tree/master/ExtendScript-Toolkit>`_ includes these code examples that
specifically demonstrate the use of interapplication messaging:

============================ ===========================================================
Interapplication messaging
============================ ===========================================================
MessagingBetweenApps.jsx Shows how to send a message to a Creative Suite application
and receive a response.
MessageSendingToInDesign.jsx
SendArrayToPhotoshop.jsx Sends message to Photoshop that creates an array in the
target and passes it back to the sender.
SendObjectToPhotoshop.jsx Sends message to Photoshop that creates a JavaScript object
in the target and passes it back to the sender.
SendDOMObjectToPhotoshop.jsx Sends message to Photoshop that creates a Photoshop object
in the target and passes values from it back to the sender.
SaveAsDifferentFileType.jsx Locates an image file, uses messaging to load it into
Photoshop and save it as a different file type.
============================ ===========================================================
.. list-table::

* - **Interapplication messaging**
-
* - `MessagingBetweenApps.jsx <https://github.com/Adobe-CEP/CEP-Resources/blob/master/ExtendScript-Toolkit/Samples/javascript/MessagingBetweenApps.jsx>`_
- Shows how to send a message to a Creative Suite application and receive a response.
* - `MessageSendingToInDesign.jsx <https://github.com/Adobe-CEP/CEP-Resources/blob/master/ExtendScript-Toolkit/Samples/javascript/MessageSendingToInDesign.jsx>`_
- Sends message to InDesign through BridgeTalk.
* - SendArrayToPhotoshop.jsx
- Sends message to Photoshop that creates an array in the target and passes it back to the sender.
* - `SendObjectToPhotoshop.jsx <https://github.com/Adobe-CEP/CEP-Resources/blob/master/ExtendScript-Toolkit/Samples/javascript/SendObjectToPhotoshop.jsx>`_
- Sends message to Photoshop that creates a JavaScript object in the target and passes it back to the sender.
* - `SendDOMObjectToPhotoshop.jsx <https://github.com/Adobe-CEP/CEP-Resources/blob/master/ExtendScript-Toolkit/Samples/javascript/SnpSendDOMObject.jsx>`_
- Sends message to Photoshop that creates a Photoshop object in the target and passes values from it back to the sender.
* - `SaveAsDifferentFileType.jsx <https://github.com/Adobe-CEP/CEP-Resources/blob/master/ExtendScript-Toolkit/Samples/javascript/SaveAsDifferentFileType.jsx>`_
- Locates an image file, uses messaging to load it into Photoshop and save it as a different file type.
14 changes: 5 additions & 9 deletions docs/introduction/extendscript-overview.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,17 +17,11 @@ JavaScript-enabled Adobe applications.

Example code
------------
The Adobe ExtendScript SDK, which contains this document, also contains a set of code samples that
The `Adobe ExtendScript SDK <https://github.com/Adobe-CEP/CEP-Resources/tree/master/ExtendScript-Toolkit>`_, which contains this document, also contains a set of code samples that
demonstrate how to use features of ScriptUI, interapplication communication, and external
communication. This book refers to these samples by name for illustration of concepts and techniques.

You can download the SDK from Adobe Developer Center, http://www.adobe.com/devnet/scripting/.

ESTK 3.8 is included with CS6, while ES3.5 is available as a standalone download:

- Windows: `AdobeExtendScriptToolkit3.5.0-mul.zip <http://download.adobe.com/pub/adobe/devnet/scripting/estk/AdobeExtendScriptToolkit3.5.0-mul.zip>`_ (`mirror <https://github.com/Adobe-CEP/CEP-Resources/tree/master/ExtendScript-Toolkit>`_)

- MacOS: `AdobeExtendScriptToolkit3.5.0-mul.dmg <http://download.adobe.com/pub/adobe/devnet/scripting/estk/AdobeExtendScriptToolkit3.5.0-mul.dmg>`_ (`mirror <https://github.com/Adobe-CEP/CEP-Resources/tree/master/ExtendScript-Toolkit>`_)
You can download the latest (and last) SDK from `Github <https://github.com/Adobe-CEP/CEP-Resources/tree/master/ExtendScript-Toolkit>`_. Earlier versions might still be accessible through `direct links <https://github.com/aenhancers/javascript-tools-guide/issues/2#issuecomment-1019312237>`_.

The samples are located under the ExtendScript SDK root directory:

Expand All @@ -40,7 +34,9 @@ Development and debugging tools
-------------------------------
For help in developing, debugging, and testing scripts, Adobe provides the ExtendScript Toolkit, an
interactive development and testing environment for ExtendScript, which is installed with all
JavaScript-enabled applications. For complete details, see :ref:`the-extendscript-toolkit`.
JavaScript-enabled applications.

For complete details, see :ref:`the-extendscript-toolkit`.

ExtendScript also provides global objects that support development and debugging:

Expand Down
2 changes: 1 addition & 1 deletion docs/user-interface-tools/automatic-layout.rst
Original file line number Diff line number Diff line change
Expand Up @@ -220,7 +220,7 @@ is the horizontal alignment and the second is the vertical alignment. This allow
horizontal placement of children in a container with row orientation, and the vertical placement of
children in a container with column orientation.

The following figures show the results of the sample script SnpAlignElements.jsx, that demonstrates
The following figures show the results of the sample script `SnpAlignElements.jsx <https://github.com/Adobe-CEP/CEP-Resources/blob/master/ExtendScript-Toolkit/Samples/javascript/SnpAlignElements.jsx>`_, that demonstrates
how to specify alignment in two dimensions.

- In the first, each control is centered vertically within its row, and placed at a specific horizontal
Expand Down
73 changes: 35 additions & 38 deletions docs/user-interface-tools/code-examples-for-scriptui.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,43 +2,40 @@

Code examples for ScriptUI
==========================
The sample code distributed with the Adobe ExtendScript SDK includes code examples that specifically
The sample code distributed with the `Adobe ExtendScript SDK <https://github.com/Adobe-CEP/CEP-Resources/tree/master/ExtendScript-Toolkit>`_ includes code examples that specifically
demonstrate different ways of building and populating a ScriptUI dialog.

=============================== ==========================================================================================
Building ScriptUI dialogs
=============================== ==========================================================================================
SnpCreateDialog.jsx Creates a very simple, modeless dialog (a palette) with OK
and Cancel button behavior.
SnpCreateUIAddMethod.jsx Shows how to add controls to a dialog using the add
method.
SnpCreateUIResourceSpec.jsx Shows how to define a resource string that creates the
control hierarchy in a dialog.
SnpCreateTreeView.jsx Shows how to create a hierarchical list with subitems.
SnpCreateProgressBar.jsx Shows how to create, initialize, and update a progress bar.
SnpCreateSlider.jsx Shows how to create and handle input from a slider control.
UsingFlashPlayer.jsx Shows how to create a Flash® Player, and use it to load a play
back a movie defined in an SWF file.
ActionScriptDemo.jsx Shows how to communicate between the Adobe
application scripting environment and the ActionScript™
scripting environment of the Flash Player.
ColorSelector.jsx Shows how to use the graphics objects to change colors in a
window.
ColorPicker.jsx A more complex version of the color-selection dialog shows
how to use additional graphics objects, including fonts and
paths.
SnpAlignElements.jsx Shows how to align elements along two dimensions in order
to control the relative positions of controls within rows and
columns.
SnpCreateDynamicScriptUI.jsx Shows how to use automatic layout, switching component
layout between "row" and "stack" orientation.
AlertBoxBuilder1.jsx Shows a way to use resource specifications. Uses the add()
method to build a dialog that collects values from the user,
and creates a resource string from those values. Saves the
string to a file, then uses it to build a new dialog. See :ref:`using-resource-strings`.
AlertBoxBuilder2.jsx Shows another way to use a resource specification, building
the same user-input dialog itself from a resource string. See
:ref:`using-resource-strings`.
SnpCustomLayoutManager.jsx Shows how to create a customized layout manager. See
:ref:`custom-layout-manager-example`.
=============================== ==========================================================================================
.. list-table::

* - **Building ScriptUI dialogs**
-
* - `SnpCreateDialog.jsx <https://github.com/Adobe-CEP/CEP-Resources/blob/master/ExtendScript-Toolkit/Samples/javascript/SnpCreateDialog.jsx>`_
- Creates a very simple, modeless dialog (a palette) with OK and Cancel button behavior.
* - `SnpCreateUIAddMethod.jsx <https://github.com/Adobe-CEP/CEP-Resources/blob/master/ExtendScript-Toolkit/Samples/javascript/SnpCreateUIAddMethod.jsx>`_
- Shows how to add controls to a dialog using the add method.
* - `SnpCreateUIResourceSpec.jsx <https://github.com/Adobe-CEP/CEP-Resources/blob/master/ExtendScript-Toolkit/Samples/javascript/SnpCreateUIResourceSpec.jsx>`_
- Shows how to define a resource string that creates the control hierarchy in a dialog.
* - `SnpCreateTreeView.jsx <https://github.com/Adobe-CEP/CEP-Resources/blob/master/ExtendScript-Toolkit/Samples/javascript/SnpCreateTreeView.jsx>`_
- Shows how to create a hierarchical list with subitems.
* - `SnpCreateProgressBar.jsx <https://github.com/Adobe-CEP/CEP-Resources/blob/master/ExtendScript-Toolkit/Samples/javascript/SnpCreateProgressBar.jsx>`_
- Shows how to create, initialize, and update a progress bar.
* - `SnpCreateSlider.jsx <https://github.com/Adobe-CEP/CEP-Resources/blob/master/ExtendScript-Toolkit/Samples/javascript/SnpCreateSlider.jsx>`_
- Shows how to create and handle input from a slider control.
* - `UsingFlashPlayer.jsx <https://github.com/Adobe-CEP/CEP-Resources/blob/master/ExtendScript-Toolkit/Samples/javascript/UsingFlashPlayer.jsx>`_
- Shows how to create a Flash® Player, and use it to load a play back a movie defined in an SWF file.
* - `ActionScriptDemo.jsx <https://github.com/Adobe-CEP/CEP-Resources/blob/master/ExtendScript-Toolkit/Samples/javascript/ActionScriptDemo.jsx>`_
- Shows how to communicate between the Adobe application scripting environment and the ActionScript™ scripting environment of the Flash Player.
* - `ColorSelector.jsx <https://github.com/Adobe-CEP/CEP-Resources/blob/master/ExtendScript-Toolkit/Samples/javascript/ColorSelector.jsx>`_
- Shows how to use the graphics objects to change colors in a window.
* - `ColorPicker.jsx <https://github.com/Adobe-CEP/CEP-Resources/blob/master/ExtendScript-Toolkit/Samples/javascript/ColorPicker.jsx>`_
- A more complex version of the color-selection dialog shows how to use additional graphics objects, including fonts and paths.
* - `SnpAlignElements.jsx <https://github.com/Adobe-CEP/CEP-Resources/blob/master/ExtendScript-Toolkit/Samples/javascript/SnpAlignElements.jsx>`_
- Shows how to align elements along two dimensions in order to control the relative positions of controls within rows and columns.
* - `SnpCreateDynamicScriptUI.jsx <https://github.com/Adobe-CEP/CEP-Resources/blob/master/ExtendScript-Toolkit/Samples/javascript/SnpCreateDynamicScriptUI.jsx>`_
- Shows how to use automatic layout, switching component layout between "row" and "stack" orientation.
* - `AlertBoxBuilder1.jsx <https://github.com/Adobe-CEP/CEP-Resources/blob/master/ExtendScript-Toolkit/Samples/javascript/AlertBoxBuilder1.jsx>`_
- Shows a way to use resource specifications. Uses the add() method to build a dialog that collects values from the user, and creates a resource string from those values. Saves the string to a file, then uses it to build a new dialog. See :ref:`using-resource-strings`.
* - `AlertBoxBuilder2.jsx <https://github.com/Adobe-CEP/CEP-Resources/blob/master/ExtendScript-Toolkit/Samples/javascript/AlertBoxBuilder2.jsx>`_
- Shows another way to use a resource specification, building the same user-input dialog itself from a resource string. See :ref:`using-resource-strings`.
* - `SnpCustomLayoutManager.jsx <https://github.com/Adobe-CEP/CEP-Resources/blob/master/ExtendScript-Toolkit/Samples/javascript/SnpCustomLayoutManager.jsx>`_
- Shows how to create a customized layout manager. See :ref:`custom-layout-manager-example`.
Original file line number Diff line number Diff line change
Expand Up @@ -84,15 +84,14 @@ This registers a function defined in your Adobe application script named ``getAc

Flash Examples
**************
These examples in the Adobe ExtendScript SDK demonstrate how to use the Flash Player:
These examples in the `Adobe ExtendScript SDK <https://github.com/Adobe-CEP/CEP-Resources/tree/master/ExtendScript-Toolkit>`_ demonstrate how to use the Flash Player:

.. todo::
Examples

======================= ====================================================================
UsingFlashPlayer.jsx Shows how to create a Flash Player, and use it to load a play back a
movie defined in an SWF file.
ActionScriptDemo.jsx Shows how to communicate between the Adobe application scripting
environment and the ActionScript scripting environment of the Flash
Player.
======================= ====================================================================
.. list-table::

* - `UsingFlashPlayer.jsx <https://github.com/Adobe-CEP/CEP-Resources/blob/master/ExtendScript-Toolkit/Samples/javascript/UsingFlashPlayer.jsx>`_
- Shows how to create a Flash® Player, and use it to load a play back a movie defined in an SWF file.
* - `ActionScriptDemo.jsx <https://github.com/Adobe-CEP/CEP-Resources/blob/master/ExtendScript-Toolkit/Samples/javascript/ActionScriptDemo.jsx>`_
- Shows how to communicate between the Adobe application scripting environment and the ActionScript™ scripting environment of the Flash Player.
14 changes: 7 additions & 7 deletions docs/user-interface-tools/drawing-objects.rst
Original file line number Diff line number Diff line change
Expand Up @@ -31,16 +31,16 @@ To make the background of a window light gray, you could use this code::
myBrush = g.newBrush( g.BrushType.SOLID_COLOR, [ 0.75, 0.75, 0.75, 1 ] );
g.backgroundColor = myBrush;

These examples in the Adobe ExtendScript SDK demonstrates how to use graphic customization objects:
These examples in the `Adobe ExtendScript SDK <https://github.com/Adobe-CEP/CEP-Resources/tree/master/ExtendScript-Toolkit>`_ demonstrates how to use graphic customization objects:

.. todo: Examples
=================== ==================================================================================
ColorSelector.jsx Uses graphic objects to change the background color of a window as the user
selects the color value with a slider.
ColorPicker.jsx A more complex version of the color-selection dialog shows how to use
additional graphics objects, including fonts and paths.
=================== ==================================================================================
.. list-table::

* - `ColorSelector.jsx <https://github.com/Adobe-CEP/CEP-Resources/blob/master/ExtendScript-Toolkit/Samples/javascript/ColorSelector.jsx>`_
- Uses graphic objects to change the background color of a window as the user selects the color value with a slider.
* - `ColorPicker.jsx <https://github.com/Adobe-CEP/CEP-Resources/blob/master/ExtendScript-Toolkit/Samples/javascript/ColorPicker.jsx>`_
- A more complex version of the color-selection dialog shows how to use additional graphics objects, including fonts and paths.

In addition, the :ref:`custom-element-class` allows you to define completely customized elements of several
types (ranges, buttons, lists), whose appearance is rendered entirely by your :ref:`control-event-ondraw` implementation.

0 comments on commit 9454baf

Please sign in to comment.