# Patent

## Title
Providing contextually sensitive tools and help content in computer-generated documents

## Abstract

A method and system are provided for creation, implementation, and use of computer-generated “smart” documents to which functionality is attached for providing contextually sensitive tools, controls and help content to users of those documents. Portions of documents are annotated with Extensible Markup Language (XML) tags and structure so that when a user enters those portions, such as by placing a computer cursor in those portions, the user is provided contextually sensitive tools, controls and/or help content. A document tools pane may open on the user's computer screen adjacent to the document being edited for providing the document tools, controls or help content related to the context of the text or data in which the cursor is located. If the user moves the cursor to another portion of the document, the user may obtain information associated with the context of the new portion of the document in which the cursor is located.

## Background
TECHNICAL FIELD
This invention relates to the provision of contextually sensitive tools and help content in computer-generated documents.
BACKGROUND OF THE INVENTION
Computer software applications allow users to create a variety of documents to assist them in work, education, and leisure. For example, popular word processing applications allow users to create letters, articles, books, memoranda, and the like. Spreadsheet programs allow users to store, manipulate, print, and display a variety of alpha-numeric data. Such applications have a number of well-known strengths, including rich editing, formatting and calculation.
However, documents created by such software applications do not provide users with contextually sensitive tools, help content, or support. That is, as the user is entering text or data into such software applications, these applications do not provide the user with helpful tools or assistance based on the context of the text or data being entered by the user. Internet web-based applications attempt to solve some business problems through the creation and deployment of web-based templates with which users may enter information that may be transmitted to a back-end web server for the purpose of registering the user for some type of service. Such web-based applications often may include links with which the user may navigate to a separate web site for helpful information or assistance with the current web-based application or document in use by the user. However, such web-based applications suffer compared to the aforementioned software application documents in that modem web-based applications seldom offer rich editing, formatting, printing, and calculation.
By way of example, in a typical setting, a user may decide to prepare a resumé using a word processing application loaded on her home computer. As the user prepares the resumé, she likely will fill in such sections such as “personal information,” “education,” “experience,” and “extra-curricular activities.” As the user is completing each of those sections, she may require assistance, including information on the preferred ordering of the sections, information on the preferred number of past jobs to place in the “experience” section, and the like. In order to receive such assistance, the user likely must read a book on resumés, or go online to an internet-based resumé help site for the information.
In contrast, the user may enter an internet-based resumé site to complete a resumé using a web-based resumé template. The user may be allowed to enter specific information in given data fields, and the user may be provided with internet web site links for navigating to sites where she may obtain assistance with various sections of the document. When the user has completed preparation of the web-based resumé, the user may be allowed to submit the resumé to some web-based job service, or the user may be able to print the template. However, the functionality of the user's word processing application, such as rich editing and formatting of the resumé, is likely not available to the user given the limitations of the web-based application in contrast to the user's computer-based word processor.
It is with respect to these and other considerations that the present invention has been made.
SUMMARY OF THE INVENTION
The present invention provides a method and system for creating, implementing and using computer-generated documents that provide contextually sensitive tools, controls and help content to the user(s) of those documents. Generally described, a schema is attached to a document defining permissible data content, data type and data structure for the document. The document is structured to associate the document with the schema, and a solution is associated with the document structure. A plurality of software components is assembled for providing the solution to the document, and the document is enabled to call the plurality of software components for providing the solution to the document based on an editing position in the document.
After the document is created, a software application for opening the document may be booted to initiate opening the document. A determination is made as to whether the document refers to the solution. A determination is made as to whether the plurality of software components for providing the solution is present in a library of software components. If so, the plurality of software components is called for providing the solution to the document.
Once the document is opened for use, focusing document editing in a particular portion of the document, such as by placing the cursor in a particular portion of the document, causes the generation of a list of Extensible Markup Language (XML) elements enclosing a position of the editing focus. A determination is made as to whether any available solutions are associated with the list of XML elements. If any available solutions are associated with the list of XML elements, each associated solution is called and is obtained for use by the document. Preferably, the solutions comprise help content and document tools associated with the context of the editing position in the document. A graphical user interface is launched for displaying each solution obtained for use by the document.
These and other features, advantages, and aspects of the present invention may be more clearly understood and appreciated from a review of the following detailed description of the disclosed embodiments and by references to the appended drawings and claims.



BRIEF DESCRIPTION OF THE DRAWINGS
FIG. 1 is a computer screen display of a software application graphical user interface through which is displayed a document and associated contextually sensitive tools and help content according to an embodiment of the present invention.
FIG. 2 is a block diagram illustrating client-side software architecture for use in conjunction with an embodiment of the present invention.
FIG. 3 is a block diagram of a computer and associated peripheral and networked devices that provide an exemplary operating environment for the present invention.
FIG. 4 is a flow chart illustrating a method for creating a document that provides contextually sensitive tools and help content according to an embodiment of the present invention.
FIG. 5 is a flow chart illustrating a method for opening a document created in accordance with an embodiment of the present invention.
FIG. 6 illustrates a computer-generated dialog box for offering multiple document solutions to a user.
FIG. 7 illustrates a computer-generated dialog box for assisting a user with downloading components to an application created in accordance with the present invention.
FIG. 8 is a flow chart illustrating a method of determining what content to display in a document tools pane according to an embodiment of the present invention.



