Graphical authoring and editing of mark-up language sequences   

This application claims the benefit of U.S. Provisional Application No. 60/543,618, filed Feb. 12, 2004, which is incorporated herein by reference.

The present invention relates to mark-up languages, and, more particularly, to graphically authoring and editing mark-up language sequences.

The increased use of digital computers in information processing has brought about an increase in the development of languages and tools to facilitate the processing of information. One such development is the mark-up language. “Mark-up” refers to a sequence of characters or other symbols that are inserted at particular places in an electronic document or file to indicate how the file should look when it is printed or displayed, or to describe the document's logical structure. A mark-up language element is often referred to as a “tag”. Tags typically delimit a unit of information in a mark-up language sequence. A mark-up language describes the content of a document and, in addition, may also describe the layout for screen or page, the relationship of the data in the documents, the type of data in various parts of the documents, and/or some programmatic functionality embedded within the document. Mark-up languages include Hypertext Mark-up Language (HTML), Extensible Mark-up Language (XML), and others developed for particular applications. A mark-up language sequence is sometimes referred to as a script and, as used herein, the phrase document, sequence and script shall be used interchangeably.

XML is similar to HTML, which is often used to define web pages. Like HTML, XML is a subset of Standard Generalized Markup Language (SGML), a standard for how to create a document structure. SGML languages contain mark-up symbols to describe the contents of a page or file.

XML is, by its nature, very flexible. It is this flexibility that makes it difficult to write and edit with a standard text editor. While there are products that provide an adequate editing environment, it has been difficult for engineers not trained in the details of XML to concisely depict a process flow (consisting of steps, logic structures, looping structures, user interactivity structures, decision logic and/or starting and end points) and generate validated XML in accordance with a particular Document Type Definition (DTD). The purpose of a DTD is to define the legal building blocks of an XML document. It defines the document structure with a list of legal elements.

While mark-up languages improve the usefulness and increase the information stored within a document, they are often difficult for a person to parse. Mark-up language scripts may often contain a series of structural elements, tags, tag sequences and programmatic steps, such as, for example, conditional statements, loops, and/or declaration statements. An element of a mark-up language is typically contained within tags. Although a script will normally have a starting point and an ending point, there may be numerous paths that can be traversed according to the various conditional and loops that may be present in the script. The presence of conditionals and loops further exacerbates the problem of a person parsing the document and understanding it.

A further complexity of XML documents is that they may contain a DTD and a schema, and have their own syntax according to the language. The DTD is an optional part of the document prolog, as specified by the XML standard. The DTD specifies constraints on the valid tags and tag sequences that can be in the document. The DTD includes both the local subset, defined in the current file, and the external subset, which consists of the definitions contained in external files that are referenced in the local subset using a parameter entity. A schema is a database-inspired method for specifying constraints on XML documents using an XML-based language. Schemas address deficiencies in DTDs, such as the inability to put constraints on the kinds of data that can occur in a particular field (for example, all numeric). Since schemas are founded on XML, they are hierarchical, so it is easier to create an unambiguous specification, and possible to determine the scope over which a comment is meant to apply. While the DTD and schema are very useful within XML, they present serious difficulties for a person in parsing the document.

Mark-up languages can be employed in various information processing tasks. For example, mark-up languages can be applied to the task of programming interactive diagnostics for an Interactive Technical Manual (IETM) system. The IETM uses a mark-up language derived from XML to describe actual test sequences in the form of programs called Test Program Sets (TPS). The IETM uses the XML scripts to query a unit under test (UUT), such as, for example, a helicopter. Because of the complexities of the TPS, diagnostic engineers must understand the testing domain, be versed in writing TPS and be well versed in writing structured XML. This presents a significant challenge to the diagnostic engineers. Attempts have been made to train such engineers in all the skills necessary, but these attempts have often resulted in failure. The most common reason cited for the failure of the training is the lack of understanding the structured data authoring as applied to the diagnostic fault flow building process.

The present invention provides a solution to the difficulty of learning structured mark-up language authoring by providing a graphical authoring and editing system. The system of the present invention allows a user to author and/or edit XML scripts without having to have intimate knowledge of the various topics needed to author XML in its native form, such as, for example, the schema and the actual XML syntax.

