<-- Previous || Up || Next -->

Summarize Text Function
String Words Class

Public Function SummarizeText( _
      ByVal vValue As Variant _
    , Optional ByVal vSeparators As Variant _
    , Optional ByVal vCompare As Variant _
    , Optional ByVal vStableSort As Variant _
    , Optional ByVal vSeparator As Variant _
    , Optional ByVal vIgnoreWords As Variant _
    ) As Variant

Summarize the words within a paragraph.
Excess spaces are removed, words are sorted by their frequency, and certain words can be ignored.

    ? SummarizeText("This is a test.  This is also a test.", , , , "a an the")
    This is a test also
See also:
    SortWords Function
    SpecialSeparators Property
    StringSimilarity Function
    SummarizeTextSample Subroutine
vValue: String containing the words which are to be summarized. Function returns Null if vValue is Null or cannot be fixed up to a String.

vSpecialSeparators: String containing the "special" separators which describe how the characters of string vValue are formed into words. vSpecialSeparators defaults to the "special" separator string describing the ANSI Windows character set if it is missing or Null or cannot be fixed up to a String. The special separators string should contain one "special" character describing the classification of each character in the default character set. The character at position 1 (Mid$(vSpecialSeparators, 1, 1)) describes Chr$(0), the character at position 2 describes Chr$(1), etc.
The special separators string can contain the following four characters:

    " " (space)  Character will be ignored within the function like SummarizeText.
    "A"          Character is alphabetic.  Alphabetic characters are collected into words.
    "0" (zero)   Character is numeric.  Number characters are collected into numbers.
    "S"          Character is a symbol which will be considered to form its own word.
vCompare: Specifies the type of comparison used to determine if words match each other and specifies the sort order/collating sequence used to sort words (if vStableSort is False). vCompare defaults to Text comparisons (case-independent) if it is missing or Null or cannot be fixed up to a number, so that words like "This" will be considered duplicates of "this".

vSeparator: String used to separate words within both the string vIgnoreWords and the result string. vSeparator defaults to a space character if it is missing or Null or cannot be fixed up to a number.

vStableSort: True if words with the same frequency (the number of times that they appear within string vValue) should appear in the result in the same order in which they appear in vValue, or False if words with the same frequency are to be sorted alphabetically (according to vCompare). vStableSort defaults to True if it is missing or Null or cannot be fixed up to a number.

vIgnoreWords: List or words which are to be ignored (removed from the input string vValue). Words must be separated by the string vSeparator. vIgnoreWords defaults to an empty string if it is missing or Null or cannot be fixed up to a String.

Copyright 1996-1999 Entisoft
Entisoft Tools is a trademark of Entisoft.