360Works Scribe 1.44 User Guide

For example, the following report:

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

• 2 blocks were added, for a total of 214 characters
• No modifications
• 1 deletion, of 47 characters

Custom Options

PDF Support

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

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

PDF Support

• PDFTitle - The document's title.
• PDFAuthor - The name of the person who created the document.
• PDFSubject - The Subject of the document.
• PDFKeywords - Keywords associated with the document.
• PDFCreator - The name of the application that created the document.
• PDFProducer - If the document was converted to PDF from another format, the name of the application that converted it to PDF.
• PDFCreationDate - The date and time the document was created, in human-readable form.
• PDFModDate - The date and time the document was most recently modified, in human-readable form.

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

Excel Support (Office 2007 format or later)

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

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

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

XML Support

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

• It can be empty, like this: ScribeDocSaveContainer(""). That tells Scribe to keep the original filename.
• It can be just a filename, like this: ScribeDocSaveContainer("MyNewFile.doc"). That tells Scribe to return a container field with this new filename.

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("") ]
 

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

• It can be empty, like this: ScribeDocSaveFile(""). That tells Scribe to save the modified file into a temporary directory, keeping the original filename.
• It can be just a filename, like this: ScribeDocSaveFile("MyNewFile.doc"). That tells Scribe to save the modified file into a temporary directory, with a new filename.
• It can be just a directory, like this: ScribeDocSaveFile( Get (DesktopPath) ). That tells Scribe to save the modified file into the specified directory, keeping the original filename.
• It can be a full path with a filename, like this: ScribeDocSaveFile( Get(DesktopPath) & "MyNewFile.doc" ). That tells Scribe to save the modified file into the specified directory with a new filename.

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.

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.

Word (.docx only) Best Practices

It is recommended for placeholders to be short and use all capital letters. It is also best not to use surrounding characters (%, <, etc.). If modification needs to be made to a placeholder, make sure to highlight the ENTIRE placeholder (%, <, included if you use them) first. This is due to how Word handles strings internally. If only a part of the placeholder string has been typed over, Word will store the string as separate XML blocks and will not be found using ScribeDocReplace.

It is also best practice if you see red or green underlines in the placeholder to fix them prior to attempting to use this function as well.

Saving the File

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

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

PDF Support

Word Support

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

Excel Support

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.

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

XML Support

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

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

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

Saving the File

Note:

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:

• onlyKnownTypes=0 or 1. If this is set to 1, then Scribe will return an empty value "" for unknown file types, instead of returning their raw contents. The default is 0.

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

• pdf
• doc, docx
• xls, xlsx
• ppt, pptx
• xml, xsd
• rtf
• htm, html
• JPEG (will read EXIF metadata)
• csv, txt, tab
• msg (Outlook emails)
• pages, key (Apple's Pages and Keynote documents '08 & '09)

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"
     )
 ]
     

Style, color and size

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")
 ]
 

 Set Field [ Globals::highlighted_text =
     ScribeHighlight(
         Documents::body ;
         "[0-9]+" ;
         "colorRGB=" & RGB(0;255;0) ;
         "styles=" + Italic"
     )
 ]
 

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

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.

     ScribePatternMatchAll(
         "Wilhelm¶wilson¶Williams¶Zander" ;
         "wil.*" ;
         "flags=includeLineEndings+caseInsensitive"
     )
     ScribePatternMatchAll(
         "Wilhelm¶wilson¶Williams¶Zander" ;
         "wil.*"
     )
 

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
 

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

The available styles are:

• Plain
• Bold
• Italic
• Underline
• Condense
• Extend
• Strikethrough
• SmallCaps
• Superscript
• Subscript
• Uppercase
• Lowercase
• Titlecase
• WordUnderline
• DoubleUnderline

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

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