Skip to content

Commit e129ce1

Browse files
author
fabianmoronzirfas
committed
chore(update docs):
1 parent a2f9c93 commit e129ce1

File tree

7 files changed

+124
-31
lines changed

7 files changed

+124
-31
lines changed

‎.gitignore

Lines changed: 99 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,100 @@
1-
_site
2-
.sass-cache
3-
.jekyll-metadata
41
.DS_Store
5-
node_modules
6-
test/report.txt
2+
test/report.txt
3+
4+
# File created using '.gitignore Generator' for Visual Studio Code: https://bit.ly/vscode-gig
5+
6+
# Created by https://www.gitignore.io/api/jekyll,node
7+
# Edit at https://www.gitignore.io/?templates=jekyll,node
8+
9+
### Jekyll ###
10+
_site/
11+
.sass-cache/
12+
.jekyll-cache/
13+
.jekyll-metadata
14+
15+
### Node ###
16+
# Logs
17+
logs
18+
*.log
19+
npm-debug.log*
20+
yarn-debug.log*
21+
yarn-error.log*
22+
23+
# Runtime data
24+
pids
25+
*.pid
26+
*.seed
27+
*.pid.lock
28+
29+
# Directory for instrumented libs generated by jscoverage/JSCover
30+
lib-cov
31+
32+
# Coverage directory used by tools like istanbul
33+
coverage
34+
35+
# nyc test coverage
36+
.nyc_output
37+
38+
# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
39+
.grunt
40+
41+
# Bower dependency directory (https://bower.io/)
42+
bower_components
43+
44+
# node-waf configuration
45+
.lock-wscript
46+
47+
# Compiled binary addons (https://nodejs.org/api/addons.html)
48+
build/Release
49+
50+
# Dependency directories
51+
node_modules/
52+
jspm_packages/
53+
54+
# TypeScript v1 declaration files
55+
typings/
56+
57+
# Optional npm cache directory
58+
.npm
59+
60+
# Optional eslint cache
61+
.eslintcache
62+
63+
# Optional REPL history
64+
.node_repl_history
65+
66+
# Output of 'npm pack'
67+
*.tgz
68+
69+
# Yarn Integrity file
70+
.yarn-integrity
71+
72+
# dotenv environment variables file
73+
.env
74+
.env.test
75+
76+
# parcel-bundler cache (https://parceljs.org/)
77+
.cache
78+
79+
# next.js build output
80+
.next
81+
82+
# nuxt.js build output
83+
.nuxt
84+
85+
# vuepress build output
86+
.vuepress/dist
87+
88+
# Serverless directories
89+
.serverless/
90+
91+
# FuseBox cache
92+
.fusebox/
93+
94+
# DynamoDB Local files
95+
.dynamodb/
96+
97+
# End of https://www.gitignore.io/api/jekyll,node
98+
99+
# Custom rules (everything added below won't be overriden by 'Generate .gitignore File' if you use 'Update' option)
100+

‎reference/document/label.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,17 @@
11
---
22
layout: entry
33
title: label
4-
codetitle: label(label)
5-
description: 'Returns the first item that is tagged with the given label in the InDesign Script Label pane (`Window -> Utilities -> Script Label`). Use this instead of `labels()`, when you know you just have one thing with that label and don''t want to deal with a single-element array.'
4+
codetitle: 'label(itemOrLabel, label)'
5+
description: 'Tags a page item with a given script label in the InDesign Script Label panel (`Window -> Utilities -> Script Label`). If only one argument is given, `label()` returns the first item that is tagged with the given label. Use this instead of `labels()`, when you know you just have one thing with that label and don''t want to deal with a single-element array.'
66
category: Document
77
subcategory: 'Page Items'
88
returns:
99
name: null
10-
description: 'The first page item with the given label.'
10+
description: 'The tagged page item or the first page item with the given label.'
1111
type: [PageItem]
1212
parameters:
13-
- {name: label, description: 'The label identifier.', optional: false, type: [String]}
13+
- {name: itemOrLabel, description: 'The page item to tag or the label identifier to search for.', optional: false, type: [String, PageItem]}
14+
- {name: label, description: 'The label identifier to tag the page item with.', optional: false, type: [String]}
1415
kind: function
1516
todo: null
1617
examples: []

