LEFT | RIGHT |
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 |
| 20 * `subscriptions.xml`: Test subscription data, should *not be imported* |
19 * `locale` directory: Localized strings, with one directory per locale. The | 21 * `locale` directory: Localized strings, with one directory per locale. The |
20 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 |
21 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 |
22 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 |
23 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 |
24 match. | 26 match. |
25 * `skin` directory: CSS files and any additional resources (images and fonts) | 27 * `skin` directory: CSS files and any additional resources (images and fonts) |
26 required for these. | 28 required for these. |
27 * `ext` directory: Test implementation of the abstraction layer. This one should | 29 * `ext` directory: Test implementation of the abstraction layer. This one should |
28 *not to be imported*, these files should rather be replaced by | 30 *not to be imported*, these files should rather be replaced by |
(...skipping 40 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
69 The behavior of this page is affected by a number of URL parameters: | 71 The behavior of this page is affected by a number of URL parameters: |
70 | 72 |
71 * `addonVersion`: sets addon version application parameter that is used for | 73 * `addonVersion`: sets addon version application parameter that is used for |
72 creating the link to the version-specific release notes | 74 creating the link to the version-specific release notes |
73 * `addSubscription=true`: this parameter should trigger a dialog for adding | 75 * `addSubscription=true`: this parameter should trigger a dialog for adding |
74 subscriptions as initiated by clicking on an "abp:subscribe" link | 76 subscriptions as initiated by clicking on an "abp:subscribe" link |
75 * `filterError=true`: causes filter validation to fail, showing validation | 77 * `filterError=true`: causes filter validation to fail, showing validation |
76 errors when adding new filters on the options page | 78 errors when adding new filters on the options page |
77 * `blockedURLs`: a comma-separated list of URLs that should be considered | 79 * `blockedURLs`: a comma-separated list of URLs that should be considered |
78 blocked (necessary to test the check for blocked scripts in sharing buttons). | 80 blocked (necessary to test the check for blocked scripts in sharing buttons). |
LEFT | RIGHT |