360Works Scribe 2.15 User Guide

Installation

Requirements

FileMaker version 11 or higher.

360 Works plug-ins require Java in order to run. FileMaker Pro will prompt you on startup to download the appropriate software if it is not found on your computer. FileMaker Server has no such prompt, and you may be required to manually download a Java Runtime (JRE) if you do not already have one. On Windows, you will need a current version of Java, Oracle downloads. On Mac, you will need the latest Java 6 update from Apple. For Mac OS 10.6, click here. For Mac OS 10.7-10.10, click here, For OS X 10.11, El Capitan click here

Note to intel Mac users: running this plugin under Rosetta is not supported. Upgrade to FileMaker 8.5 to run our plugin in native Intel mode.

Install Steps for FileMaker Pro

Drag the plugin from the MAC or WIN folder into your FileMaker extensions, and restart FileMaker.

If the plugin does not load correctly, double-check that you meet the system requirements.

WebDirect Install (FMS 13+)

Install plug-ins for use with WebDirect by dragging the appropriate plugin to FileMaker Server/Web Publishing/publishing-engine/cwpc/Plugins

Install steps for Instant Web Publishing

You do not need to do this step unless you plan on using the plugin with Instant Web Publishing with FileMaker Server Advanced. You will need an Enterprise license to use this feature.

For installing into the Web Publishing Engine with FileMaker Server or FileMaker Server Advanced, drag the plugin from the MAC (.fmplugin file) or WIN (.fmx file) folder into the FileMaker Server/Web Publishing/publishing-engine/wpc/Plugins folder. If there is no Plugins folder inside the wpc folder, then create it manually. Restart FileMaker Web Publishing, and now the plugins should be ready to go.

The easiest way to test whether the plugin is working is to have a calculation which calls the version function of the plugin, and display that on an IWP layout. If it shows "?", then the plugin is not working. If it shows a number, then the plugin has been installed successfully.

Install steps for Custom Web Publishing

If you are using FileMaker Server 12.0v1 or earlier, you can follow the same procedure as detailed above for custom web publishing. However, in FileMaker Server 12.0v2 and later, custom web publishing now runs as a 64-bit application and requires a slightly different location. You will need an Enterprise license to use this feature.

For Mac, the single plug-in file in the MAC directory contains both 32-bit and 64-bit versions. For Windows, look for the plug-in that has the extension .fmx64 and use it in exclusively in custom web publishing.

To install 64-bit plug-ins, install either the .fmx64 or the .fmplugin to the following directory:

,FileMaker Server / Web Publishing / publishing-engine / cwpc / Plugins

If it does not exist, create the Plugin folder manually. Restart FileMaker Web Publishing, and then you can then test a script that contains a plug-in and see if it returns the correct values.

Please note that plug-ins do not work with the web publishing engine of the Mac version of FileMaker Server 8.0v4.

Install steps for server scheduled scripts

You do not need to do this step unless you plan on using the plugin with scheduled script triggering. You will need an Enterprise license to use this feature.

  1. Drag the plugin from the MAC (.fmplugin file) or WIN (.fmx64 file) folder into the FileMaker Server extensions folder. On Mac OS X, this is located at /Library/FileMaker Server/Database Server/Extensions folder. On Windows, this is at C:\Program Files\FileMaker\FileMaker Server\Database Server\Extensions.
  2. In the Server Admin application, restart FileMaker Server by stopping and starting it.
  3. Go to Configuration -> Database Server->Server Plug-ins and check the box that says 'Enable FileMaker Server to use plug-ins', and then check the 'enabled' box for this plugin. Click the 'save' button and wait a few seconds to make sure that the 'enabled' check box stays checked. If it does not, then there was an error loading the plugin and you should contact us for help troubleshooting. You should now be able to write schedules that trigger scripts which use the plugin.

Auto Update

360Works has created an AutoUpdate helper database which makes setting up AutoUpdate much easier. This file includes pre-configured plugin files which you can place on your server, and an AutoUpdate script for each of our plugins which you can paste into your own solution.

You can get the AutoUpdate360Works file at:

Follow the instructions included in the file to either host your own Auto Update server or pull the files from ours.

Uninstalling the plugin

Uninstall the plugin by quitting FileMaker Pro or stopping FileMaker Server and removing the plugin file from your Extensions directory.

