REST Service Interface

Taporware Rest service uses plain text HTTP protocol so that you can submit your request use either POST or GET method.

• Service URI: http://tapor1-dev.mcmaster.ca/~restserv/html/listwords.
• Parameters:
  • htmlInput -- any HTML text
  • htmlTag --- any valid HTML tag in your submitted HTML text
  • listOption -- a HTML single valued selection control (select or radio control). The values are same as parameter "range" in the CGI interface above.
  • optionSeletion -- values depend on the "list option"
  • sorting -- a select control. The values are same as parameter "sorting" in the CGI interface above
  • outFormat -- a select control for output format. The values are same as parameter "display" in the CGI interface above
• See sample interface in http://tapor1-dev.mcmaster.ca/~restserv/html/listwordtool

• Endpoint URL: http://taporware.mcmaster.ca:9982
• Service URI: http://taporware.mcmaster.ca/~taporware/webservice

Predefined Parameter Values in Tool Bar

Predefined parameter values in Tool Bar

• Source: the page the user is currently in.
• Element: body or set by site owner
• Words listed: all words except the glasgow stop-list
• Stemmer: use inflectional stemmer to process all the words before listing
• Sorting: by frequency
• Display format: HTML

Term Defination

• stop words: Words ignored in a query because they are so commonly used that they can't contribute to relevancy. Includes conjunctions, prepositions, and articles such as and, to and a.

• pattern: A sequence of characters used either with regular expression notation or for path name expansion, as a means of selecting various character strings or path names, respectively. Values are matched against patterns to see if they should be included/excluded. In patterns "*" matches any string, "?" matches any single character.

Use List Words TAPoRware Tool in Your Web Page

You can add a button in your web page to list all the words in that page by call TAPoRware cgi script.

Here is the code for this function

<form method="post" name="textForm" enctype="multipart/form-data" action="http://taporware.mcmaster.ca/~taporware/cgi-bin/prototype/tlistword.cgi" onsubmit="document.textForm.texturl.value=document.location.href">

<input type="hidden" name="source" value="url">

<input type="hidden" name="texturl">

<input type="hidden" name="freetext" value="yes"/>

<input type="hidden" name="range" value="all" />

<input type="hidden" name="sorting" value="2">

<input type="hidden" name="display" value="1">

<input type="hidden" name="taporface" value="new">

<input type="submit" name="doIt" value="List All Words of the Page">

</form>

• Service Method: list_Words_HTML

• Obtain HTML string by URL or from user's local disk

• Extract words based on user specified criteria if necessary

• Sort and count words with similar letters ignoring capitalization
• Extract words based on user specified criteria
• Generate output format based on user's selection

• Enter a valid URL in the URL field or enter a local upload html text
• Enter a valid html tag or tag list seperated by comma, default is "body"
• Select which list you want to get and enter the corresponding text if necessary
• Select sorting criterion
• Select output format
• If you want the results displayed in the same window with taporware interface, uncheck the check box - "Open results in new window"
• Finally, click the "Submit" button

• URL: http://taporware.mcmaster.ca/cgi-bin/prototype/hlistword.cgi

Here are the parameters:

• Endpoint URL: http://strange.mcmaster.ca:9982
• Service URI: http://strange.mcmaster.ca/~taporware/webservice
• Service Method: find_Collocation_Plain
• parameters:
  • htmlInput -- any html string
  • htmlTag -- any html element (tag) name or multple html element name separated by comma
  • listOption -- values are same as parameter "range" in the CGI interface above
  • optionSeletion -- values are corresponding to the "list option"
  • sorting -- values are same as parameter "listsort" in the CGI interface above
  • outFormat -- values are same as parameter "listdisp" in the CGI interface above

• Tokenize text into words using spaces and punctuation marks
• Count words with similar letters ignoring capitalization

• There should be a setting to preserve capitalization so that "Canadian" and "canadian" would be two different words.
• We need to check multilingual texts - how are accents being handled?

List Words

See http://taporware/~taporware/htmlTools/listword.shtml

Description

History

Pseudocode

Ways of Using

CGI Interface

Web Service Interface

Known Bugs

To Do

-- MattPatey - 13 Oct 2005