Side by Side Diff: README.md
Issue 6180766664884224:
Issue 1663 - Made first-run page use an asynchronous messaging protocol (Closed)
Patch Set: Documentation fixes
Created Dec. 17, 2014, 5:46 p.m.
| Left: | ||
| Right: |
Use n/p to move between diff chunks;
N/P to move between comments.
« no previous file with comments
|
« no previous file
|
ext/content.js » ('j')
|
no next file with comments »
Toggle Intra-line Diffs ('i') | Expand Comments ('e') | Collapse Comments ('c') | Hide Comments ('s')
Toggle Intra-line Diffs ('i') | Expand Comments ('e') | Collapse Comments ('c') | Hide Comments ('s')
| OLD | NEW |
|---|---|
| (Empty) | |
| 1 Shared Adblock Plus UI code | |
| 2 =========================== | |
| 3 | |
| 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 | |
| 6 tested within this repository, even though they might not work exactly the same | |
| 7 as they will do in the final product. | |
| 8 | |
| 9 Directory structure | |
| 10 ------------------- | |
| 11 | |
| 12 * Top-level files: HTML pages and scripts meant to be imported into the | |
| 13 respective products. | |
| 14 * `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 | |
| 16 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 | |
| 18 one JSON file per HTML page, file names of HTML page and JSON file should | |
| 19 match. | |
| 20 * `skin` directory: CSS files and any additional resources (images and fonts) | |
| 21 required for these. | |
| 22 * `ext` directory: Test implementation of the abstraction layer. This one should | |
| 23 *not to be imported*, these files should rather be replaced by | |
| 24 product-specific versions providing the same interface. | |
| 25 | |
| 26 Testing | |
| 27 ------- | |
| 28 | |
| 29 In Firefox and Safari the HTML pages can be opened directly from the file system | |
| 30 and should be fully functional. Due to security restrictions in Chrome, there | |
| 31 you need to pass in the `--allow-file-access-from-files` command line flag when | |
| 32 starting the application. Alternatively, you can run `test_server.py` (requires | |
| 33 Python 2.7) and open the HTML pages under URLs like | |
| 34 `http://127.0.0.1:5000/firstRun.html`. | |
| 35 | |
| 36 Various aspects of the pages can be tested by setting parameters in the URL. The | |
| 37 only universal parameter is `locale`, e.g. `?locale=es-AR`. This parameter | |
| 38 overrides browser's locale which will be used by default. | |
| 39 | |
| 40 firstRun.html | |
| 41 ------------- | |
| 42 | |
| 43 This is the implementation of the Adblock Plus first-run page that will show up | |
| 44 whenever changes are applied automatically to user's Adblock Plus configuration. | |
| 45 This will usually happen when the user first installs Adblock Plus (initial | |
| 46 setup), but it can also happen in the user's settings get lost for some reason. | |
| 47 | |
| 48 The behavior of this page is affected by a number of URL parameters: | |
| 49 | |
| 50 * `platform`, `platformVersion`, `application`, `applicationVersion`: sets | |
| 51 application parameters that are normally determined by Adblock Plus. Using | |
| 52 `?platform=safari&platformVersion=5.0` should trigger a warning. | |
| 53 * `seenDataCorruption`, `filterlistsReinitialized`: setting these parameters to | |
| 54 `true` should trigger warnings referring to issues detected by Adblock Plus. | |
| 55 * `blockedURLs`: a comma-separated list of URLs that should be considered | |
| 56 blocked (necessary to test the check for blocked scripts in sharing buttons). | |
| OLD | NEW |
« no previous file with comments
|
« no previous file
|
ext/content.js » ('j')
|
no next file with comments »