Demo mode and Registering the plugin

Plugins will run in demo mode until they are registered. While running in Demo mode, the product will run for 2 hours every time you launch FileMaker / FileMaker Server / FileMaker Web Publishing Engine. The 2 hour time limit will reset every time you relaunch FileMaker. There is no expiration date when Demo mode stops working. There are no feature differences between the Demo version and the licensed version.

Once you have purchased the plugin, you can register it with the license key. Once a valid license key is entered, the product will run for as long as FileMaker is running. After FileMaker starts up with the plugin installed, open FileMaker preferences, click on the Plug-ins tab, select the plugin from the list, and click the Configure button. Enter your license key and company name in this dialog. You will only need to do this once on a given machine. Alternately, you can use the registration function to register the plugin during a startup script.

Note that if you are running the plugin with FileMaker Server / FileMaker Web Publishing Engine, you must use the registration function to register the plugin, since there is no preferences dialog on FileMaker Server to enter the license key and company name.

Feedback

We love to hear your suggestions for improving our products! If you are experiencing problems with this plugin, or have a feature request, or are happy with it, we'd appreciate hearing about it. Send us a message on our website, or email us!

Error Handling/Reporting

When something unexpected happens, the plug-in will pop up a dialog showing what the error message is. This makes it easy to see what went wrong. However, in some cases, you (the developer) may prefer to show your own message to the user, or possibly not show a message at all. In that case, you can call ScribeSetErrorCapture with a parameter of true. That will suppress the error dialog from appearing to the user.

When you call this function, it is set for that plug-in for as long as FileMaker is running, so if you want to do all of your own error handling, you can just set it to true once in your startup script. However, we recommend only turning it on when your script is prepared to check for errors, and then turning it off after finishing that section.

Whether or not you suppress the error dialogs, a plugin function will return the word ERROR if something goes wrong. It's a good idea to put your plugin functions in an 'If' statement so that you don't execute a bunch of script steps after something has gone wrong. If you'd like for your script to get the error message, you can get that by calling the ScribeLastError function.

Here is an example of basic error reporting:

Set Variable [ $result = MyPluginFunction("x" ; "y" ; "z") ]
If [ $result = "ERROR" ]
    Exit Script[ "Error occurred: " & ScribeLastError ]
Else
    ... do more stuff here ...
End If

Chaining Multiple Functions Together

Since the string "ERROR" evaluates to false when evaluated by FileMaker, and most plugin functions return a 1 when successful, you can chain multiple dependent plugin operations together using the "and" operator. However, in this case the result will be a 1 or a 0, not "ERROR". For example:

// chain multiple calls together
// if any of the functions fail, the calculation will
// short-circuit with a result of false,
// and none of the subsequent function calls will be evaluated.
Set Variable [ $success =
    FirstPluginFunction("x") and
    SecondPluginFunction("y") and
    ThirdPluginFunction("z")
]
If [not $success]
    Show Custom Dialog [ "An error occurred: " & ScribeLastError ]
End If

Note: the above only works for plugin functions which return 1 on success! Check the documentation for each function used in this manner.

Additional Error Checking - Plugin not installed

If a plugin is not installed correctly, calls to a plugin function will return "?". As part of your startup script, you should check for this occurrence and display a warning accordingly that the plugin needs to be installed. Note: when treated as a boolean true/false value, FileMaker will treat ? as true.

Examples

Scribe is a multi-purpose plugin for reading and manipulating documents, and working with text. See the 'How to use Scribe.fp7' file for step-by-step tutorials.

Function Summary

Function Detail

ScribeDifferenceReport ( someText ; otherText )

Returns a report on the types of differences between two blocks of text. This will always return three return-separated values: additions, modifications, deletions. Each line consists of a label, edit count, and character count.

For example, the following report:

 additions: 2 214
 modifications: 0 0
 deletions: 1 47
 
Indicates that:

Parameters:
someText - initial text
otherText - modified text
Returns: report on the number of differences between the two blocks of text.

ScribeDifferencesBetween ( someText ; otherText { ; options } )

Returns the highlighted differences between two blocks of text. Any text which is in 'otherText' but not in 'someText' is considered an addition, and is styled according to the ScribeStyleAddedText style. Any block of text which has changed from 'someText' to 'otherText' is considered modified text, and is styled according to the ScribeStyleModifiedText style. Any text which is in 'someText' but not in 'otherText' is considered a deletion, and is styled according to the ScribeStyleDeletedText style.