DETAILED DESCRIPTION
The present invention is directed toward creation, implementation and use of computer-generated “smart” documents to which functionality is attached for providing contextually sensitive tools, help content and controls to users of those documents. According to an embodiment of the invention, portions of documents are structured so that when a user enters those portions, such as by placing a computer cursor in those portions, the document points to a solution that may provide the user contextually sensitive tools and/or help content. For example, if a user is preparing a resumé to assist her in obtaining a job, the user may place her computer cursor in the “education” section the resumé. According to the present invention, the placement of computer cursor in the “education” section may provide the user with contextually sensitive information. The document may point to an overall solution, e.g., a resumé document solution, or individual portions of the document may point to contextual subsets of the solution, e.g., and “experience” section solution of a resume document solution. A document tools pane may open on the user's computer screen adjacent to the document being edited and may provide a narrative on suggested approaches for the completion of the “education” section. If the user moves the cursor to another portion of the document, for example to the “objectives” section of the resumé, the user may obtain information associated with that context, such as examples of proper employment objectives statements.
It should be understood that the contextually sensitive tools and help content provided to a user in accordance with an embodiment of the present invention may be provided for a variety of software application programs, including word processors, spreadsheets, web browsers, text editors, and the like. Moreover, the types and content of helpful information and tools provided to a user according to an embodiment of the present invention may include a variety of tools and actions and help information as desired by the creator of the software applications in use by the user.
Referring to FIG. 1, a computer screen display is illustrated showing an exemplary software application 100 with which a document and associated document tools pane providing document tools and help content is illustrated. The document 110 depicted in FIG. 1 shows an employee annual performance review template with which an employ may complete her annual performance review or with which she may complete a performance review of one of her employees. The application 100 depicted in FIG. 1 is a word processing application used for displaying and editing the document 110, but as should be understood by those skilled in the art, the application 100 could include other software applications, including spreadsheet applications, text editing applications, and the like. Moreover, the document 110 illustrated in FIG. 1 depicts an annual performance review document, but the document 110 could include a variety of other documents and templates edited by the user, including resumé templates, will templates, desktop publishing documents, letters, financial spreadsheets, and the like.
Referring to the exemplary document shown in FIG. 1, the word processing application 100 provides typical functionality associated with a word processor, accessible via drop down menus such as, File, Edit, View, Insert, Format, etc. The document 110 is displayed in the work area of the application 100, and a document tools pane 135 is illustrated to the right of the document 110. As should be understood, the display illustrated in FIG. 1 is by way of example only, and the components illustrated in FIG. 1 may be organized in a variety of different ways pleasing to the user. That is, the document tools pane may be located on the bottom of the screen display, to the left of the document 110, or according to other orientations allowed by the application 100.
A detailed discussion of the creation and implementation of the “smart” document 110 illustrated in FIG. 1 follows below, but generally described according to an embodiment of the present invention, once the user places her computer cursor within a particular section of the document 110, for example the “objectives” section 125 illustrated in FIG. 1, the user is provided with tools and help content in the document tools pane 135. For example, if the user places her computer cursor in the “objectives” section 125, the user may be provided with “Objective Writing Tips” 155 shown in the document tools pane 135. Selection of the “Objective Writing Tips” 155, as illustrated in FIG. 1, causes a display of “Objective Writing Tips” text 160 that provide the user with helpful information as to how to complete the “objectives” section the performance review document 110, illustrated in FIG. 1. If the user moves the cursor to a different section of the document, for example the personal information section 120, information provided in the document tools pane 135 will be provided to give the user assistance with the completion of the personal information section 120.
In addition to helpful information to assist the user, a variety of document tools and actions 145 are provided. For example, the “Submit Review” action may allow the user to submit the completed document 110 to her supervisor or to her employee after completion of the document. The “Open Last Review” action may allow the user to open the last performance review so that she may determine whether she completed her objectives as set forth in the last review. If the document in use by the user is some other type of document, for example a resumé document, helpful information in the document tools pane might include information on preparing the “education” section, the “experience” section, and/or the “personal information” section. A will document 110 might be associated with helpful information regarding legal rules for preparation of wills, rules regarding estate beneficiaries, and the like.
In addition to the document actions and help content illustrated in the pane 135, a variety of document controls may be provided, including radio buttons, text boxes, check boxes, ActiveX controls, XML tree controls, and the like. For example, a text box may be provided to allow a user to select from a list of pre-written text items. Or, the user may be allowed to enter text in a list box provided in the pane 135 that will then be inserted into the document or used by the application with respect to some other functionality of the application. A radio button or check box may be provided to allow the user to select from different choices of document actions or help content. For example, if the document is a will, check boxes may be provided with which the user may select “married,” “single,” etc., to obtain help information based on the user's personal will and estate profile.
Referring to FIG. 2, a general system architecture for creating and utilizing a “smart” document 110 in accordance with the present invention is illustrated. A software application 100, as described above, is opened on the user's computer 20 to create or edit a document 110 according to the present invention. A schema library 105 is provided for containing all of the executable files required for providing the contextually sensitive functionality to the document 110. For example, the schema library may include a variety of components, including individual modular software routines that have been compiled and dynamically linked and that are ready to use by the application 100 for providing contextually sensitive functionality to the document 110.
Such components may include a number of dynamically-linked libraries (dll), which include executable files or routines stored separately from the software application 100. The dlls are loaded by the software application 100 only when they are needed to provide functionality to the document 110. Additionally, as described in detail below, the schema library 105 may include a number of Extensible Markup Language (XML) files for providing contextually sensitive functionality in association with XML structure that has been applied to the document 110.
A solution property 115 is included in the document 110 for pointing the document to a particular solution contained in the schema library 105. The solution location property 118 provides the document 110 and the application 100 with information as to the location of the solution property in the schema library or to a remote location provided via a distributed computing environment, such as is provided from a web-based server via the Internet.
According to the present invention, and as described in detail below, when a user focuses on a particular portion of the document 110, such as the “objectives” section of the performance review document 110 illustrated in FIG. 1, a solution property 115 points the document to the “objectives” section help solution illustrated in the document tools pane 135. The solution location 118 provides the document 110 and the application 100 with the location of the components, dlls, or XML files necessary for implementing that solution. As should be understood, exemplary components may include components for drawing the document tools pane 135, components for displaying the information associated with the particular context, in this case the “objectives” section, and components for executing document actions such as “Submit Review” action 145.
FIG. 3 and the following discussion are intended to provide a brief, general description of a suitable computing environment in which the invention may be implemented. While the invention will be described in the general context of an application program that runs on an operating system in conjunction with a personal computer, those skilled in the art will recognize that the invention also may be implemented in combination with other program modules. Generally, program modules include routines, programs, components, data structures, etc. that perform particular tasks or implement particular abstract data types. Moreover, those skilled in the art will appreciate that the invention may be practiced with other computer system configurations, including hand-held devices, multiprocessor systems, microprocessor-based or programmable consumer electronics, cell phones, minicomputers, mainframe computers, and the like. The invention may also be practiced in distributed computing environments where tasks are performed by remote processing devices that are linked through a communications network. In a distributed computing environment, program modules may be located in both local and remote memory storage devices.
With reference to FIG. 3, an exemplary system for implementing the invention includes a conventional personal computer 20, including a processing unit 21, a system memory 22, and a system bus 23 that couples the system memory to the processing unit 21. The system memory 22 includes read-only memory (ROM) 24 and random access memory (RAM) 25. A basic input/output system 26 (BIOS), containing the basic routines that help to transfer information between elements within the personal computer 20, such as during start-up, is stored in ROM 24. The personal computer 20 further includes a hard disk drive 27, a magnetic disk drive 28, e.g., to read from or write to a removable disk 29, and an optical disk drive 30, e.g., for reading a CD-ROM disk 31 or to read from or write to other optical media. The hard disk drive 27, magnetic disk drive 28, and optical disk drive 30 are connected to the system bus 23 by a hard disk drive interface 32, a magnetic disk drive interface 33, and an optical drive interface 34, respectively. The drives and their associated computer-readable media provide non-volatile storage for the personal computer 20. Although the description of computer-readable media above refers to a hard disk, a removable magnetic disk and a CD-ROM disk, it should be appreciated by those skilled in the art that other types of media which are readable by a computer, such as magnetic cassettes, flash memory cards, digital video disks, Bernoulli cartridges, and the like, may also be used in the exemplary operating environment.
A number of program modules may be stored in the drives and RAM 25, including an operating system 35, one or more application programs 100, a word processor program module 37 (or other type of program module), program data, such as the manifest 38, and other program modules (not shown).
A user may enter commands and information into the personal computer 20 through a keyboard 40 and pointing device, such as a mouse 42. Other input devices (not shown) may include a microphone, joystick, game pad, satellite dish, scanner, or the like. These and other input devices are often connected to the processing unit 21 through a serial port interface 46 that is coupled to the system bus, but may be connected by other interfaces, such as a game port or a universal serial bus (USB). A monitor 47 or other type of display device is also connected to the system bus 23 via an interface, such as a video adapter 48. In addition to the monitor, personal computers typically include other peripheral output devices (not shown), such as speakers or printers.
The personal computer 20 may operate in a networked environment using logical connections to one or more remote computers, such as a remote computer 49. The remote computer 49 may be a server, a router, a peer device or other common network node, and typically includes many or all of the elements described relative to the personal computer 20, although only a memory storage device 50 has been illustrated in FIG. 3. The logical connections depicted in FIG. 3 include a local area network (LAN) 51 and a wide area network (WAN) 52. Such networking environments are commonplace in offices, enterprise-wide computer networks, intranets and the Internet.
When used in a LAN networking environment, the personal computer 20 is connected to the LAN 51 through a network interface 53. When used in a WAN networking environment, the personal computer 20 typically includes a modem 54 or other means for establishing communications over the WAN 52, such as the Internet. The modem 54, which may be internal or external, is connected to the system bus 23 via the serial port interface 46. In a networked environment, program modules depicted relative to the personal computer 20, or portions thereof, may be stored in the remote memory storage device. It will be appreciated that the network connections shown are exemplary and other means of establishing a communications link between the computers may be used.
FIG. 4 is a flow chart illustrating a method of creating a “smart” document 110 according to an embodiment of the present invention. The method 300 begins at start step 305 and proceeds to step 310 where an XML schema is attached to the document. As is understood by those skilled in the art, a schema sets up the grammar and rules associated with Extensible Markup Language (XML) tags applied to the document 110 to provide XML structure to the document 110. The schema attached to the document 110 illustrated in FIG. 1 may set out all of the grammatical, data type and data content rules allowed for tags associated with the document 110. For example, the “personal information” section 120, which includes the name, e-mail name, title, and employee identification for the employee, may have schema that requires that data entered into the “name” block must be in the form of “first name,” followed by “middle name,” followed by “last name.”
As understood by those skilled in the art of Extensible Markup Language usage, once that portion of the document 110 is annotated with XML structure corresponding to the “name” element, for example, manipulation of data entered into that section of the document may be performed by software components without regard to the actual content of the data so long as the content was entered according to the schema prescribed for that portion of the document.
At step 315, the document 110 is annotated with XML structure that will be associated with tools and help functionality for providing contextually sensitive functionality to the document as described above. A simplified XML structure annotation for the employee review document 110 illustrated in FIG. 1 is as follows.










