sitescripts/content_blocker_lists/README.md - Issue 29332452: Noissue - Add documentation for content_blocker_lists

Keyboard Shortcuts

	File
u :	up to issue
m :	publish + mail comments
M :	edit review message
j / k :	jump to file after / before current file
J / K :	jump to next file with a comment after / before current file
	Side-by-side diff
i :	toggle intra-line diffs
e :	expand all comments
c :	collapse all comments
s :	toggle showing all comments
n / p :	next / previous diff chunk or comment
N / P :	next / previous comment
<Up> / <Down> :	next / previous line
<Enter> :	respond to / edit current comment
d :	mark current comment as done

	Issue
u :	up to list of issues
m :	publish + mail comments
j / k :	jump to patch after / before current patch
o / <Enter> :	open current patch in side-by-side view
i :	open current patch in unified diff view

	Issue List
j / k :	jump to issue after / before current issue
o / <Enter> :	open current issue
# :	close issue

	Comment/message editing
<Ctrl> + s or <Ctrl> + Enter :	save comment
<Esc> :	cancel edit

Delta Between Two Patch Sets: sitescripts/content_blocker_lists/README.md

Issue 29332452: Noissue - Add documentation for content_blocker_lists (Closed)

Left Patch Set: Created Dec. 8, 2015, 4:01 p.m.

Right Patch Set: Minor corrections Created Dec. 10, 2015, 1:08 p.m.

Left:
Right:

Use n/p to move between diff chunks; N/P to move between comments.

Jump to:

Left: Side by side diff | Download
Right: Side by side diff | Download

LEFT	RIGHT
1 # Content blocker lists	1 # Content blocker lists

2	2

3 ## Introduction	3 ## Introduction

4	4

5 The `sitescripts.content_blocker_lists.bin` package contains scripts	5 The `sitescripts.content_blocker_lists.bin` package contains scripts

6 used on the server side for producing our content blocker lists.	6 used on the server side for producing our content blocker lists.

7 [Content blocker lists can be used by newer versions of Safari and iOS][1].	7 [Content blocker lists can be used by newer versions of Safari and iOS][1].

8	8

9 ## generate_lists.py	9 ## generate_lists.py

10	10

11 The generate_list.py script wraps [ab2blocklist][2] so that we can more	11 The `generate_list.py` script wraps [abp2blocklist][2] so that we can more
Sebastian Noack 2015/12/09 17:06:25 Typo: ab2blocklist -> abp2blocklist Typo: ab2blocklist -> abp2blocklist kzar 2015/12/10 13:09:23 Done. Show quoted text On 2015/12/09 17:06:25, Sebastian Noack wrote: > Typo: ab2blocklist -> abp2blocklist Done.
12 conveniently produce our content blocker lists on our servers. The script	12 conveniently produce our content blocker lists on our servers. The script

13 additionally wraps the lists with some metadata [as specified in issue 3176][3].	13 additionally wraps the lists with some metadata [as specified in issue 3176][3].

14	14

15 To use add the relevant configuration to your scritescripts.ini file. For	15 To use add the relevant configuration to your `scritescripts.ini` file. For
Sebastian Noack 2015/12/09 17:06:25 Nit: Put filenames in backticks Nit: Put filenames in backticks kzar 2015/12/10 13:09:23 Done. Show quoted text On 2015/12/09 17:06:25, Sebastian Noack wrote: > Nit: Put filenames in backticks Done.
16 example:	16 example:

17	17

18 [content_blocker_lists]	18 [content_blocker_lists]

19 abp2blocklist_url=https://hg.adblockplus.org/abp2blocklist	19 abp2blocklist_url=https://hg.adblockplus.org/abp2blocklist

20 abp2blocklist_path=%(root)s/content_blocker_lists/abp2blocklist	20 abp2blocklist_path=%(root)s/content_blocker_lists/abp2blocklist

21 easylist_url=https://easylist-downloads.adblockplus.org/easylist_noadult.txt	21 easylist_url=https://easylist-downloads.adblockplus.org/easylist_noadult.txt

22 exceptionrules_url=https://easylist-downloads.adblockplus.org/exceptionrules .txt	22 exceptionrules_url=https://easylist-downloads.adblockplus.org/exceptionrules .txt

23 easylist_content_blocker_path=%(root)s/content_blocker_lists/easylist_conten t_blocker.json	23 easylist_content_blocker_path=%(root)s/content_blocker_lists/easylist_conten t_blocker.json

24 easylist_content_blocker_expires=4 days	24 easylist_content_blocker_expires=4 days

25 combined_content_blocker_path=%(root)s/content_blocker_lists/easylist+except ionrules_content_blocker.json	25 combined_content_blocker_path=%(root)s/content_blocker_lists/easylist+except ionrules_content_blocker.json

26 combined_content_blocker_expires=4 days	26 combined_content_blocker_expires=4 days

27	27

28 Then you can run the script as follows:	28 Then you can run the script as follows:

29	29

30 python -m sitescripts.content_blocker_lists.bin.generate_lists	30 python -m sitescripts.content_blocker_lists.bin.generate_lists

31	31

32 [1]: https://webkit.org/blog/3476/content-blockers-first-look/	32 [1]: https://webkit.org/blog/3476/content-blockers-first-look/

33 [2]: https://hg.adblockplus.org/abp2blocklist/	33 [2]: https://hg.adblockplus.org/abp2blocklist/

34 [3]: https://issues.adblockplus.org/ticket/3176	34 [3]: https://issues.adblockplus.org/ticket/3176

LEFT	RIGHT