Skip to content

Commit

Permalink
[ci skip] updating documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
trieloff committed Jun 18, 2019
1 parent 43baa82 commit 1c22180
Show file tree
Hide file tree
Showing 319 changed files with 1,483 additions and 1,483 deletions.
496 changes: 248 additions & 248 deletions STABILIZING.md

Large diffs are not rendered by default.

168 changes: 84 additions & 84 deletions docs/reference/README.md

Large diffs are not rendered by default.

14 changes: 7 additions & 7 deletions docs/reference/assets/aggregated-asset.schema.md
Original file line number Diff line number Diff line change
Expand Up @@ -222,7 +222,7 @@ The value of this property **must** be equal to one of the [known values below](
### Copyright Owner ID

ID of the copyright owner.
If the PLUS-ID being stored in this property is registered with the PLUS Coalition, it should be expressed as a URL. For example: http://plus-id.org/PLUS-ID
If the PLUS-ID being stored in this property is registered with the PLUS Coalition, it should be expressed as a URL. For example: http://plus-id.org/PLUS-ID.

`plus:copyrightOwnerID`
* is optional
Expand Down Expand Up @@ -261,7 +261,7 @@ Name of Copyright Owner.

## repo:createDate

The server date and time when the resource was created in the repository, such as when an asset file is first uploaded or a directory is created by the server as the parent of a new asset. The Date Time property should conform to ISO 8601 standard. An example form is "2004-10-23T12:00:00-06:00".
The server date and time when the resource was created in the repository, such as when an asset file is first uploaded or a directory is created by the server as the parent of a new asset. The date time property should conform to ISO 8601 standard. An example form is "2004-10-23T12:00:00-06:00".

`repo:createDate`
* is optional
Expand Down Expand Up @@ -369,7 +369,7 @@ ID of the user who initiated the action that most recently caused the resource t

## repo:modifyDate

The server date and time when the resource was last modified in the repository, such as when a new version of an asset is uploaded or a directory's child resource is added or removed. The Date Time property should conform to ISO 8601 standard. An example form is "2004-10-23T12:00:00-06:00".
The server date and time when the resource was last modified in the repository, such as when a new version of an asset is uploaded or a directory's child resource is added or removed. The date time property should conform to ISO 8601 standard. An example form is "2004-10-23T12:00:00-06:00".

`repo:modifyDate`
* is optional
Expand Down Expand Up @@ -519,7 +519,7 @@ Vertical resolution in pixels per `resolutionUnit`.
## tiff:imageLength
### Length

Height in pixels. To maintain continuity with the XMP and TIFF standards, the height of an image or video is specified in the property `imageLength`. The duration of the video (also commonly called length) is specified in the property `extent`
Height in pixels. To maintain continuity with the XMP and TIFF standards, the height of an image or video is specified in the property `imageLength`. The duration of the video (also commonly called length) is specified in the property `extent`.

`tiff:imageLength`
* is optional
Expand All @@ -540,7 +540,7 @@ Height in pixels. To maintain continuity with the XMP and TIFF standards, the he
## tiff:imageWidth
### Width

Width in pixels
Width in pixels.

`tiff:imageWidth`
* is optional
Expand Down Expand Up @@ -569,7 +569,7 @@ The orientation of the image. Following values are permitted:
- `5` = Mirror horizontal and rotate 270 degrees clockwise
- `6` = Rotate 90 degrees clockwise
- `7` = Mirror horizontal and rotate 90 degrees clockwise
- `8` = Rotate 270 degrees clockwise
- `8` = Rotate 270 degrees clockwise.

`tiff:orientation`
* is optional
Expand Down Expand Up @@ -673,7 +673,7 @@ The video frame rate in frames per second (FPS). Predefined values include:
These examples show common video and audio frame rates:
- Film at 24 fps (frame rate = 24, rate basis = 1): `f24`
- Speech-to-text in milliseconds (frame rate = 1000, rate basis = 1): `f1000`
- NTSC at 29.97 fps (frame rate = 30000, rate basis = 1001): `f30000s1001`
- NTSC at 29.97 fps (frame rate = 30000, rate basis = 1001): `f30000s1001`.

`xmpDM:videoFrameRate`
* is optional
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/assets/artboard.schema.json
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
"properties": {
"xdm:name": {
"type": "string",
"description": "Name of the artboard. This would be visible to the user and users can specify names that can help them uniquely identfiy different Artboards."
"description": "Name of the artboard. This would be visible to the user and users can specify names that can help them uniquely identify different artboards."
}
}
}
Expand Down
12 changes: 6 additions & 6 deletions docs/reference/assets/artboard.schema.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ Artboards can contain layers and layer groups, but not other artboards.
## xdm:height
### Height

