Skip to content

Commit

Permalink
docs : minor amendments and updates
Browse files Browse the repository at this point in the history
  • Loading branch information
nickorr committed Jul 16, 2024
1 parent 913f1bf commit 6c4479b
Show file tree
Hide file tree
Showing 11 changed files with 92 additions and 14 deletions.
2 changes: 1 addition & 1 deletion docs/Functions/BE_ArrayChangeValue.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

**Description**

Changes the array item at valueNumber to newValue in array number array.
Changes the *array* item at *valueNumber* to *newValue*.

**Parameters**

Expand Down
2 changes: 1 addition & 1 deletion docs/Functions/BE_ArrayDelete.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

**Description**

Removes the array from memory.
Removes *array* from memory.

**Parameters**

Expand Down
40 changes: 40 additions & 0 deletions docs/Functions/BE_JSON_ArraySize.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
## BE_JSON_ArraySize

BE_JSON_ArraySize ( json { ; path } )

**Description**

Will return the number of values in a JSON array.

**Parameters**

* *json* : the array to count.
* *name* ( optional ) : the path within the JSON to locate the array to count.

**Keywords**

JSON Array Size

**Version History**

* 2.1.0 : First Release
* 4.1.0 : Added the optional path parameter

**Notes**

If *path* is not included, it counts the array at the root of the JSON, and will return 1 for a non array type.

If *path* is included, the format is as per the *BE_JSONPath* function, which is NOT the same as the internal FileMaker JSON functions introduced in version 16.

**Compatibility**

| Platform | Compatibility |
|-----------|-----------|
| Status | Active |
| Mac FMP | Yes |
| Win FMP | Yes |
| FMS | Yes |
| iOS | Yes |
| Linux | Yes |

**Example Code**
2 changes: 1 addition & 1 deletion docs/Functions/BE_OpenURL.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Sends the url to the users default web browser.

**Keywords**

keyword keyword
URL

**Version History**

Expand Down
2 changes: 1 addition & 1 deletion docs/Functions/BE_ValuesUnique.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Removes duplicate values from listOfValues.

**Keywords**

Values Unique
Values Unique List

**Version History**

Expand Down
2 changes: 1 addition & 1 deletion docs/Functions/BE_XMLParse.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

**Description**

Parses an XML file at path to determine if it's properly formed. Does not check XSD details, just whether every tag is properly opened and closed.
Parses an XML file at *pathOrXMLText* to determine if it's properly formed. Does not check XSD details, just whether every tag is properly opened and closed.

The result will be empty when successful with a *BE_GetLastError* returning 0.

Expand Down
37 changes: 37 additions & 0 deletions docs/Functions/BE_XMLStripInvalidCharacters.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
## BE_XMLStripInvalidCharacters

BE_XMLStripInvalidCharacters ( path ; { resultFilePath } )

**Description**

This function removes characters considered invalid in XML from the file at *path*, and optionally writes the fixed file to the *resultFilePath*.

**Parameters**

* *path* : The path to the text XML file to read.
* *resultFilePath* ( optional, default:path ) : If supplied, this will write the output to a new file. If not supplied then the original file will be overwritten.

**Keywords**

XML Strip Invalid Characters

**Version History**

* 4.2.0 : First Release

**Notes**

Used originally internal as a BaseElements developer tool function, likely not useful for anyone else.

**Compatibility**

| Platform | Compatibility |
|-----------|-----------|
| Status | Active |
| Mac FMP | Yes |
| Win FMP | Yes |
| FMS | Yes |
| iOS | Yes |
| Linux | Yes |

**Example Code**
4 changes: 2 additions & 2 deletions docs/Functions/BE_XPath.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

**Description**

This finds the first instance of a node at the path xpath within the text xml.
This finds the first instance of a node at the path *xpathText* within the text *xmlText*.

**Parameters**

Expand All @@ -13,7 +13,7 @@ This finds the first instance of a node at the path xpath within the text xml.
* *namespaceListText* ( optional ) : Namespace list as "prefix1=href1 prefix2=href2...".
* *asTextBoolean* ( optional, default:False ) : Whether to return the XML nodeset as text instead of the standard XPath result.

The *asTextBoolean* parameter when set to True allows you to get raw XML from the source - normally where the XPath function would return a node, with it's opening and closing tag, this will return the value inside that tag instead
The *asTextBoolean* parameter when set to True allows you to get raw XML from the source - normally where the XPath function would return a node, with it's opening and closing tag, this will return the value inside that tag instead.

**Keywords**

Expand Down
7 changes: 4 additions & 3 deletions docs/Functions/BE_XPathAll.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

**Description**

This finds all instances of a node at the path xpath within the text xml. Similar to running *BE_XPath* in a loop.
This finds all instances of a node at the path *xpathText* within the text *xmlText*.

**Parameters**

Expand All @@ -18,8 +18,9 @@ XML XPath

**Version History**

* 1.0.0 : First Release
* 1.2.0 :
* 1.2.0 : First Release
* 2.2.0 : support objects of type XPATH_BOOLEAN, XPATH_NUMBER and XPATH_STRING
* 2.2.1 : return an empty string when getting an empty node set as xml

**Notes**

Expand Down
4 changes: 2 additions & 2 deletions docs/Functions/BE_XSLTApply.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

**Description**

Applies the XSLT given by the xsltText parameter, to the XML file at xmlPath, and writes the output to outputPath.
Applies the XSLT given by the *xsltText* parameter, to the XML file at *xmlFilePath*, and writes the output to *outputFilePath*.

**Parameters**

Expand All @@ -29,7 +29,7 @@ XML XSLT Memory

**Notes**

When the scriptName option is used, the script parameter is the response from the XSLT function, if present, and the outputFilePath otherwise.
When the *scriptName* option is used, the script parameter sent to *scriptName* is the response from the XSLT function if present, or the *outputFilePath* otherwise.

**Compatibility**

Expand Down
4 changes: 2 additions & 2 deletions docs/Functions/BE_Zip.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,14 @@

**Description**

Compresses the file(s) found at the filePathList.
Compresses the file(s) found at the *filePathList* and optionally saves the zip file to *archiveFilePath*.

**Parameters**

* *filePathList* : a plugin file path, or a container field.
* *archiveFilePath* : a plugin file path to put the result.

If the *archiveFilePath* parameter is not specified, then the zip file is put into the same folder as first file in the list, and has the .zip extension appended to the filename. This will overwrite an existing file if it exists with that name already.
If the *archiveFilePath* parameter is not specified, then the zip file is put into the same folder as first filename in the list, and has the .zip extension appended to the filename. This will overwrite an existing file if it exists with that name already.

**Keywords**

Expand Down

0 comments on commit 6c4479b

Please sign in to comment.