ftmf Filter Syntax - Full-Text Retrieval (FTR) - Help

Full-Text Retrieval (FTR) Help

Language
English
Product
Full-Text Retrieval (FTR)
Search by Category
Help

The ftmf filter parameters allow you to change some of the default filter settings when the document is opened. The format of the filter with its optional parameters is:

ftmf[/c=[e|f]][/f= field number][/h=[d][i]]

[/i= translation][/nc][/sx= field number]

[/tp field number][/v][/z]

These parameters are interpreted as follows:

/c= setcode

The /c parameter is used to recognize WordPerfect documents prepared with the Europa3 character set. The /c parameter is specified in the following way:

/c=e

Parameter

Description

c=e

Set Extended Character Set flag to force usage of the UTF8_EFTCS character set for WordPerfect version 5 and 6 files.

c=f

Reset Extended Character Set flag.

The /i option takes precedence over the /c option in setting the character set.

/f

The /f option is used to specify the field number in which to store document format (FT_FORMAT) information. The default is field 102. If you specify /f, document format information is not stored.

/h

The /h parameter is used to choose whether or not hidden text is displayed and/or indexed. By default, hidden text is not displayed or indexed.

Parameter

Description

h=

Hidden text is not displayed and not indexed.

h=d

Hidden text is displayed but not indexed.

h=i

Hidden text is indexed but not displayed.

h=ior h=id

Hidden text is displayed and indexed.

All hidden text appears in the FTDF output stream. The /h parameter controls whether this text is surrounded by control sequences to suppress display and/or indexing. The hidden text display option has no effect on the original document data stream passed to high-fidelity viewers. These viewers do not display hidden text.

/i= translation

The /i parameter is used to override the default character set used to translate the document. The document is assumed to be in the character set specified by this parameter.

If the specified character set is a recognized alias, it is translated to either UTF8_FTCS or UTF8_EFTCS. Recognized aliases are:

Aliases for UTF8_FTCS

Aliases for UTF8_EFTCS

a

ASCII

e

c

MACINTOSH

EUROPA3

d

DOS

UTF8_EFTCS

i

ISO_LATIN1

n

WIN_LATIN1

x

ISO_LATIN2

y

WIN_LATIN2

UTF8_FTCS

If the specified character set is not a recognized alias, it is accepted literally. The supplied name must have an entry in the FULTEXT.FTC file.

If neither the /c nor /i options are specified, the character set is "default_ftmf", which must have an entry in FULTEXT.FTC.

/nc

The /nc option diverts all the summary fields that normally go to the catalog, such as author, size, and subject to the FTDF stream.

/s field = field number

The /s parameter controls how document summary information is stored in the FTR collection.

Field

Document Summary Field

a

Author

k

Keyword

s

Subject

t

Title

Field number is the collection field number. The defaults are:

Field

Default Field Number

Author

97

Keyword

104

Subject

107

Title

0 (Disabled)

/tp= field number

The /tp parameter specifies the field number to be used to store the total page count of the document. If this parameter is omitted, the total page count is not stored. If the /tp parameter is specified, then 1 plus the number of page breaks stored in the document is recorded as the page count in the field specified by the field number.

Depending on the document format, the type of page breaks used in the document can affect the page count. For more information, see Page Breaks.

/v

The /v option displays tag information that is normally hidden. Affected tags are:

Tag Type Value

Description

SCCCA_BOOKMARK

Delimits content tagged as a bookmark.

SCCCA_HYPERLINK

Delimits content tagged as a hypertext link.

SCCCA_COMPILEDFIELD

Tags content resulting from an application compiling a field code such as a date. The lack of consistent support by applications for this field makes it unreliable as a search property.

SCCCA_FOOTNOTEREFERENCE

Tags content that references a footnote.

SCCCA_ANNOTATIONREFERENCE

Tags content that references an annotation.

SCCCA_ENDNOTEREFERENCE

Tags content that references an endnote.

SCCCA_FRAME

Tags content stored within a frame.

SCCCA_INDEXENTRY

Delimits content that should be placed in the index.

SCCCA_LISTENTRY

Tags content for entry in a list.

SCCCA_CAPTIONTEXT

Tags content that is used as a caption on objects such as tables, equations, and figures.

SCCCA_VECTORSAVETAG

/z

The /z parameter disables binary file recognition. When this option is specified, ftmf does not block processing of binary files.

See Also

Supported Document Features
Unsupported Document Features