sections/README.md

   1 # Sections
   2
   3 **🇭🇺 [Kattints ide a magyar nyelvű változatért][hu-version].**
   4
   5 This directory contains the section files that are actually contains the filtering rules. We use these files to generate
   6 the filter lists based on the [`filters.json`][filters-json] file.
   7
   8 Hufilter supports the following adblockers:
   9
  10 - <img src="https://cdn.adguard.com/website/github.com/AGLint/adg_logo.svg" width="14px"> [AdGuard][adg-url]
  11 - <img src="https://cdn.adguard.com/website/github.com/AGLint/abp_logo.svg" width="14px"> [Adblock Plus][abp-url]
  12 - <img src="https://cdn.adguard.com/website/github.com/AGLint/ubo_logo.svg" width="14px"> [uBlock Origin][ubo-url]
  13
  14 ## Common and adblocker-specific rules
  15
  16 If a filtering rule works with all supported adblockers, it will be placed into one of the common section file, which
  17 are located in the root of the `sections` directory. For example, `sections/ads.txt`.
  18
  19 If a filtering rule only works with a specific adblocker, it will be placed in the corresponding "specific"
  20 section directory based on the adblocker it works with:
  21
  22 - [`adguard-specific` folder][adg-section]
  23 - [`adblock-plus-specific` folder][abp-section]
  24 - [`ublock-origin-specific` folder][ubo-section]
  25
  26 > **Note:** If a filtering rule is common, but doesn't work without a specific rule, it will also be placed in the
  27 > corresponding "specific" section directory. For example, if you hide a cookie notice with a common rule, but the
  28 > website disables scrolling until you accept the cookies, you will need to add a specific rule to enable scrolling.
  29 > If you put the hiding rule into the common section in this case, the website will be broken for users who use
  30 > adblockers that don't supports your specific rule, since the scrolling will be disabled for them.
  31
  32 ## Section files
  33
  34 We use the same file structure in each section directory:
  35
  36 - `ads.txt` - Contains rules for blocking advertisements.
  37 - `annoyances.txt` - Contains rules for blocking annoying elements on websites, such as cookie notices, newsletter
  38   subscription prompts, floating elements and so on.
  39 - `antiadblock.txt` - Contains rules for bypassing anti-adblock protections.
  40 - `selfpromo.txt` - Contains rules for blocking self-promotion and donation requests.
  41 - `trackers.txt` - Contains rules for blocking trackers and other privacy-invasive technologies.
  42 - `unbreak.txt` - Contains rules for resolving issues caused by incorrect blocking.
  43
  44 [abp-section]: https://github.com/hufilter/hufilter/tree/master/sections/adblock-plus-specific
  45 [abp-url]: https://adblockplus.org
  46 [adg-section]: https://github.com/hufilter/hufilter/tree/master/sections/adguard-specific
  47 [adg-url]: https://adguard.com
  48 [filters-json]: https://github.com/hufilter/hufilter/blob/master/filters.json
  49 [hu-version]: https://github.com/hufilter/hufilter/blob/master/sections/README.hu.md
  50 [ubo-section]: https://github.com/hufilter/hufilter/tree/master/sections/ublock-origin-specific
  51 [ubo-url]: https://github.com/gorhill/uBlock