Sample XML Structure

















<Employee Review>









<Personal Information>



<Name>









<first_name>Joe</first_name>



<last_name>Smith</last_name>









</Name>



<email Name>









<email>Joe@Address.com</email>









</email Name>









*



*



*









</Employee Review>










The schema attached to the document 110 prescribes the data type and data structure rules entered within the XML document structure. As should be understood, the XML structure illustrated above is simplified in nature, and is provided for purposes of illustration only. A sample XML schema associated with the example XML structure above is as follows.










Sample Schema

















<xsd:schema   xmlns:xsd=“http://www.w3.org/2001/XMLSchema”







xmlns=“urn:reviewForm”









targetNamespace=“urn:reviewForm”



elementFormDefault=“qualified”>









<xsd:annotation>



<xsd:documentation xml:lang=“en”>









The schema for the August 2001 Microsoft employee review form.









</xsd:documentation>



</xsd:annotation>



<xsd:element name=“Review” type=“ReviewType” />



<xsd:complexType name=“EmployeeManagerResponsesType”>









<xsd:all>









<xsd:element name=“EmployeeResponse” type=“xsd:string” />



<xsd:element name=“ManagerResponse” type=“xsd:string” />









</xsd:all>









</xsd:complexType>



<xsd:simpleType name=“RatingScore”>









<xsd:restriction base=“xsd:decimal”>









<xsd:enumeration value=“2.5” />



<xsd:enumeration value=“3.0” />



<xsd:enumeration value=“3.5” />