The present invention provides a drag and drop flowchart interface to edit and modify the structure of diagnostic fault flows written in XML. The resulting graphical representation of the “programming structures” of the mark-up language makes the diagnostic fault flow much easier to understand by engineers of varying skill levels. The details of the syntax of XML are automatically generated and are abstracted away from the diagnostic engineer. This feature allows the diagnostic engineer to focus on the original design of the fault flow logic, and then insert the details where necessary. It also allows novice diagnostic engineers to understand, generate, and maintain the diagnostic fault flows, and generate the XML structured data.

Element tags can represent instructions similar to evaluating and modifying data within a computer program For instance, a tag can represent an “if” condition, a “for loop” or any number of programming elements. The systems and methods of the present invention allow a user to graphically author and edit an XML document to perform program instructions. Further, the systems and methods of the present invention ensure that the created data is both well formed (i.e. the XML is properly structured), and valid (i.e. follows the intended structure of the DTD).

Exemplary embodiments in accordance with the present invention will now be described with reference to the accompanying drawings, in which:

FIG. 1 is a flowchart showing an exemplary method of creating and adding a mark-up language component to a library;

FIG. 2 is a high-level block diagram of an exemplary system for graphically authoring and editing mark-up language sequences in accordance with the present invention;

FIG. 3 is an exemplary XML mark-up language sequence;

FIG. 4 is a graphical flowchart representation of the XML sequence shown in FIG. 3;

FIG. 5 is a screenshot of an exemplary tool for graphically authoring mark-up language sequences in accordance with the present invention showing an exemplary component palette and flowchart working area;

FIG. 6 is a screenshot of an exemplary XML property form in accordance with the present invention; and

FIG. 7 is a screenshot of an exemplary tool combining the palette, flowchart, property form and XML tree views.

The systems and methods of the present invention provide a graphical authoring and editing tool for mark-up languages. The graphical editing and authoring tool comprises the following modules: a drag and drop graphical flowchart view of the code from a template of shapes corresponding to major elements of the mark-up language (as determined by the schema describing the proper mark-up language elements and properties), a mark-up language view of the document, a view that permits the user to view and/or choose from the acceptable values for an individual mark-up language element attribute or property for each element shown in the flowchart view and synchronization of all views into a single unified tool.

XML is used for the sake of clarity in the descriptions of the exemplary embodiments of the methods and systems of the present invention. However, it should be appreciated that XML is used for illustrative purposes only and the system and methods of the present invention may be used with other mark-up languages.

Exemplary embodiments of the present invention are shown demonstrated in Microsoft™ Visio™, Visio™ is often used as a development platform for graphical flowcharting applications, such as, for example, Unified Modeling Language (UML) and the like. Visio™ is shown here for illustrative purposes only. It should be appreciated that other graphical systems, including custom designed graphical systems, can be used with the present invention.

The descriptions of the exemplary embodiments are directed to a particular application of mark-up languages, the IETM, for purposes of illustration. However, it should be appreciated that the systems and methods of the present invention may be used with other mark-up languages in other applications.

XML is a World Wide Web Consortium (W3C) standard that allows the user to create his own mark-up language tags. XML is “extensible” because the markup symbols are unlimited and self-defining.

An author can insert markup tags directly into a document by typing symbols in. More sophisticated editors that allow a user to create a document as the user wants it to appear are also available, such as, for example, a “what you see is what you get”, or WYSIWYG, editor.

XML describes a class of data objects called XML documents and partially describes the behavior of computer programs which process them. XML markup encodes a description of the document's storage layout and logical structure. XML provides a mechanism to impose constraints on the storage layout and logical structure.

An XML document primarily consists of a strictly nested hierarchy of elements with a single root. Elements can contain character data, child elements, or a mixture of both. In addition, they can have attributes. Child character data and child elements are strictly ordered.

A Document Type Definition (DTD) is a specific definition that follows the rules of SGML. A DTD is a specification that accompanies a document and defines the markups. XML uses a DTD and/or an XML schema to describe the data. An XML document along with an accompanying DTD and/or schema is designed to be self-descriptive.

