Rietveld Code Review Tool
Help | Bug tracker | Discussion group | Source code

Side by Side Diff: README.md

Issue 29559679: Issue 5803 - rename new-options to options (Closed)
Patch Set: Created Sept. 29, 2017, 4:34 p.m.
Left:
Right:
Use n/p to move between diff chunks; N/P to move between comments.
Jump to:
View unified diff | Download patch
« no previous file with comments | « no previous file | ext/background.js » ('j') | ext/background.js » ('J')
Toggle Intra-line Diffs ('i') | Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
OLDNEW
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 * `new-options.html`, `new-options.js`: Options page, see below 19 * `options.html`, `options.js`: Options page, see below
20 * `subscriptions.xml`: Test subscription data, should *not be imported* 20 * `subscriptions.xml`: Test subscription data, should *not be imported*
21 * `locale` directory: Localized strings, with one directory per locale. The 21 * `locale` directory: Localized strings, with one directory per locale. The
22 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
23 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
24 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
25 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
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
(...skipping 46 matching lines...) Expand 10 before | Expand all | Expand 10 after
76 This is a web extension implementation of the Adblock Plus for Firefox Mobile 76 This is a web extension implementation of the Adblock Plus for Firefox Mobile
77 options page. 77 options page.
78 78
79 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
80 parameters: 80 parameters:
81 81
82 * `addSubscription=true`: this parameter should trigger a dialog for adding 82 * `addSubscription=true`: this parameter should trigger a dialog for adding
83 subscriptions as initiated by clicking on an "abp:subscribe" link 83 subscriptions as initiated by clicking on an "abp:subscribe" link
84 * `showPageOptions=true`: shows page-specific options 84 * `showPageOptions=true`: shows page-specific options
85 85
86 new-options.html 86 options.html
87 ------------ 87 ------------
88 88
89 This is the new implementation of the Adblock Plus options page which will be 89 This is the implementation of the Adblock Plus options page which will be
Thomas Greiner 2017/09/29 16:51:09 Detail: Since we're removing "new" from this sente
saroyanm 2017/09/29 17:09:32 Agree, Done.
90 the primary UI for changing settings and for managing filter lists. 90 the primary UI for changing settings and for managing filter lists.
91 91
92 To aid testing, the behavior of this page is affected by a number of URL 92 To aid testing, the behavior of this page is affected by a number of URL
93 parameters: 93 parameters:
94 94
95 * `addonVersion`: sets addon version application parameter that is used for 95 * `addonVersion`: sets addon version application parameter that is used for
96 creating the link to the version-specific release notes 96 creating the link to the version-specific release notes
97 * `addSubscription=true`: this parameter should trigger a dialog for adding 97 * `addSubscription=true`: this parameter should trigger a dialog for adding
98 subscriptions as initiated by clicking on an "abp:subscribe" link 98 subscriptions as initiated by clicking on an "abp:subscribe" link
99 * `filterError=true`: causes filter validation to fail, showing validation 99 * `filterError=true`: causes filter validation to fail, showing validation
(...skipping 11 matching lines...) Expand all
111 Linting 111 Linting
112 ------- 112 -------
113 113
114 You can lint the code using [ESLint](http://eslint.org). 114 You can lint the code using [ESLint](http://eslint.org).
115 115
116 eslint *.js lib ext 116 eslint *.js lib ext
117 117
118 You will need to set up ESLint and our configuration first, see 118 You will need to set up ESLint and our configuration first, see
119 [eslint-config-eyeo](https://hg.adblockplus.org/codingtools/file/tip/eslint-conf ig-eyeo) 119 [eslint-config-eyeo](https://hg.adblockplus.org/codingtools/file/tip/eslint-conf ig-eyeo)
120 for more information. 120 for more information.
OLDNEW
« no previous file with comments | « no previous file | ext/background.js » ('j') | ext/background.js » ('J')

Powered by Google App Engine
This is Rietveld