<xsd:enumeration value=“4.0” />



<xsd:enumeration value=“4.5” />



<xsd:enumeration value=“5.0” />









</xsd:restriction>









</xsd:simpleType>



<xsd:complexType name=“RatingType”>









<xsd:all>









<xsd:element name=“EmployeeRating” type=“RatingScore” />



<xsd:element name=“EmployeeComments” type=“xsd:string” />



<xsd:element name=“ManagerRating” type=“RatingScore” />



<xsd:element name=“ManagerComments” type=“xsd:string” />









</xsd:all>









</xsd:complexType>



<xsd:complexType name=“IdentityType”>









<xsd:all>









<xsd:element name=“Name” type=“xsd:string” />



<xsd:element name=“Alias” type=“xsd:string” />



<xsd:element name=“Title” type=“xsd:string” />



<xsd:element name=“EmployeeID” type=“xsd:positiveInteger” />



<xsd:element name=“Reviewer” type=“xsd:string” />



<xsd:element name=“Department” type=“xsd:string” />



<xsd:element name=“Date” type=“xsd:date” />









</xsd:all>









</xsd:complexType>



<xsd:complexType name=“ReviewType” mixed=“true”>









<xsd:all>



<xsd:element name=“ReviewPeriod” type=“xsd:string” />



<xsd:element name=“Identity” type=“IdentityType” />










<xsd:element
name=“CurrentObjectives”







type=“EmployeeManagerResponsesType” />










<xsd:element
 name=“FutureObjectives”







type=“EmployeeManagerResponsesType” />










<xsd:element
name=“StrengthsAndWeaknesses”







type=“EmployeeManagerResponsesType” />









<xsd:element name=“Ratings” type=“RatingType” />



</xsd:all>









</xsd:complexType>



</xsd:schema>










At step 320, the document 110 is saved along with the associated document schema and XML structure.

At step 325, software programming code is written that is necessary to display and handle tools, controls and actions in the document tools pane 135 according to the position of the user's cursor within the document 110. The code written at step 325 includes all required XML files, including Extensible Style Sheet Language (XSL) files, including XSL transformations and XSL formatting objects. As understood by those skilled in the art, XSL transformations include files containing specific rules by which one XML document is transformed into another XML document. As should be understood by those skilled in the art, all XML files, including XML documents and XML transformation documents, are written for processing the document 110 as an XML-structured document.
According to one embodiment, an XML schema may be written to define a list of document actions, controls and help content that are associated with a solution or contextual subset of a solution that are correspondingly associated with XML structure (elements) in the document. The XML schema may be written using any editing tool or XML schema editing tool to create an instance of the schema. The XML schema may be written to include directly in the XML schema all of the properties of the schema and a list of the document actions, controls and help content to be displayed. An exemplary XML schema is set out above.
Other code written for the document 110 at step 325 includes all of the components, such as dynamic-link libraries (dll), needed by the application 100 and the document 110 for providing the contextually sensitive functionality to the document 110, as described with reference to FIG. 1. For example, a dll in the form of an application programming interface (API) may be written to call on a particular solution contained in the schema library 105 when the computer cursor is located by the user within a particular context of the document 110. That is, when the computer cursor is placed within a particular section or portion of the document 110, such as the “name” portion, an application program interface is included for finding the solution property 115 associated with the “name” portion of the document 110 and for calling that solution to provide document tools, actions and help content associated with the “name” portion of the document.
Other exemplary components that are written at step 325 include components for drawing the document tools pane 135 and for displaying textual information associated with the XML elements in the document 110 within which the computer cursor is presently located. Other components may include modular software routines for displaying an action, such as a “submit review” button, for allowing the user to submit the review to a third party, such as the user's employee or the user's supervisor. Still other components may be included for drawing and for providing functionality to controls, such as radio buttons, text boxes and check boxes, as described above with reference to FIG. 1. Any component object model add-ins that may be needed to provide functionality according to the present invention are also written at step 325. In addition to software components necessary providing the document tools and help functionality described herein, the actual text of help content that is drawn into the pane 135 is assembled for deployment when a corresponding help topic is called.
Controls, such as radio buttons, text boxes and check boxes, may be provided in the pane 135 without an associated schema being attached to the document. By declaring that a control is associated with a particular XML element, that control may be provided at the top of the pane 135 above other actions, controls and help topics prescribed by the schema. Similarly, a control may be provided immediately above all other items, including those described above, in the pane 135 by declaring that the control is associated with the entire schema for the document rather than to individual XML elements prescribed by the schema.
All of the aforementioned files, components, component add-ins, dlls, schema files, and XML files are assembled and stored for use by the application 100 in providing the contextually sensitive functionality of the document 110. The schema library 105 may be in the form of a database containing pointers to the aforementioned stored components that may be stored in the memory of the computer 20 in various locations, including the computer's registry.
According to embodiment of the present invention, an application programming interface (API) is provided for implementing the functionality of the present invention to provide a “smart” document solution to the document 110. The API includes properties and methods or instructions that are called upon when a particular action is initiated, for example, opening the document 110 that in turn points to a solution, as described above. Listed below is sample computer programming code for implementing the “smart” document API. The sample code listed below is not limiting of variations that may be made in computer programming code that may be written for implementing the API according to the present invention.
Sample Smart Document API


    
    
        Implements ISmartDocument
        Private Sub ISmartDocument_SmartDocInitialize(ByVal document As Object, ByVal bstrSolutionPath As String)
        Private Property Get ISmartDocument_SmartDocXMLTypeCount( ) As Long
        Private Property Get ISmartDocument_SmartDocXMLTypeName(ByVal smartDocID As Long) As String
        Private Property Get ISmartDocument_SmartDocXMLTypeCaption(ByVal smartDocID As Long, ByVal LocaleID As Long) As String
        Private Property Get ISmartDocument_ControlCount(ByVal SmartDocXMLTypeName As String) As Long
        Private Property Get ISmartDocument_ControlID(ByVal SmartDocXMLTypeName As String, ByVal ControlIndex As Long) As Long
        Private Property Get ISmartDocument_ControlTypeFromID(ByVal ControlID As Long, ByVal ApplicationName As String, ByVal LocaleID As Long) As C_TYPE
        Private Property Get ISmartDocument_ControlNameFromID(ByVal ControlID As Long) As String
        Private Property Get ISmartDocument_IsControlDynamic(ByVal ControlID As Long, ByVal ApplicationName As String, ByVal LocaleID As Long) As Boolean
        Private Property Get ISmartDocument_ControlCaptionFromID(ByVal ControlIDAs Long, ByVal ApplicationName As String, ByVal LocaleID As Long, ByVal bstrText As String, ByVal bstrXML As String, ByVal Target As Object) As String
        Private Sub ISmartDocument_PopulateRadioGroup(ByVal ControlID As Long, ByVal ApplicationName As String, ByVal LocaleID As Long, ByVal bstrText As String, ByVal bstrXML As String, ByVal Target As Object, List( ) As String, count As Long, InitialSelected As Long) Private Sub ISmartDocument_OnRadioGroupSelectChange(ByVal ControlID As Long, ByVal Target As Object, ByVal Selected As Long, ByVal Value As String)
        Private Sub ISmartDocument_PopulateImage(ByVal ControlID As Long, ByVal ApplicationName As String, ByVal LocaleID As Long, ByVal bstrText As String, ByVal bstrXML As String, ByVal Target As Object, ImageSrc As String)
        Private Sub ISmartDocument_ImageClick(ByVal ControlID As Long, ByVal ApplicationName As String, ByVal Target As Object, ByVal Text As String, ByVal Xml As String, ByVal LocaleID As Long, ByVal XCoordinate As Long, ByVal YCoordinate As Long)
        Private Sub ISmartDocument_PopulateDocumentFragment(ByVal ControlID As Long, ByVal ApplicationName As String, ByVal LocaleID As Long, ByVal bstrText As String, ByVal bstrXML As String, ByVal Target As Object, DocumentFragment As String)
        Private Sub ISmartDocument_PopulateActiveXProps(ByVal ControlID As Long, ByVal ApplicationName As String, ByVal LocaleID As Long, ByVal bstrText As String, ByVal bstrXML As String, ByVal Target As Object, PropBag As SmartTagLib.IActiveXProperties)
        Private Sub ISmartDocument_PopulateCheckbox(ByVal ControlID As Long, ByVal ApplicationName As String, ByVal LocaleID As Long, ByVal bstrText As String, ByVal bstrXML As String, ByVal Target As Object, Checked As Boolean)
        Private Sub ISmartDocument_OnCheckboxChange(ByVal ControlID As Long, ByVal Target As Object, ByVal Checked As Boolean)
        Private Sub ISmartDocument_PopulateListOrComboContent(ByVal ControlID As Long, ByVal ApplicationName As String, ByVal LocaleID As Long, ByVal bstrText As String, ByVal bstrXML As String, ByVal Target As Object, List( ) As String, count As Long, InitialSelected As Long, IsEditable As Boolean, ControlOnSameLine As Boolean)
        Private Sub ISmartDocument_OnListOrComboSelectChange(ByVal ControlID As Long, ByVal Target As Object, ByVal Selected As Long, ByVal Value As String)
        Private Sub ISmartDocument_PopulateTextboxContent(ByVal ControlID As Long, ByVal ApplicationName As String, ByVal LocaleID As Long, ByVal bstrText As String, ByVal bstrXML As String, ByVal Target As Object, Value As String, ControlOnSameLine As Boolean)
        Private Sub ISmartDocument_OnTextboxContentChange(ByVal ControlID As Long, ByVal Target As Object, ByVal Value As String)
        Private Sub ISmartDocument_PopulateHelpContent(ByVal ControlID As Long, ByVal ApplicationName As String, ByVal LocaleID As Long, ByVal bstrText As String, ByVal bstrXML As String, ByVal Target As Object, Content As String)
        Private Sub ISmartDocument_InvokeControl(ByVal ControlID As Long, ByVal ApplicationName As String, ByVal Target As Object, ByVal Text As String, ByVal Xml As String, ByVal LocaleID As Long)
    
    


