Bookmarklet to Manage Style Checker Results

The bookmarklet below helps you work with the result files of the documentation style checker.

Installation

To install, drag the ☑ Check to the bookmarks bar of your browser.

Usage

To start the bookmarklet:

1. Open a result file.
2. Click ☑ Check in the bookmarks bar.

• Mark a result message as done by clicking it. Unmark a result message by clicking it again.
• Collapse a section of results by clicking its title. Re-open a section of results by clicking its title again.
• You can show or hide different types of messages using the check boxes on the top right.

Questions and Answers

What Is a Bookmarklet?

A bookmarklet is a small script that can be used like a normal browser bookmark. However, instead of opening a new Web page, it executes a bit of code on the Web page that is currently opened. Also see the Wikipedia entry Bookmarklet.

Do I Need this Bookmarklet?

No. It makes working with the results files from the SUSE Documentation Style Checker easier, though.

Why is the functionality of the boomarklet not built into the results file itself?

The result file is an XML document. Thus it is not possible to add Javascript to it directly. There may be other ways to work around this problem, but a bookmarklet seemed the simplest.