Height of the artboard
Height of the artboard.

`xdm:height`
* is optional
Expand All @@ -71,7 +71,7 @@ Height of the artboard

## xdm:name

Name of the artboard. This would be visible to the user and users can specify names that can help them uniquely identfiy different Artboards.
Name of the artboard. This would be visible to the user and users can specify names that can help them uniquely identify different artboards.

`xdm:name`
* is optional
Expand All @@ -91,7 +91,7 @@ Name of the artboard. This would be visible to the user and users can specify na
## xdm:originX
### Origin X

Origin X position - Base system is cartesian, relative to master page and origin in top, left (X increasing to right, Y increasing downwards)
Origin X position - base system is cartesian, relative to master page and origin in top, left (X increasing to right, Y increasing downwards).

`xdm:originX`
* is optional
Expand All @@ -111,7 +111,7 @@ Origin X position - Base system is cartesian, relative to master page and origin
## xdm:originY
### Origin Y

Origin Y position - Base system is cartesian, relative to master page and origin in top, left (X increasing to right, Y increasing downwards)
Origin Y position - base system is cartesian, relative to master page and origin in top, left (X increasing to right, Y increasing downwards).

`xdm:originY`
* is optional
Expand All @@ -131,7 +131,7 @@ Origin Y position - Base system is cartesian, relative to master page and origin
## xdm:unit
### Unit

Unit used for artboard coordinates (`originX`, `originY`, `width` and `height`). For example: `inch`, `mm`, `pixel`, `pica`, `point` (default is `pixel`)
Unit used for artboard coordinates (`originX`, `originY`, `width` and `height`). For example: `inch`, `mm`, `pixel`, `pica`, `point` (default is `pixel`).

`xdm:unit`
* is optional
Expand All @@ -152,7 +152,7 @@ Unit used for artboard coordinates (`originX`, `originY`, `width` and `height`).
## xdm:width
### Width

Width of the artboard
Width of the artboard.