The systems and methods of the present invention provide a mark-up language authoring tool that comprises a drag-and-drop flowchart interface to create and modify the structure of diagnostic fault flows. The native format of the diagnostic fault flows is XML. The resulting graphical representation of the “programming structures” of the XML makes the diagnostic fault flow much easier to understand by all levels of engineers. Details of the XML syntax are automatically generated and invisible to the diagnostic engineer.

Element tags in this tool can represent instructions similar to evaluating and modifying data within a computer program. For example, a tag can represent an “if” condition or a “for” loop. The generated XML is able to include the diagnostic decision-making process or “diagnostic flow.” The user can graphically author XML documents to perform programming instructions by placing symbols chosen from a user-selectable palette into a flowchart. The tool also ensures that the generated XML is properly structured and valid.

The graphical authoring tool allows a user to understand and edit XML structures without having to understand the full syntax of the XML language. The XML author's productivity is increased using the drag and drop capability to author XML. It gives a graphical view of the XML data. The graphical representations of the XML elements can be filtered to display and use only those elements allowed by the data type definition. This capability frees the user from being required to perform all validations after writing the actual XML data.

In order to use the graphical mark-up language authoring tool, a library of XML components is created to provide the user with components from which to choose. FIG. 1 shows a flowchart of an exemplary method of creating and adding a mark-up language component to a library. In particular, the method 10 starts with step 100. Control then proceeds to step 110.

In step 110, resources are accepted. The resources accepted comprise a mark-up language element 160 containing the mark-up language code and attributes and properties 170 associated with the mark-up language element 160. Control then transfers to step 120.

In step 120, a graphical symbol is designated to represent the mark-up language component. Control then transfers to step 130.

In step 130, the resources, comprising the mark-up language code, the properties and attributes, and the graphical symbol, are packaged in a database. Control then transfers to step 140.

In step 140, the packaged resources are added to a mark-up language component library. Control then transfers to step 150, where the sequence ends.

Steps 100-150 may be repeated as necessary to add all of the components required by the contemplated use of the present invention.

Once the library of mark-up language components has been created, the authoring tool can be used to author or edit mark-up language sequences. FIG. 2 shows an exemplary system 20 for graphically authoring and editing a mark-up language sequences in accordance with the present invention. In particular, the system comprises a computer 230, and a memory 200 containing a mark-up language authoring tool program 210, a mark-up language component library 220, and a mark-up language sequence 280. In addition, the system comprises input from the author 240, a graphical view 250 of the mark-up language sequence, a mark-up language view 260 of the mark-up language sequence, and an attributes and properties view 270 of the mark-up language components (not shown).

In operation, the computer 230 executes the mark-up language authoring tool program 210. The mark-up language authoring tool program 210 loads the mark-up language component library 220 into memory 200. The mark-up language authoring tool program 210, either automatically, or under user control, loads the mark-up language sequence 280 into memory 200.

The computer 230 through executing the mark-up language authoring tool program 210 presents a graphical view 250 of the mark-up language sequence 280, a mark-up language view 260 of the mark-up language sequence 280, and/or an attributes and properties view 270 of the mark-up language sequence 280. The computer 230 receives input from the author 240. The input from the author 240 is used to author and/or edit the mark-up language sequence 280. The input from the author may typically be received through an input device capable of indicating a cursor coordinate position on a graphical interface, such as, for example, a computer mouse, trackball, graphics tablet, light pen, keyboard, or the like. The mark-up language sequence is authored and/or edited by graphically selecting mark-up language components (not shown) from a user-selectable list created from the mark-up language component library 220 and placing the component in the mark-up language sequence 280 in a “drag-and-drop” fashion. “Drag-and-drop” refers to a method of using an input device to select a displayed graphical symbol and then using the input device to indicate a desired location for the item represented by the graphical symbol to be placed.

FIG. 3 shows an exemplary XML file of a simple control sequence. This XML sample is used to show the complexity of the XML language in comparison with the complexity of the task being performed. Even for a relatively simple task, the XML document can be difficult to understand by the non-expert. In particular, the XML listing in FIG. 3 represents a true/false test sequence. First, the XML sequence determines if a variable has been set. If the variable has been set, then a command name will be stored in the variable. Then, the sequence prompts for a positive or negative response. Based on this response, the sequence sets the value of a response variable to a logical value of true or false.

