michael/clear-urls-browser-extension
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
3ecda9f2d9
clear-urls-browser-extension/.wiki/1.1-Interface.md
Kevin Röbert fcec22608d Try a wiki fix
2018-06-06 19:00:12 +02:00

3.2 KiB
Raw Blame History

Interface

Please note: the following descriptions refers to versions 1.2.1.x.

Structure

ClearURLs is divided into two areas. The head (1) and body (2-5).

Image of structure[1]

Head

The head is marked as "1." in the image [1] above. The head consists of the logo (orange trash can), the addon name (ClearURLs) and the version number.

Body

The body is marked as "2.-5." in the image [1] above. The body is divided into four areas (Configs, Statistics, Rules-Status and Log-Button). All areas have headings except the Log-Button.

Configs

In the configs area (2.) are three switch buttons (Filters, Logging, Badges). If a switch is green, then this function is active. Else (the switch is orange) the function is disabled.

The filters switch activates the cleaning functionality of ClearURLs. If you disable this option, the whole addon is disabled.

The logging switch activate the logging functionality of ClearURLs. We advise against activating this feature, if you do not need it, because it reduces your privacy if anybody reach/steal your log. To see your log, you must click on the Log-Button "5.".

The Badges switch activates the badge functionality (See WebExtensions API) of the addon. In the current version (1.2.x.x) the addon counts the blocked elements per url in the current tab.

Statistics

In the statistics area (3.) are three small headings (Elements, Blocked and Percentage).

Under the heading "Elements" stands the total value of all fields in all visited urls since the last "Reset".

Under the heading "Blocked" stands the total value of fields in urls blocked by ClearURLs since the last "Reset".

Under the heading "Percentage" stands the percentage of blocked fields in relation to the total fields since the last "Reset". ((Elements/Blocked)*100) (fixed to three decimal places). The progress bar (first element in section "3." > Statistics) use the same value and is only a visualization of "Percentage".

Finally, the "Reset" button. The "Reset" button reset all statistic elements, in detail:

  1. Elements
  2. Blocked
  3. Percentage
  4. Progress bar

The "Reset" button do not delete the rules. The rules are stable.

Rules-Status

Under the heading "Rules-Status" (4.) stands the status of the rules file. ClearURLs know four different states:

  1. "up to date": No changes, the rules are up to date
  2. "updated": ClearURLs has downloaded new rules and activate them
  3. "update available": ClearURLs has downloaded new rules, but something goes wrong, so ClearURLs is using the old rules and tries to download the new rules by the next browser start
  4. "error": Something unexpected happened. ClearURLs does not work correctly until browser reboot

Log-Button

With the log button (5.) you get to the log file.