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 * `utils.js`: Utility functions, to be removed soon. | |
16 * `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 |
17 to messages sent by UI code. | 16 to messages sent by UI code. |
18 * `background.html`, `background.js`: Test implementation of the background | 17 * `background.html`, `background.js`: Test implementation of the background |
19 page, should *not be imported*. | 18 page, should *not be imported*. |
20 * `locale` directory: Localized strings, with one directory per locale. The | 19 * `locale` directory: Localized strings, with one directory per locale. The |
21 Firefox format for locale identifiers is used (xx-YY where xx is the language | 20 Firefox format for locale identifiers is used (xx-YY where xx is the language |
22 code and YY the optional region code). The localization strings themselves are | 21 code and YY the optional region code). The localization strings themselves are |
23 stored in the JSON format, like the one used by Chrome extensions. There is | 22 stored in the JSON format, like the one used by Chrome extensions. There is |
24 one JSON file per HTML page, file names of HTML page and JSON file should | 23 one JSON file per HTML page, file names of HTML page and JSON file should |
25 match. | 24 match. |
(...skipping 27 matching lines...) Expand all Loading... |
53 | 52 |
54 The behavior of this page is affected by a number of URL parameters: | 53 The behavior of this page is affected by a number of URL parameters: |
55 | 54 |
56 * `platform`, `platformVersion`, `application`, `applicationVersion`: sets | 55 * `platform`, `platformVersion`, `application`, `applicationVersion`: sets |
57 application parameters that are normally determined by Adblock Plus. Using | 56 application parameters that are normally determined by Adblock Plus. Using |
58 `?platform=safari&platformVersion=5.0` should trigger a warning. | 57 `?platform=safari&platformVersion=5.0` should trigger a warning. |
59 * `seenDataCorruption`, `filterlistsReinitialized`: setting these parameters to | 58 * `seenDataCorruption`, `filterlistsReinitialized`: setting these parameters to |
60 `true` should trigger warnings referring to issues detected by Adblock Plus. | 59 `true` should trigger warnings referring to issues detected by Adblock Plus. |
61 * `blockedURLs`: a comma-separated list of URLs that should be considered | 60 * `blockedURLs`: a comma-separated list of URLs that should be considered |
62 blocked (necessary to test the check for blocked scripts in sharing buttons). | 61 blocked (necessary to test the check for blocked scripts in sharing buttons). |
OLD | NEW |