A number of properties and methods are included in the API listed above. The SmartDocInitialize method includes routines and instructions executed when the API is called upon to provide “smart” document functionality to the docket 110. The SmartDocXMLTypeCount property includes the number of XML element types associated with the solution. The SmartDocXMLTypeName property includes unique identifiers for the XML element types associated with the “smart” document solution. The SmartDocXMLTypeCaption property includes captions associated with XML elements that may be included in a menu or pane such as the help pane 135.
The ControlCount property includes the number of controls associated with the “smart” document solution for a particular XML element type. The ControlID property includes unique identifiers for the controls. The ControlTypeFromID property includes the types of controls available for use with an associated solution, for example, radio buttons, textboxes, and check boxes. The ControlNameFromID property returns a name associated with each control for use internally by a given application program 100.
The PopulateRadioGroup method includes routines and instructions that are executed for populating radio control buttons within a menu or pane such as the help pane 135. The OnRadioGroupSelectChange method includes routines and instructions that are executed when a radio group (radio button) is selected or deselected.
The PopulateImage method includes routines and instructions that are executed for populating an image associated with a solution, such as an image populated within the help pane 135. The ImageClick method includes routines and instructions that are executed when an image is selected by a user.
The PopulateDocumentFragment method includes routines and instructions that are executed for populating the user interface with text or data. The PopulateActiveXProps method includes routines and instructions that are executed for obtaining ActiveX functionality associated with a document solution.
The PopulateCheckbox method includes routines and instructions for providing a checkbox control in a user interface such as the help pane 135. The OnCheckboxChange method includes routines and instructions that are executed when a checkbox control is selected or deselected by a user.
The PopulateListOrComboContent method includes routines and instructions that are executed to populate a list box control in a user interface such as the pane 135. The OnListOrComboSelectChange method includes routines and instructions that are executed upon the selection of an item in a list box control.
The PopulateTextboxContent method includes routines and instructions for populating a textbox in a user interface such as the pane 135. The OnTextboxContentChange method includes routines and instructions that are executed for handling an event associated with the change of content in a textbox control within a user interface such as the pane 135.
The PopulateHelpContent method includes routines and instructions for populating a help content field within the pane 135 with required text or data. The InvokeControl method includes routines and instructions that are executed when a control such as a radio button, textbox, or checkbox is selected or deselected.
Referring still to FIG. 4, at step 330, a determination is made as to whether the document 110 may work in a client-server operation. That is, components providing contextually sensitive functionality to the application 100, or updates or changes to those components, may be stored at a remote server location separate from the computer 20. If the document is to be enabled to obtain necessary components for operation of the application and document from a remote server location, the method proceeds to step 335, and server code is written to a server location for responding to client-side actions performed by the user at the computer 20. That is, application programming interfaces for corresponding between the computer 20 and a remote server 49 are written for obtaining server-based data and application components necessary for providing the contextually sensitive functionality of the present invention. If it is desired that the application point to a remote server for data and application components, a solution location identifier, such as a solution URL, is added to point the application to a location on the remote server to obtain the necessary data and application components.
At step 340, a manifest of all of the programming components described above is created for identifying the list of components, dlls, schema files, and XML files that will be used to provide various solutions and functionality to the document 110. A pointer is added to the document 110 for pointing the document to the manifest of components for obtaining functionality provided by individual and various components. For a detailed description of the manifest, see U.S. patent application entitled “Mechanism for Downloading Software Components From A Remote Source For Use By A Local Software Application,” Ser. No. 10/164,960, filed Jun. 6, 2002, which is incorporated herein by this reference as if fully set out herein. At step 350, all files, code, and changes to the document 110 are saved, and the document creation method ends at step 390. Accordingly, the document 110 is now in a condition to be opened and utilized by a user.
FIG. 5 refers to the steps involved in opening and utilizing the document 110. For purposes of example only, the employee performance review document 110 is described with reference to the steps involved in opening a “smart” document created and implemented in accordance with an embodiment of the present invention. The method 400 begins at start step 405, and proceeds to step 410 where the application 100 is booted by the user. As is understood by those skilled in the art, the application 100 may be booted by selecting the application or by selecting a document 110 created with the application 100.
At step 415, the user selects the document 110 for opening in a manner consistent with the application 100. At step 420, a determination is made as to whether the document 110 refers to a solution. That is, at step 420, a determination is made as to whether the document 110 is annotated with pointers to a solution or to multiple solutions for providing contextually sensitive tools and help information to the document, as described above. As a part of the check to determine whether the document 110 points to a solution or to multiple solutions, a determination is also made as to whether a schema has been attached to the document as described above. If the document does refer to a solution, for example a solution for providing the user with assistance in preparation of the user's employee review document 110, the method proceeds to step 425 and the application 100 calls the schema library 105 to determine whether the solution referred to by the document 110 is stored in the schema library 105. At the schema library, the determination includes a determination as to what components in the schema library are necessary; that is, what components are associated with the solution I.D. For example, the document 110 may have a schema attached to define the rules governing the XML structure of the document 110, but that was created without reference to a particular solution.
At step 430, a determination is made as to whether the solution is stored in the schema library. As should be understood, multiple solutions may be attached to the document 110. For example, a first solution might include helpful information and actions to provide contextually sensitive information regarding completion of the document 110 by a particular user. A second solution may be attached to the document 110 for providing information to a supervisor of the user so that the contextually sensitive information provided to the supervisor will give the supervisor information as to how to evaluate each section of the employee's review document.
If multiple solutions are referred to by the document 110, a prompt may be provided to the user, such as the dialog box 500, illustrated in FIG. 6, to notify the user that multiple solutions are available for this document. The user may then select one solution from the list of solutions for providing the desired functionality to the user after the document opens.
At step 435, a determination is made as to whether the user actually wants the solution to be provided to the user after the document 110 is opened. As should be understood, a dialog box similar to the dialog box 500 may be presented to the user to query the user as to whether she desires the help content and tools functionality. The user may have completed the document 110 on numerous occasions and may not now desire additional help functionality or action functionality. If desired, the user may elect to always receive the solution upon opening the document 110. Similarly, the user may elect to have the document 110 via the application 100 check for updates to the solution each time the document 110 is opened.
If the user declines the solution, the method proceeds to step 455, and the document is opened without “smart” document solutions according to the normal procedures required and implemented by the application 100. If the user does desire the functionality of the solution referred to by the document 110, the method proceeds to step 440, and the solution is loaded for use by the application 100 and document 110. As should be understood by those skilled in the art, loading the solution includes calls from the document 110 via the application 100 to all necessary files, dlls, component add-ins, and XML files associated with the solution and stored in the schema library 105.
Upon being called by the document 110, each called file is registered with the application 100 via the computer's operating system, and a path is established between each called file and the application 100 and document 110 for provision of the functionality associated with each file. For example, if a particular dll that is used for drawing the document tools pane 135 must be assigned a registry key for proper communication with the application 100 and document 110, this registration process is performed during the load solution step 440. At step 445, the “smart” document 110 is opened and is displayed on the user's computer screen, as illustrated in FIG. 1.
Referring back to step 420, if the document does not refer to a solution, the method proceeds to step 450, and a determination is made as to whether a schema has been attached to the document. If the document has an attached schema, but no reference to a particular solution, the method proceeds to step 430 and a “check” is made of the schema library as to whether a solution does exist that may be associated with the schema that is attached to the document 110. That is, even where no solution is referred to in the document 110, the schema library may have solutions that have been obtained by the user of the computer 20 subsequent to the creation of the document 110 that may be utilized by the document 110 even though the document 110 was not originally created to refer to the solution.
If a solution does exist in the schema library for the document 110, the method proceeds to step 435, and the steps thereafter, as described above. If a schema is not attached to the document 110, the method proceeds to step 455, and the document is opened without “smart” document solutions.
Referring back to step 430, if no solution(s) are found in the schema library associated with the solution referred to by the document 110 or associated with the attached schema, the method proceeds to step 460, and a determination is made as to whether the user would like to download a solution. At step 460, the user may be “prompted” by the application 100 and informed that the document 110 will work more efficiently, or will be more useful, if the user downloads certain help and action functionality to the user's document 110. The user may be provided with a “prompt” in the form of a dialog box, such as the dialog box 600 illustrated in FIG. 7. A number of queries may be made to the user to ask the user whether the user would like components comprising the desired solution to be downloaded according to a number of methods. If the user declines to download solution functionality and components, the method proceeds back to step 455, and the document is opened without “smart” document solutions as described above.
If the user desires to download the solution(s) offered to the user, the method proceeds to step 465. At step 465, components necessary for providing the desired solution(s) to the document 110 are downloaded to the user's computer 20 from some remote source, such as a remote web-based server. In order to locate the remote source, the application 100 uses the solution location pointer 118 from the document 110 to locate and obtain the necessary solution components. For a detailed description of a mechanism for downloading data and application components and other software modules from a remote location to the application 100, see U.S. patent application entitled “Mechanism for Downloading Software Components From A Remote Source For Use By A Local Software Application,” Ser. No. 10/164,960, filed Jun. 6, 2002, which is incorporated herein by this reference as if fully set out herein. At step 470, the downloaded solutions are loaded into the client-side schema library 105, and the solution is loaded as described above so that the document 110 will include the functionality of the solution.
FIG. 8 is a flow chart illustrating a method for determining what to display in the document tools pane 135 after a document 110 is opened with a “smart” document solution. For purposes of the description of the steps illustrated with reference to FIG. 8, the document 110 has been opened with a “smart” document solution which has been loaded and is running. By way of example, consider that the user has placed the computer cursor in a particular location with the document 110, such as the “objectives” section 125.
The method 700 begins at start step 705, and proceeds to step 710, where a list of XML elements that surround the cursor is generated. The position of the cursor within the XML hierarchy is located, and the X-path expression to get to the position where the cursor is located is determined. For example, referring to the simplified XML code set forth above, the cursor may be located within the “e-mail” tag and inside the larger XML tree within the “employee review” tag.
At step 715, a determination is made as to which tools and help content should appear in the document tools pane 135. To make this determination, the application 100 enters a look-up table stored on the client computer 20 that contains information about which XML elements have which particular tools, help content, controls, etc., associated with those XML elements. For example, if the cursor is located in the “e-mail name” element within the “personal information” section 120, the application 100 will enter the look-up table to determine which particular tools or help content are associated with the e-mail name element.
Each document action, help item, and control associated with each element is populated with a unique identification (ID) associated with each XML element to which it is applied so that the application 100 may readily locate the actions, help items, or tools associated with the XML element. At step 720, a determination is made as to whether any of the actions, help items, or controls are dynamic. A control may appear differently based on the context or background information for the context. The “objectives” section of the review document 110 may be associated with a “Submit Review” button when the section is completed. On the other hand, if the section is not completed, the “Submit Review” button may not appear in the pane 135 because the document should not be submitted without the completed “objections” section. Accordingly, the “Submit Review” button in this case may be identified as dynamic at step 720, and the method then proceeds to step 725. At step 725, the document 110 via the application 100 calls the component representing the “Submit Review” button and provides that component with the context of the cursor position, for example, whether the “objectives” element has been completed or not.
At step 730, after a determination has been made that the actions, help content, or controls are static or dynamic, the contents of the document tools pane 135 are drawn on the user's computer screen adjacent to the document 110, as illustrated in FIG. 1. At step 735, a determination is made as to whether the cursor is moved to a new context. For example, after the user completes an entry in the “objectives” section 125, the user may move the cursor to the “personal information” section 120 to complete that section. If the cursor does not move, the method proceeds to step 790 and ends. That is, as long as the cursor stays in the current context, no additional changes are made to the content of the document tools pane 135. If the cursor is moved to a new context within the document, the method proceeds back to step 710 where a new list of XML elements containing the cursor is generated, and the method proceeds on as described above to provide new content in the document tools pane 135 associated with the new position and context of the cursor.
Referring back to FIG. 1, the following is a description of the tools and help content drawn in the document tools pane 135. The particular text and controls illustrated in FIG. 1 are by way of example only, and vary with the context of the cursor position as described above. The name 140 is a name for the document XML element associated with the actions and tools shown in the document tools pane 135. The name may refer to the schema that is attached to the document, for example, employee performance review form, or the name 140 may refer to the XML element in which the cursor is currently located. For example, if the cursor is located in the “objectives” section, the name 140 may be re-drawn as “objectives section.” The document actions 145 are displayed based on the cursor context and based on whether the actions are static or dynamic. As set forth above, the “Submit Review” action, for example, may be a dynamic action that is not displayed in the document actions pane 135 if all required sections of the document 110 have not been completed. The “Last Years Objectives” help topic 155 is shown in a collapsed display. Selecting the “+” expands the help topic to display additional sub-topics contained therein. The “Objective Writing Tips” help topic is shown in an expanded view, showing the full content 160 available under that help topic. If an XML element within the document 110 has no “smart” document actions or tools associated with it, that XML element is not shown or identified in the document tools pane 135.
Help topics and tools may be nested, meaning that sub-help topics and sub-actions may be included in help topics and document tools. If the cursor is in multiple elements because of nesting, then the number of sections in the document tools pane 135 can be greater than two. In this case, the nested elements are shown in order of nesting where the outermost element is at the top of the document tools pane 135 and innermost element is at the bottom of the document tools pane 135. If the elements, actions, tools, and help content do not fit on one page, a scroll bar may be provided, as illustrated in FIG. 1, that will extend over the entire document tools pane 135. Action and help content are listed in the order in which the dlls, or components that provide them to the document 110 return their names in response to a call from the application 100. According to one embodiment, XML elements that are not associated with actions, controls or help topics are not shown to the user. If desired, however, all XML elements may be shown in the pane 135 to make the user aware of the complete XML structure of the document 110.
Accordingly, after the document 110 is opened, and the “smart” document solution is loaded and implemented as described above, the user of the document 110 may now enter the document and complete the document with the help of the “smart” document functionality provided in the document tools pane 135. As the user moves the computer cursor through various sections of the document that are tagged with XML structure, the user may be provided with helpful information and tools associated with that portion of the document.
It will be apparent to those skilled in the art that various modifications or variations may be made in the present invention without departing from the scope or spirit of the invention. Other embodiments of the invention will be apparent to those skilled in the art from consideration of the specification and practice of the invention disclosed herein.

