Skip to content

Commit

Permalink
use consistent tab spacing of 4 spaces
Browse files Browse the repository at this point in the history
  • Loading branch information
rendertom committed Aug 23, 2020
1 parent 0f87b1c commit c26c30b
Show file tree
Hide file tree
Showing 17 changed files with 190 additions and 190 deletions.
66 changes: 33 additions & 33 deletions docs/application/application.rst
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ Get a build version of current application *(Adobe Premiere Pro version 14.3.1 (

.. code:: javascript
parseInt(app.build); // 45
parseInt(app.build); // 45
----

Expand Down Expand Up @@ -98,7 +98,7 @@ Get a path to a currently active preference file

.. code:: javascript
app.getAppPrefPath; // /Users/USERNAME/Documents/Adobe/Premiere Pro/14.0/Profile-USERNAME/
app.getAppPrefPath; // /Users/USERNAME/Documents/Adobe/Premiere Pro/14.0/Profile-USERNAME/
----

Expand All @@ -123,7 +123,7 @@ Get a path to a currently active configuration folder

.. code:: javascript
app.getAppSystemPrefPath; // /Library/Application Support/Adobe/Adobe Premiere Pro 2020/
app.getAppSystemPrefPath; // /Library/Application Support/Adobe/Adobe Premiere Pro 2020/
----

Expand All @@ -148,7 +148,7 @@ Get a path to a currently active preference file

.. code:: javascript
app.getPProPrefPath; // /Users/USERNAME/Documents/Adobe/Premiere Pro/14.0/Profile-USERNAME/
app.getPProPrefPath; // /Users/USERNAME/Documents/Adobe/Premiere Pro/14.0/Profile-USERNAME/
----

Expand All @@ -173,7 +173,7 @@ Get a path to a currently active configuration folder

.. code:: javascript
app.getPProSystemPrefPath; // /Library/Application Support/Adobe/Adobe Premiere Pro 2020/
app.getPProSystemPrefPath; // /Library/Application Support/Adobe/Adobe Premiere Pro 2020/
----

Expand All @@ -198,7 +198,7 @@ Get a path to a Learn panel's directory

.. code:: javascript
app.learnPanelContentDirPath; // /Users/Shared/Adobe/Premiere Pro 2020/Learn Panel/
app.learnPanelContentDirPath; // /Users/Shared/Adobe/Premiere Pro 2020/Learn Panel/
----

Expand All @@ -223,7 +223,7 @@ Get a path to a Learn panel's example projects' directory

.. code:: javascript
app.learnPanelExampleProjectDirPath; // /Users/Shared/Adobe/Premiere Pro/14.0/Tutorial/Going Home project/
app.learnPanelExampleProjectDirPath; // /Users/Shared/Adobe/Premiere Pro/14.0/Tutorial/Going Home project/
----

Expand Down Expand Up @@ -265,7 +265,7 @@ Get a path to applications executable file.

.. code:: javascript
app.path; // /Applications/Adobe Premiere Pro 2020/Adobe Premiere Pro 2020.app/
app.path; // /Applications/Adobe Premiere Pro 2020/Adobe Premiere Pro 2020.app/
----

Expand Down Expand Up @@ -409,7 +409,7 @@ Get a version of a current application *(Adobe Premiere Pro version 14.3.1 (Buil

.. code:: javascript
app.version; // 14.3.1
app.version; // 14.3.1
----

Expand Down Expand Up @@ -484,20 +484,20 @@ Get a list of available workspaces.

.. code:: javascript
app.getWorkspaces();
/* [
"All Panels",
"Assembly",
"Audio",
"Color",
"Editing",
"Effects",
"Graphics",
"Learning",
"Libraries",
"Metalogging",
"Production"
]; */
app.getWorkspaces();
/* [
"All Panels",
"Assembly",
"Audio",
"Color",
"Editing",
"Effects",
"Graphics",
"Learning",
"Libraries",
"Metalogging",
"Production"
]; */
----

Expand Down Expand Up @@ -530,10 +530,10 @@ Test for valid project files

.. code:: javascript
app.isDocument('~/Desktop/myProject.prproj'); // true
app.isDocument('~/Desktop/textFile.txt'); // false
app.isDocument('~/Desktop/footageFile.mov'); // false
app.isDocument('~/Desktop/imageFile.mov'); // false
app.isDocument('~/Desktop/myProject.prproj'); // true
app.isDocument('~/Desktop/textFile.txt'); // false
app.isDocument('~/Desktop/footageFile.mov'); // false
app.isDocument('~/Desktop/imageFile.mov'); // false
----

Expand Down Expand Up @@ -712,12 +712,12 @@ Returns **true** if successful.

.. code:: javascript
var extensionID = 'com.adobe.PProPanel';
// 0 - while testing (to enable rapid reload);
// 1 - for "Never unload me, even when not visible."
var persistent = 0;
var extensionID = 'com.adobe.PProPanel';
// 0 - while testing (to enable rapid reload);
// 1 - for "Never unload me, even when not visible."
var persistent = 0;
app.setExtensionPersistent(extensionID, persistent);
app.setExtensionPersistent(extensionID, persistent);
----

Expand Down Expand Up @@ -759,7 +759,7 @@ Returns 'true' if successful.
if (scratchPath && scratchPath.exists) {
app.setScratchDiskPath(scratchPath.fsName, ScratchDiskType.FirstAutoSaveFolder);
}
----

.. _app.setSDKEventMessage:
Expand Down
14 changes: 7 additions & 7 deletions docs/collection/componentcollection.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,14 @@
ComponentCollection object
################################################

| ``app.project.rootItem.children[index].videoComponents()``
| ``app.project.sequences[index].audioTracks[index].clips[index].components``
| ``app.project.sequences[index].videoTracks[index].clips[index].components``
| ``app.project.rootItem.children[index].videoComponents()``
| ``app.project.sequences[index].audioTracks[index].clips[index].components``
| ``app.project.sequences[index].videoTracks[index].clips[index].components``

*add a description*

ComponentCollection is a subclass of :ref:`collection`. All methods and attributes of Collection, in addition to those listed below, are available when working with ComponentCollection.
ComponentCollection is a subclass of :ref:`collection`. All methods and attributes of Collection, in addition to those listed below, are available when working with ComponentCollection.

----

Expand All @@ -25,9 +25,9 @@ Attributes
ComponentCollection.numItems
*********************************************

| ``app.project.rootItem.children[index].videoComponents().numItems``
| ``app.project.sequences[index].audioTracks[index].clips[index].components.numItems``
| ``app.project.sequences[index].videoTracks[index].clips[index].components.numItems``
| ``app.project.rootItem.children[index].videoComponents().numItems``
| ``app.project.sequences[index].audioTracks[index].clips[index].components.numItems``
| ``app.project.sequences[index].videoTracks[index].clips[index].components.numItems``
**Description**

Expand Down
2 changes: 1 addition & 1 deletion docs/collection/markercollection.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ MarkerCollection object

The MarkerCollection object represents a collection of :ref:`Marker objects <marker>` in a :ref:`projectItem` and :ref:`sequence`.

MarkerCollection is a subclass of :ref:`collection`. All methods and attributes of Collection, in addition to those listed below, are available when working with MarkerCollection.
MarkerCollection is a subclass of :ref:`collection`. All methods and attributes of Collection, in addition to those listed below, are available when working with MarkerCollection.

----

Expand Down
10 changes: 5 additions & 5 deletions docs/collection/projectcollection.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,12 @@
ProjectCollection object
################################################

| ``app.projects``
| ``app.production.projects``
| ``app.projects``
| ``app.production.projects``
The ProjectCollection object represents a collection of :ref:`Project objects <project>`.

ProjectCollection is a subclass of :ref:`collection`. All methods and attributes of Collection, in addition to those listed below, are available when working with ProjectCollection.
ProjectCollection is a subclass of :ref:`collection`. All methods and attributes of Collection, in addition to those listed below, are available when working with ProjectCollection.

----

Expand All @@ -23,8 +23,8 @@ Attributes
ProjectCollection.numProjects
*********************************************

| ``app.projects.numProjects``
| ``app.production.projects.numProjects``
| ``app.projects.numProjects``
| ``app.production.projects.numProjects``
**Description**

Expand Down
2 changes: 1 addition & 1 deletion docs/collection/projectitemcollection.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ ProjectItemCollection object

The ProjectItemCollection object represents a collection of :ref:`ProjectItem objects <projectItem>` in an active project.

ProjectItemCollection is a subclass of :ref:`collection`. All methods and attributes of Collection, in addition to those listed below, are available when working with ProjectItemCollection.
ProjectItemCollection is a subclass of :ref:`collection`. All methods and attributes of Collection, in addition to those listed below, are available when working with ProjectItemCollection.

----

Expand Down
2 changes: 1 addition & 1 deletion docs/collection/sequencecollection.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ SequenceCollection object

The SequenceCollection object represents a collection of all the :ref:`Sequence objects <sequence>` in the active project.

SequenceCollection is a subclass of :ref:`collection`. All methods and attributes of Collection, in addition to those listed below, are available when working with SequenceCollection.
SequenceCollection is a subclass of :ref:`collection`. All methods and attributes of Collection, in addition to those listed below, are available when working with SequenceCollection.

----

Expand Down
10 changes: 5 additions & 5 deletions docs/collection/trackcollection.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,12 @@
TrackCollection object
################################################

| ``app.project.sequences[index].audioTracks``
| ``app.project.sequences[index].videoTracks``
| ``app.project.sequences[index].audioTracks``
| ``app.project.sequences[index].videoTracks``
The TrackCollection object represents a collection of :ref:`Track objects <track>` in a sequence.

TrackCollection is a subclass of :ref:`collection`. All methods and attributes of Collection, in addition to those listed below, are available when working with TrackCollection.
TrackCollection is a subclass of :ref:`collection`. All methods and attributes of Collection, in addition to those listed below, are available when working with TrackCollection.

----

Expand All @@ -23,8 +23,8 @@ Attributes
TrackCollection.numTracks
*********************************************

| ``app.project.sequences[index].audioTracks.numTracks``
| ``app.project.sequences[index].videoTracks.numTracks``
| ``app.project.sequences[index].audioTracks.numTracks``
| ``app.project.sequences[index].videoTracks.numTracks``
**Description**

Expand Down
10 changes: 5 additions & 5 deletions docs/collection/trackitemcollection.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,12 @@
TrackItemCollection object
################################################

| ``app.project.sequences[index].audioTracks[index].clips``
| ``app.project.sequences[index].videoTracks[index].clips``
| ``app.project.sequences[index].audioTracks[index].clips``
| ``app.project.sequences[index].videoTracks[index].clips``
The TrackItemCollection object represents a collection of :ref:`TrackItem objects <trackItem>` on a track.

TrackItemCollection is a subclass of :ref:`collection`. All methods and attributes of Collection, in addition to those listed below, are available when working with TrackItemCollection.
TrackItemCollection is a subclass of :ref:`collection`. All methods and attributes of Collection, in addition to those listed below, are available when working with TrackItemCollection.

----

Expand All @@ -23,8 +23,8 @@ Attributes
TrackItemCollection.numItems
*********************************************

| ``app.project.sequences[index].audioTracks[index].clips.numItems``
| ``app.project.sequences[index].videoTracks[index].clips.numItems``
| ``app.project.sequences[index].audioTracks[index].clips.numItems``
| ``app.project.sequences[index].videoTracks[index].clips.numItems``
**Description**

Expand Down
4 changes: 2 additions & 2 deletions docs/general/marker.rst
Original file line number Diff line number Diff line change
Expand Up @@ -131,7 +131,7 @@ Marker.getColorByIndex()
``app.project.activeSequence.getFirstMarker().getColorByIndex(index)``

.. note::
This functionality was added in Adobe Premire Pro 13.x.
This functionality was added in Adobe Premire Pro 13.x.

**Description**

Expand Down Expand Up @@ -201,7 +201,7 @@ Marker.setColorByIndex()
``app.project.activeSequence.getFirstMarker().setColorByIndex(colorIndex, markerIndex)``

.. note::
This functionality was added in Adobe Premire Pro 13.x.
This functionality was added in Adobe Premire Pro 13.x.

**Description**

Expand Down
2 changes: 1 addition & 1 deletion docs/general/project.rst
Original file line number Diff line number Diff line change
Expand Up @@ -123,7 +123,7 @@ Get a path of a curently active project

.. code:: javascript
app.project.path; // /Users/USERNAME/Desktop/Project.prproj
app.project.path; // /Users/USERNAME/Desktop/Project.prproj
----

Expand Down
4 changes: 2 additions & 2 deletions docs/introduction/changelog.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,5 +15,5 @@ What's new and changed for scripting?
************************************************************************************************************************************

- Scripting access to Marker colors:
- Added: :ref:`Marker.getColorByIndex`
- Added: :ref:`Marker.setColorByIndex`
- Added: :ref:`Marker.getColorByIndex`
- Added: :ref:`Marker.setColorByIndex`
44 changes: 22 additions & 22 deletions docs/item/projectitem.rst
Original file line number Diff line number Diff line change
Expand Up @@ -66,22 +66,22 @@ Returns an object, containing similar data

.. code:: javascript
{
value: [
sRGB,
BT.601 (NTSC),
BT.601 (PAL),
BT.709,
BT.709 (Scene),
BT.2020,
BT.2020 (Scene),
BT.2100 PQ,
BT.2100 PQ (Scene),
BT.2100 HLG,
BT.2100 HLG (Scene),
DCDM XYZ,
]
};
{
value: [
sRGB,
BT.601 (NTSC),
BT.601 (PAL),
BT.709,
BT.709 (Scene),
BT.2020,
BT.2020 (Scene),
BT.2100 PQ,
BT.2100 PQ (Scene),
BT.2100 HLG,
BT.2100 HLG (Scene),
DCDM XYZ,
]
};
**Type**

Expand Down Expand Up @@ -110,12 +110,12 @@ Rename first project item.

.. code:: javascript
var item = app.project.rootItem.children[0];
if (item) {
item.name = item.name + ', updated by PProPanel.';
} else {
alert('Could not rename project item');
}
var item = app.project.rootItem.children[0];
if (item) {
item.name = item.name + ', updated by PProPanel.';
} else {
alert('Could not rename project item');
}
----

Expand Down

0 comments on commit c26c30b

Please sign in to comment.