Scenarios

What license is used ?

Public Domain license.

Why scenarios ?

Scenarios are an easy, implementation-independent way to test interoperability. By using this approach, you also avoid issues that may arise when uploading real life documents (IPR, accidentally disclosing sensitive information).

How can I create a new scenario ?

  • Log in
  • Change the URL in the browser to http://plugtest.opendocsociety.org/doku.php?id=scenarios:date:shortname (for example …scenarios:20090622:foobar)
  • Click on the “Create this page” in the top left corner of the new wiki page
  • Open a new window and go to the scenarios template page
  • Click “Edit this page” in the top left corner of the template wiki page
  • Copy the source to the first window and click “Cancel” on the template page
  • Add the steps and save the scenario

I want to save a document created by a scenario, is there a file name convention ?

The scenario should mention a name for the document, simply add an underscore as a separator and a suffix containing of the short name (listed in the implementations) followed by the version

Example:

  • For a document created with OpenOffice.org 3.1: simplescenario_ooo31.odt
  • If the document is changed/saved again in KOffice 2.0alpha: simplescenario_ooo31_koffice20a.odt

If you want to add the platform, simply add a hyphen as a separator and suffix it with one of the following names:

BSD bsd
Linux lin
MacOSX mac
Symbian sbn
Windows XP xp
Windows Vista vis
Windows 7 w7

Example:

  • For a document created with OpenOffice.org 3.1 on Vista: simplescenario_ooo31-vis.odt
  • If the document is changed/saved again in KOffice 2.0 alpha3 on FreeBSD: simplescenario_ooo31-vis_koffice20a3-bsd.odt

How do I upload a document ?

Uploading is done by clicking on the “add image” icon while editing a page in the text editor:

  1. A new browser window will appear.
  2. Select the file you'd like to upload (note that some file types like .txt are not allowed) but do not close the window.
  3. If the file has been successfully uploaded, the file name will appear in the file list
  4. Click on the file name, this will add the necessary wiki code to the wiki page you're editing

Where can I add the results or comments ?

Each scenario has a “tracker” section, where you can report issues. Issues can, but don't have to, be grouped per implementation.

click to enlarge

The most recent scenarios also provide a “files” section where you can upload the resulting ODF file from your implementation. Optionally, a PDF rendering can be added for viewing convenience (Note that this ODF-to-PDF conversion may introduce new issues, so use it with caution)

click to enlarge

Linking scenario issues to 3rd party bug track tools (sourceforge etc)

It is considered good practice to report the issues being found to the implementer/vendor(s), preferably by using the publicly available bug track tool for that implementation (if available, check the implementation pages on this wiki to find out if an implementation provides such a facility)

If possible, please also add a link from the scenario wiki page to the relevant bug ticket(s). You can do this easily by adding a link in the “comment” column of the Tracker.

click to enlarge

Creating a todo list for your implementation

On a related note, it also comes in handy to have an overview of all the scenarios that have open issues for a particular implementation. This can easily be done within the wiki by adding an internal link from the open issue (in the Write and/or Read column of the tracker) to the implementation(s) wiki page.

Then, you can go to the page of your favorite and click on Issues/Backlinks to see a list of scenarios with open issues.

Analysis and discussion

Underneath every scenario, there's a section where you can add a more lengthy analysis on the issues being found. This is also a good place to document/summarize mailing list discussions related to that scenario.

faq/scenarios.txt · Last modified: 2010/10/24 18:14 (external edit)
www.ez.nl www.noiv.nl www.opendocsociety.org