## Claims

1. A method of providing contextually sensitive functionality to a computer-generated document, comprising the steps of:
attaching a schema to the document defining permissible data content, data type and data structure for the document, whereby the schema includes a definition of permissible data content, data type and data structure for particular portions of the document;
structuring the document to associate the document with the schema;
associating a solution with the document structure;
assembling a plurality of software components for providing the solution to the document;
enabling the document to call the plurality of software components for providing the solution to the document based on an editing position in the document; and
implementing an Application Programming Interface for providing the solution to the document, comprising the steps of:
providing a SmartDocXMLTypeCount property including a number of XML element types associated with the solution;
providing a SmartDocXMLTypeName property including unique identifiers for the XML element types associated with the solution;
providing a SmartDocXMLTypeCaption property including captions associated with XML elements that may be displayed to a user;
providing a ControlCount property including a number of controls associated with the solution;
providing a ControlID property including unique identifiers for the controls;
providing a ControlTypeFromID property including the types of controls available for use with the solution;
providing a ControlNameFromID property for returning a name associated with each control for use internally by an application program providing the document;
providing a PopulateRadioGroup method including routines and instructions that are executed for populating radio controls that may be displayed to a user;
providing an OnRadioGroupSelectChange method including routines and instructions that are executed when a radio control is selected;
providing a PopulateImage method including routines and instructions that are executed for populating an image associated with the solution;
providing an ImageClick method including routines and instructions that are executed when an image is selected;
providing a PopulateDocumentFragment method including routines and instructions that are executed for displaying data;
providing a PopulateActiveXProps method including routines and instructions that are executed for obtaining ActiveX functionality associated with the solution;
providing a PopulateCheckbox method including routines and instructions for providing a checkbox control;
providing an OnCheckboxChange method including routines and instructions that are executed when a checkbox control is selected;
providing a PopulateListOrComboContent method including routines and instructions that are executed to populate a list box control;
providing OnListOrComboSelectChange method including routines and instructions that are executed upon the selection of an item in a list box control;
providing a PopulateTextboxContent method including routines and instructions for populating a textbox;
providing an OnTextboxContentChange method including routines and instructions that are executed for handling an event associated with a change of content in the textbox control;
providing a PopulateHelpContent method including routines and instructions for populating a help content field with data; and
providing an InvokeControl method including routines and instructions that are executed when a control is selected;