`xdm:width`
* is optional
Expand Down
4 changes: 2 additions & 2 deletions docs/reference/assets/copyright-owner.schema.json
Original file line number Diff line number Diff line change
Expand Up @@ -9,14 +9,14 @@
"$id": "https://ns.adobe.com/xdm/assets/copyright-owner",
"title": "Copyright Owner",
"type": "object",
"description": "Describes the owner of a copyrighted work through name and ID",
"description": "Describes the owner of a copyrighted work through name and ID.",
"definitions": {
"copyright": {
"properties": {
"plus:copyrightOwnerID": {
"title": "Copyright Owner ID",
"type": "string",
"description": "ID of the copyright owner.\nIf the PLUS-ID being stored in this property is registered with the PLUS Coalition, it should be expressed as a URL. For example: http://plus-id.org/PLUS-ID"
"description": "ID of the copyright owner.\nIf the PLUS-ID being stored in this property is registered with the PLUS Coalition, it should be expressed as a URL. For example: http://plus-id.org/PLUS-ID."
},
"plus:copyrightOwnerName": {
"title": "Copyright Owner Name",
Expand Down
4 changes: 2 additions & 2 deletions docs/reference/assets/copyright-owner.schema.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
https://ns.adobe.com/xdm/assets/copyright-owner
```

Describes the owner of a copyrighted work through name and ID
Describes the owner of a copyrighted work through name and ID.

| [Abstract](../../abstract.md) | [Extensible](../../extensions.md) | [Status](../../status.md) | [Identifiable](../../id.md) | [Custom Properties](../../extensions.md) | [Additional Properties](../../extensions.md) | Defined In |
|-------------------------------|-----------------------------------|---------------------------|-----------------------------|------------------------------------------|----------------------------------------------|------------|
Expand All @@ -30,7 +30,7 @@ Describes the owner of a copyrighted work through name and ID
### Copyright Owner ID

ID of the copyright owner.
If the PLUS-ID being stored in this property is registered with the PLUS Coalition, it should be expressed as a URL. For example: http://plus-id.org/PLUS-ID
If the PLUS-ID being stored in this property is registered with the PLUS Coalition, it should be expressed as a URL. For example: http://plus-id.org/PLUS-ID.

`plus:copyrightOwnerID`
* is optional
Expand Down
6 changes: 3 additions & 3 deletions docs/reference/assets/font.schema.json
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@
"type": "string",
"name": "Font Face",
"meta:usereditable": false,
"description": "The name of the typeface, i.e. the specific weight or instance of the fontFamily. For example: Bold, Italic"
"description": "The name of the typeface, i.e. the specific weight or instance of the fontFamily. For example: Bold, Italic."
},
"xdm:fontFamily": {
"type": "string",
Expand All @@ -55,13 +55,13 @@
"type": "string",
"name": "Font Name",
"meta:usereditable": false,
"description": "PostScript name of the font. For example: `TimesNewRomanPS-BoldItalicMT`. `font_name` is manadatory to identify the font used in an asset but an asset may not have a `font` property if it has only images/vector arts (no text)."
"description": "PostScript name of the font. For example: `TimesNewRomanPS-BoldItalicMT`. `font_name` is mandatory to identify the font used in an asset but an asset may not have a `font` property if it has only images/vector arts (no text)."
},
"xdm:fontType": {
"type": "string",
"name": "Font Type",
"meta:usereditable": false,
"description": "The font type, such as TrueType, Type 1, OpenType, and so on. `font_type` is manadatory to identify font category but an asset may not have a `font` property if it has only images/vector arts (no text).",
"description": "The font type, such as TrueType, Type 1, OpenType, and so on. `font_type` is mandatory to identify font category but an asset may not have a `font` property if it has only images/vector arts (no text).",
"meta:enum": [
"TrueType",
"Type 1",
Expand Down
6 changes: 3 additions & 3 deletions docs/reference/assets/font.schema.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ All items must be of the type:

## xdm:fontFace

The name of the typeface, i.e. the specific weight or instance of the fontFamily. For example: Bold, Italic
The name of the typeface, i.e. the specific weight or instance of the fontFamily. For example: Bold, Italic.

`xdm:fontFace`
* is optional
Expand Down Expand Up @@ -154,7 +154,7 @@ The font file name (not a complete path). For example: `Times New Roman.otf`. So

## xdm:fontName

PostScript name of the font. For example: `TimesNewRomanPS-BoldItalicMT`. `font_name` is manadatory to identify the font used in an asset but an asset may not have a `font` property if it has only images/vector arts (no text).
PostScript name of the font. For example: `TimesNewRomanPS-BoldItalicMT`. `font_name` is mandatory to identify the font used in an asset but an asset may not have a `font` property if it has only images/vector arts (no text).

`xdm:fontName`
* is **required**
Expand All @@ -173,7 +173,7 @@ PostScript name of the font. For example: `TimesNewRomanPS-BoldItalicMT`. `font_

## xdm:fontType

The font type, such as TrueType, Type 1, OpenType, and so on. `font_type` is manadatory to identify font category but an asset may not have a `font` property if it has only images/vector arts (no text).
The font type, such as TrueType, Type 1, OpenType, and so on. `font_type` is mandatory to identify font category but an asset may not have a `font` property if it has only images/vector arts (no text).

`xdm:fontType`
* is **required**
Expand Down
8 changes: 4 additions & 4 deletions docs/reference/assets/image.schema.json
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
"http://ns.adobe.com/adobecloud/core/1.0/asset",
"https://ns.adobe.com/xdm/assets/rectangular"
],
"description": "The Image class is for raster and vector image assets, including JPEG, PNG, SVG files",
"description": "The image class is for raster and vector image assets, including JPEG, PNG, SVG files.",
"definitions": {
"rational": {
"$id": "https://ns.adobe.com/xdm/assets/image/rational",
Expand All @@ -26,12 +26,12 @@
"properties": {
"tiff:numerator": {
"title": "Numerator",
"description": "The numerator of a fraction",
"description": "The numerator of a fraction.",
"type": "integer"
},
"tiff:denominator": {
"title": "Denominator",
"description": "The denominator of a fraction",
"description": "The denominator of a fraction.",
"not": {
"maximum": 0,
"minimum": 0
Expand All @@ -50,7 +50,7 @@
"type": "integer",
"meta:usereditable": false,
"title": "Orientation",
"description": "The orientation of the image. Following values are permitted:\n- `1` = Horizontal (normal)\n- `2` = Mirror horizontal\n- `3` = Rotate 180 degrees\n- `4` = Mirror vertical\n- `5` = Mirror horizontal and rotate 270 degrees clockwise\n- `6` = Rotate 90 degrees clockwise\n- `7` = Mirror horizontal and rotate 90 degrees clockwise\n- `8` = Rotate 270 degrees clockwise",
"description": "The orientation of the image. Following values are permitted:\n- `1` = Horizontal (normal)\n- `2` = Mirror horizontal\n- `3` = Rotate 180 degrees\n- `4` = Mirror vertical\n- `5` = Mirror horizontal and rotate 270 degrees clockwise\n- `6` = Rotate 90 degrees clockwise\n- `7` = Mirror horizontal and rotate 90 degrees clockwise\n- `8` = Rotate 270 degrees clockwise.",
"minimum": 1,
"maximum": 8,
"meta:enum": {
Expand Down
12 changes: 6 additions & 6 deletions docs/reference/assets/image.schema.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
https://ns.adobe.com/xdm/assets/image
```

The Image class is for raster and vector image assets, including JPEG, PNG, SVG files
The image class is for raster and vector image assets, including JPEG, PNG, SVG files.

| [Abstract](../../abstract.md) | [Extensible](../../extensions.md) | [Status](../../status.md) | [Identifiable](../../id.md) | [Custom Properties](../../extensions.md) | [Additional Properties](../../extensions.md) | Defined In |
|-------------------------------|-----------------------------------|---------------------------|-----------------------------|------------------------------------------|----------------------------------------------|------------|
Expand Down Expand Up @@ -303,7 +303,7 @@ Vertical resolution in pixels per `resolutionUnit`.
## tiff:imageLength
### Length

Height in pixels. To maintain continuity with the XMP and TIFF standards, the height of an image or video is specified in the property `imageLength`. The duration of the video (also commonly called length) is specified in the property `extent`
Height in pixels. To maintain continuity with the XMP and TIFF standards, the height of an image or video is specified in the property `imageLength`. The duration of the video (also commonly called length) is specified in the property `extent`.

`tiff:imageLength`
* is optional
Expand All @@ -324,7 +324,7 @@ Height in pixels. To maintain continuity with the XMP and TIFF standards, the he
## tiff:imageWidth
### Width

Width in pixels
Width in pixels.

`tiff:imageWidth`
* is optional
Expand Down Expand Up @@ -353,7 +353,7 @@ The orientation of the image. Following values are permitted:
- `5` = Mirror horizontal and rotate 270 degrees clockwise
- `6` = Rotate 90 degrees clockwise
- `7` = Mirror horizontal and rotate 90 degrees clockwise
- `8` = Rotate 270 degrees clockwise
- `8` = Rotate 270 degrees clockwise.

`tiff:orientation`
* is optional
Expand Down Expand Up @@ -435,7 +435,7 @@ Describes the proportional relationship between the width and the height. To det
## tiff:denominator
### Denominator

The denominator of a fraction
The denominator of a fraction.

`tiff:denominator`
* is optional
Expand All @@ -455,7 +455,7 @@ The denominator of a fraction
## tiff:numerator
### Numerator

The numerator of a fraction
The numerator of a fraction.

`tiff:numerator`
* is optional
Expand Down
4 changes: 2 additions & 2 deletions docs/reference/assets/language-alternative.schema.json
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,11 @@
"language-alternative": {
"properties": {
"xdm:text": {
"title": "The localized text",
"title": "Localized Text",
"type": "string"
},
"xml:lang": {
"title": "The locale of the language alternative. Locales are expressed following [RFC BCP47](https://tools.ietf.org/html/bcp47)",
"title": "The locale of the language alternative. Locales are expressed following [RFC BCP47](https://tools.ietf.org/html/bcp47).",
"type": "string",
"pattern": "^(((([A-Za-z]{2,3}(-([A-Za-z]{3}(-[A-Za-z]{3}){0,2}))?)|[A-Za-z]{4}|[A-Za-z]{5,8})(-([A-Za-z]{4}))?(-([A-Za-z]{2}|[0-9]{3}))?(-([A-Za-z0-9]{5,8}|[0-9][A-Za-z0-9]{3}))*(-([0-9A-WY-Za-wy-z](-[A-Za-z0-9]{2,8})+))*(-(x(-[A-Za-z0-9]{1,8})+))?)|(x(-[A-Za-z0-9]{1,8})+)|((en-GB-oed|i-ami|i-bnn|i-default|i-enochian|i-hak|i-klingon|i-lux|i-mingo|i-navajo|i-pwn|i-tao|i-tay|i-tsu|sgn-BE-FR|sgn-BE-NL|sgn-CH-DE)|(art-lojban|cel-gaulish|no-bok|no-nyn|zh-guoyu|zh-hakka|zh-min|zh-min-nan|zh-xiang)))$"
}
Expand Down
4 changes: 2 additions & 2 deletions docs/reference/assets/language-alternative.schema.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ A tuple in a set of language alternatives, i.e. pairs of localized text and thei
| [xml:lang](#xmllang) | `string` | `https://ns.adobe.com/xdm/assets/language-alternative#/definitions/language-alternative` |

## xdm:text
### The localized text
### Localized Text

`xdm:text`
* is optional
Expand All @@ -45,7 +45,7 @@ A tuple in a set of language alternatives, i.e. pairs of localized text and thei


## xml:lang
### The locale of the language alternative. Locales are expressed following [RFC BCP47](https://tools.ietf.org/html/bcp47)
### The locale of the language alternative. Locales are expressed following [RFC BCP47](https://tools.ietf.org/html/bcp47).

`xml:lang`
* is optional
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/assets/layer-group.schema.json
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
"xdm:name": {
"type": "string",
"title": "Name",
"description": "Name of the Layer Group. This will be visible to the user and users can specify names that can help them to identify different Layer Groups"
"description": "Name of the layer group. This will be visible to the user and users can specify names that can help them to identify different layer groups."
},
"xdm:layers": {
"name": "Layers",
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/assets/layer-group.schema.md
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@ Unknown type ``.
## xdm:name
### Name

Name of the Layer Group. This will be visible to the user and users can specify names that can help them to identify different Layer Groups
Name of the layer group. This will be visible to the user and users can specify names that can help them to identify different layer groups.

`xdm:name`
* is optional
Expand Down
Loading

0 comments on commit 1c22180

Please sign in to comment.