Skip to content

Commit 8a2c770

Browse files
committed
Tweak some admoniitions
1 parent 846e6b8 commit 8a2c770

24 files changed

+56
-27
lines changed

docs/index.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,8 @@ If you're not sure where to start, take a look at the [Overview](./introduction/
1717

1818
This endeavour is primarily community-supported & run; contributors are welcome and encouraged to suggest fixes, adjustments, notes/warnings, and anything else that may help the project.
1919

20+
For specific information on how to contribute & best practices, see the [Documentation Contribution Guide](https://docsforadobe.dev/contributing/contribution-guide/).
21+
2022
## Licensing & Ownership
2123

2224
This project exists for educational purposes only.

docs/item/avitem.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,11 @@
66

77
The AVItem object provides access to attributes and methods of audio/visual files imported into After Effects.
88

9-
> AVItem is a subclass of Item. All methods and attributes of Item, in addition to those listed below, are available when working with AVItem. See [Item object](item.md)
9+
!!! info
10+
AVItem is a subclass of Item. All methods and attributes of Item, in addition to those listed below, are available when working with AVItem. See [Item object](item.md)
1011

11-
> AVItem is the base class for both CompItem and FootageItem, so AVItem attributes and methods are also available when working with CompItem and FootageItem objects. See [CompItem object](compitem.md) and [FootageItem object](footageitem.md).
12+
!!! info
13+
AVItem is the base class for both CompItem and FootageItem, so AVItem attributes and methods are also available when working with CompItem and FootageItem objects. See [CompItem object](compitem.md) and [FootageItem object](footageitem.md).
1214

1315
!!! warning
1416
CompItems and FootageItems, while logical descendants of AVItem, are not *really* subclasses of AVItem as AVItem doesn't exist in Extendscript, ie. attempting to check if `item instanceof AVItem` will fail because AVItem is undefined. This is also true for `Item` itself.

docs/item/compitem.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,8 @@
99

1010
The CompItem object represents a composition, and allows you to manipulate and get information about it. Access the objects by position index number in a project's item collection.
1111

12-
> CompItem is a subclass of [AVItem object](avitem.md), which is a subclass of [Item object](item.md). All methods and attributes of AVItem and Item, in addition to those listed below, are available when working with CompItem.
12+
!!! info
13+
CompItem is a subclass of [AVItem object](avitem.md), which is a subclass of [Item object](item.md). All methods and attributes of AVItem and Item, in addition to those listed below, are available when working with CompItem.
1314

1415
#### Example
1516

docs/item/footageitem.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,8 @@
77

88
The FootageItem object represents a footage item imported into a project, which appears in the Project panel. These are accessed by position index number in a project's item collection.
99

10-
> FootageItem is a subclass of [AVItem object](avitem.md), which is a subclass of [Item object](item.md). All methods and attributes of AVItem and Item, in addition to those listed below, are available when working with FootageItem.
10+
!!! info
11+
FootageItem is a subclass of [AVItem object](avitem.md), which is a subclass of [Item object](item.md). All methods and attributes of AVItem and Item, in addition to those listed below, are available when working with FootageItem.
1112

1213
---
1314

docs/item/item.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,8 @@
99

1010
The Item object represents an item that can appear in the Project panel. The first item is at index 1.
1111

12-
> Item is the base class for [AVItem object](avitem.md) and for [FolderItem object](folderitem.md), which are in turn the base classes for various other item types, so Item attributes and methods are available when working with all of these item types.
12+
!!! info
13+
Item is the base class for [AVItem object](avitem.md) and for [FolderItem object](folderitem.md), which are in turn the base classes for various other item types, so Item attributes and methods are available when working with all of these item types.
1314

1415
#### Example
1516

docs/item/itemcollection.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,8 @@
66

77
The ItemCollection object represents a collection of items. The ItemCollection belonging to a Project object contains all the Item objects for items in the project. The ItemCollection belonging to a FolderItem object contains all the Item objects for items in that folder.
88

9-
> ItemCollection is a subclass of [Collection object](../other/collection.md). All methods and attributes of Collection, in addition to those listed below, are available when working with ItemCollection.
9+
!!! info
10+
ItemCollection is a subclass of [Collection object](../other/collection.md). All methods and attributes of Collection, in addition to those listed below, are available when working with ItemCollection.
1011

1112
---
1213

docs/layer/avlayer.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,11 @@
66

77
The AVLayer object provides an interface to those layers that contain AVItem objects (composition layers, footage layers, solid layers, text layers, and sound layers).
88

9-
> AVLayer is a subclass of [Layer object](layer.md). All methods and attributes of Layer, in addition to those listed below, are available when working with AVLayer.
9+
!!! info
10+
AVLayer is a subclass of [Layer object](layer.md). All methods and attributes of Layer, in addition to those listed below, are available when working with AVLayer.
1011

11-
> AVLayer is a base class for [TextLayer object](textlayer.md), so AVLayer attributes and methods are available when working with TextLayer objects.
12+
!!! info
13+
AVLayer is a base class for [TextLayer object](textlayer.md), so AVLayer attributes and methods are available when working with TextLayer objects.
1214

1315
#### AE Properties
1416

docs/layer/cameralayer.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,8 @@
66

77
The CameraLayer object represents a camera layer within a composition. Create it using [LayerCollection.addCamera()](layercollection.md#layercollectionaddcamera). It can be accessed in an item's layer collection either by index number or by a name string.
88

9-
> CameraLayer is a subclass of [Layer object](layer.md). All methods and attributes of Layer are available when working with CameraLayer.
9+
!!! info
10+
CameraLayer is a subclass of [Layer object](layer.md). All methods and attributes of Layer are available when working with CameraLayer.
1011

1112
#### AE Properties
1213

docs/layer/layer.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,11 @@
66

77
The Layer object provides access to layers within compositions. It can be accessed from an item's layer collection either by index number or by a name string.
88

9-
> Layer is a subclass of [PropertyGroup](../property/propertygroup.md), which is a subclass of [PropertyBase](../property/propertybase.md). All methods and attributes of PropertyGroup, in addition to those listed below, are available when working with Layer, with the exception that `propertyIndex` attribute is set to `undefined`.
9+
!!! info
10+
Layer is a subclass of [PropertyGroup](../property/propertygroup.md), which is a subclass of [PropertyBase](../property/propertybase.md). All methods and attributes of PropertyGroup, in addition to those listed below, are available when working with Layer, with the exception that `propertyIndex` attribute is set to `undefined`.
1011

11-
> Layer is the base class for [CameraLayer object](cameralayer.md), [LightLayer object](lightlayer.md), and [AVLayer object](avlayer.md), so Layer attributes and methods are available when working with all layer types. Layers contain AE properties, in addition to their JavaScript attributes and methods. For examples of how to access properties in layers, see [PropertyBase object](../property/propertybase.md).
12+
!!! info
13+
Layer is the base class for [CameraLayer object](cameralayer.md), [LightLayer object](lightlayer.md), and [AVLayer object](avlayer.md), so Layer attributes and methods are available when working with all layer types. Layers contain AE properties, in addition to their JavaScript attributes and methods. For examples of how to access properties in layers, see [PropertyBase object](../property/propertybase.md).
1214

1315
#### Example
1416

docs/layer/layercollection.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,8 @@
66

77
The LayerCollection object represents a set of layers. The LayerCollection belonging to a [CompItem object](../item/compitem.md) contains all the layer objects for layers in the composition. The methods of the collection object allow you to manipulate the layer list.
88

9-
> LayerCollection is a subclass of [Collection object](../other/collection.md). All methods and attributes of Collection, in addition to those listed below, are available when working with LayerCollection.
9+
!!! info
10+
LayerCollection is a subclass of [Collection object](../other/collection.md). All methods and attributes of Collection, in addition to those listed below, are available when working with LayerCollection.
1011

1112
#### Example
1213

0 commit comments

Comments
 (0)