If the variable has not been set, then an error condition is detected and a message is generated to the operator and a variable is set to a value indicating a variable fault.

FIG. 4 shows a flowchart view of the exemplary XML document shown in FIG. 3. The flowchart view shown in FIG. 4 permits a wider range of people with varying technical expertise in XML to understand the sequence contained in the document. In particular, the flowchart begins with a subtask label element 402. As can be seen in the XML shown in FIG. 3, the subtask identification label is “LIB.TRUEFALSE.” Next, control transfers to a decision element 404.

The decision element 404 evaluates an expression that determines whether a variable has been set. The variable stores a command if it has been set. If the variable is set, control transfers to a step sequence element 406. If the variable is not set, control transfers to a different step sequence element 414. From the flowchart it can be readily observed that the subtask contains two primary branches of XML code.

The step sequence element 406 contains the label of the step sequence, “It Does”, which represents the step sequence executed when the command does exist. Control then transfers to a step element 408.

The step element 408 contains the functionality for the next step in the step sequence. Within the step element 408 control transfers to a dialog element 410.

The dialog element 410 queries a user for input. Once the user input is received, the dialog element 410 sets a response variable based on the response to the dialog element 410. If the response was positive then the response variable is set to a logical value of TRUE. If the response received was negative then the response variable is set to a logical value of FALSE. Control then transfers to a terminal element 412, where the sequence ends and control returns to the task (not shown) that initiated the subtask 402.

If the result of the decision element 404 was that the variable did not contain a command, then control transfers to the step sequence element 414. Step sequence element 414 contains the label of the step sequence, “It does not exist.” Control then transfers to a step sequence element 416.

The step sequence element 416 contains the step title of “Logical Error Fault Group.” The step sequence element 416 also contains a text description summarizing the error condition for the operator. Within the step element 416, control transfers to a fault group element 418.

The fault group element 418 contains the fault title and other details related to the fault, such as, for example, probability. Once the fault group element 418 has been evaluated, control transfers to a step sequence element 420.

The step sequence 420 contains a breakpoint element 422. The break point element 422 stops execution of the mark-up language flow sequence to alert the operator to the error condition. After the breakpoint element has been executed, control then transfers to a terminal element 412, where the sequence ends and control returns to the task (not shown) that initiated the subtask 402.

FIG. 5 is a screenshot of an exemplary tool for graphically authoring mark-up language sequences in accordance with the present invention showing an exemplary graphic interface containing sections for a mark-up language component palette and flowchart working area. In particular, there is a palette 502 of user-selectable components represented by icons 506 and an authoring and editing area 504. The sections of the graphical interface can be windows, drop down lists, menu selection items, pop-up boxes, dialog boxes or any other graphical user interface element that is capable of implementing the necessary functions for graphically authoring and editing mark-up language sequences according to the present invention.

In operation, the flowchart view can be used to insert and delete instructions. The palette 502 of user-selectable component icons 506 has representations of each of the available components. The palette 502 is constructed from the schema and configuration files so it only contains the icons that generate valid XML elements. When an icon 506 is dragged from the template and dropped on an existing flow view, the shape is then inserted automatically into the flowchart. Additionally, the XML is automatically generated and inserted into the XML document and all other views are synchronized to the flowchart. With one drag and drop operation, an XML script is generated that is well formed and, by design, is validated according to the schema. No further error checking is necessary.

FIG. 6 is a screenshot of an exemplary XML property form in accordance with the present invention. In particular, the properties form contains a user interface component for entering a title of the component, an expression associated with the element, assertions associated with the various fields of the component, and additional fields for selecting and entering other properties of the component. Assertions are programming constructs designed to validate the data of a particular field or property associated with the component.