Custom Options

Pass "verbose=true" as a custom option to cause modifications to be displayed as a delete then an insert, instead of a modification.

Parameters:
someText - intial text
otherText - revised text
options - options
Returns: Styled text which displays the differences between the two strings, according to highlighting parameters.

ScribeDocAppend ( data { ; key=value } )

(Currently only for Microsoft Word) Appends data to the end of the currently loaded document (see ScribeDocLoad. This is useful if your file template does not contain text to replace, or you want to add a repeating section to a document.

Optional arguments:

newPage=true: force a page break before the appended document

Parameters:
data - text or image or another document to append to the currently loaded document
Returns: 1 on success, or "ERROR" if an error occurs.

ScribeDocCancel

Closes the currently loaded document without saving any pending changes. This releases any in-memory resources or file locks used by the currently loaded document.

Returns: Always returns 1

ScribeDocListFields

Lists all fields in the loaded document.

PDF Support

Returns any named acrofields.

Word Support (Office 2007 format or later. Works with .docx files only.)

Returns any named placeholder tags.

Excel Support (Office 2007 format or later. Works with .xlsx files only.)

Returns a list of sheets in the excel document.

Returns: return-separated list of field names. For Excel documents, this returns the bottom-right cell coordinate.

ScribeDocLoad ( containerOrUrl { ; password=xxxxx } )

Loads a file. You must load a file before calling any of the other ScribeDoc* functions.

Parameters:
containerOrUrl - container, path (including File URLs), or URL for the file being loaded.
args - optional arguments.
Returns: 1 if the file was successfully loaded, or "ERROR" if the an error occurred.

ScribeDocReadValue ( name { ; key=value ; ... } )

Reads a field value from the currently loaded file. The behavior of this function depends on the type of document currently loaded (see ScribeDocLoad).

PDF Support

To read an acrofield from a PDF, pass the name of the acrofield whose value you wish to retrieve.

To read metadata values, use the respective name parameter: Note: the descriptions for the fields above are suggested by PDF standards community, but may not strictly represent the values in those fields.

Word Support (Office 2007 format or later. Works with .doc and .docx files.)

Microsoft Word supports named placeholders in word documents called Content Control Fields. Pass the tag name of the Content Control Field as the parameter. Content control fields can only be created on Office 2007 on Windows, but can be read and written on both Windows and Mac. More information about how to make content control fields can be found here.

Table Support

Read values from a specific table cell in Microsoft Word using Excel-style syntax, e.g. to read the 3rd column of the 15th row of the first table in a Word document:
     ScribeDocReadValue("Table1!C15")
 

Excel Support (Office 2007 format or later)

To read values from an excel sheet, pass the coordinates of a single cell, e.g. "A5".

To specify a sheet other than the first sheet, include the sheet name followed by an exclamation point, e.g. "Sheet 2!BB42".

New Excel Features in Scribe 2.0

To read a range of values as CSV, specify the start and end columns delimited by a colon, e.g. A1:C15. Optionally, pass "invert=true" as an additional parameter to read rows-first instead of column-first. Optionally, pass "rowSeparator=x" or "fieldSeparator=y" as additional parameter to specify custom delimiters.

ScribeDocReadValue("A1:C15" ; "fieldSeparator=|")

To get the maximum bounds of a worksheet, request MaxRow( ) or MaxCol ( ). Optionally, pass in worksheet=... as an additional parameter, for example:

ScribeDocReadValue("MaxRow()" ; "worksheet=Second Sheet" )

To read a cell's formula (instead of the formula result), pass "formula" as an optional parameter, e.g.

$c3Formula = ScribeDocReadValue( "C3" ; "formula" ) // SUM(A1,B1)
     
This will return the formula text, if one is specified on the cell.

To read cell comments, pass "commentText" as an optional parameter, e.g.

$c3Comment = ScribeDocReadValue( "C3" ; "commentText" )
     
This will return the color as a numeric value, which you can pass to FileMaker as a

To read cell background colors, pass "background" as an optional parameter, e.g. to read a cell value and then style some FileMaker text the same color:

$c3BackgroundColor = ScribeDocReadValue( "C3" ; "background" )
     # $c3BackgroundColor is a numeric color value, we can use it to style some text
     TextColor ( myTable::sampleField ; $c3BackgroundColor )
     

XML Support

To read values from an XML document, pass an XPath expression identifying the node to be modified as the first parameter.

Parameters:
name - attribute name to read.
Returns: value of the named attribute in the currently loaded file, or "ERROR" if an error occurs.

ScribeDocSaveContainer ( newName {; flatten=true ; type=file } )

Returns the currently loaded file as a container field, applying any modifications. This closes the document after saving it to a temporary folder.

The newName parameter tells Scribe what to name the container field value. This can take two forms:

The optional flatten parameter can be used with PDF forms to save a "flattened" version of the form, this would make the form fields unenterable.

The optional type parameter can be set to "file" to explicitly save a file container instead of an image.

PDF Password support (new in Scribe 2.0), pass a "password" parameter to password-protect the saved PDF. You can optionally specify separate "userPassword" and "ownerPassword" parameters.

For example, if you've done a find and replace operation on a Word document and would like to store it into a container field called 'ResultContainer' while retaining the original filename, you would do it this way:

 Set Field[ ResultContainer; ScribeDocSaveContainer("") ]
 

Parameters:
Returns: A container field value which can be inserted into any container field with a Set Field script step.

ScribeDocSaveFile ( path {; flatten=true } )

Saves the currently loaded file to disk, applying any modifications. This closes the document after saving it.

The path parameter tells Scribe where to save the file to. This can take several forms:

The optional flatten parameter can be used with PDF forms to save a "flattened" version of the form, this would make the form fields unenterable.

PDF Password support (new in Scribe 2.0), pass a "password" parameter to password-protect the saved PDF. You can optionally specify separate "userPassword" and "ownerPassword" parameters.

Parameters:
Returns: FileMaker file path to the saved file, for example 'file:/Macintosh HD/Users/jesse/Desktop/Letter_to_clients.docx'. This can be used with the 'Insert File' script step to insert the file into a container field in FileMaker.

ScribeDocSubstitute ( searchText ; replaceText )

Replaces all occurrences of searchText with replaceText in the currently loaded document. Note that searchText and replaceText should generally should be short pieces of text, which only span one line (for convenience... long search strings can be more complicated to correctly enter into FileMaker calculations). This feature is only available for Microsoft Word 2007 and later (.docx files only). To replace named form fields or cells in a PDF form, Word Document, or other file, use the ScribeDocWriteValue function instead.

Word documents support image replacement in Scribe 2.0, you can pass a container as the replaceValue, and an image will be inserted into your Word document.

To use this, you must first load a document using ScribeDocLoad.

Image Support in Microsoft Word Files

Pass a container as the replaceText to add it to the Word document.

ScribeDocSubstitute("[placeholder]" ; myTable::myContainer )

Saving the File

After calling ScribeDocSubstitute one or more times, save the modified file using ScribeDocSaveFile.

If you need to substitute many different text occurrences, just call this function once for each term that you want to find and replace.

Parameters:
searchString - text to find
replaceValue - text to replace searchString with. Word documents support image replacement as well.
Returns: 1 on success, or "ERROR" if an error occurs.

ScribeDocWriteValue ( name ; value { ; key=value ; ... } )

Write a field value in the currently loaded file. The behavior of this function depends on the type of document currently loaded (see ScribeDocLoad).

To use this, you must first load a document using ScribeDocLoad.

PDF Support

To write an acrofield on a PDF, pass the name of the acrofield whose value you wish to set as the first parameter. You can also write values to checkboxes and radio buttons. The only values you can write are "Off" or "Yes", and they are case-sensitive.

To write XMP metadata to a PDF, use the PDFMetadata key, and pass in the XMP xml you wish to write (read this using ScribeDocReadValue

To write attachments to a PDF, use the PDFAttachment key, and pass in a container to attach to the file. Existing attachments with matching names will be replaced, otherwise a new attachment will be added to the PDF.

Word Support

Microsoft Word supports named placeholders in word documents (.docx files only) called Content Control Fields. Pass the tag name of the Content Control Field as the first parameter. Content control fields can only be created on Office 2007 on Windows, but can be read and written on both Windows and Mac. More information about how to make content control fields can be found here.

To do a find/replace operation on text in a word document, use the ScribeDocSubstitute function.

Table Support in Microsoft Word Files

Use excel-style syntax to refer to table cells in a word document. For example, to write a value to the 3rd row, 4th column of the first table in a Word document:

     ScribeDocWriteValue("Table1!D3", "This is a table cell")
 

Writing to non-existent table cells will create new rows/columns as needed, copying cell styles from preceding cells.

Image Support in Microsoft Word Files

Use ScribeDocSubstitute or ScribeDocAppend to add images to a Word document.

Excel Support

To write values to an excel sheet (.xlsx files only), pass the coordinates of a single cell, e.g. "A5" as the first parameter.

The second parameter can be text or an image in a container field. Images will be placed so the top-left corner of the image is in the cell indicated by the name parameter.

To specify a sheet other than the first sheet, include the sheet name followed by an exclamation point, e.g. "Sheet 2!BB42".

Writing a value to a non-existent sheet will generate an error. If you specify a non-existent cell or row, it will be created.

To write formulas to an Excel sheet, preface the value with an equals sign, e.g.
     ScribeDocWriteValue("C3" ; "=SUM(A1,B1)" )
 
To explicitly write a value with a leading equals sign, pass "literal" as the optional third parameter.
wrap
Set to true to wrap newlines in the written text

PowerPoint Support (new in Scribe version 2)

Write images to a PowerPoint file by specifying the sheet number and optional coordinates for the image to add to the PowerPoint presentation. For example, to add an image from a container field to the first slide:

 ScribeDocWriteValue(
     "1" ;
     MyTable::MyImage ;
     "x=100" ;
     "y=200" ;
     "width=300" ;
     "height=400"
 )
 

XML Support

To write values to an XML document, pass an XPath expression identifying the node to be modified as the first parameter.

PDF Support (in Scribe 2.0)

Use the following functions to modify a PDF:

Adding Pages to a PDF

ScribeDocWriteValue("newPage()" ; "2" )

Adding Images to a PDF

ScribeDocWriteValue("addImage()" ; 
     my::imageContainer ; 
     "page=2" ; 
     "x=100" ; 
     "y=100" ; 
     "width=300" ; 
     "height=400" )

Adding Text to a PDF

ScribeDocWriteValue("addText()" ; 
     "Hello, PDF!" ;
     "page=2" ; 
     "x=200" ; 
     "y=500" )

Saving the File

After calling ScribeDocWriteValue one or more times, save the modified file using ScribeDocSaveFile.

Note:

Due to the nature of writing directly to the document XML, calculations in Excel cells may not fire automatically when the value is written.

Parameters:
name - field / cell to write to
fmValue - data to write
Returns: 1 on success, or "ERROR" if an error occurs.

ScribeFileAsKeywords ( fileOrContainer )

Returns a unique list of keywords for the file. Unlike ScribeFileAsText, this only returns unique names, and strips out common "stop words" like "a", "and", "the", etc. This can reduce storage requirements if you are performing text searches against the contents of files, but don't need the extracted text to be human-readable.

Parameters:
file - file or container field to extract index from
See also: ScribeFileAsText
Returns: A unique list of keywords in the currently loaded document, or "ERROR" if an error occurs.

ScribeFileAsText ( fileOrContainer{; param1=value1; param2=value2} )

Returns the plain text content of the file.

For binary file document formats such as Word, PDF, etc. this attempts to return a human-readable presentation of the document. XML documents are returned as-is. Any unrecognized file will have its raw text contents returned (see optional parameters to customize this).

You can pass in optional additional parameters to customize the behavior of this function. A list of customizations follows:

Here is a list of supported file types for reading text from:

Parameters:
file - file or container field to extract text from
Returns: plain text content of the currently loaded document, or an empty string if the input is empty, or "ERROR" if an error occurs.

ScribeHighlight ( text; highlightPattern {; param1=value1 ; param2=value2 ; ...} )

Highlights all occurrences of highlightPattern in text.

Unlike the substitute function, this is case-insensitive by default. The highlightPattern function supports regular expression patterns.

Regular Expression Pattern Processing

Using the flags optional parameter, you may set the following options, each of which influences the way patterns are matched.

caseInsensitive
Enables case-insensitive matching for US-ASCII characters.
multiline
Does not match line-terminating characters. This means that when the input text is a return-separated list, each line is matched independently.
literal
Treats metacharacters like ^ and $ and escape sequences like \t as literals.
includeLineEndings
Matches line-terminating characters, which means that a return-separated list would be treated as a single text block.
ignoreWhitespace
Ignores whitespace characters.

Example

Example of a highlight operation to match the string "file://" at the beginning of each line of a return-separated list.

 Set Field [ Globals::highlighted_text =
     ScribeHighlight(
     "file://temp/doc.txt" & ¶ &
     "file://documents/doc.txt" & ¶ &
     "http://my.site.com/home" & ¶ &
     "ftp://my.ftpsite.com/upload" ;
         "^file://" ;
         "flags=multiline"
     )
 ]
     
This matches "file://temp/doc.txt" & ¶ & "file://documents/doc.txt"

Style, color and size

Highlighting style is determined by the three optional parameters: colorRGB, styles, and size. Consult the Filemaker TextStyleAdd and TextColor documentation for more details about named Filemaker text styles and colors.

Example

Example of a highlight operation to make any occurrences of "atlanta" blue and bold (the default highlight style is bold, blue text):

 Set Field [ Globals::highlighted_text =
     ScribeHighlight(Documents::body ; "atlanta")
 ]
 
Example of a highlight operation to highlight runs of 1 or more sequential numbers as green italic text:
 Set Field [ Globals::highlighted_text =
     ScribeHighlight(
         Documents::body ;
         "[0-9]+" ;
         "colorRGB=" & RGB(0;255;0) ;
         "styles=" + Italic"
     )
 ]
 

Parameters:
text - The input text
highlightPattern - the word or regular expression pattern to highlight
additionalParameters - Additional parameters are specified using a name=value syntax. The parameters colorRGB, size and styles control the look of the replaced text. The parameter flags controls the way in which pattern matching is performed.
Returns: The input text with all occurrences of highlightPattern highlighted with the current styles.

ScribeLastError

Returns the last Scribe-related error which occurred. This should be called any time that a plugin function returns "ERROR" to get a user-readable description of the error.

Returns: Error text, or "" if there was no error.

ScribeLicenseInfo

Returns information about the license used.


ScribePatternMatchAll ( text; regex {; flags=flag1+flag2+flag3+...} )

Returns a newline-delimited list containing pattern matches. Any text that is not a pattern match will be omitted.

Example of a function to extract a return-separated list of numbers from a string.

 ScribePatternMatchAll("123 and 5321 are open, but 0121 is closed" ; "[0-9]+")
 /* returns the following:
 123
 5321
 0121
 */
 

Regular Expression Pattern Processing

Using the flags optional parameter, you may set the following options, each of which influences the way patterns are matched.
caseInsensitive
Enables case-insensitive matching for US-ASCII characters.
multiline
Does not match line-terminating characters. This means that when the input text is a return-separated list, each line is matched independently.
literal
Treats metacharacters like ^ and $ and escape sequences like \t as literals.
includeLineEndings
Matches line-terminating characters, which means that a return-separated list would be treated as a single text block.
ignoreWhitespace
Ignores whitespace characters.
The default behavior of this function uses the caseInsensitive and includeLineEndings flags, so the following function calls are equivalent:
     ScribePatternMatchAll(
         "Wilhelm¶wilson¶Williams¶Zander" ;
         "wil.*" ;
         "flags=includeLineEndings+caseInsensitive"
     )
     ScribePatternMatchAll(
         "Wilhelm¶wilson¶Williams¶Zander" ;
         "wil.*"
     )
 

Parameters:
text - input text
regex - regular expression pattern.
flags - An additional parameter used to specify flags that control how pattern matching is performed. To specify multiple flags, separate each with a plus sign (e.g., ..."flags=literal+ignoreWhitespace")
Returns: Any pattern matches, separated by line breaks.

ScribePatternReplaceAll ( text; regex; replacement {; param1=value1 ; param2=value2 ; ...} )

Replace all occurrences of a regex pattern with some replacement text. The replacement text can optionally be styled.

Highlighting style is determined by the three optional parameters: colorRGB, styles, and size. Consult the FileMaker TextStyleAdd and TextColor documentation for more details about named Filemaker text styles and colors.

Backreferences can also be used with the regular expression. Replacement text can use dollar sign syntax ($1, $2, etc.) to refer to these groups.

Regular Expression Pattern Processing

Using the flags optional parameter, you may set the following options, each of which influences the way patterns are matched.

caseInsensitive
Enables case-insensitive matching for US-ASCII characters.
multiline
Does not match line-terminating characters. This means that when the input text is a return-separated list, each line is matched independently.
literal
Treats metacharacters like ^ and $ and escape sequences like \t as literals.
includeLineEndings
Matches line-terminating characters, which means that a return-separated list would be treated as a single text block.
ignoreWhitespace
Ignores whitespace characters.

Example of simple replace, converting two or more consecutive line breaks to a single line break:

 ScribePatternReplaceAll(
     "Line one¶Line Two¶¶¶Line Three¶Line Four" ;
     "\n+" ;
     "ΒΆ"
 )
 // returns "Line one¶Line Two¶Line Three¶Line Four"
 

Example of a highlighting replace operation, highlighting the literal string "quick" by using styles:

 ScribePatternReplaceAll("The quick brown fox" ;
     "quick" ;
     "quick" ;
     "colorRGB=" & RGB(128 ; 128 ; 255) ;
     "styles=" + Bold
 )
 // returns The quick brown fox
 

Parameters:
text - The input text
regex - The regular expression
replacement - The text to replace the found occurrences with
additionalParameters - Additional parameters are specified using a name=value syntax. The parameters colorRGB, size and styles control the look of the replaced text. The parameter flags controls the way in which pattern matching is performed.
See also: ScribeHighlight
Returns: The input text with all occurrences of regex replaced with replacement

ScribeRegister ( licenseKey; registeredTo )

Registers the plugin.

Parameters:
licenseKey - a valid license key
registeredTo - the company the plugin is registered to
Returns: 1 on success, or "ERROR" on failure.

ScribeSetErrorCapture ( errorCapture )

Toggles error dialogs on or off. When something unexpected happens, the plug-in will pop up a dialog displaying the error message. This makes it easy to see what went wrong. However, in some cases, you (the developer) may prefer to show your own message to the user, or possibly not show a message at all. In that case, you can call ScribeSetErrorCapture with a parameter of True. That will suppress the error dialog from appearing to the user.

Parameters:
errorCapture - set to true to suppress the default popups.

ScribeStyleAddedText ( color ; styles { ; open ; close } )

Sets the style to use for displaying added text. The default plugin behavior is to display added text as green.

This will affect all calls to ScribeDifferencesBetween until you quit FileMaker.

The available styles are:

Parameters:
color - a FileMaker RGB value (such as 'rgb(255,0,0)' for red) or HTML-style hex value (such as "#FF0000" for red)
styles - Any of the Filemaker style keywords, or -1 to hide text of this type in the diff result.
open - An optional text string appended before an addition
close - An optional text string appended after an addition
Returns: 1 on success, or "ERROR" on failure. Use diffLastError to get more information on the error.

ScribeStyleDeletedText ( color ; styles { ; open ; close } )

Sets the style to use for displaying deleted text. The default plugin behavior is to display deleted text as red with a strikethrough style.

This will affect all calls to ScribeDifferencesBetween until you quit FileMaker.

Parameters:
color - a FileMaker RGB value (such as 'rgb(255,0,0)' for red) or HTML-style hex value (such as "#FF0000" for red)
styles - Any of the Filemaker style keywords, or -1 to hide text of this type in the diff result.
open - An optional text string appended before a deletion
close - An optional text string appended after a deletion
Returns: 1 on success, or "ERROR" on failure. Use ScribeLastError to get more information on the error.

ScribeStyleModifiedText ( color ; styles { ; open ; close } )

Sets the style to use for displaying modified text. The default plugin behavior is to display modified text as blue.

This will affect all calls to ScribeDifferencesBetween until you quit FileMaker.

Parameters:
color - a FileMaker RGB value (such as 'rgb(255,0,0)' for red) or HTML-style hex value (such as "#FF0000" for red)
styles - Any of the Filemaker style keywords, or -1 to hide text of this type in the diff result.
open - An optional text string appended before a modification
close - An optional text string appended after a modification
Returns: 1 on success, or "ERROR" on failure. Use ScribeLastError to get more information on the error.

ScribeVersion

Returns the version of the plugin which is installed.