feat(linked -textframes): adds docs for textframes and linkedtexftframes functions

Also updates some other docs

Author: ff6347

_source/_data/categories.json

@@ -1 +1 @@
-{"blendMode":true,"color":true,"colorMode":true,"fill":true,"fillTint":true,"gradient":true,"gradientMode":true,"lerpColor":true,"noFill":true,"noStroke":true,"opacity":true,"stroke":true,"strokeTint":true,"swatch":true,"forEach":true,"binary":true,"hex":true,"unbinary":true,"unhex":true,"CSV":true,"HashList":true,"JSON":true,"endsWith":true,"join":true,"nf":true,"nfc":true,"nfp":true,"nfs":true,"split":true,"splitTokens":true,"startsWith":true,"trim":true,"trimWord":true,"isArray":true,"isInteger":true,"isNumber":true,"isString":true,"isText":true,"isURL":true,"clear":true,"close":true,"doc":true,"layer":true,"referencePoint":true,"remove":true,"revert":true,"units":true,"bleeds":true,"canvasMode":true,"guideX":true,"guideY":true,"margins":true,"pasteboard":true,"addPage":true,"applyMasterPage":true,"masterPage":true,"nextPage":true,"page":true,"pageCount":true,"pageNumber":true,"previousPage":true,"removePage":true,"applyObjectStyle":true,"arrange":true,"bounds":true,"duplicate":true,"graphics":true,"group":true,"items":true,"label":true,"labels":true,"nameOnPage":true,"objectStyle":true,"selection":true,"selections":true,"ungroup":true,"addToStory":true,"characters":true,"lines":true,"linkTextFrames":true,"paragraphs":true,"placeholder":true,"stories":true,"textStyleRanges":true,"words":true,"delay":true,"frameRate":true,"height":true,"width":true,"VERSION":true,"EPSILON":true,"HALF_PI":true,"KAPPA":true,"PI":true,"QUARTER_PI":true,"SINCOS_LENGTH":true,"TWO_PI":true,"LOREM":true,"inspect":true,"printInfo":true,"projectFolder":true,"property":true,"size":true,"stackArray":true,"image":true,"imageMode":true,"shellExecute":true,"download":true,"file":true,"files":true,"folder":true,"loadString":true,"loadStrings":true,"selectFile":true,"selectFiles":true,"selectFolder":true,"day":true,"hour":true,"millis":true,"millisecond":true,"minute":true,"month":true,"second":true,"timestamp":true,"weekday":true,"year":true,"abs":true,"ceil":true,"constrain":true,"dist":true,"exp":true,"floor":true,"lerp":true,"log":true,"mag":true,"map":true,"max":true,"min":true,"norm":true,"pow":true,"round":true,"sq":true,"sqrt":true,"noise":true,"noiseDetail":true,"noiseSeed":true,"random":true,"randomSeed":true,"acos":true,"asin":true,"atan":true,"atan2":true,"cos":true,"degrees":true,"radians":true,"sin":true,"tan":true,"Vector":true,"print":true,"println":true,"savePDF":true,"savePNG":true,"saveString":true,"saveStrings":true,"ellipseMode":true,"rectMode":true,"strokeWeight":true,"arc":true,"ellipse":true,"line":true,"point":true,"quad":true,"rect":true,"triangle":true,"addPath":true,"beginShape":true,"endShape":true,"vertex":true,"mode":true,"noLoop":true,"applyMatrix":true,"popMatrix":true,"printMatrix":true,"pushMatrix":true,"resetMatrix":true,"rotate":true,"scale":true,"transform":true,"translate":true,"text":true,"textAlign":true,"textFont":true,"textKerning":true,"textLeading":true,"textSize":true,"textTracking":true,"typo":true,"applyCharacterStyle":true,"applyParagraphStyle":true,"characterStyle":true,"paragraphStyle":true}
+{"blendMode":true,"color":true,"colorMode":true,"fill":true,"fillTint":true,"gradient":true,"gradientMode":true,"lerpColor":true,"noFill":true,"noStroke":true,"opacity":true,"stroke":true,"strokeTint":true,"swatch":true,"forEach":true,"binary":true,"hex":true,"unbinary":true,"unhex":true,"CSV":true,"HashList":true,"JSON":true,"contains":true,"endsWith":true,"join":true,"nf":true,"nfc":true,"nfp":true,"nfs":true,"split":true,"splitTokens":true,"startsWith":true,"trim":true,"trimWord":true,"isArray":true,"isInteger":true,"isNumber":true,"isString":true,"isText":true,"isURL":true,"clear":true,"close":true,"doc":true,"layer":true,"referencePoint":true,"remove":true,"revert":true,"units":true,"bleeds":true,"canvasMode":true,"guideX":true,"guideY":true,"margins":true,"pasteboard":true,"addPage":true,"applyMasterPage":true,"masterPage":true,"nextPage":true,"page":true,"pageCount":true,"pageNumber":true,"previousPage":true,"removePage":true,"applyObjectStyle":true,"arrange":true,"bounds":true,"duplicate":true,"graphics":true,"group":true,"items":true,"label":true,"labels":true,"linkedTextFrames":true,"nameOnPage":true,"objectStyle":true,"selection":true,"selections":true,"textFrames":true,"ungroup":true,"addToStory":true,"characters":true,"lines":true,"linkTextFrames":true,"paragraphs":true,"placeholder":true,"stories":true,"textStyleRanges":true,"words":true,"delay":true,"frameRate":true,"height":true,"width":true,"VERSION":true,"EPSILON":true,"HALF_PI":true,"KAPPA":true,"PI":true,"QUARTER_PI":true,"SINCOS_LENGTH":true,"TWO_PI":true,"LOREM":true,"inspect":true,"printInfo":true,"projectFolder":true,"property":true,"size":true,"stackArray":true,"image":true,"imageMode":true,"shellExecute":true,"download":true,"file":true,"files":true,"folder":true,"loadJSON":true,"loadString":true,"loadStrings":true,"selectFile":true,"selectFiles":true,"selectFolder":true,"day":true,"hour":true,"millis":true,"millisecond":true,"minute":true,"month":true,"second":true,"timestamp":true,"weekday":true,"year":true,"abs":true,"ceil":true,"constrain":true,"dist":true,"exp":true,"floor":true,"lerp":true,"log":true,"mag":true,"map":true,"max":true,"min":true,"norm":true,"pow":true,"round":true,"sq":true,"sqrt":true,"noise":true,"noiseDetail":true,"noiseSeed":true,"random":true,"randomSeed":true,"acos":true,"asin":true,"atan":true,"atan2":true,"cos":true,"degrees":true,"radians":true,"sin":true,"tan":true,"Vector":true,"print":true,"println":true,"saveJSON":true,"savePDF":true,"savePNG":true,"saveString":true,"saveStrings":true,"ellipseMode":true,"rectMode":true,"strokeWeight":true,"arc":true,"ellipse":true,"line":true,"point":true,"quad":true,"rect":true,"triangle":true,"addPath":true,"beginShape":true,"endShape":true,"vertex":true,"mode":true,"noLoop":true,"applyMatrix":true,"popMatrix":true,"printMatrix":true,"pushMatrix":true,"resetMatrix":true,"rotate":true,"scale":true,"transform":true,"translate":true,"text":true,"textAlign":true,"textFont":true,"textKerning":true,"textLeading":true,"textSize":true,"textTracking":true,"typo":true,"applyCharacterStyle":true,"applyParagraphStyle":true,"characterStyle":true,"paragraphStyle":true}