In operation, not all details associated with a particular component can be contained in a drag and drop flowchart symbol. Individual XML instructions have associated attributes and elements (referred to herein as properties). To abstract the user from the underlying XML, the interface also needs a facility for the entry of properties associated with an XML component. The XML graphical editing tool uses the XML Properties Form of FIG. 6 for this purpose. Using the XML Properties Form to input XML Properties, the user does not have to remember property names nor type them in. The user chooses from a drop down list or selects a button. The values for the selected property (the second column of FIG. 6) is either a drop down list itself, filled through a sub form, or filled using keyboard input (validated as the user types). The actual form layout is dynamically generated from the XML Schema rules (thus when the schema changes, the property forms change). While the exemplary property form shown contains specific user interface elements, it should be appreciated that the property form can be implemented with a variety of user interface elements according to the contemplated use of the present invention.

FIG. 7 is a screenshot of an exemplary tool combining a palette, a flowchart, a properties form and an XML tree view. In particular, the unified authoring and editing environment of FIG. 7 contains a palette 502 of user-selectable components represented by icons, an authoring and editing area 504, a properties form 702, and an XML tree view 704.

In operation, using the unified graphical XML tool described herein, the user is totally abstracted from the XML and the underlying XML schema. The user sets up the flow of the program in the flowchart views by a simple drag and drop facility. The individual properties of each instruction are then selected and entered on the Properties Forms. The user then can see the resultant XML code viewed in the XML tree view 704 window. There is much less chance for entry errors that can be time consuming, since only the valid options are available for selection or allowed to be entered. Data entry through a keyboard is reduced. There are no post-editing error messages. Errors are avoided since errors are either not possible (through the use of drag-and-drop symbols and selection lists) or entries are validated in real-time as the entries are typed. The unified graphical XML tool also provides an integrated design environment to visualize and maintain scripts. The tool keeps the user focused on solving a problem, not focused on ensuring the data is well formed or valid. The typical user (since the interface abstracts away the underlying XML code) can be less experienced and skilled in mark-up languages.

Additionally, for a more advanced user, a tree view 704 of the XML code is provided in addition to the flowchart and the property form inputs. This view permits the more advanced user to view and edit the XML code directly. All views are synchronized. A change in one view is reflected in the other views. Once the graphical editing of the mark-up language is complete, the graphical mark-up language authoring tool program may store the native mark-up language code representation of the mark-up language sequence.

As shown in the above figures, the graphical mark-up language methods and systems can be implemented on a general-purpose computer, a special-purpose computer, a programmed microprocessor or microcontroller and peripheral integrated circuit element, and ASIC or other integrated circuit, a digital signal processor, a hardwired electronic or logic circuit such as a discrete element circuit, a programmed logic device such as a PLD, PLA, FPGA, PAL, or the like. In general, any process capable of implementing the functions described herein can be used to implement a system for graphically authoring and/or editing mark-up language sequences according to this invention.

Furthermore, the disclosed system may be readily implemented in software using object or object-oriented software development environments that provide portable source code that can be used on a variety of computer platforms. Alternatively, the disclosed system for graphically authoring and editing mark-up language sequences may be implemented partially or fully in hardware using standard logic circuits or a VLSI design. Other hardware or software can be used to implement the systems in accordance with this invention depending on the speed and/or efficiency requirements of the systems, the particular function, and/or a particular software or hardware system, microprocessor, or microcomputer system being utilized. The graphical mark-up language authoring and editing system illustrated herein can readily be implemented in hardware and/or software using any known or later developed systems or structures, devices and/or software by those of ordinary skill in the applicable art from the functional description provided herein and with a general basic knowledge of the computer and mark-up language arts.

Moreover, the disclosed methods may be readily implemented in software executed on programmed general-purpose computer, a special purpose computer, a microprocessor, or the like. In these instances, the systems and methods of this invention can be implemented as program embedded on personal computer such as JAVA® or CGI script, as a resource residing on a server or graphics workstation, as a routine embedded in a dedicated encoding/decoding system, or the like. The system can also be implemented by physically incorporating the system and method into a software and/or hardware system, such as the hardware and software systems of an image processor.

It is, therefore, apparent that there is provided in accordance with the present invention, systems and methods for graphically authoring and editing mark-up language sequences. While this invention has been described in conjunction with a number of embodiments, it is evident that many alternatives, modifications and variations would be or are apparent to those of ordinary skill in the applicable arts. Accordingly, applicants intend to embrace all such alternatives, modifications, equivalents and variations that are within the spirit and scope of this invention.