User Guide

414 Dynamic Documents
Example
The following code snippet from a participant file shows a translator searchPatterns tag:
<searchPatterns whereToSearch="comment">
<searchPattern paramNames=",ssi_comment_includeUrl">
<![CDATA[/<!--\s*#include\s+(file|virtual)\s*=\s*"([^"]*)"\s*-->/i]]>
</searchPattern>
</searchPatterns>
The search pattern contains a JavaScript regular expression that specifies two submatches
(both of which are contained within parentheses). The first submatch is for the text string
file or virtual. The second submatch is a file reference.
To access the translator URL pattern, your code should look like the following example:
var serverModel = dw.getDocumentDOM().serverModel;
var includeArray = new Array();
includeArray = serverModel.getServerIncludeUrlPatterns();
The call to serverModel.getServerIncludeUrlPatterns() returns the following three
properties:
dom.serverModel.getServerInfo()
Availability
Dreamweaver MX.
Description
Returns information that is specific to the current server model. This information is defined
in the HTML definition file for the server model, which is located in the Configuration/
ServerModels folder.
fileRef
The 1-based index of the regular expression submatch that
corresponds to the included file reference.
type
The portion of the paramName value that remains after removing the
_includeUrl suffix. This type is assigned to the type attribute of the
<MM:BeginLock> tag. For an example, see Server Model SSI.htm in
the Configuration/Translators folder.
Property Return value
pattern /<!--\s*#include\s+(file|virtual)\s*=\s*"([^"]*)"\s*-->/i
fileRef 2
type ssi_comment
Property Description
000_DW_API_Print.book Page 414 Wednesday, July 20, 2005 11:58 AM