‎reference/document/selection.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,16 @@
11
---
22
layout: entry
33
title: selection
4-
codetitle: selection()
5-
description: 'Returns the first currently selected object. Use this if you know you only have one selected item and don''t want to deal with an array.'
4+
codetitle: 'selection([item])'
5+
description: 'If no argument is given, returns the first currently selected object. If a page item is given as argument, the page item will be selected.'
66
category: Document
77
subcategory: 'Page Items'
88
returns:
99
name: null
1010
description: 'The first selected object.'
1111
type: [Object]
12-
parameters: []
12+
parameters:
13+
- {name: item, description: 'The page item to select.', optional: true, type: [PageItem]}
1314
kind: function
1415
todo: null
1516
examples: []

‎reference/index.html

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,6 @@
44
order: 3
55
---
66

7-
<style>
8-
9-
</style>
107

118
<h2 id="cat-ndx">Categories</h2>
129
<div class="index">

‎reference/math/Vector.cross.md

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,23 @@
11
---
22
layout: entry
33
title: Vector.cross
4-
codetitle: 'Vector.cross(v, [y], [z])'
5-
description: 'Calculates the cross product from this vector to another as `x`, `y`, and `z` components or full vector.'
4+
codetitle: 'Vector.cross(v1, v2)'
5+
description: 'Static function. Calculates the cross product of two vectors. Is meant to be called "static" i.e. `Vector.cross(v1, v2);`'
66
category: Math
77
subcategory: Vector
88
returns:
99
name: null
1010
description: 'The cross product.'
1111
type: [Number]
1212
parameters:
13-
- {name: v, description: 'Either a full vector or an `x` component.', optional: false, type: [Vector, Number]}
14-
- {name: y, description: 'The `y` component.', optional: true, type: [Number]}
15-
- {name: z, description: 'The `z` component.', optional: true, type: [Number]}
13+
- {name: v1, description: 'The first vector.', optional: false, type: [Vector]}
14+
- {name: v2, description: 'The second vector.', optional: false, type: [Vector]}
15+
kind: function
16+
todo: null
17+
examples: []
18+
19+
---
20+
: 'The `z` component.', optional: true, type: [Number]}
1621
kind: function
1722
todo: null
1823
examples: []

‎reference/math/Vector.dot.md

Lines changed: 5 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,18 @@
11
---
22
layout: entry
33
title: Vector.dot
4-
codetitle: 'Vector.dot(v1, v2)'
5-
description: 'Static function. Calculates the dot product of two vectors. Is meant to be called "static" i.e. `Vector.dot(v1, v2);`'
4+
codetitle: 'Vector.dot(v, [y], [z])'
5+
description: 'Calculates the dot product from this vector to another as `x`, `y`, and `z` components or full vector.'
66
category: Math
77
subcategory: Vector
88
returns:
99
name: null
1010
description: 'The dot product.'
1111
type: [Number]
1212
parameters:
13-
- {name: v1, description: 'The first vector.', optional: false, type: [Vector]}
14-
- {name: v2, description: 'The second vector.', optional: false, type: [Vector]}
15-
kind: function
16-
todo: null
17-
examples: []
18-
19-
---
20-
on: 'The `z` component.', optional: true, type: [Number]}
13+
- {name: v, description: 'Either a full vector or an `x` component.', optional: false, type: [Vector, Number]}
14+
- {name: y, description: 'The `y` component.', optional: true, type: [Number]}
15+
- {name: z, description: 'The `z` component.', optional: true, type: [Number]}
2116
kind: function
2217
todo: null
2318
examples: []

‎reference/typography/typo.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ returns:
1010
description: 'The property value(s) if the function acts as getter or the items the property was assigned to.'
1111
type: [null, null, null]
1212
parameters:
13-
- {name: item, description: 'The object to apply the property to.', optional: false, type: [Document, Spread, Page, Layer, Story, TextFrame, Text]}
13+
- {name: item, description: 'The object to apply the property to.', optional: false, type: [Document, Spread, Page, Layer, Story, TextFrame, TextPath, Text]}
1414
- {name: property, description: 'The text property name or an object of key/value property/value pairs. If property is a string and no value is given, the function acts as getter.', optional: false, type: [String, Object]}
1515
- {name: value, description: 'The value to apply to the property.', optional: true, type: [null]}
1616
kind: function

0 commit comments

Comments
 (0)