_source/_data/cats-and-subcats.json

@@ -37,6 +37,8 @@ basil.js x.x.x DAY MONTH YEAR
 + Added property()
   sets a property of an object to a given value
 + Added graphics() to loop over graphics in a given container
++ Added textFrames() to loop over text frames in a given container
++ Added linkedTextFrames() to loop over all linked text frames of a text frame chain
 + Added textStyleRanges() to loop over text style ranges in a given container
 + Added swatch()
   returns a color or gradient of a given name

_source/_data/function-list.json

@@ -1,17 +1,17 @@
 ---
 layout: entry
 title: endsWith
-codetitle: 'endsWith(str, suffix)'
-description: 'Checks whether a string ends with a specific character or string.'
+codetitle: 'endsWith(searchContainer, valueToFind)'
+description: 'Checks whether a string ends with a specific character or string or if an array ends with a specific element.'
 category: Data
 subcategory: 'String Functions'
 returns:
     name: null
     description: 'Returns either true or false'
     type: [Boolean]
 parameters:
-    - {name: str, description: 'A string to be checked', optional: false, type: [String]}
-    - {name: suffix, description: 'The string to look for', optional: false, type: [String]}
+    - {name: searchContainer, description: 'A string or array to be checked', optional: false, type: [String]}
+    - {name: valueToFind, description: 'The value to search for', optional: false, type: [String]}
 kind: function
 todo: null
 examples: []

_source/download/changelog.txt

@@ -1,17 +1,17 @@
 ---
 layout: entry
 title: startsWith
-codetitle: 'startsWith(str, prefix)'
-description: 'Checks whether a string starts with a specific character or string.'
+codetitle: 'startsWith(searchContainer, valueToFind)'
+description: 'Checks whether a string starts with a specific character or string or if an array starts with a specific value.'
 category: Data
 subcategory: 'String Functions'
 returns:
     name: null
     description: 'Returns either true or false'
     type: [Boolean]
 parameters:
-    - {name: str, description: 'A string to be checked', optional: false, type: [String]}
-    - {name: prefix, description: 'The string to look for', optional: false, type: [String]}
+    - {name: searchContainer, description: 'A string or an array to be checked', optional: false, type: [String]}
+    - {name: valueToFind, description: 'The value to search for', optional: false, type: [String]}
 kind: function
 todo: null
 examples: []

_source/reference/data/endsWith.md

@@ -0,0 +1,19 @@
+---
+layout: entry
+title: linkedTextFrames
+codetitle: 'linkedTextFrames(item, [cb])'
+description: "Returns an array of all linked text frames or text paths in relation to a given Text Frame, Text Path, Story or Text Object.\nIf a callback function is given, `textFrames()` calls this callback function on each text frame of the given container. When the callback function returns false, the loop stops and the `textFrames()` function returns an array of all text frames up to this point."
+category: Document
+subcategory: 'Page Items'
+returns:
+    name: null
+    description: 'The array of linked text frames or text paths.'
+    type: [Array]
+parameters:
+    - {name: item, description: 'The text frame, text path, story or text object of the text frame chain.', optional: false, type: [TextFrame, TextPath, Story, TextObject]}
+    - {name: cb, description: 'The callback function to call with each text frame or text path. When this function returns false the loop stops. Passed arguments: `textFrame`, `loopCount`.', optional: true, type: [Function]}
+kind: function
+todo: null
+examples: []
+
+---

_source/reference/data/startsWith.md

@@ -0,0 +1,19 @@
+---
+layout: entry
+title: textFrames
+codetitle: 'textFrames(container, [cb])'
+description: "Returns a collection of all text frames in the given container. The container object can be a Document, Page, Layer, Group, Story, Page Item or Text Object.\nIf a callback function is given, `textFrames()` calls this callback function on each text frame of the given container. When the callback function returns false, the loop stops and the `textFrames()` function returns an array of all text frames up to this point."
+category: Document
+subcategory: 'Page Items'
+returns:
+    name: null
+    description: 'An array of Text Frames.'
+    type: [Array]
+parameters:
+    - {name: container, description: 'The document, page, layer, group, story, page item or text object to iterate the text frames in.', optional: false, type: [Document, Page, Layer, Group, Story, PageItem, TextObject]}
+    - {name: cb, description: 'The callback function to call with each text frame. When this function returns false the loop stops. Passed arguments: `textFrame`, `loopCount`.', optional: true, type: [Function]}
+kind: function
+todo: null
+examples: []
+
+---

_source/reference/document/linkedTextFrames.md

@@ -1,23 +1,18 @@
 ---
 layout: entry
 title: Vector.dist
-codetitle: 'Vector.dist(v1, v2)'
-description: 'Static function. Calculates the Euclidean distance between two points (considering a point as a vector object). Is meant to be called "static" i.e. `Vector.dist(v1, v2);`'
+codetitle: 'Vector.dist(v, [y], [z])'
+description: 'Calculates the distance from this vector to another as `x`, `y`, and `z` components or full vector.'
 category: Math
 subcategory: Vector
 returns:
     name: null
     description: 'The distance.'
     type: [Number]
 parameters:
-    - {name: v1, description: 'The first vector.', optional: false, type: [Vector]}
-    - {name: v2, description: 'The second vector.', optional: false, type: [Vector]}
-kind: function
-todo: null
-examples: []
-
----
-}
+    - {name: v, description: 'Either a full vector or an `x` component.', optional: false, type: [Vector, Number]}
+    - {name: y, description: 'The `y` component.', optional: true, type: [Number]}
+    - {name: z, description: 'The `z` component.', optional: true, type: [Number]}
 kind: function
 todo: null
 examples: []

_source/reference/document/textFrames.md

@@ -1,23 +1,18 @@
 ---
 layout: entry
 title: Vector.dot
-codetitle: 'Vector.dot(v1, v2)'
-description: 'Static function. Calculates the dot product of two vectors. Is meant to be called "static" i.e. `Vector.dot(v1, v2);`'
+codetitle: 'Vector.dot(v, [y], [z])'
+description: 'Calculates the dot product from this vector to another as `x`, `y`, and `z` components or full vector.'
 category: Math
 subcategory: Vector
 returns:
     name: null
     description: 'The dot product.'
     type: [Number]
 parameters:
-    - {name: v1, description: 'The first vector.', optional: false, type: [Vector]}
-    - {name: v2, description: 'The second vector.', optional: false, type: [Vector]}
-kind: function
-todo: null
-examples: []
-
----
-on: 'The `z` component.', optional: true, type: [Number]}
+    - {name: v, description: 'Either a full vector or an `x` component.', optional: false, type: [Vector, Number]}
+    - {name: y, description: 'The `y` component.', optional: true, type: [Number]}
+    - {name: z, description: 'The `z` component.', optional: true, type: [Number]}
 kind: function
 todo: null
 examples: []