OLD | NEW |
1 Shared Adblock Plus UI code | 1 Shared Adblock Plus UI code |
2 =========================== | 2 =========================== |
3 | 3 |
4 The user interface elements defined in this repository will be used by various | 4 The user interface elements defined in this repository will be used by various |
5 Adblock Plus products like Adblock Plus for Firefox. Their functionality can be | 5 Adblock Plus products like Adblock Plus for Firefox. Their functionality can be |
6 tested within this repository, even though they might not work exactly the same | 6 tested within this repository, even though they might not work exactly the same |
7 as they will do in the final product. | 7 as they will do in the final product. |
8 | 8 |
9 Directory structure | 9 Directory structure |
10 ------------------- | 10 ------------------- |
11 | 11 |
12 * Top-level files: | 12 * Top-level files: |
13 * `firstRun.html` and `firstRun.js`: First-run page, see below | 13 * `firstRun.html` and `firstRun.js`: First-run page, see below |
14 * `i18n.js`: Localization functions, should be included by all pages. | 14 * `i18n.js`: Localization functions, should be included by all pages. |
15 * `messageResponder.js`: Script to be used on the background page to respond | 15 * `messageResponder.js`: Script to be used on the background page to respond |
16 to messages sent by UI code. | 16 to messages sent by UI code. |
17 * `background.html`, `background.js`: Test implementation of the background | 17 * `background.html`, `background.js`: Test implementation of the background |
18 page, should *not be imported*. | 18 page, should *not be imported*. |
19 * `options.html`, `options.js`: Options page, see below | 19 * `new-options.html`, `new-options.js`: Options page, see below |
20 * `subscriptions.xml`: Test subscription data, should *not be imported* | 20 * `subscriptions.xml`: Test subscription data, should *not be imported* |
21 * `locale` directory: Localized strings, with one directory per locale. The | 21 * `locale` directory: Localized strings, with one directory per locale. The |
22 Firefox format for locale identifiers is used (xx-YY where xx is the language | 22 Firefox format for locale identifiers is used (xx-YY where xx is the language |
23 code and YY the optional region code). The localization strings themselves are | 23 code and YY the optional region code). The localization strings themselves are |
24 stored in the JSON format, like the one used by Chrome extensions. There is | 24 stored in the JSON format, like the one used by Chrome extensions. There is |
25 one JSON file per HTML page, file names of HTML page and JSON file should | 25 one JSON file per HTML page, file names of HTML page and JSON file should |
26 match. | 26 match. |
27 * `skin` directory: CSS files and any additional resources (images and fonts) | 27 * `skin` directory: CSS files and any additional resources (images and fonts) |
28 required for these. | 28 required for these. |
29 * `ext` directory: Test implementation of the abstraction layer. This one should | 29 * `ext` directory: Test implementation of the abstraction layer. This one should |
(...skipping 23 matching lines...) Expand all Loading... |
53 the command line. (You will also need the Crowdin API key for the project.) | 53 the command line. (You will also need the Crowdin API key for the project.) |
54 | 54 |
55 firstRun.html | 55 firstRun.html |
56 ------------- | 56 ------------- |
57 | 57 |
58 This is the implementation of the Adblock Plus first-run page that will show up | 58 This is the implementation of the Adblock Plus first-run page that will show up |
59 whenever changes are applied automatically to user's Adblock Plus configuration. | 59 whenever changes are applied automatically to user's Adblock Plus configuration. |
60 This will usually happen when the user first installs Adblock Plus (initial | 60 This will usually happen when the user first installs Adblock Plus (initial |
61 setup), but it can also happen in case the user's settings get lost. | 61 setup), but it can also happen in case the user's settings get lost. |
62 | 62 |
63 The behavior of this page is affected by a number of URL parameters: | 63 To aid testing, the behavior of this page is affected by a number of URL |
| 64 parameters: |
64 | 65 |
65 * `platform`, `platformVersion`, `application`, `applicationVersion`: sets | 66 * `platform`, `platformVersion`, `application`, `applicationVersion`: sets |
66 application parameters that are normally determined by Adblock Plus. Using | 67 application parameters that are normally determined by Adblock Plus. Using |
67 `?platform=safari&platformVersion=5.0` should trigger a warning. | 68 `?platform=safari&platformVersion=5.0` should trigger a warning. |
68 * `filterlistsReinitialized`: setting these parameters to `true` should | 69 * `filterlistsReinitialized`: setting these parameters to `true` should |
69 trigger warnings referring to issues detected by Adblock Plus. | 70 trigger warnings referring to issues detected by Adblock Plus. |
70 * `blockedURLs`: a comma-separated list of URLs that should be considered | 71 * `blockedURLs`: a comma-separated list of URLs that should be considered |
71 blocked (necessary to test the check for blocked scripts in sharing buttons). | 72 blocked (necessary to test the check for blocked scripts in sharing buttons). |
72 | 73 |
73 options.html | 74 new-options.html |
74 ------------ | 75 ------------ |
75 | 76 |
76 This is the implementation of the Adblock Plus options page which is the primary | 77 This is the new implementation of the Adblock Plus options page which will be |
77 UI for changing settings and for managing filter lists. | 78 the primary UI for changing settings and for managing filter lists. |
78 | 79 |
79 The behavior of this page is affected by a number of URL parameters: | 80 To aid testing, the behavior of this page is affected by a number of URL |
| 81 parameters: |
80 | 82 |
81 * `addonVersion`: sets addon version application parameter that is used for | 83 * `addonVersion`: sets addon version application parameter that is used for |
82 creating the link to the version-specific release notes | 84 creating the link to the version-specific release notes |
83 * `addSubscription=true`: this parameter should trigger a dialog for adding | 85 * `addSubscription=true`: this parameter should trigger a dialog for adding |
84 subscriptions as initiated by clicking on an "abp:subscribe" link | 86 subscriptions as initiated by clicking on an "abp:subscribe" link |
85 * `filterError=true`: causes filter validation to fail, showing validation | 87 * `filterError=true`: causes filter validation to fail, showing validation |
86 errors when adding new filters on the options page | 88 errors when adding new filters on the options page |
87 * `blockedURLs`: a comma-separated list of URLs that should be considered | 89 * `blockedURLs`: a comma-separated list of URLs that should be considered |
88 blocked (necessary to test the check for blocked scripts in sharing buttons). | 90 blocked (necessary to test the check for blocked scripts in sharing buttons). |
89 * `downloadStatus`: sets downloadStatus parameter for filter lists, can be used | 91 * `downloadStatus`: sets downloadStatus parameter for filter lists, can be used |
90 to trigger various filter list download errors | 92 to trigger various filter list download errors |
91 * `platform=chromium`: shows the opt-out for the developer tools panel | 93 * `platform=chromium`: shows the opt-out for the developer tools panel |
92 * `safariContentBlocker=true`: sets Safari content blocker mock API | 94 * `safariContentBlocker=true`: sets Safari content blocker mock API |
93 * `showNotificationUI=true`: simulates user having opted-out of notifications | 95 * `showNotificationUI=true`: simulates user having opted-out of notifications |
94 | 96 |
95 | 97 |
96 [crowdin]: https://crowdin.com | 98 [crowdin]: https://crowdin.com |
OLD | NEW |