Make a cheatsheet on the rules syntax

Discussion on adblockplus.org website and translations

Re: Make a cheatsheet on the rules syntax

Postby Wladimir Palant » Tue Aug 23, 2011 10:14 pm

They should be in the same table but having some section headers there would make sense.

Working on that list once again makes me wonder whether we should have $dtd, $xbl and $ping - chances of seeing any of these types on the web are more than slim. Maybe we should just list them as $other.
Wladimir Palant
ABP Developer
 
Posts: 8398
Joined: Fri Jun 09, 2006 6:59 pm
Location: Cologne, Germany

Re: Make a cheatsheet on the rules syntax

Postby Michael » Wed Aug 24, 2011 9:31 am

If the cheat sheet is only intended to refer to popular syntax, I would omit all of the options you have listed and add a note to the bottom of the table stating that there are more options available, with the text linking to the existing documentation on filter options.
Michael
 
Posts: 1361
Joined: Sat Dec 19, 2009 1:29 pm

Re: Make a cheatsheet on the rules syntax

Postby Wladimir Palant » Wed Aug 24, 2011 9:36 am

Or that, sounds like a good idea (I guess that at least $match-case would fall into the same category).
Wladimir Palant
ABP Developer
 
Posts: 8398
Joined: Fri Jun 09, 2006 6:59 pm
Location: Cologne, Germany

Re: Make a cheatsheet on the rules syntax

Postby Wladimir Palant » Wed Aug 24, 2011 10:05 am

I created a proposal to reduce the number of type options: viewtopic.php?f=4&t=8244
Wladimir Palant
ABP Developer
 
Posts: 8398
Joined: Fri Jun 09, 2006 6:59 pm
Location: Cologne, Germany

Re: Make a cheatsheet on the rules syntax

Postby Michael » Wed Aug 24, 2011 1:28 pm

I have only included the options that I think likely to be added to filters by the average user, adding only brief references to dtd, ping, xbl, xmlhttprequest, other, collapse, donottrack and match-case at the bottom of the table.

I have also made a start with element hiding section, adding one example to each of the tables. Does this demonstrate your envisaged arrangement for the section?
Michael
 
Posts: 1361
Joined: Sat Dec 19, 2009 1:29 pm

Re: Make a cheatsheet on the rules syntax

Postby Wladimir Palant » Wed Aug 24, 2011 1:46 pm

I changed the table layout slightly - I think that repeating the table header several times is confusing, also made the section headers regular table cells (but spanning two columns). I'll probably add some additional stying to the section headers later. One more nit: are you sure that xmlhttprequest is uncommon? Anyway, I think that it is starting to look good.

I guess that the separation in the element hiding section makes sense though I would probably say "Domain selection" instead of "Domain matching" (and probably a few more minor wording changes).
Wladimir Palant
ABP Developer
 
Posts: 8398
Joined: Fri Jun 09, 2006 6:59 pm
Location: Cologne, Germany

Re: Make a cheatsheet on the rules syntax

Postby Michael » Wed Aug 24, 2011 2:05 pm

Wladimir Palant wrote:...also made the section headers regular table cells (but spanning two columns).

Thanks, I'd been intending to modify the header layout at the end anyway.

Wladimir Palant wrote:One more nit: are you sure that xmlhttprequest is uncommon?

I would certainly class the option as uncommon. I cannot imagine that ordinary users, whom I have assumed are the intended audience, would need to know about the option, and even in major subscriptions such as Fanboy's List and Adversity it is only used once in each. The option is used a dozen times or so in EasyList, but relative to the total number of filters it is certainly unusual for it to be required.

Wladimir Palant wrote:I would probably say "Domain selection" instead of "Domain matching"

Agreed, I will implement this.
Michael
 
Posts: 1361
Joined: Sat Dec 19, 2009 1:29 pm

Re: Make a cheatsheet on the rules syntax

Postby Michael » Wed Aug 24, 2011 10:10 pm

I've practically finished the element hiding section of the cheat sheet, but it appears that the column width may need to be adjusted for, for example, example.com,~mail.example.com#selector.
Michael
 
Posts: 1361
Joined: Sat Dec 19, 2009 1:29 pm

Re: Make a cheatsheet on the rules syntax

Postby Wladimir Palant » Thu Aug 25, 2011 7:44 am

Done.
Wladimir Palant
ABP Developer
 
Posts: 8398
Joined: Fri Jun 09, 2006 6:59 pm
Location: Cologne, Germany

Re: Make a cheatsheet on the rules syntax

Postby Michael » Tue Aug 30, 2011 5:47 pm

Thanks. I've made a few more modifications and, as far as I'm concerned, the cheat sheet is finished. Any comments?
Michael
 
Posts: 1361
Joined: Sat Dec 19, 2009 1:29 pm

Re: Make a cheatsheet on the rules syntax

Postby Wladimir Palant » Wed Nov 16, 2011 1:20 pm

Let's make another attempt at this. The cheatsheet has the tendency to grow into large and complicated tables, so I thought about a different approach. Here is what I have so far: https://adblockplus.org/en/filter-cheatsheet (some of the old tables still remain at the end). The way it looks right now we could replace the current documentation with it rather than creating an additional page. One would only need to add a "more info" link to some explanation boxes - e.g. going to the full list of filter options or a detailed explanation of separator characters.

Comments?
Wladimir Palant
ABP Developer
 
Posts: 8398
Joined: Fri Jun 09, 2006 6:59 pm
Location: Cologne, Germany

Previous

Return to Website and translations

Who is online

Users browsing this forum: No registered users and 127 guests