Unicorn

Unicorn Use Cases

System

The system is composed by the core of UniCORN, that is to say, no module nor output template. The framework itself, no more, no less.

But considering the need of modules and outputs for UniCORN to be useful, we will also use an "extended" system composed of the framework, some observers (CSS validator, Markup validator, link checker) and outputs (xhtml, soap).

Users

There are two types of users:

• Framework maintainers are the ones who create new output formats, or new observers. It will probably be people working at/for the W3C.
• Those who will use UniCORN as a tool to check documents. They can also be separated in two:
  • humans beings
  • computers doing automatic validation/check

Humans will mostly use the Web interface to check documents, whereas computers will build the request directly and get a "computer readable" document (in SOAP for example).

Framework maintainers use cases

Adding a new observer

A framework maintainer might need to add new micro-observers (when a new recommendation is out for example).

1. First, he will have to create the observer corresponding to the need and having output format compatible with the framework (it specification will be available here).
2. Then, he has to create the contract document in order to plug the observer in the framework. The contract format specification will also be available.
3. The maintainer adds the location of the WADL and RDF contract files in a UniCORN's configuration file.
4. Finally, the maintainer creates a task for this observer, or extends existing ones.
5. The framework reads the new contract and includes the observer in its observers list, same thing for the tasks (maybe after a restart, or a command issued by the maintainer).

Adding a new output format

New recommendations imply new output formats. So, the maintainer will have to build new output templates. To do so, it's quite "simple". He needs to create a new template page:

1. According to the template and output format specifications, he builds the new template.
2. He places the new template in the templates directory.
3. The framework discovers the new output format and makes it available for the users.

Users use cases

In this part we will use the extended system, because if we consider only the framework, the user won't be able to do anything, since the framework provides as many services as there are observers and output templates: zero observer means zero service.

Single observer

1. A user comes on the framework webpage
2. He enters the URL of a document in the URL text box
3. He selects a task that will involve a single observer: the markup validation for example
4. The framework displays a list of parameters for this task
5. The user sets the parameters he wants
6. He pushes the "Check" button
7. The framework validates the document against XHTML specification, using the XHTML observer
8. It returns the result of the validation in a new webpage

Output format selection

1. A user comes on the framework webpage
2. He enters the URL of a document in the URL text box
3. He selects the output format: SOAP
4. He selects a task that will involve a single observer: the markup validation for example
5. The framework displays a list of parameters for this task
6. The user sets the parameters he wants
7. He pushes the "Check" button
8. The framework validates the document against XHTML specification, using the XHTML observer
9. It returns the result of the validation in as a SOAP document

Multiple observers

1. A user comes on the framework webpage
2. He enters the URL of a document in the URL text box
3. He selects the task HTML+CSS+Links which involves three observers:
   • XHTML validation
   • CSS validation
   • Link check
4. The framework displays a list of parameters
5. The user sets the parameters he wants
6. He pushes the "Check" button
7. The framework validates the document against XHTML and CSS specifications, using XHTML and CSS observers, and checks the links through the link checker observer
8. It returns the result of the validations and check in a new webpage

File upload

1. A user comes on the framework webpage
2. He clicks on the browse button of the "Validate by file upload" section and selects the XHTML document he wants to test in the File Chooser.
3. He selects the task HTML+CSS+Links which involves three observers:
   • XHTML validation
   • CSS validation
   • Link check
4. The framework displays a list of parameters
5. The user sets the parameters he wants
6. He pushes the "Check" button
7. The framework downloads the document and tries to guess it's type (xml, html, css, ...). It finds it is an XHTML document
8. The framework validates the document against XHTML and CSS specifications, using XHTML and CSS observers, and checks the links through the link checker observer
9. It returns the result of the validations and check in a new webpage

Direct input

1. A user comes on the framework webpage
2. He writes an XHTML fragment in the "Direct input" section's textarea. The fragment is complete (has a doctype declaration).
3. He selects the task HTML+CSS+Links which involves three observers:
   • XHTML validation
   • CSS validation
   • Link check
4. He selects the MIME-type of the code, so that the framework can know what type of document it is
5. The framework displays a list of parameters
6. The user sets the parameters he wants
7. He pushes the "Check" button
8. The framework validates the document against XHTML and CSS specifications, using XHTML and CSS observers, and checks the links through the link checker observer
9. It returns the result of the validations and check in a new webpage

Advanced interface

1. A user comes on the framework webpage
2. He enters the URL of a document in the URL text box
3. He selects the task HTML+CSS+Links which involves three observers:
   • XHTML validation
   • CSS validation
   • Link check
4. The framework displays a list of parameters
5. The user clicks on the "More parameters" link in the CSS validation section
6. More parameters appear in the CSS validation section
7. The user sets the parameters he wants
8. He pushes the "Check" button
9. The framework validates the document against XHTML and CSS specifications, using XHTML and CSS observers, and checks the links through the link checker observer
10. It returns the result of the validations and check in a new webpage

Language selection

1. A user comes on the framework webpage
2. He selects the language he prefers
3. The webpage is reloaded with the new language
4. He enters the URL of a document in the URL text box
5. He selects the task he wants to activate: XHTML in that case
6. The framework displays a list of parameters for this task
7. The user sets the parameters he wants
8. He pushes the "Check" button
9. The framework validates the document against XHTML specification, using the XHTML observer
10. It returns the result of the validation in a new webpage, in the selected language

Incompatible checks

1. A user comes on the framework webpage
2. He enters the URL of a CSS document in the URL text box
3. He selects the task HTML+CSS:
   • XHTML validation
   • CSS validation
4. The framework displays a list of parameters
5. The user sets the parameters he wants
6. He pushes the "Check" button
7. The framework validates the document against CSS specification using the CSS observer, but can't validate it against XHTML specification.
8. It returns the result of the validation in a new webpage.

Input redirection

1. A user comes on the framwork webpage
2. He clicks on the browse button of the "Validate by file upload" section and selects the XHTML document he wants to test in the File Chooser.
3. He select the task "CSS validation".
4. The framework displays a list of parameters
5. The user sets the parameters he wants
6. He pushes the "Check" button
7. The framework check mime type of the document and found it doesn't handle by CSS observer with this input method.
8. The framework find about another input method which CSS observer can handle this mime type and found the URI input method.
9. The framework redirect input from upload to uri input method and returns the result of the validation in a new web page.

Error use cases

Resource not found

1. A user comes on the framework webpage
2. He enters the URL of a document in the URL text box
3. He selects the task he wants to activate: XHTML in that case
4. The framework displays a list of parameters
5. The user sets the parameters he wants
6. He pushes the "Check" button
7. The framework does not find the document at the specified URL
8. It reports the error in a new webpage