whereby the step of structuring the document includes structuring the particular portions of the document to associate the particular portions of the document with permissible data content, permissible data type, and permissible data structure for the particular portions of the document as defined by the schema;
whereby the step of structuring the particular portions of the document includes annotating the particular portions of the document with XML structure;
whereby the step of associating a solution with the document structure, further comprises associating controls with the XML structure; and
whereby the step of associating controls with the XML structure includes associating radio buttons, check boxes or text boxes with the XML structure.

2. A computer-readable medium with computer-executable instructions encoded thereon for providing contextually sensitive functionality to a computer-generated document, the instructions comprising:
attaching a schema to the document defining permissible data content, data type and data structure for the document, whereby the schema includes a definition of permissible data content, data type and data structure for particular portions of the document;
structuring the document to associate the document with the schema;
associating a solution with the document structure;
assembling a plurality of software components for providing the solution to the document;
enabling the document to call the plurality of software components for providing the solution to the document based on an editing position in the document; and
implementing an Application Programming Interface for providing the solution to the document, comprising the steps of:
providing a SmartDocXMLTypeCount property including a number of XML element types associated with the solution;
providing a SmartDocXMLTypeName property including unique identifiers for the XML element types associated with the solution;
providing a SmartDocXMLTypeCaption property including captions associated with XML elements that may be displayed to a user;
providing a ControlCount property including a number of controls associated with the solution;
providing a ControlID property including unique identifiers for the controls;
providing a ControlTypeFromID property including the types of controls available for use with the solution;
providing a ControlNameFromID property for returning a name associated with each control for use internally by an application program providing the document;
providing a PopulateRadioGroup method including routines and instructions that are executed for populating radio controls that may be displayed to a user;
providing an OnRadioGroupSelectChange method including routines and instructions that are executed when a radio control is selected;
providing a PopulateImage method including routines and instructions that are executed for populating an image associated with the solution;
providing an ImageClick method including routines and instructions that are executed when an image is selected;
providing a PopulateDocumentFragment method including routines and instructions that are executed for displaying data;
providing a PopulateActiveXProps method including routines and instructions that are executed for obtaining ActiveX functionality associated with the solution;
providing a PopulateCheckbox method including routines and instructions for providing a checkbox control;
providing an OnCheckboxChange method including routines and instructions that are executed when a checkbox control is selected;
providing a PopulateListOrComboContent method including routines and instructions that are executed to populate a list box control;
providing OnListOrComboSelectChange method including routines and instructions that are executed upon the selection of an item in a list box control;
providing a PopulateTextboxContent method including routines and instructions for populating a textbox;
providing an OnTextboxContentChange method including routines and instructions that are executed for handling an event associated with a change of content in the textbox control;
providing a PopulateHelpContent method including routines and instructions for populating a help content field with data; and
providing an InvokeControl method including routines and instructions that are executed when a control is selected;

whereby the step of structuring the document includes structuring the particular portions of the document to associate the particular portions of the document with permissible data content, permissible data type, and permissible data structure for the particular portions of the document as defined by the schema;
whereby the step of structuring the particular portions of the document includes annotating the particular portions of the document with XML structure;
whereby the step of associating a solution with the document structure, further comprises associating controls with the XML structure; and
whereby the step of associating controls with the XML structure includes associating radio buttons, check boxes or text boxes with the XML structure.