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 ------------------- |
(...skipping 15 matching lines...) Expand all Loading... |
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 |
30 *not to be imported*, these files should rather be replaced by | 30 *not to be imported*, these files should rather be replaced by |
31 product-specific versions providing the same interface. | 31 product-specific versions providing the same interface. |
32 | 32 |
33 Testing | 33 Testing |
34 ------- | 34 ------- |
35 | 35 |
36 In Firefox and Safari the HTML pages can be opened directly from the file system | 36 In Firefox the HTML pages can be opened directly from the file system |
37 and should be fully functional. Due to security restrictions in Chrome, there | 37 and should be fully functional. Due to security restrictions in Chrome, there |
38 you need to pass in the `--allow-file-access-from-files` command line flag when | 38 you need to pass in the `--allow-file-access-from-files` command line flag when |
39 starting the application. Alternatively, you can run `test_server.py` (requires | 39 starting the application. Alternatively, you can run `test_server.py` (requires |
40 Python 2.7) and open the HTML pages under URLs like | 40 Python 2.7) and open the HTML pages under URLs like |
41 `http://127.0.0.1:5000/firstRun.html`. | 41 `http://127.0.0.1:5000/firstRun.html`. |
42 | 42 |
43 Various aspects of the pages can be tested by setting parameters in the URL. The | 43 Various aspects of the pages can be tested by setting parameters in the URL. The |
44 only universal parameter is `locale`, e.g. `?locale=es-AR`. This parameter | 44 only universal parameter is `locale`, e.g. `?locale=es-AR`. This parameter |
45 overrides browser's locale which will be used by default. | 45 overrides browser's locale which will be used by default. |
46 | 46 |
(...skipping 10 matching lines...) Expand all Loading... |
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 To aid testing, the behavior of this page is affected by a number of URL | 63 To aid testing, the behavior of this page is affected by a number of URL |
64 parameters: | 64 parameters: |
65 | 65 |
66 * `platform`, `platformVersion`, `application`, `applicationVersion`: sets | 66 * `platform`, `platformVersion`, `application`, `applicationVersion`: sets |
67 application parameters that are normally determined by Adblock Plus. Using | 67 application parameters that are normally determined by Adblock Plus. |
68 `?platform=safari&platformVersion=5.0` should trigger a warning. | |
69 * `filterlistsReinitialized`: setting these parameters to `true` should | 68 * `filterlistsReinitialized`: setting these parameters to `true` should |
70 trigger warnings referring to issues detected by Adblock Plus. | 69 trigger warnings referring to issues detected by Adblock Plus. |
71 * `blockedURLs`: a comma-separated list of URLs that should be considered | 70 * `blockedURLs`: a comma-separated list of URLs that should be considered |
72 blocked (necessary to test the check for blocked scripts in sharing buttons). | 71 blocked (necessary to test the check for blocked scripts in sharing buttons). |
73 | 72 |
74 new-options.html | 73 new-options.html |
75 ------------ | 74 ------------ |
76 | 75 |
77 This is the new implementation of the Adblock Plus options page which will be | 76 This is the new implementation of the Adblock Plus options page which will be |
78 the primary UI for changing settings and for managing filter lists. | 77 the primary UI for changing settings and for managing filter lists. |
79 | 78 |
80 To aid testing, the behavior of this page is affected by a number of URL | 79 To aid testing, the behavior of this page is affected by a number of URL |
81 parameters: | 80 parameters: |
82 | 81 |
83 * `addonVersion`: sets addon version application parameter that is used for | 82 * `addonVersion`: sets addon version application parameter that is used for |
84 creating the link to the version-specific release notes | 83 creating the link to the version-specific release notes |
85 * `addSubscription=true`: this parameter should trigger a dialog for adding | 84 * `addSubscription=true`: this parameter should trigger a dialog for adding |
86 subscriptions as initiated by clicking on an "abp:subscribe" link | 85 subscriptions as initiated by clicking on an "abp:subscribe" link |
87 * `filterError=true`: causes filter validation to fail, showing validation | 86 * `filterError=true`: causes filter validation to fail, showing validation |
88 errors when adding new filters on the options page | 87 errors when adding new filters on the options page |
89 * `blockedURLs`: a comma-separated list of URLs that should be considered | 88 * `blockedURLs`: a comma-separated list of URLs that should be considered |
90 blocked (necessary to test the check for blocked scripts in sharing buttons). | 89 blocked (necessary to test the check for blocked scripts in sharing buttons). |
91 * `downloadStatus`: sets downloadStatus parameter for filter lists, can be used | 90 * `downloadStatus`: sets downloadStatus parameter for filter lists, can be used |
92 to trigger various filter list download errors | 91 to trigger various filter list download errors |
93 * `platform=chromium`: shows the opt-out for the developer tools panel | 92 * `platform=chromium`: shows the opt-out for the developer tools panel |
94 * `safariContentBlocker=true`: sets Safari content blocker mock API | |
95 * `showNotificationUI=true`: simulates user having opted-out of notifications | 93 * `showNotificationUI=true`: simulates user having opted-out of notifications |
96 | 94 |
97 | 95 |
98 [crowdin]: https://crowdin.com | 96 [crowdin]: https://crowdin.com |
OLD | NEW |