Software Requirements and Specifications

September 23, 2002

First Draft

Back

Requirements

  1. The application shall be able to display concurrently multiple documents from a variety of file formats including XSLT, XML, schemes, and text files. Users shall be allowed to edit, save, and close any open documents on-demand.
    1. XML, XSL, and Schema files

      2. i. Files of this type shall be checked that are well-formed according to the W3C Recommendation 6 October 2000 for “Extensible Markup Language (XML) 1.0 (Second Edition)”.

      ii.This check shall occur whenever a document first opens and whenever users change the document.

      iii. Errors found during checking for well-formess shall be properly identified with a line number, character number, and problem description if available.

    2. XML Files

      3. i. In addition to the above, XML files shall be validated using given schemas whenever these are available. A schema file may be supplied by users or created on-command by the application from a given XML file. Any inconsistencies between the Schema and the XML file shall be properly displayed and include the node name, line, number, first character number, and inconsistency description whenever it’s available.

  1. Creating Schema files on-demand.
    1. From a given XML file, users shall be able to select a command that starts the process of creating a Schema for the XML file.
    2. The created schema shall be presented to the user as a first draft that users may edit, save, and/or close.
  2. Creating output files and XSLT files
    1. From a given XML and Schema files, users shall be able to construct an output file.  This output file shall include elements that are linked to the XML and/or Schema.
    2. While an output file is being created by the user, a matching XSLT file shall be created. This XSLT file shall reflect the latest user changes to the output file.
    3. Users shall also have the option to edit the XSLT file and changes shall be immediately reflected on the output file. Maintain a one-to-one correspondence between the output file and the XSLT file.
    4. Any errors found on the schema and/or XSLT files shall be properly displayed including a line number, character number, and error description if available.
    5. The application shall allow users to specify to include the xPath of elements from XML files that get mapped to an output file. This xPath shall be added as an attribute labeled ‘xPath’ which will allow applications to link elements on an output file back to the original XML structure.
  3. Maintaining projects
    1. The application shall allow users to maintain a list of related files in a project. A project shall consist of a list of XML, XSLT, Scheme, output files, and the relationship between all of these files.
    2. Users shall be able to add and remove files from a project.