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: HTML pages and scripts meant to be imported into the | 12 * Top-level files: |
13 respective products. | 13 * `firstRun.html` and `firstRun.js`: First-run page, see below |
| 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 |
| 17 to messages sent by UI code. |
| 18 * `background.html`, `background.js`: Test implementation of the background |
| 19 page, should *not be imported*. |
14 * `locale` directory: Localized strings, with one directory per locale. The | 20 * `locale` directory: Localized strings, with one directory per locale. The |
15 Firefox format for locale identifiers is used (xx-YY where xx is the language | 21 Firefox format for locale identifiers is used (xx-YY where xx is the language |
16 code and YY the optional region code). The localization strings themselves are | 22 code and YY the optional region code). The localization strings themselves are |
17 stored in the JSON format, like the one used by Chrome extensions. There is | 23 stored in the JSON format, like the one used by Chrome extensions. There is |
18 one JSON file per HTML page, file names of HTML page and JSON file should | 24 one JSON file per HTML page, file names of HTML page and JSON file should |
19 match. | 25 match. |
20 * `skin` directory: CSS files and any additional resources (images and fonts) | 26 * `skin` directory: CSS files and any additional resources (images and fonts) |
21 required for these. | 27 required for these. |
22 * `ext` directory: Test implementation of the abstraction layer. This one should | 28 * `ext` directory: Test implementation of the abstraction layer. This one should |
23 *not to be imported*, these files should rather be replaced by | 29 *not to be imported*, these files should rather be replaced by |
(...skipping 23 matching lines...) Expand all Loading... |
47 | 53 |
48 The behavior of this page is affected by a number of URL parameters: | 54 The behavior of this page is affected by a number of URL parameters: |
49 | 55 |
50 * `platform`, `platformVersion`, `application`, `applicationVersion`: sets | 56 * `platform`, `platformVersion`, `application`, `applicationVersion`: sets |
51 application parameters that are normally determined by Adblock Plus. Using | 57 application parameters that are normally determined by Adblock Plus. Using |
52 `?platform=safari&platformVersion=5.0` should trigger a warning. | 58 `?platform=safari&platformVersion=5.0` should trigger a warning. |
53 * `seenDataCorruption`, `filterlistsReinitialized`: setting these parameters to | 59 * `seenDataCorruption`, `filterlistsReinitialized`: setting these parameters to |
54 `true` should trigger warnings referring to issues detected by Adblock Plus. | 60 `true` should trigger warnings referring to issues detected by Adblock Plus. |
55 * `blockedURLs`: a comma-separated list of URLs that should be considered | 61 * `blockedURLs`: a comma-separated list of URLs that should be considered |
56 blocked (necessary to test the check for blocked scripts in sharing buttons). | 62 blocked (necessary to test the check for blocked scripts in sharing buttons). |
OLD | NEW |