1.2 Introduction
The use cases listed below were created by XML Query and XSL Working Groups, to illustrate important applications of full-text querying within an XML query language. Each use case exercises a specific functionality relevant to full-text querying. An XML Schema and sample input data are provided. Each use case specifies a query applied to the input data, a solution in XQuery, a solution in XPath (when possible), and the expected results.
The document supplements the XML Query Use Cases which can be found in the W3C XML Query Use Cases [XML Query Use Cases]. Use cases for character string querying are included in the XML Query Use Cases, not in this document.
The full-text queries in the following use cases are performed on text which has been tokenized, i.e., broken into a sequence of words, units of punctuation, and spaces.
A word is defined as any character, n-gram, or sequence of characters returned by a tokenizer as a basic unit to be queried. Each instance of a word consists of zero or more consecutive characters. Beyond that words are implementation defined. Note that consecutive words need not be separated by either punctuation or space, and words may overlap. A phrase is an ordered list of words. A phrase may contain any number of words.
Tokenization enables functions and operators which work with the relative positioning of words (e.g., proximity operators). Tokenization also enables functions and operators which operate on a part or the root of the word (e.g., wildcards, stemming).
These use cases:
(1) Present some possible functions and features for tokenized text support in XQuery and XPath. None are yet available in XQuery or XPath. Please comment on these use cases and recommend others.
(2) Illustrate simple and complex queries. The more complex queries would normally only be constructed by programmers, librarians, and other expert users, or provided for novice users via saved queries and graphical user interfaces. Each query is intended to illustrate a single functionality, although queries might overlap in their functionalities (e.g., phrases and ordered distance queries allowing no intervening words). Overlapping and similar functionalities are noted in the comments on query
behavior.
(3) Draw from sample data which are almost entirely in English. Use cases in other languages are solicited, especially where they illustrate language-specific implementations of functions and features. Among the most sought after are use cases for queries using prefix and infix wild cards, proximity queries, and operators and queries requiring functionality which may not have Western language equivalents.
(4) Include queries which in most instances can be written with pure Boolean full-text predicates or with scoring (e.g., scoring on the number of occurrences of a word or phrase, scoring on how close words are to one another within a distance query, scoring on how similar a word is to the one being stemmed) [BYR99] [HTK00]. A few, those in Section 17 (SCORE), cannot be written with Boolean full-text predicates. Scoring methodologies will not be defined
in this recommendation. Scoring will be implementation defined. Results are provided in document order, except those in Section 17 (SCORE). Results could be returned ordered differently, such as by relevance (based on implementation defined scoring) or explicitly by element.
(5) Query element content. See Section 4 (OTHER) for explicit queries on attribute values.
(6) Include queries which are case-insensitive. When returning a paragraph, the text is returned as it occurs in the data model. This approach was chosen to keep the sample data short and the expected results meaningful. It would have be equally valid to return only the character queried. A case-sensitive query is found in Section 9 (CHARACTER).
(7) Include queries which when they target XML elements are understood, unless otherwise stated, to query text within any text node descendant of the element.
(8) Include queries which return only elements and attributes which meet all the conditions specified in the query. In particular, Boolean queries return results where the Boolean conditions in the query are satisfied, i.e., are used to select what is being returned to users.
Query results may be returned in different ways. From a query for books containing the word "usability", users might be interested in returning, for each book containing the word "usability", its number and its entire content. In another situation for the same query, users might be interested in returning, for each book containing the word "usability", its number and only the elements and attributes in the content which contain the word "usability". As in this second situation, the queries in
these use cases return only elements and attributes which meet all the conditions specified in the query.
The Return clause may also include additional or different elements and attributes if specified, and may construct new elements.
(9) Include queries which provide some of the basic functionality of fuzzy match querying (e.g., wildcards, stemming, thesaurus support, proximity).
(10) Provide highlighting of found words and phrases in the expected results of queries as an aid to users. The presence of highlighting says nothing about whether highlighting will be a feature of XQuery or XPath full-text querying.
(11) Display query solutions in XQuery and when possible in XPath. Queries which may not be written in XPath include those which contain element constructors, and cannot be written without let and order by clauses.
Examples of full-text querying functionalities for XML query languages can be found in [FGR01], [HTK00], [MJK98], [SCH01] and [TWE00].
To make the output more readable, the output of queries has been formatted using white space which may not be returned by a query processor. This white space should not be considered normative for the correctness of results.
These use cases represent a snapshot of an ongoing work. Some important operators and features are not yet adequately covered by a use case. The XML Query and XSL Working Groups reserve the right to add, delete, or modify individual queries or whole use cases as the work progresses. The presence of a query in this set of use cases does not necessarily indicate that the query will be expressible in XQuery [XQuery 1.0: An XML Query Language] and/or XPath [XML Path Language (XPath) 2.0] to be created by the XML Query and XSL Working Groups.
1.3 Presentation of Use Cases
The queries in these use cases are presented in the following format:
Query number Query title
User statement of query
Statement of functionality illustrated by query
-
Operands: Parts of words, words, phrases
-
Functionality: Operators, functions, collations, other functionality
-
Data context: One XPath expression locating the data being queried.
-
Query context: One or more XPath expressions locating the elements and attributes to be queried. The context of elements and attributes used in the Query context is relative to the Data context defined above.
-
Return: One or more XPath expressions which are returned only if the conditions specified in the query are met. Returned elements or attributes may differ from those specified in the Query context. Newly constructed elements might be returned. As in the Query context, the context of elements and attributes in Return statements is relative to the Data context defined above.
-
Comments: Comments on query behavior in general, and against the sample data in particular, plus the rationale for including this query in the use cases.
Solution in XQuery:
Solutions illustrating XQuery Full-Text syntax
appear here. All queries may be written in XQuery.
Solutions are written to return Boolean full-text predicates
and not to invoke scoring, except for those in Section 17 (SCORE),
however all the queries in the document may be written as scored
queries with the addition of a score clause.
All queries are written assuming the default function namespace,
without the fn: prefix.
See Issue 1 [staticErrorTesting]: The queries in the Full-Text Use Cases have not yet been tested to ensure they do not cause static errors, such as cardinality errors.
Solution in XPath:
Solutions illustrating XPath Full-Text syntax appear
(when the query may be written in XPath) here.
Solutions are written to return Boolean full-text predicates
and not to invoke scoring, except for those in Section 17 (SCORE),
however all the queries in the document may be written as scored
queries with the addition of a score clause.
All queries are written assuming the default function namespace,
without the fn: prefix.
See Issue 1 [staticErrorTesting]: The queries in the Full-Text Use Cases have not yet been tested to ensure they do not cause static errors, such as cardinality errors.
Expected Result:
Results are provided here.
Found words and phrases are highlighted.
For brevity, only the elements and attributes which meet
the conditions specified in the query are displayed. Others are
replaced with ...s.
Results are provided in document order, except those
in Section 17 (SCORE)
1.5 Sample Data
The data consists of a collection of three books. Two are primarily instructive text. The third is a guide to a manuscript collection. All contain metadata and full text.
The sample data binds to this URL: "http://bstore1.example.com/full-text.html".
<books>
<book number="1">
<metadata>
<title shortTitle="Improving Web Site Usability">Improving
the Usability of a Web Site Through Expert Reviews and
Usability Testing</title>
<author>Millicent Marigold</author>
<author>Montana Marigold</author>
<publicationInfo>
<place>New York</place>
<publisher>Ersatz Publications</publisher>
<dateIssued>2001</dateIssued>
<dateRevised>2002</dateRevised>
</publicationInfo>
<price>25.99</price>
<subjects xml:lang="en">
<subject>Usability testing</subject>
<subject>Web site development</subject>
<subject>Heuristic evaluation</subject>
<subject>Cognitive walk-through</subject>
<subject>Web site usability</subject>
</subjects>
<subjects xml:lang="fr">
<subject>Tests d'ergonomie</subject>
<subject>Développement de site web</subject>
<subject>Évaluation heuristique</subject>
<subject>Parcours cognitif</subject>
<subject>Ergonomie de site web</subject>
</subjects>
<subjects xml:lang="zh">
<subject>可用性测试</subject>
<subject>网站建置</subject>
<subject>启发式评价</subject>
<subject>认知推演</subject>
<subject>网站可用性</subject>
</subjects>
</metadata>
<content>
<introduction>
<author>Elina Rose</author>
<p>The usability of a Web site is how well the
site supports the user in achieving specified
goals. A Web site should facilitate learning,
and enable efficient and effective task
completion, while propagating few errors.
Satisfaction with the site is also important.
The user must not only be well-served, but must
feel well-served.</p>
<p>Expert reviews and usability testing are
methods of identifying problems in layout,
terminology, and navigation before they frustrate
users and drive them away from your site.</p>
<p>The most successful projects employ multiple
methods in multiple iterations. As Millicent
Marigold remarked during a recent conference,
"Don't stop. Iterate, iterate, then iterate
again."</p>
<p>This book has been approved by the Web Site
Users Association.</p>
</introduction>
<part number="1">
<title>Expert Reviews</title>
<introduction>
<p>Expert reviewers identify problems
and recommend changes to web sites based
on research in human computer interaction
and their experience in the field.</p>
<p>Two expert review methods are discussed
here. They are heuristic evaluation and
cognitive walk-through.</p>
<p>Expert review methods should be
initiated early in the development process,
as soon as paper <b>p</b>rototypes
(hand-drawn pictures of Web pages) or
<b>w</b>ireframes (electronic mockups) are
available. They should be conducted using
the hardware and software similar to that
employed by users.</p>
</introduction>
<chapter>
<title>Heuristic Evaluation</title>
<p>Expert reviewers critique an interface to
determine conformance with recognized
usability principles. <footnote>One of the
best known lists of heuristics is <citation
url="http://www.useit.com/papers/heuristic
/heuristic_list.html">Ten Usability
Heuristics by Jacob Nielson</citation>. Another
is <citation url="http://usability.gov
/guidelines/index.html"> Research-Based Web
Design and Usability Guidelines</citation>
</footnote></p>
</chapter>
<chapter>
<title>Cognitive Walk-Through</title>
<p>Expert reviewers evaluate Web site
understandability and ease of learning while
performing specified tasks. They walk through
the site answering questions such as "Would a
user know by looking at the screen how to
complete the first step of the task?" and "If
the user completed the first step, would the
user know what to do next?," with the goal of
identifying any obstacles to completing the
task and assessing whether the user would
cognitively be aware that he was successful in
completing a step in the process.</p>
</chapter>
</part>
<part number="2">
<chapter>
<title>Usability Testing</title>
<p>Once the problems identified by expert
reviews have been corrected, it is time to
conduct some tests of the site with your unique
audience or audiences by conducting usability
testing.</p>
<p>Users are asked to complete tasks which
measure the success of the information
architecture and navigational elements of the
site.</p>
<p>Then changes are made to improve service to
users.</p>
</chapter>
</part>
</content>
</book>
<book number="2">
<metadata>
<title shortTitle="Usability Basics">Usability
Basics: How to Plan for and Conduct Usability Tests
on Web Site Thereby Improving the Usability of Your
Web Site</title>
<publicationInfo>
<place>New York</place>
<publisher>Ersatz Publications</publisher>
<publisher>Electronic BookWorks</publisher>
<dateIssued>2000</dateIssued>
<dateRevised>2001</dateRevised>
</publicationInfo>
<price>174.00</price>
<subjects xml:lang="en">
<subject>Usability testing</subject>
<subject>Web site development</subject>
<subject>Guides and finding aids</subject>
</subjects>
<subjects xml:lang="fr">
<subject>Tests d'ergonomie</subject>
<subject>Développement de site web</subject>
<subject>Guides et outils de recherche</subject>
</subjects>
<subjects xml:lang="zh">
<subject>可用性测试</subject>
<subject>网站建置</subject>
<subject>指南和检索工具</subject>
</subjects>
</metadata>
<content>
<introduction>
<p>This is a basic handbook for planning and
conducting usability tests on Web sites. Usability
testing should be used in conjunction with other
expert review methods.</p>
<p>This book has not been approved by the Web Site
Users Association.</p>
</introduction>
<part number="1">
<chapter>
<title>Planning then Conducting Usability
Tests</title>
<p>Take the following steps to plan usability
testing. <step number="1">Clarify and
articulate the goal of the usability testing.
</step> <step number="2">Identify tasks which
are critical for users to be able to complete
successfully.</step> <step number="3">Compile
a script of questions or instructions which
will prompt the user to attempt those
tasks.</step> <step number="4">Identify your
users and begin recruiting them.</step> <step
number="5">Conduct a pretest on a few users.
</step> <step number="6">Edit the script based
on insights gleaned from the pretest.</step>
<step number="7">Resume testing.</step></p>
</chapter>
</part>
<part number="2">
<chapter>
<title>Conducting Usability Tests</title>
<p>Users can be tested at any computer
workstation <footnote>They may be most
comfortable at their own workstation.
</footnote> or in a lab.</p>
<p>Give the user the script, then assure them
that you are testing the Web site, not them.
Users are asked to verbalize their thoughts as
they complete the tasks. The event is recorded
or someone takes notes. It is often preferable
to have two testers, <footnote>Usability
testing can be done at great expense or on a
shoe string, using <testingProcedure>in-house
expertise</testingProcedure> or
<testingProcedure>contracting with human
computer interaction professionals
</testingProcedure>.</footnote> one to ask the
questions, another to take notes. Testers should
offer no guidance or comments to the user. Mouse
movements, typing, expressions, and the user's
words should be recorded.</p>
</chapter>
<chapter>
<title>Evaluating and Implementing Results</title>
<p>Compile the results and review collectively.
Make changes to the site to alleviate the problems
found in Web site components which were propagating
the largest number of or the most devastating errors.
Begin new iterations of testing and changes, until
users are successful in the accomplishing the
tasks.</p>
</chapter>
</part>
</content>
</book>
<book number="3">
<metadata>
<title shortTitle="Usabilityguy Manuscript
Guide">John Wesley Usabilityguy: A Register of His
Papers</title>
<author>Millicent Marigold</author>
<author>Morty Marigold</author>
<publicationInfo>
<place>Washington, D.C.</place>
<publisher>Ersatz Manuscript Library</publisher>
<dateIssued>1998</dateIssued>
<dateRevised>2002</dateRevised>
</publicationInfo>
<price>21.49</price>
<subjects xml:lang="en">
<subject>Computers</subject>
<subject>Software evaluation</subject>
<subject>Usability testing</subject>
<subject>Manuscript collections</subject>
</subjects>
<subjects xml:lang="fr">
<subject>Ordinateurs</subject>
<subject>Évaluation de logiciels</subject>
<subject>Tests d'ergonomie</subject>
<subject>Collections de manuscrits</subject>
</subjects>
<subjects xml:lang="zh">
<subject>计算机</subject>
<subject>软件评价</subject>
<subject>可用性测试</subject>
<subject>手稿专藏</subject>
</subjects>
</metadata>
<content>
<introduction>
<p>The papers of John Wesley Usabilityguy span the
years 1946-2001, with the bulk of the items
concentrated in the period from 1985 to 2001. The
papers feature his career as a developer of software
applications and usability specialist. The collection
consists of correspondence, memoranda, journals,
speeches, article drafts, book drafts, notes, charts,
graphs, family papers, clippings, printed matter,
photographs, résumés and other materials.</p>
</introduction>
<part number="1"><container type="box">1-12</container>
<title>Subject File, <date normalize="1930/1974">
1930-1974</date></title>
<introduction>
<p>Correspondence, telegrams, memoranda, journals,
logs, testimony, approved travel orders, invitations,
charts, graphs, forms, biographical data, photographs,
book drafts, clippings and other printed matter,
résumés and miscellaneous material. Organized by
name of person or organization, topic, or type of
material.</p>
</introduction>
<component><container type="box">1</container>
<componentTitle>Computers</componentTitle>
<subComponent>
<componentTitle>Software,
<componentDate normalize="1946/1947">1946-1947
</componentDate>
</componentTitle>
</subComponent>
<subComponent>
<componentTitle>Human Computer Interaction
research, <componentDate normalize="1945/1952">
1945-1952</componentDate>
</componentTitle>
<subsubComponent>
<componentTitle>Flow diagram,
<componentDate normalize="1950">1950
</componentDate>
</componentTitle>
</subsubComponent>
<subsubComponent>
<componentTitle>General,
<componentDate normalize="1947/1951">1947-1951
</componentDate>
</componentTitle>
</subsubComponent>
<subsubComponent><container type="box">2</container>
<componentTitle>Eye Movement research,
<componentDate normalize="1949/1950">1949-1950
</componentDate>
</componentTitle>
</subsubComponent>
<subsubComponent>
<componentTitle>User profiling,
<componentDate normalize="1950/1959">1950s
</componentDate>
</componentTitle>
</subsubComponent>
</subComponent>
</component>
<component>
<componentTitle>Web User Appreciation Award,
<componentDate normalize="1956">1956</componentDate>
</componentTitle>
</component>
</part>
<part number="2"><container type="box">3-5</container>
<title>Writings File,
<date normalize="1985/1999">1985-1999</date>
</title>
<introduction>
<p>Correspondence, articles, book drafts, notes,
contracts, clippings, and printed matter. Arranged
alphabetically by type (articles, books, reports,
and miscellaneous) and therein alphabetically by
type of material, subject, or title.</p>
</introduction>
<component>
<componentTitle>Writings by Usabilityguy
</componentTitle>
<subComponent>
<componentTitle><componentDate normalize="1996">
1996</componentDate>
</componentTitle>
<subsubComponent>
<componentTitle>"How Many Users Are Enough
for User Testing?"</componentTitle>
</subsubComponent>
<subsubComponent>
<componentTitle>"How to Evaluate Results from
User Tests."</componentTitle>
</subsubComponent>
<subsubComponent>
<container type="box">5</container>
<componentTitle>"When Are You Done Testing?"
</componentTitle>
</subsubComponent>
<subsubComponent>
<componentTitle>"Do-It-Yourself User Testing"
</componentTitle>
</subsubComponent>
</subComponent>
</component>
<component>
<componentTitle>Charitable Contributions
</componentTitle>
<subComponent>
<componentTitle>Diseases: AIDS, Hepatitis,
Tuberculosis <componentDate normalize=
"1990/1999">1990-1999</componentDate>
</componentTitle>
</subComponent>
<subComponent>
<componentTitle>Environmental Conservation:
Rivers <componentDate normalize="1995">1995
</componentDate>
</componentTitle>
</subComponent>
</component>
</part>
</content>
</book>
</books>