Opened on 06/28/2017 at 12:15:34 PM
Closed on 07/31/2017 at 11:36:45 AM
#5353 closed defect (fixed)
Writing filters documentation does not include latest filter changes.
| Reported by: | Ross | Assignee: | hfiguiere |
|---|---|---|---|
| Priority: | P3 | Milestone: | |
| Module: | Websites | Keywords: | |
| Cc: | hfiguiere, sebastian, lisabielik, wspee, greiner | Blocked By: | |
| Blocking: | Platform: | Unknown / Cross platform | |
| Ready: | no | Confidential: | no |
| Tester: | Unknown | Verified working: | no |
| Review URL(s): | |||
Description (last modified by Ross)
Environment
N/A.
How to reproduce
Observed behaviour
Newer filter features are not described at all on the Writing filters documentation page. This includes new filter options, such as $websocket and $webrtc, along with documentation about property filters.
These are currently described in various blog posts such as:
- https://adblockplus.org/development-builds/new-syntax-for-advanced-element-hiding-rules
- https://adblockplus.org/development-builds/new-css-property-filter-syntax
Expected behaviour
The Writing filters page to describe all currently available/public filter options and syntax.
Attachments (0)
Change History (16)
comment:2 Changed on 06/28/2017 at 12:20:44 PM by hfiguiere
- Cc hfiguiere added
comment:3 Changed on 07/05/2017 at 12:03:49 PM by sebastian
- Cc sebastian added
comment:4 Changed on 07/05/2017 at 12:04:49 PM by hfiguiere
- Owner set to hfiguiere
comment:5 Changed on 07/05/2017 at 12:18:41 PM by sebastian
comment:6 Changed on 07/07/2017 at 05:41:29 PM by hfiguiere
- Review URL(s) modified (diff)
- Status changed from new to reviewing
comment:7 Changed on 07/07/2017 at 06:20:41 PM by hfiguiere
The webrtc and websocket options are already documented.
comment:8 Changed on 07/12/2017 at 01:58:26 PM by juliandoucette
- Cc lisabielik wspee added
I'm guessing that you forgot to have your content reviewed by Lisa?
comment:9 Changed on 07/12/2017 at 01:59:06 PM by juliandoucette
- Priority changed from Unknown to P3
comment:10 follow-up: ↓ 11 Changed on 07/27/2017 at 03:03:37 PM by greiner
- Cc greiner added
We removed support for the simplified element hiding filter syntax while introducing the new one for element hiding emulation filters in #5287. Therefore I'd suggest also removing any references to those from /filters and /filter-cheatsheet.
comment:11 in reply to: ↑ 10 ; follow-up: ↓ 12 Changed on 07/27/2017 at 04:37:55 PM by hfiguiere
Replying to greiner:
We removed support for the simplified element hiding filter syntax while introducing the new one for element hiding emulation filters in #5287. Therefore I'd suggest also removing any references to those from /filters and /filter-cheatsheet.
We just removed [-abp-properties=] and this didn't have any mention in the documentation anyway. The simplified element hiding filter still exist and work (the ## rules)
comment:12 in reply to: ↑ 11 Changed on 07/27/2017 at 04:46:39 PM by greiner
Replying to hfiguiere:
We just removed [-abp-properties=] and this didn't have any mention in the documentation anyway. The simplified element hiding filter still exist and work (the ## rules)
I'm not referring to regular element hiding filters (e.g. example.com##div#foo) but to the variant that doesn't use CSS selectors (e.g. example.com#div(id=foo)).
comment:13 follow-up: ↓ 14 Changed on 07/27/2017 at 05:26:17 PM by hfiguiere
oh ! my bad, I misunderstood.
Maybe an issue should be filed for this one.
We should IMHO get a complete documentation review and editing.
comment:14 in reply to: ↑ 13 Changed on 07/27/2017 at 05:41:28 PM by greiner
Replying to hfiguiere:
oh ! my bad, I misunderstood.
No worries. They've been deprecated for years already so most people have probably never heard of them.
Maybe an issue should be filed for this one.
We should IMHO get a complete documentation review and editing.
Ok, that's fine. I thought it'd be reasonable to post here first since this ticket concerns including the latest filter changes and since it hasn't been set to "ready" yet.
Anyway, I created #5454 for the removal of the documentation of the simplified syntax now.
comment:15 Changed on 07/31/2017 at 08:50:28 AM by abpbot
A commit referencing this issue has landed:
Issue 5353 - Add advanced element hiding filters documentation
comment:16 Changed on 07/31/2017 at 11:36:45 AM by hfiguiere
- Resolution set to fixed
- Status changed from reviewing to closed
Usually, we update the filter documentation, as soon as we release a new version featuring the new syntax. That said, it would be great if we could land the changed to the documentation next week, on July 12th, when we release Adblock Plus 1.13.3.