diff --git a/i18n/be/docusaurus-plugin-content-docs/current/adguard-for-windows/features/extensions.md b/i18n/be/docusaurus-plugin-content-docs/current/adguard-for-windows/features/extensions.md index 260fa0e83b3..17884a6df33 100644 --- a/i18n/be/docusaurus-plugin-content-docs/current/adguard-for-windows/features/extensions.md +++ b/i18n/be/docusaurus-plugin-content-docs/current/adguard-for-windows/features/extensions.md @@ -9,7 +9,7 @@ This article covers AdGuard for Windows, a multifunctional ad blocker that prote ::: -AdGuard can significantly broaden website functionality working as a [user script manager](/general/extensions). AdGuard Users can add their own scripts, as well as manage existing ones. +AdGuard can significantly extend website functionality by working as a [userscript manager](/general/extensions.md). AdGuard users can add their own scripts as well as manage existing ones. ![Extensions \*mobile\_border](https://cdn.adtidy.org/content/kb/ad_blocker/windows/overview/userscripts.png) diff --git a/i18n/be/docusaurus-plugin-content-docs/current/general/extensions.md b/i18n/be/docusaurus-plugin-content-docs/current/general/extensions.md new file mode 100644 index 00000000000..0cf454b4329 --- /dev/null +++ b/i18n/be/docusaurus-plugin-content-docs/current/general/extensions.md @@ -0,0 +1,301 @@ +--- +title: Extensions +sidebar_position: 6 +--- + +## Userscripts + +Userscripts (we also call them "extensions") are, de facto, miniprograms written in JavaScript. They modify or extend the functionality of one or more websites. Many AdGuard users may be already familiar with such userscripts as AdGuard Assistant, Popup Blocker, and AdGuard Extra. + +:::note Supported apps + +AdGuard can significantly broaden website functionality by acting as a userscript manager. You can add your custom scripts or manage the existing ones in our three products: [AdGuard for Windows](/adguard-for-windows/features/extensions), [AdGuard for Android](/adguard-for-android/features/settings#userscripts), and [AdGuard for Mac](/adguard-for-mac/features/extensions). + +::: + +### Recommended AdGuard scripts + +These userscripts come directly from the AdGuard developers, and we can guarantee that they are effective and safe. For some of the userscripts developed by others that we consider good and reliable, [scroll down to the next section](#top-picks). You can also find some of the [popular websites with scripts](#more-userscripts) below, but remember that whenever you download a userscript from an unknown source, you are exposing yourself to a certain risk, as some scripts may be harmful to your computer. + +#### AdGuard Extra + +An extension that blocks ads in difficult cases when the usual filter-based approach is not enough. AdGuard Extra comes pre-installed in AdGuard standalone apps, except for the one for iOS, so you don't need to do anything to enable it. However, if you want to use it alongside AdGuard Browser Extension or any other ad blocker, you'll need to use an additional extension. Learn more about this userscript and how to install it on [GitHub](https://github.com/AdguardTeam/AdGuardExtra). + +![AdGuard Extra](https://cdn.adtidy.org/content/kb/ad_blocker/general/adguard-extra.png) + +#### AdGuard Popup Blocker + +The name speaks for itself: it blocks popups — one of the most annoying types of ads on websites. Learn more about this userscript, its key features, and installation on [GitHub](https://github.com/AdguardTeam/PopupBlocker). + +![AdGuard Popup Blocker](https://cdn.adtidy.org/content/kb/ad_blocker/general/popup-blocker-installation.png) + +#### AdGuard Assistant (legacy version) + +This custom extension is designed to control filtering directly from the browser page (manual blocking, allowlisting, etc.). + +:::note + +This version of Assistant is legacy and there is no point in using it on new systems, as it has been replaced with the full-fledged [Browser Assistant](https://adguard.com/adguard-assistant/overview.html). However, the legacy Assistant may be useful if there is no Browser Assistant for your browser. If this is your case, you can learn how to install AdGuard Assistant on [GitHub](https://github.com/AdguardTeam/AdguardAssistant). + +::: + +#### Disable AMP + +A script that is only pre-installed in AdGuard for Android. It disables AMP (Accelerated Mobile Pages) on the Google search results page. Learn more about this userscript and how to install it on [GitHub](https://github.com/AdguardTeam/DisableAMP). + +![Disable AMP](https://cdn.adtidy.org/content/kb/ad_blocker/general/disable-amp-installation.png) + +### Top picks outside AdGuard{#top-picks} + +These userscripts are not developed by AdGuard, and therefore we can't give a 100% guarantee that they are safe and/or work at all times. However, in our experience they deserve a recommendation because they've all earned their good reputation. + +#### Don't track me Google + +This script removes Google's tracking feature from the links in Google search results. It speeds up the loading of search results and allows you to right-click or tap to copy the link URL. + +Its source code is [available on GitHub](https://github.com/Rob--W/dont-track-me-google). This userscript can be downloaded from [GreasyFork](https://greasyfork.org/en/scripts/428243-don-t-track-me-google) and installed in any AdGuard CoreLibs-based app. + +#### microShield + +A userscript for people visiting Korean websites and some international websites. The microShield userscript blocks Ad-Shield ads and anti-adblocks. Its original source code is available at [asdefuser](https://github.com/seia-soto/userscripts/tree/master/sources/asdefuser) and [AdShield Defuser](https://github.com/seia-soto/adshield-defuser). This userscript can be installed in AdGuard CoreLibs-based apps, Violentmonkey, Tampermonkey, and [quoid/userscripts](https://github.com/quoid/userscripts). Learn more about microShield and how to install it on [GitHub](https://github.com/List-KR/microShield). + +### Where can you get more userscripts?{#more-userscripts} + +Since userscripts are mainly created by enthusiasts, you should be cautious when installing them. Any script from an unknown source carries a potential risk. Yet, there is a great variety of interesting scripts that, if installed carefully and responsibly, can really make using some websites more convenient. + +Here we will describe some of the most popular userscript catalogs. + +#### Userscript.Zone + +[Userscript.Zone](https://www.userscript.zone) is a website that allows searching for userscripts by entering a matching URL or domain. The website is easy to use and has a high level of credibility as only scripts from moderated pages are displayed. + +#### Greasy Fork + +[Greasy Fork](https://greasyfork.org/) is a userscript catalog of Stylish creators. The scripts in this catalog are moderated, so their credibility is much higher. + +#### OpenUserJS.org + +[OpenUserJS.org](https://openuserjs.org/) is an open-source userscript catalog written in nodeJS. It's not moderated, so keep an eye out for suspicious scripts. + +#### Community + +If you like the idea of customizing your browser with userscripts and have questions, you can ask them on one of these websites: + +- [Stackoverflow](https://stackoverflow.com/questions/tagged/userscripts) +- [FreeNode](https://webchat.freenode.net/#greasemonkey) +- [Reddit](https://www.reddit.com/r/userscripts/) + +### Development + +#### Request license + +If you are developing your own custom script and want to test how it works with AdGuard, you can request a beta license key for the app. + +To get it, please send an email to devteam@adguard.com with the following information: + +**Subject:** Userscript author license request + +**Body:** Please tell us about the userscripts you are working on. + +Here is a [mailto link](mailto:devteam@adguard.com?Subject=Userscript%20author%20license%20request\&Body=Hello%2C%0A%0AMy%20userscript%28s%29%3A%20LINK). + +#### Compatibility + +#### Metadata block + +#### Supported properties + +```text +@name +@namespace +@description +@version +@match +@include +@exclude +@grant +@connect +@require +@resource +@downloadURL +@updateURL +@supportURL +@homepageURL +@homepage +@website +@source +@run-at +@noframes +@icon +@iconURL +@defaulticon +@icon64 +@icon64URL +``` + +#### Unsupported properties + +These properties will be simply ignored by AdGuard. + +```text +@unwrap +``` + +#### Supported GM functions + +AdGuard supports both old GM\_ functions and new GM4 API that use GM object. + +#### Values + +:::note + +All listed old Greasemonkey functions are deprecated but still supported. + +::: + +```text +GM.info / GM_info +GM.setValue / GM_setValue +GM.getValue / GM_getValue +GM.listValues / GM_listValues +GM.deleteValue / GM_deleteValue +GM.getResourceUrl / GM_getResourceURL +GM.setClipboard / GM_setClipboard +GM.xmlHttpRequest / GM_xmlhttpRequest +GM.openInTab / GM_openInTab +GM.notification +unsafeWindow +GM_getResourceText +GM_addStyle +GM_log +``` + +[Here](https://wiki.greasespot.net/GM.info) you can find more information about Greasemonkey API. + +#### Example + +```javascript +// ==UserScript== +// @name Name as shown to the user when locale is english or unknown +// @name:ru Name as shown to the user when locale is russian +// @description Description as shown to the user when locale is english or unknown +// @description:ru Description as shown to the user when locale is russian +// @icon https://myhomepage.com/myuserscript.png +// @version 1.0.0.0 +// @downloadURL https://dl.myhomepage.org/myuserscript.user.js +// @updateURL https://dl.myhomepage.org/myuserscript.meta.js +// @homepageURL https://myhomepage.com/myuserscript +// @include * +// @exclude *://website.com/* +// @resource https://myhomepage.com/myuserscript.css +// @require https://myhomepage.com/mylibrary.js +// @grant property:settings +// @grant GM_getValue +// @grant GM_setValue +// @grant GM_deleteValue +// @grant GM_listValues +// @grant GM_getResourceText +// @grant GM_getResourceURL +// @grant GM_addStyle +// @grant GM_log +// @grant GM_setClipboard +// @grant GM_xmlhttpRequest +// @grant unsafeWindow +// @grant GM_info +// @grant GM_openInTab +// @grant GM_registerMenuCommand +// @run-at document-start +// ==/UserScript== +!function(){( + console.log("I am loaded!"); +)}(); +``` + +## Userstyles + +Userstyles allow users to customize their online experience. Whether you’re looking to change the appearance of a website or automate repetitive tasks, styles offer a world of possibilities. + +AdGuard has the option to upload or create your own userstyles. This is an advanced feature, so you will need some knowledge of HTML and CSS. + +:::info Supported apps + +Currently, two AdGuard apps allow you to create and manage userstyles: AdGuard for Windows (v7.19 or later) and AdGuard for Mac (v2.16 or later). We also plan to implement this new feature in AdGuard v4.8 for Android in the nearest future. + +::: + +This is an experimental feature, so if you encounter any problems while adding or creating a userstyle, please contact our support team at . + +### How to set up a userstyle in AdGuard + +You can download userstyles from various websites. One of the most popular userstyle websites is [https://userstyles.world/](https://userstyles.world/explore), which we will use as an example for the following instructions on how to set up the userstyle in AdGuard. + +1. Follow the link above and choose the userstyle you like + +2. Right-click the _Install_ button and choose _Copy Link Address_ + +3. Open AdGuard settings → _Extensions_ + +4. Press the [+] button and paste the userstyle link + +5. Done! + +If you’re familiar with CSS rules, you can also create the userstyles yourself. + +:::note + +We don’t support userstyles that contain `@var` or `@advanced` in the metadata. AdGuard also doesn’t support `@preprocessor` without the `default` value. + +::: + +1. Open AdGuard settings → _Extensions_ + +2. Press the [+] button and choose the _Create userstyle_ option. A new window will appear on your screen + +3. To create a userstyle, first write the title with metadata, for example + + ```CSS + /* ==UserStyle== + @name New userstyle + @version 1.0 + ==/UserStyle== */ + ``` + +4. Write the CSS part after the meta data. AdGuard supports website domain names matching (`@-moz-document domain(…), …`). For example: + + ```CSS + body { + background: gray; + } + ``` + + Or: + + ```CSS + @-moz-document domain('example.org'), + domain('example.net'), + domain('example.com') body { + background: gray; + } + ``` + +5. Once you’re finished, press _Save and Close_. Your new userstyle has been successfully added to AdGuard + +### Example + +```css +/* ==UserStyle== +@name Example userstyle +@namespace https://example.org/userstyle +@homepageURL https://example.org/userstyle +@version 1.0.0 +@license Other +@description This is an example +@author example +@preprocessor default +==/UserStyle== */ +@-moz-document regexp("https?\:\/\/(www\.)?example\.(org|com).*") { + body { + background-color: #000000 !important; + } +} +``` diff --git a/i18n/be/docusaurus-plugin-content-docs/current/general/how-to-install.md b/i18n/be/docusaurus-plugin-content-docs/current/general/how-to-install.md index bae3060668a..106a29529a8 100644 --- a/i18n/be/docusaurus-plugin-content-docs/current/general/how-to-install.md +++ b/i18n/be/docusaurus-plugin-content-docs/current/general/how-to-install.md @@ -1,6 +1,6 @@ --- title: How to install AdGuard -sidebar_position: 8 +sidebar_position: 9 --- Depending on which AdGuard app or browser extension you want to install, follow one of these links to find the relevant article: diff --git a/i18n/bn/docusaurus-plugin-content-docs/current/adguard-for-windows/features/extensions.md b/i18n/bn/docusaurus-plugin-content-docs/current/adguard-for-windows/features/extensions.md index 260fa0e83b3..17884a6df33 100644 --- a/i18n/bn/docusaurus-plugin-content-docs/current/adguard-for-windows/features/extensions.md +++ b/i18n/bn/docusaurus-plugin-content-docs/current/adguard-for-windows/features/extensions.md @@ -9,7 +9,7 @@ This article covers AdGuard for Windows, a multifunctional ad blocker that prote ::: -AdGuard can significantly broaden website functionality working as a [user script manager](/general/extensions). AdGuard Users can add their own scripts, as well as manage existing ones. +AdGuard can significantly extend website functionality by working as a [userscript manager](/general/extensions.md). AdGuard users can add their own scripts as well as manage existing ones. ![Extensions \*mobile\_border](https://cdn.adtidy.org/content/kb/ad_blocker/windows/overview/userscripts.png) diff --git a/i18n/bn/docusaurus-plugin-content-docs/current/general/extensions.md b/i18n/bn/docusaurus-plugin-content-docs/current/general/extensions.md new file mode 100644 index 00000000000..0cf454b4329 --- /dev/null +++ b/i18n/bn/docusaurus-plugin-content-docs/current/general/extensions.md @@ -0,0 +1,301 @@ +--- +title: Extensions +sidebar_position: 6 +--- + +## Userscripts + +Userscripts (we also call them "extensions") are, de facto, miniprograms written in JavaScript. They modify or extend the functionality of one or more websites. Many AdGuard users may be already familiar with such userscripts as AdGuard Assistant, Popup Blocker, and AdGuard Extra. + +:::note Supported apps + +AdGuard can significantly broaden website functionality by acting as a userscript manager. You can add your custom scripts or manage the existing ones in our three products: [AdGuard for Windows](/adguard-for-windows/features/extensions), [AdGuard for Android](/adguard-for-android/features/settings#userscripts), and [AdGuard for Mac](/adguard-for-mac/features/extensions). + +::: + +### Recommended AdGuard scripts + +These userscripts come directly from the AdGuard developers, and we can guarantee that they are effective and safe. For some of the userscripts developed by others that we consider good and reliable, [scroll down to the next section](#top-picks). You can also find some of the [popular websites with scripts](#more-userscripts) below, but remember that whenever you download a userscript from an unknown source, you are exposing yourself to a certain risk, as some scripts may be harmful to your computer. + +#### AdGuard Extra + +An extension that blocks ads in difficult cases when the usual filter-based approach is not enough. AdGuard Extra comes pre-installed in AdGuard standalone apps, except for the one for iOS, so you don't need to do anything to enable it. However, if you want to use it alongside AdGuard Browser Extension or any other ad blocker, you'll need to use an additional extension. Learn more about this userscript and how to install it on [GitHub](https://github.com/AdguardTeam/AdGuardExtra). + +![AdGuard Extra](https://cdn.adtidy.org/content/kb/ad_blocker/general/adguard-extra.png) + +#### AdGuard Popup Blocker + +The name speaks for itself: it blocks popups — one of the most annoying types of ads on websites. Learn more about this userscript, its key features, and installation on [GitHub](https://github.com/AdguardTeam/PopupBlocker). + +![AdGuard Popup Blocker](https://cdn.adtidy.org/content/kb/ad_blocker/general/popup-blocker-installation.png) + +#### AdGuard Assistant (legacy version) + +This custom extension is designed to control filtering directly from the browser page (manual blocking, allowlisting, etc.). + +:::note + +This version of Assistant is legacy and there is no point in using it on new systems, as it has been replaced with the full-fledged [Browser Assistant](https://adguard.com/adguard-assistant/overview.html). However, the legacy Assistant may be useful if there is no Browser Assistant for your browser. If this is your case, you can learn how to install AdGuard Assistant on [GitHub](https://github.com/AdguardTeam/AdguardAssistant). + +::: + +#### Disable AMP + +A script that is only pre-installed in AdGuard for Android. It disables AMP (Accelerated Mobile Pages) on the Google search results page. Learn more about this userscript and how to install it on [GitHub](https://github.com/AdguardTeam/DisableAMP). + +![Disable AMP](https://cdn.adtidy.org/content/kb/ad_blocker/general/disable-amp-installation.png) + +### Top picks outside AdGuard{#top-picks} + +These userscripts are not developed by AdGuard, and therefore we can't give a 100% guarantee that they are safe and/or work at all times. However, in our experience they deserve a recommendation because they've all earned their good reputation. + +#### Don't track me Google + +This script removes Google's tracking feature from the links in Google search results. It speeds up the loading of search results and allows you to right-click or tap to copy the link URL. + +Its source code is [available on GitHub](https://github.com/Rob--W/dont-track-me-google). This userscript can be downloaded from [GreasyFork](https://greasyfork.org/en/scripts/428243-don-t-track-me-google) and installed in any AdGuard CoreLibs-based app. + +#### microShield + +A userscript for people visiting Korean websites and some international websites. The microShield userscript blocks Ad-Shield ads and anti-adblocks. Its original source code is available at [asdefuser](https://github.com/seia-soto/userscripts/tree/master/sources/asdefuser) and [AdShield Defuser](https://github.com/seia-soto/adshield-defuser). This userscript can be installed in AdGuard CoreLibs-based apps, Violentmonkey, Tampermonkey, and [quoid/userscripts](https://github.com/quoid/userscripts). Learn more about microShield and how to install it on [GitHub](https://github.com/List-KR/microShield). + +### Where can you get more userscripts?{#more-userscripts} + +Since userscripts are mainly created by enthusiasts, you should be cautious when installing them. Any script from an unknown source carries a potential risk. Yet, there is a great variety of interesting scripts that, if installed carefully and responsibly, can really make using some websites more convenient. + +Here we will describe some of the most popular userscript catalogs. + +#### Userscript.Zone + +[Userscript.Zone](https://www.userscript.zone) is a website that allows searching for userscripts by entering a matching URL or domain. The website is easy to use and has a high level of credibility as only scripts from moderated pages are displayed. + +#### Greasy Fork + +[Greasy Fork](https://greasyfork.org/) is a userscript catalog of Stylish creators. The scripts in this catalog are moderated, so their credibility is much higher. + +#### OpenUserJS.org + +[OpenUserJS.org](https://openuserjs.org/) is an open-source userscript catalog written in nodeJS. It's not moderated, so keep an eye out for suspicious scripts. + +#### Community + +If you like the idea of customizing your browser with userscripts and have questions, you can ask them on one of these websites: + +- [Stackoverflow](https://stackoverflow.com/questions/tagged/userscripts) +- [FreeNode](https://webchat.freenode.net/#greasemonkey) +- [Reddit](https://www.reddit.com/r/userscripts/) + +### Development + +#### Request license + +If you are developing your own custom script and want to test how it works with AdGuard, you can request a beta license key for the app. + +To get it, please send an email to devteam@adguard.com with the following information: + +**Subject:** Userscript author license request + +**Body:** Please tell us about the userscripts you are working on. + +Here is a [mailto link](mailto:devteam@adguard.com?Subject=Userscript%20author%20license%20request\&Body=Hello%2C%0A%0AMy%20userscript%28s%29%3A%20LINK). + +#### Compatibility + +#### Metadata block + +#### Supported properties + +```text +@name +@namespace +@description +@version +@match +@include +@exclude +@grant +@connect +@require +@resource +@downloadURL +@updateURL +@supportURL +@homepageURL +@homepage +@website +@source +@run-at +@noframes +@icon +@iconURL +@defaulticon +@icon64 +@icon64URL +``` + +#### Unsupported properties + +These properties will be simply ignored by AdGuard. + +```text +@unwrap +``` + +#### Supported GM functions + +AdGuard supports both old GM\_ functions and new GM4 API that use GM object. + +#### Values + +:::note + +All listed old Greasemonkey functions are deprecated but still supported. + +::: + +```text +GM.info / GM_info +GM.setValue / GM_setValue +GM.getValue / GM_getValue +GM.listValues / GM_listValues +GM.deleteValue / GM_deleteValue +GM.getResourceUrl / GM_getResourceURL +GM.setClipboard / GM_setClipboard +GM.xmlHttpRequest / GM_xmlhttpRequest +GM.openInTab / GM_openInTab +GM.notification +unsafeWindow +GM_getResourceText +GM_addStyle +GM_log +``` + +[Here](https://wiki.greasespot.net/GM.info) you can find more information about Greasemonkey API. + +#### Example + +```javascript +// ==UserScript== +// @name Name as shown to the user when locale is english or unknown +// @name:ru Name as shown to the user when locale is russian +// @description Description as shown to the user when locale is english or unknown +// @description:ru Description as shown to the user when locale is russian +// @icon https://myhomepage.com/myuserscript.png +// @version 1.0.0.0 +// @downloadURL https://dl.myhomepage.org/myuserscript.user.js +// @updateURL https://dl.myhomepage.org/myuserscript.meta.js +// @homepageURL https://myhomepage.com/myuserscript +// @include * +// @exclude *://website.com/* +// @resource https://myhomepage.com/myuserscript.css +// @require https://myhomepage.com/mylibrary.js +// @grant property:settings +// @grant GM_getValue +// @grant GM_setValue +// @grant GM_deleteValue +// @grant GM_listValues +// @grant GM_getResourceText +// @grant GM_getResourceURL +// @grant GM_addStyle +// @grant GM_log +// @grant GM_setClipboard +// @grant GM_xmlhttpRequest +// @grant unsafeWindow +// @grant GM_info +// @grant GM_openInTab +// @grant GM_registerMenuCommand +// @run-at document-start +// ==/UserScript== +!function(){( + console.log("I am loaded!"); +)}(); +``` + +## Userstyles + +Userstyles allow users to customize their online experience. Whether you’re looking to change the appearance of a website or automate repetitive tasks, styles offer a world of possibilities. + +AdGuard has the option to upload or create your own userstyles. This is an advanced feature, so you will need some knowledge of HTML and CSS. + +:::info Supported apps + +Currently, two AdGuard apps allow you to create and manage userstyles: AdGuard for Windows (v7.19 or later) and AdGuard for Mac (v2.16 or later). We also plan to implement this new feature in AdGuard v4.8 for Android in the nearest future. + +::: + +This is an experimental feature, so if you encounter any problems while adding or creating a userstyle, please contact our support team at . + +### How to set up a userstyle in AdGuard + +You can download userstyles from various websites. One of the most popular userstyle websites is [https://userstyles.world/](https://userstyles.world/explore), which we will use as an example for the following instructions on how to set up the userstyle in AdGuard. + +1. Follow the link above and choose the userstyle you like + +2. Right-click the _Install_ button and choose _Copy Link Address_ + +3. Open AdGuard settings → _Extensions_ + +4. Press the [+] button and paste the userstyle link + +5. Done! + +If you’re familiar with CSS rules, you can also create the userstyles yourself. + +:::note + +We don’t support userstyles that contain `@var` or `@advanced` in the metadata. AdGuard also doesn’t support `@preprocessor` without the `default` value. + +::: + +1. Open AdGuard settings → _Extensions_ + +2. Press the [+] button and choose the _Create userstyle_ option. A new window will appear on your screen + +3. To create a userstyle, first write the title with metadata, for example + + ```CSS + /* ==UserStyle== + @name New userstyle + @version 1.0 + ==/UserStyle== */ + ``` + +4. Write the CSS part after the meta data. AdGuard supports website domain names matching (`@-moz-document domain(…), …`). For example: + + ```CSS + body { + background: gray; + } + ``` + + Or: + + ```CSS + @-moz-document domain('example.org'), + domain('example.net'), + domain('example.com') body { + background: gray; + } + ``` + +5. Once you’re finished, press _Save and Close_. Your new userstyle has been successfully added to AdGuard + +### Example + +```css +/* ==UserStyle== +@name Example userstyle +@namespace https://example.org/userstyle +@homepageURL https://example.org/userstyle +@version 1.0.0 +@license Other +@description This is an example +@author example +@preprocessor default +==/UserStyle== */ +@-moz-document regexp("https?\:\/\/(www\.)?example\.(org|com).*") { + body { + background-color: #000000 !important; + } +} +``` diff --git a/i18n/bn/docusaurus-plugin-content-docs/current/general/how-to-install.md b/i18n/bn/docusaurus-plugin-content-docs/current/general/how-to-install.md index bae3060668a..106a29529a8 100644 --- a/i18n/bn/docusaurus-plugin-content-docs/current/general/how-to-install.md +++ b/i18n/bn/docusaurus-plugin-content-docs/current/general/how-to-install.md @@ -1,6 +1,6 @@ --- title: How to install AdGuard -sidebar_position: 8 +sidebar_position: 9 --- Depending on which AdGuard app or browser extension you want to install, follow one of these links to find the relevant article: diff --git a/i18n/cs/docusaurus-plugin-content-docs/current/adguard-for-windows/features/extensions.md b/i18n/cs/docusaurus-plugin-content-docs/current/adguard-for-windows/features/extensions.md index d4bf7066b20..2013e1519df 100644 --- a/i18n/cs/docusaurus-plugin-content-docs/current/adguard-for-windows/features/extensions.md +++ b/i18n/cs/docusaurus-plugin-content-docs/current/adguard-for-windows/features/extensions.md @@ -9,7 +9,7 @@ Tento článek popisuje AdGuard pro Windows, multifunkční blokátor reklam, kt ::: -AdGuard dokáže výrazně rozšířit funkčnost webových stránek a funguje jako [správce uživatelských skriptů](/general/extensions). Uživatelé AdGuardu mohou přidávat své vlastní skripty a také spravovat stávající. +AdGuard can significantly extend website functionality by working as a [userscript manager](/general/extensions.md). AdGuard users can add their own scripts as well as manage existing ones. ![Extensions \*mobile\_border](https://cdn.adtidy.org/content/kb/ad_blocker/windows/overview/userscripts.png) diff --git a/i18n/cs/docusaurus-plugin-content-docs/current/general/extensions.md b/i18n/cs/docusaurus-plugin-content-docs/current/general/extensions.md new file mode 100644 index 00000000000..a9ab9cb990c --- /dev/null +++ b/i18n/cs/docusaurus-plugin-content-docs/current/general/extensions.md @@ -0,0 +1,301 @@ +--- +title: Rozšíření +sidebar_position: 6 +--- + +## Uživatelské skripty + +Userscripts (we also call them "extensions") are, de facto, miniprograms written in JavaScript. Upravují nebo rozšiřují funkce jedné nebo více webových stránek. Mnoho uživatelů AdGuardu již možná zná uživatelské skripty jako AdGuard asistent, Blokátor vyskakovacích oken a AdGuard Extra. + +:::note Supported apps + +AdGuard může výrazně rozšířit funkčnost webových stránek tím, že funguje jako správce uživatelských skriptů. You can add your custom scripts or manage the existing ones in our three products: [AdGuard for Windows](/adguard-for-windows/features/extensions), [AdGuard for Android](/adguard-for-android/features/settings#userscripts), and [AdGuard for Mac](/adguard-for-mac/features/extensions). + +::: + +### Doporučené skripty AdGuardu + +Tyto uživatelské skripty pocházejí přímo od vývojářů AdGuardu a můžeme zaručit, že jsou účinné a bezpečné. For some of the userscripts developed by others that we consider good and reliable, [scroll down to the next section](#top-picks). You can also find some of the [popular websites with scripts](#more-userscripts) below, but remember that whenever you download a userscript from an unknown source, you are exposing yourself to a certain risk, as some scripts may be harmful to your computer. + +#### AdGuard Extra + +Rozšíření, které blokuje reklamu v obtížných případech, kdy běžný přístup založený na filtru nestačí. AdGuard Extra comes pre-installed in AdGuard standalone apps, except for the one for iOS, so you don't need to do anything to enable it. Pokud jej však chcete používat společně s Rozšířením prohlížeče AdGuard nebo jiným blokátorem reklam, musíte použít další rozšíření. Learn more about this userscript and how to install it on [GitHub](https://github.com/AdguardTeam/AdGuardExtra). + +![AdGuard Extra](https://cdn.adtidy.org/content/kb/ad_blocker/general/adguard-extra.png) + +#### AdGuard blokátor vyskakovacích oken + +The name speaks for itself: it blocks popups — one of the most annoying types of ads on websites. Learn more about this userscript, its key features, and installation on [GitHub](https://github.com/AdguardTeam/PopupBlocker). + +![AdGuard Popup Blocker](https://cdn.adtidy.org/content/kb/ad_blocker/general/popup-blocker-installation.png) + +#### AdGuard asistent (starší verze) + +This custom extension is designed to control filtering directly from the browser page (manual blocking, allowlisting, etc.). + +:::note + +This version of Assistant is legacy and there is no point in using it on new systems, as it has been replaced with the full-fledged [Browser Assistant](https://adguard.com/adguard-assistant/overview.html). However, the legacy Assistant may be useful if there is no Browser Assistant for your browser. If this is your case, you can learn how to install AdGuard Assistant on [GitHub](https://github.com/AdguardTeam/AdguardAssistant). + +::: + +#### Zakázat AMP + +Skript, který je předinstalován pouze v aplikaci AdGuard pro Android. Zakáže AMP (Accelerated Mobile Pages) na stránce s výsledky vyhledávání Google. Learn more about this userscript and how to install it on [GitHub](https://github.com/AdguardTeam/DisableAMP). + +![Disable AMP](https://cdn.adtidy.org/content/kb/ad_blocker/general/disable-amp-installation.png) + +### Top picks outside AdGuard{#top-picks} + +These userscripts are not developed by AdGuard, and therefore we can't give a 100% guarantee that they are safe and/or work at all times. However, in our experience they deserve a recommendation because they've all earned their good reputation. + +#### Don't track me Google + +This script removes Google's tracking feature from the links in Google search results. It speeds up the loading of search results and allows you to right-click or tap to copy the link URL. + +Its source code is [available on GitHub](https://github.com/Rob--W/dont-track-me-google). This userscript can be downloaded from [GreasyFork](https://greasyfork.org/en/scripts/428243-don-t-track-me-google) and installed in any AdGuard CoreLibs-based app. + +#### microShield + +A userscript for people visiting Korean websites and some international websites. The microShield userscript blocks Ad-Shield ads and anti-adblocks. Its original source code is available at [asdefuser](https://github.com/seia-soto/userscripts/tree/master/sources/asdefuser) and [AdShield Defuser](https://github.com/seia-soto/adshield-defuser). This userscript can be installed in AdGuard CoreLibs-based apps, Violentmonkey, Tampermonkey, and [quoid/userscripts](https://github.com/quoid/userscripts). Learn more about microShield and how to install it on [GitHub](https://github.com/List-KR/microShield). + +### Kde můžete získat další uživatelské skripty?{#more-userscripts} + +Since userscripts are mainly created by enthusiasts, you should be cautious when installing them. Any script from an unknown source carries a potential risk. Yet, there is a great variety of interesting scripts that, if installed carefully and responsibly, can really make using some websites more convenient. + +Zde popíšeme některé z nejoblíbenějších katalogů uživatelských skriptů. + +#### Userscript.Zone + +[Userscript.Zone](https://www.userscript.zone) is a website that allows searching for userscripts by entering a matching URL or domain. The website is easy to use and has a high level of credibility as only scripts from moderated pages are displayed. + +#### Greasy Fork + +[Greasy Fork](https://greasyfork.org/) is a userscript catalog of Stylish creators. The scripts in this catalog are moderated, so their credibility is much higher. + +#### OpenUserJS.org + +[OpenUserJS.org](https://openuserjs.org/) is an open-source userscript catalog written in nodeJS. It's not moderated, so keep an eye out for suspicious scripts. + +#### Komunita + +If you like the idea of customizing your browser with userscripts and have questions, you can ask them on one of these websites: + +- [Stackoverflow](https://stackoverflow.com/questions/tagged/userscripts) +- [FreeNode](https://webchat.freenode.net/#greasemonkey) +- [Reddit](https://www.reddit.com/r/userscripts/) + +### Vývoj + +#### Žádost o licenci + +If you are developing your own custom script and want to test how it works with AdGuard, you can request a beta license key for the app. + +Chcete-li ji získat, zašlete e-mail na adresu devteam@adguard.com a uveďte následující informace: + +**Subject:** Userscript author license request + +**Body:** Please tell us about the userscripts you are working on. + +Here is a [mailto link](mailto:devteam@adguard.com?Subject=Userscript%20author%20license%20request\&Body=Hello%2C%0A%0AMy%20userscript%28s%29%3A%20LINK). + +#### Kompatibilita + +#### Blokování metadat + +#### Podporované vlastnosti + +```text +@name +@namespace +@description +@version +@match +@include +@exclude +@grant +@connect +@require +@resource +@downloadURL +@updateURL +@supportURL +@homepageURL +@homepage +@website +@source +@run-at +@noframes +@icon +@iconURL +@defaulticon +@icon64 +@icon64URL +``` + +#### Nepodporované vlastnosti + +These properties will be simply ignored by AdGuard. + +```text +@unwrap +``` + +#### Podporované funkce GM + +AdGuard podporuje jak staré funkce GM\_, tak nové rozhraní GM4 API, které používá objekt GM. + +#### Hodnoty + +:::note + +Všechny uvedené staré funkce Greasemonkey jsou zastaralé, ale stále podporované. + +::: + +```text +GM.info / GM_info +GM.setValue / GM_setValue +GM.getValue / GM_getValue +GM.listValues / GM_listValues +GM.deleteValue / GM_deleteValue +GM.getResourceUrl / GM_getResourceURL +GM.setClipboard / GM_setClipboard +GM.xmlHttpRequest / GM_xmlhttpRequest +GM.openInTab / GM_openInTab +GM.notification +unsafeWindow +GM_getResourceText +GM_addStyle +GM_log +``` + +[Here](https://wiki.greasespot.net/GM.info) you can find more information about Greasemonkey API. + +#### Příklad + +```javascript +// ==UserScript== +// @name Name as shown to the user when locale is english or unknown +// @name:ru Name as shown to the user when locale is russian +// @description Description as shown to the user when locale is english or unknown +// @description:ru Description as shown to the user when locale is russian +// @icon https://myhomepage.com/myuserscript.png +// @version 1.0.0.0 +// @downloadURL https://dl.myhomepage.org/myuserscript.user.js +// @updateURL https://dl.myhomepage.org/myuserscript.meta.js +// @homepageURL https://myhomepage.com/myuserscript +// @include * +// @exclude *://website.com/* +// @resource https://myhomepage.com/myuserscript.css +// @require https://myhomepage.com/mylibrary.js +// @grant property:settings +// @grant GM_getValue +// @grant GM_setValue +// @grant GM_deleteValue +// @grant GM_listValues +// @grant GM_getResourceText +// @grant GM_getResourceURL +// @grant GM_addStyle +// @grant GM_log +// @grant GM_setClipboard +// @grant GM_xmlhttpRequest +// @grant unsafeWindow +// @grant GM_info +// @grant GM_openInTab +// @grant GM_registerMenuCommand +// @run-at document-start +// ==/UserScript== +!function(){( + console.log("I am loaded!"); +)}(); +``` + +## Userstyles + +Userstyles allow users to customize their online experience. Whether you’re looking to change the appearance of a website or automate repetitive tasks, styles offer a world of possibilities. + +AdGuard has the option to upload or create your own userstyles. This is an advanced feature, so you will need some knowledge of HTML and CSS. + +:::info Supported apps + +Currently, two AdGuard apps allow you to create and manage userstyles: AdGuard for Windows (v7.19 or later) and AdGuard for Mac (v2.16 or later). We also plan to implement this new feature in AdGuard v4.8 for Android in the nearest future. + +::: + +This is an experimental feature, so if you encounter any problems while adding or creating a userstyle, please contact our support team at . + +### How to set up a userstyle in AdGuard + +You can download userstyles from various websites. One of the most popular userstyle websites is [https://userstyles.world/](https://userstyles.world/explore), which we will use as an example for the following instructions on how to set up the userstyle in AdGuard. + +1. Follow the link above and choose the userstyle you like + +2. Right-click the _Install_ button and choose _Copy Link Address_ + +3. Open AdGuard settings → _Extensions_ + +4. Press the [+] button and paste the userstyle link + +5. Hotovo! + +If you’re familiar with CSS rules, you can also create the userstyles yourself. + +:::note + +We don’t support userstyles that contain `@var` or `@advanced` in the metadata. AdGuard also doesn’t support `@preprocessor` without the `default` value. + +::: + +1. Open AdGuard settings → _Extensions_ + +2. Press the [+] button and choose the _Create userstyle_ option. A new window will appear on your screen + +3. To create a userstyle, first write the title with metadata, for example + + ```CSS + /* ==UserStyle== + @name New userstyle + @version 1.0 + ==/UserStyle== */ + ``` + +4. Write the CSS part after the meta data. AdGuard supports website domain names matching (`@-moz-document domain(…), …`). Např: + + ```CSS + body { + background: gray; + } + ``` + + Or: + + ```CSS + @-moz-document domain('example.org'), + domain('example.net'), + domain('example.com') body { + background: gray; + } + ``` + +5. Once you’re finished, press _Save and Close_. Your new userstyle has been successfully added to AdGuard + +### Příklad + +```css +/* ==UserStyle== +@name Example userstyle +@namespace https://example.org/userstyle +@homepageURL https://example.org/userstyle +@version 1.0.0 +@license Other +@description This is an example +@author example +@preprocessor default +==/UserStyle== */ +@-moz-document regexp("https?\:\/\/(www\.)?example\.(org|com).*") { + body { + background-color: #000000 !important; + } +} +``` diff --git a/i18n/cs/docusaurus-plugin-content-docs/current/general/how-to-install.md b/i18n/cs/docusaurus-plugin-content-docs/current/general/how-to-install.md index d2273ffff43..b1f8617e0bd 100644 --- a/i18n/cs/docusaurus-plugin-content-docs/current/general/how-to-install.md +++ b/i18n/cs/docusaurus-plugin-content-docs/current/general/how-to-install.md @@ -1,6 +1,6 @@ --- title: Jak nainstalovat AdGuard -sidebar_position: 8 +sidebar_position: 9 --- Podle toho, kterou aplikaci AdGuard nebo rozšíření prohlížeče chcete nainstalovat, vyhledejte příslušný článek pomocí jednoho z těchto odkazů: diff --git a/i18n/da/docusaurus-plugin-content-docs/current/adguard-for-windows/features/extensions.md b/i18n/da/docusaurus-plugin-content-docs/current/adguard-for-windows/features/extensions.md index 260fa0e83b3..17884a6df33 100644 --- a/i18n/da/docusaurus-plugin-content-docs/current/adguard-for-windows/features/extensions.md +++ b/i18n/da/docusaurus-plugin-content-docs/current/adguard-for-windows/features/extensions.md @@ -9,7 +9,7 @@ This article covers AdGuard for Windows, a multifunctional ad blocker that prote ::: -AdGuard can significantly broaden website functionality working as a [user script manager](/general/extensions). AdGuard Users can add their own scripts, as well as manage existing ones. +AdGuard can significantly extend website functionality by working as a [userscript manager](/general/extensions.md). AdGuard users can add their own scripts as well as manage existing ones. ![Extensions \*mobile\_border](https://cdn.adtidy.org/content/kb/ad_blocker/windows/overview/userscripts.png) diff --git a/i18n/da/docusaurus-plugin-content-docs/current/general/extensions.md b/i18n/da/docusaurus-plugin-content-docs/current/general/extensions.md new file mode 100644 index 00000000000..0cf454b4329 --- /dev/null +++ b/i18n/da/docusaurus-plugin-content-docs/current/general/extensions.md @@ -0,0 +1,301 @@ +--- +title: Extensions +sidebar_position: 6 +--- + +## Userscripts + +Userscripts (we also call them "extensions") are, de facto, miniprograms written in JavaScript. They modify or extend the functionality of one or more websites. Many AdGuard users may be already familiar with such userscripts as AdGuard Assistant, Popup Blocker, and AdGuard Extra. + +:::note Supported apps + +AdGuard can significantly broaden website functionality by acting as a userscript manager. You can add your custom scripts or manage the existing ones in our three products: [AdGuard for Windows](/adguard-for-windows/features/extensions), [AdGuard for Android](/adguard-for-android/features/settings#userscripts), and [AdGuard for Mac](/adguard-for-mac/features/extensions). + +::: + +### Recommended AdGuard scripts + +These userscripts come directly from the AdGuard developers, and we can guarantee that they are effective and safe. For some of the userscripts developed by others that we consider good and reliable, [scroll down to the next section](#top-picks). You can also find some of the [popular websites with scripts](#more-userscripts) below, but remember that whenever you download a userscript from an unknown source, you are exposing yourself to a certain risk, as some scripts may be harmful to your computer. + +#### AdGuard Extra + +An extension that blocks ads in difficult cases when the usual filter-based approach is not enough. AdGuard Extra comes pre-installed in AdGuard standalone apps, except for the one for iOS, so you don't need to do anything to enable it. However, if you want to use it alongside AdGuard Browser Extension or any other ad blocker, you'll need to use an additional extension. Learn more about this userscript and how to install it on [GitHub](https://github.com/AdguardTeam/AdGuardExtra). + +![AdGuard Extra](https://cdn.adtidy.org/content/kb/ad_blocker/general/adguard-extra.png) + +#### AdGuard Popup Blocker + +The name speaks for itself: it blocks popups — one of the most annoying types of ads on websites. Learn more about this userscript, its key features, and installation on [GitHub](https://github.com/AdguardTeam/PopupBlocker). + +![AdGuard Popup Blocker](https://cdn.adtidy.org/content/kb/ad_blocker/general/popup-blocker-installation.png) + +#### AdGuard Assistant (legacy version) + +This custom extension is designed to control filtering directly from the browser page (manual blocking, allowlisting, etc.). + +:::note + +This version of Assistant is legacy and there is no point in using it on new systems, as it has been replaced with the full-fledged [Browser Assistant](https://adguard.com/adguard-assistant/overview.html). However, the legacy Assistant may be useful if there is no Browser Assistant for your browser. If this is your case, you can learn how to install AdGuard Assistant on [GitHub](https://github.com/AdguardTeam/AdguardAssistant). + +::: + +#### Disable AMP + +A script that is only pre-installed in AdGuard for Android. It disables AMP (Accelerated Mobile Pages) on the Google search results page. Learn more about this userscript and how to install it on [GitHub](https://github.com/AdguardTeam/DisableAMP). + +![Disable AMP](https://cdn.adtidy.org/content/kb/ad_blocker/general/disable-amp-installation.png) + +### Top picks outside AdGuard{#top-picks} + +These userscripts are not developed by AdGuard, and therefore we can't give a 100% guarantee that they are safe and/or work at all times. However, in our experience they deserve a recommendation because they've all earned their good reputation. + +#### Don't track me Google + +This script removes Google's tracking feature from the links in Google search results. It speeds up the loading of search results and allows you to right-click or tap to copy the link URL. + +Its source code is [available on GitHub](https://github.com/Rob--W/dont-track-me-google). This userscript can be downloaded from [GreasyFork](https://greasyfork.org/en/scripts/428243-don-t-track-me-google) and installed in any AdGuard CoreLibs-based app. + +#### microShield + +A userscript for people visiting Korean websites and some international websites. The microShield userscript blocks Ad-Shield ads and anti-adblocks. Its original source code is available at [asdefuser](https://github.com/seia-soto/userscripts/tree/master/sources/asdefuser) and [AdShield Defuser](https://github.com/seia-soto/adshield-defuser). This userscript can be installed in AdGuard CoreLibs-based apps, Violentmonkey, Tampermonkey, and [quoid/userscripts](https://github.com/quoid/userscripts). Learn more about microShield and how to install it on [GitHub](https://github.com/List-KR/microShield). + +### Where can you get more userscripts?{#more-userscripts} + +Since userscripts are mainly created by enthusiasts, you should be cautious when installing them. Any script from an unknown source carries a potential risk. Yet, there is a great variety of interesting scripts that, if installed carefully and responsibly, can really make using some websites more convenient. + +Here we will describe some of the most popular userscript catalogs. + +#### Userscript.Zone + +[Userscript.Zone](https://www.userscript.zone) is a website that allows searching for userscripts by entering a matching URL or domain. The website is easy to use and has a high level of credibility as only scripts from moderated pages are displayed. + +#### Greasy Fork + +[Greasy Fork](https://greasyfork.org/) is a userscript catalog of Stylish creators. The scripts in this catalog are moderated, so their credibility is much higher. + +#### OpenUserJS.org + +[OpenUserJS.org](https://openuserjs.org/) is an open-source userscript catalog written in nodeJS. It's not moderated, so keep an eye out for suspicious scripts. + +#### Community + +If you like the idea of customizing your browser with userscripts and have questions, you can ask them on one of these websites: + +- [Stackoverflow](https://stackoverflow.com/questions/tagged/userscripts) +- [FreeNode](https://webchat.freenode.net/#greasemonkey) +- [Reddit](https://www.reddit.com/r/userscripts/) + +### Development + +#### Request license + +If you are developing your own custom script and want to test how it works with AdGuard, you can request a beta license key for the app. + +To get it, please send an email to devteam@adguard.com with the following information: + +**Subject:** Userscript author license request + +**Body:** Please tell us about the userscripts you are working on. + +Here is a [mailto link](mailto:devteam@adguard.com?Subject=Userscript%20author%20license%20request\&Body=Hello%2C%0A%0AMy%20userscript%28s%29%3A%20LINK). + +#### Compatibility + +#### Metadata block + +#### Supported properties + +```text +@name +@namespace +@description +@version +@match +@include +@exclude +@grant +@connect +@require +@resource +@downloadURL +@updateURL +@supportURL +@homepageURL +@homepage +@website +@source +@run-at +@noframes +@icon +@iconURL +@defaulticon +@icon64 +@icon64URL +``` + +#### Unsupported properties + +These properties will be simply ignored by AdGuard. + +```text +@unwrap +``` + +#### Supported GM functions + +AdGuard supports both old GM\_ functions and new GM4 API that use GM object. + +#### Values + +:::note + +All listed old Greasemonkey functions are deprecated but still supported. + +::: + +```text +GM.info / GM_info +GM.setValue / GM_setValue +GM.getValue / GM_getValue +GM.listValues / GM_listValues +GM.deleteValue / GM_deleteValue +GM.getResourceUrl / GM_getResourceURL +GM.setClipboard / GM_setClipboard +GM.xmlHttpRequest / GM_xmlhttpRequest +GM.openInTab / GM_openInTab +GM.notification +unsafeWindow +GM_getResourceText +GM_addStyle +GM_log +``` + +[Here](https://wiki.greasespot.net/GM.info) you can find more information about Greasemonkey API. + +#### Example + +```javascript +// ==UserScript== +// @name Name as shown to the user when locale is english or unknown +// @name:ru Name as shown to the user when locale is russian +// @description Description as shown to the user when locale is english or unknown +// @description:ru Description as shown to the user when locale is russian +// @icon https://myhomepage.com/myuserscript.png +// @version 1.0.0.0 +// @downloadURL https://dl.myhomepage.org/myuserscript.user.js +// @updateURL https://dl.myhomepage.org/myuserscript.meta.js +// @homepageURL https://myhomepage.com/myuserscript +// @include * +// @exclude *://website.com/* +// @resource https://myhomepage.com/myuserscript.css +// @require https://myhomepage.com/mylibrary.js +// @grant property:settings +// @grant GM_getValue +// @grant GM_setValue +// @grant GM_deleteValue +// @grant GM_listValues +// @grant GM_getResourceText +// @grant GM_getResourceURL +// @grant GM_addStyle +// @grant GM_log +// @grant GM_setClipboard +// @grant GM_xmlhttpRequest +// @grant unsafeWindow +// @grant GM_info +// @grant GM_openInTab +// @grant GM_registerMenuCommand +// @run-at document-start +// ==/UserScript== +!function(){( + console.log("I am loaded!"); +)}(); +``` + +## Userstyles + +Userstyles allow users to customize their online experience. Whether you’re looking to change the appearance of a website or automate repetitive tasks, styles offer a world of possibilities. + +AdGuard has the option to upload or create your own userstyles. This is an advanced feature, so you will need some knowledge of HTML and CSS. + +:::info Supported apps + +Currently, two AdGuard apps allow you to create and manage userstyles: AdGuard for Windows (v7.19 or later) and AdGuard for Mac (v2.16 or later). We also plan to implement this new feature in AdGuard v4.8 for Android in the nearest future. + +::: + +This is an experimental feature, so if you encounter any problems while adding or creating a userstyle, please contact our support team at . + +### How to set up a userstyle in AdGuard + +You can download userstyles from various websites. One of the most popular userstyle websites is [https://userstyles.world/](https://userstyles.world/explore), which we will use as an example for the following instructions on how to set up the userstyle in AdGuard. + +1. Follow the link above and choose the userstyle you like + +2. Right-click the _Install_ button and choose _Copy Link Address_ + +3. Open AdGuard settings → _Extensions_ + +4. Press the [+] button and paste the userstyle link + +5. Done! + +If you’re familiar with CSS rules, you can also create the userstyles yourself. + +:::note + +We don’t support userstyles that contain `@var` or `@advanced` in the metadata. AdGuard also doesn’t support `@preprocessor` without the `default` value. + +::: + +1. Open AdGuard settings → _Extensions_ + +2. Press the [+] button and choose the _Create userstyle_ option. A new window will appear on your screen + +3. To create a userstyle, first write the title with metadata, for example + + ```CSS + /* ==UserStyle== + @name New userstyle + @version 1.0 + ==/UserStyle== */ + ``` + +4. Write the CSS part after the meta data. AdGuard supports website domain names matching (`@-moz-document domain(…), …`). For example: + + ```CSS + body { + background: gray; + } + ``` + + Or: + + ```CSS + @-moz-document domain('example.org'), + domain('example.net'), + domain('example.com') body { + background: gray; + } + ``` + +5. Once you’re finished, press _Save and Close_. Your new userstyle has been successfully added to AdGuard + +### Example + +```css +/* ==UserStyle== +@name Example userstyle +@namespace https://example.org/userstyle +@homepageURL https://example.org/userstyle +@version 1.0.0 +@license Other +@description This is an example +@author example +@preprocessor default +==/UserStyle== */ +@-moz-document regexp("https?\:\/\/(www\.)?example\.(org|com).*") { + body { + background-color: #000000 !important; + } +} +``` diff --git a/i18n/da/docusaurus-plugin-content-docs/current/general/how-to-install.md b/i18n/da/docusaurus-plugin-content-docs/current/general/how-to-install.md index bae3060668a..106a29529a8 100644 --- a/i18n/da/docusaurus-plugin-content-docs/current/general/how-to-install.md +++ b/i18n/da/docusaurus-plugin-content-docs/current/general/how-to-install.md @@ -1,6 +1,6 @@ --- title: How to install AdGuard -sidebar_position: 8 +sidebar_position: 9 --- Depending on which AdGuard app or browser extension you want to install, follow one of these links to find the relevant article: diff --git a/i18n/de/docusaurus-plugin-content-docs/current/adguard-for-windows/features/extensions.md b/i18n/de/docusaurus-plugin-content-docs/current/adguard-for-windows/features/extensions.md index f2c087c1fb6..a5d0ff9435d 100644 --- a/i18n/de/docusaurus-plugin-content-docs/current/adguard-for-windows/features/extensions.md +++ b/i18n/de/docusaurus-plugin-content-docs/current/adguard-for-windows/features/extensions.md @@ -9,7 +9,7 @@ Dieser Artikel behandelt AdGuard für Windows, einem multifunktionalen Werbebloc ::: -AdGuard can significantly broaden website functionality working as a [user script manager](/general/extensions). Sie können ihre eigenen Skripte hinzufügen und bestehende Skripte verwalten. +AdGuard can significantly extend website functionality by working as a [userscript manager](/general/extensions.md). AdGuard users can add their own scripts as well as manage existing ones. ![Erweiterungen \*mobile\_border](https://cdn.adtidy.org/content/kb/ad_blocker/windows/overview/userscripts.png) diff --git a/i18n/de/docusaurus-plugin-content-docs/current/general/ad-filtering/filter-policy.md b/i18n/de/docusaurus-plugin-content-docs/current/general/ad-filtering/filter-policy.md index 9b449d8ef19..93554b60ae3 100644 --- a/i18n/de/docusaurus-plugin-content-docs/current/general/ad-filtering/filter-policy.md +++ b/i18n/de/docusaurus-plugin-content-docs/current/general/ad-filtering/filter-policy.md @@ -48,7 +48,7 @@ AdGuard-Filter zum Blockieren von Werbung umfassen: - **Der Basisfilter** blockiert Werbung auf englischsprachigen Websites und solchen, für die es keinen eigenen Filter gibt. Er enthält auch allgemeine Filterregeln, die für alle Websites unabhängig von der Sprache gelten - **Filter gegen mobile Werbung** blockiert Werbung auf mobilen Versionen von Websites und in mobilen Apps. Es gibt keine Unterteilung nach Sprachen - **Sprachspezifische Filter** folgen der gleichen Politik wie der **Basisfilter**, sind aber auf Websites in bestimmten Sprachen beschränkt -- Quick-Fixes-Filter zur schnellen Behebung kritischer Probleme bei der Filterung von Inhalten auf beliebten Websites ohne Aktualisierung der MV3-Erweiterung. +- **Quick-Fixes-Filter** zur schnellen Behebung kritischer Probleme bei der Filterung von Inhalten auf beliebten Websites ohne Aktualisierung der MV3-Erweiterung. Das Ziel von Werbeblockern ist es, alle Arten von Werbung auf Websites, in Apps und auf bestimmten Geräten, die Werbung aus dem Internet laden können, zu blockieren: diff --git a/i18n/de/docusaurus-plugin-content-docs/current/general/extensions.md b/i18n/de/docusaurus-plugin-content-docs/current/general/extensions.md new file mode 100644 index 00000000000..8950497c96b --- /dev/null +++ b/i18n/de/docusaurus-plugin-content-docs/current/general/extensions.md @@ -0,0 +1,301 @@ +--- +title: Erweiterungen +sidebar_position: 6 +--- + +## Benutzerskripte + +Userscripts (we also call them "extensions") are, de facto, miniprograms written in JavaScript. Sie ändern oder erweitern die Funktionalität einer oder mehrerer Websites. Many AdGuard users may be already familiar with such userscripts as AdGuard Assistant, Popup Blocker, and AdGuard Extra. + +:::note Supported apps + +AdGuard can significantly broaden website functionality by acting as a userscript manager. You can add your custom scripts or manage the existing ones in our three products: [AdGuard for Windows](/adguard-for-windows/features/extensions), [AdGuard for Android](/adguard-for-android/features/settings#userscripts), and [AdGuard for Mac](/adguard-for-mac/features/extensions). + +::: + +### Empfohlene AdGuard-Skripte + +Diese Benutzerskripte stammen direkt von AdGuard und wir können garantieren, dass sie effektiv und sicher sind. For some of the userscripts developed by others that we consider good and reliable, [scroll down to the next section](#top-picks). You can also find some of the [popular websites with scripts](#more-userscripts) below, but remember that whenever you download a userscript from an unknown source, you are exposing yourself to a certain risk, as some scripts may be harmful to your computer. + +#### AdGuard Extra + +Eine Erweiterung, die Werbung in schwierigen Fällen blockiert, wenn der übliche filterbasierte Ansatz nicht ausreicht. AdGuard Extra comes pre-installed in AdGuard standalone apps, except for the one for iOS, so you don't need to do anything to enable it. Wenn Sie es jedoch zusammen mit AdGuard Browsererweiterung oder einem anderen Werbeblocker verwenden möchten, müssen Sie eine zusätzliche Erweiterung verwenden. Learn more about this userscript and how to install it on [GitHub](https://github.com/AdguardTeam/AdGuardExtra). + +![AdGuard Extra](https://cdn.adtidy.org/content/kb/ad_blocker/general/adguard-extra.png) + +#### AdGuard Pop-up-Blocker + +The name speaks for itself: it blocks popups — one of the most annoying types of ads on websites. Learn more about this userscript, its key features, and installation on [GitHub](https://github.com/AdguardTeam/PopupBlocker). + +![AdGuard Popup Blocker](https://cdn.adtidy.org/content/kb/ad_blocker/general/popup-blocker-installation.png) + +#### AdGuard-Assistent (alte Version) + +This custom extension is designed to control filtering directly from the browser page (manual blocking, allowlisting, etc.). + +:::note + +This version of Assistant is legacy and there is no point in using it on new systems, as it has been replaced with the full-fledged [Browser Assistant](https://adguard.com/adguard-assistant/overview.html). However, the legacy Assistant may be useful if there is no Browser Assistant for your browser. If this is your case, you can learn how to install AdGuard Assistant on [GitHub](https://github.com/AdguardTeam/AdguardAssistant). + +::: + +#### AMP deaktivieren + +Ein Skript, das nur in AdGuard für Android vorinstalliert ist. Es deaktiviert AMP (Accelerated Mobile Pages) auf der Google-Suchergebnisseite. Learn more about this userscript and how to install it on [GitHub](https://github.com/AdguardTeam/DisableAMP). + +![Disable AMP](https://cdn.adtidy.org/content/kb/ad_blocker/general/disable-amp-installation.png) + +### Top picks outside AdGuard{#top-picks} + +These userscripts are not developed by AdGuard, and therefore we can't give a 100% guarantee that they are safe and/or work at all times. However, in our experience they deserve a recommendation because they've all earned their good reputation. + +#### Don't track me Google + +This script removes Google's tracking feature from the links in Google search results. It speeds up the loading of search results and allows you to right-click or tap to copy the link URL. + +Its source code is [available on GitHub](https://github.com/Rob--W/dont-track-me-google). This userscript can be downloaded from [GreasyFork](https://greasyfork.org/en/scripts/428243-don-t-track-me-google) and installed in any AdGuard CoreLibs-based app. + +#### microShield + +A userscript for people visiting Korean websites and some international websites. The microShield userscript blocks Ad-Shield ads and anti-adblocks. Its original source code is available at [asdefuser](https://github.com/seia-soto/userscripts/tree/master/sources/asdefuser) and [AdShield Defuser](https://github.com/seia-soto/adshield-defuser). This userscript can be installed in AdGuard CoreLibs-based apps, Violentmonkey, Tampermonkey, and [quoid/userscripts](https://github.com/quoid/userscripts). Learn more about microShield and how to install it on [GitHub](https://github.com/List-KR/microShield). + +### Wo kann man weitere Benutzerskripte erhalten? {#more-userscripts} + +Since userscripts are mainly created by enthusiasts, you should be cautious when installing them. Any script from an unknown source carries a potential risk. Yet, there is a great variety of interesting scripts that, if installed carefully and responsibly, can really make using some websites more convenient. + +Im Folgenden werden einige der beliebtesten Benutzerskript-Kataloge beschrieben. + +#### Userscript.Zone + +[Userscript.Zone](https://www.userscript.zone) is a website that allows searching for userscripts by entering a matching URL or domain. The website is easy to use and has a high level of credibility as only scripts from moderated pages are displayed. + +#### Greasy Fork + +[Greasy Fork](https://greasyfork.org/) is a userscript catalog of Stylish creators. The scripts in this catalog are moderated, so their credibility is much higher. + +#### OpenUserJS.org + +[OpenUserJS.org](https://openuserjs.org/) is an open-source userscript catalog written in nodeJS. It's not moderated, so keep an eye out for suspicious scripts. + +#### Community + +If you like the idea of customizing your browser with userscripts and have questions, you can ask them on one of these websites: + +- [Stackoverflow](https://stackoverflow.com/questions/tagged/userscripts) +- [FreeNode](https://webchat.freenode.net/#greasemonkey) +- [Reddit](https://www.reddit.com/r/userscripts/) + +### Entwicklung + +#### Lizenz anfordern + +If you are developing your own custom script and want to test how it works with AdGuard, you can request a beta license key for the app. + +Um sie zu erhalten, senden Sie bitte eine E-Mail an devteam@adguard.com mit den folgenden Informationen: + +**Subject:** Userscript author license request + +**Body:** Please tell us about the userscripts you are working on. + +Here is a [mailto link](mailto:devteam@adguard.com?Subject=Userscript%20author%20license%20request\&Body=Hello%2C%0A%0AMy%20userscript%28s%29%3A%20LINK). + +#### Kompatibilität + +#### Metadaten-Block + +#### Unterstützte Eigenschaften + +```text +@name +@namespace +@description +@version +@match +@include +@exclude +@grant +@connect +@require +@resource +@downloadURL +@updateURL +@supportURL +@homepageURL +@homepage +@website +@source +@run-at +@noframes +@icon +@iconURL +@defaulticon +@icon64 +@icon64URL +``` + +#### Nicht unterstützte Eigenschaften + +These properties will be simply ignored by AdGuard. + +```text +@unwrap +``` + +#### Unterstützte GM-Funktionen + +AdGuard unterstützt sowohl die alten GM\_-Funktionen als auch die neue GM4-API, die das GM-Objekt verwendet. + +#### Werte + +:::note + +Alle aufgeführten früheren Greasemonkey-Funktionen sind veraltet, werden aber weiterhin unterstützt. + +::: + +```text +GM.info / GM_info +GM.setValue / GM_setValue +GM.getValue / GM_getValue +GM.listValues / GM_listValues +GM.deleteValue / GM_deleteValue +GM.getResourceUrl / GM_getResourceURL +GM.setClipboard / GM_setClipboard +GM.xmlHttpRequest / GM_xmlhttpRequest +GM.openInTab / GM_openInTab +GM.notification +unsafeWindow +GM_getResourceText +GM_addStyle +GM_log +``` + +[Here](https://wiki.greasespot.net/GM.info) you can find more information about Greasemonkey API. + +#### Beispiel + +```javascript +// ==Benutzerskript== +// @name Name, wie er dem Benutzer angezeigt wird, wenn das Gebietsschema Englisch oder unbekannt ist +// @name:ru Name, wie er dem Benutzer angezeigt wird, wenn das Gebietsschema russisch ist +// @description Beschreibung, wie sie dem Benutzer angezeigt wird, wenn das Gebietsschema englisch oder unbekannt ist +// @description:ru Beschreibung, wie sie dem Benutzer angezeigt wird, wenn das Gebietsschema russisch ist +// @icon https://myhomepage.com/myuserscript.png +// @version 1.0.0.0 +// @downloadURL https://dl.myhomepage.org/myuserscript.user.js +// @updateURL https://dl.myhomepage.org/myuserscript.meta.js +// @homepageURL https://myhomepage.com/myuserscript +// @include * +// @exclude *://website.com/* +// @resource https://myhomepage.com/myuserscript.css +// @require https://myhomepage.com/mylibrary.js +// @grant property:settings +// @grant GM_getValue +// @grant GM_setValue +// @grant GM_deleteValue +// @grant GM_listValues +// @grant GM_getResourceText +// @grant GM_getResourceURL +// @grant GM_addStyle +// @grant GM_log +// @grant GM_setClipboard +// @grant GM_xmlhttpRequest +// @grant unsafeWindow +// @grant GM_info +// @grant GM_openInTab +// @grant GM_registerMenuCommand +// @run-at document-start +// ==/UserScript== +!function(){( + console.log("I am loaded!"); +)}(); +``` + +## Userstyles + +Userstyles allow users to customize their online experience. Whether you’re looking to change the appearance of a website or automate repetitive tasks, styles offer a world of possibilities. + +AdGuard has the option to upload or create your own userstyles. This is an advanced feature, so you will need some knowledge of HTML and CSS. + +:::info Supported apps + +Currently, two AdGuard apps allow you to create and manage userstyles: AdGuard for Windows (v7.19 or later) and AdGuard for Mac (v2.16 or later). We also plan to implement this new feature in AdGuard v4.8 for Android in the nearest future. + +::: + +This is an experimental feature, so if you encounter any problems while adding or creating a userstyle, please contact our support team at . + +### How to set up a userstyle in AdGuard + +You can download userstyles from various websites. One of the most popular userstyle websites is [https://userstyles.world/](https://userstyles.world/explore), which we will use as an example for the following instructions on how to set up the userstyle in AdGuard. + +1. Follow the link above and choose the userstyle you like + +2. Right-click the _Install_ button and choose _Copy Link Address_ + +3. Open AdGuard settings → _Extensions_ + +4. Press the [+] button and paste the userstyle link + +5. Fertig! + +If you’re familiar with CSS rules, you can also create the userstyles yourself. + +:::note + +We don’t support userstyles that contain `@var` or `@advanced` in the metadata. AdGuard also doesn’t support `@preprocessor` without the `default` value. + +::: + +1. Open AdGuard settings → _Extensions_ + +2. Press the [+] button and choose the _Create userstyle_ option. A new window will appear on your screen + +3. To create a userstyle, first write the title with metadata, for example + + ```CSS + /* ==UserStyle== + @name New userstyle + @version 1.0 + ==/UserStyle== */ + ``` + +4. Write the CSS part after the meta data. AdGuard supports website domain names matching (`@-moz-document domain(…), …`). Zum Beispiel: + + ```CSS + body { + background: gray; + } + ``` + + Or: + + ```CSS + @-moz-document domain('example.org'), + domain('example.net'), + domain('example.com') body { + background: gray; + } + ``` + +5. Once you’re finished, press _Save and Close_. Your new userstyle has been successfully added to AdGuard + +### Beispiel + +```css +/* ==UserStyle== +@name Example userstyle +@namespace https://example.org/userstyle +@homepageURL https://example.org/userstyle +@version 1.0.0 +@license Other +@description This is an example +@author example +@preprocessor default +==/UserStyle== */ +@-moz-document regexp("https?\:\/\/(www\.)?example\.(org|com).*") { + body { + background-color: #000000 !important; + } +} +``` diff --git a/i18n/de/docusaurus-plugin-content-docs/current/general/how-to-install.md b/i18n/de/docusaurus-plugin-content-docs/current/general/how-to-install.md index ebb4bd7bbe0..b79b038324a 100644 --- a/i18n/de/docusaurus-plugin-content-docs/current/general/how-to-install.md +++ b/i18n/de/docusaurus-plugin-content-docs/current/general/how-to-install.md @@ -1,6 +1,6 @@ --- title: So installieren Sie AdGuard -sidebar_position: 8 +sidebar_position: 9 --- Je nachdem, welche AdGuard-App oder Browsererweiterung Sie installieren möchten, folgen Sie einem dieser Links, um den entsprechenden Artikel zu finden: diff --git a/i18n/es/docusaurus-plugin-content-docs/current/adguard-for-windows/features/extensions.md b/i18n/es/docusaurus-plugin-content-docs/current/adguard-for-windows/features/extensions.md index 4e281975840..8d201005143 100644 --- a/i18n/es/docusaurus-plugin-content-docs/current/adguard-for-windows/features/extensions.md +++ b/i18n/es/docusaurus-plugin-content-docs/current/adguard-for-windows/features/extensions.md @@ -9,7 +9,7 @@ Este artículo trata sobre AdGuard para Windows, un bloqueador de anuncios multi ::: -AdGuard puede ampliar significativamente la funcionalidad del sitio web trabajando como [gestor de scripts de usuario](/general/extensions). Los usuarios de AdGuard pueden añadir sus propios scripts, así como gestionar los existentes. +AdGuard can significantly extend website functionality by working as a [userscript manager](/general/extensions.md). AdGuard users can add their own scripts as well as manage existing ones. ![Extensiones \*mobile\_border](https://cdn.adtidy.org/content/kb/ad_blocker/windows/overview/userscripts.png) diff --git a/i18n/es/docusaurus-plugin-content-docs/current/general/extensions.md b/i18n/es/docusaurus-plugin-content-docs/current/general/extensions.md new file mode 100644 index 00000000000..bff7a88f30f --- /dev/null +++ b/i18n/es/docusaurus-plugin-content-docs/current/general/extensions.md @@ -0,0 +1,301 @@ +--- +title: Extensiones +sidebar_position: 6 +--- + +## Userscripts + +Los scripts de usuario (también los llamamos "extensiones") son, de facto, miniprogramas escritos en JavaScript. Modifican o amplían la funcionalidad de uno o más sitios web. Es posible que muchos usuarios de AdGuard ya estén familiarizados con scripts de usuario como AdGuard Assistant, Popup Blocker y AdGuard Extra. + +:::note Supported apps + +AdGuard puede ampliar significativamente la funcionalidad del sitio web al actuar como administrador de scripts de usuario. You can add your custom scripts or manage the existing ones in our three products: [AdGuard for Windows](/adguard-for-windows/features/extensions), [AdGuard for Android](/adguard-for-android/features/settings#userscripts), and [AdGuard for Mac](/adguard-for-mac/features/extensions). + +::: + +### Scripts de AdGuard recomendados + +Estos scripts de usuario provienen directamente de los desarrolladores de AdGuard y podemos garantizar que son efectivos y seguros. For some of the userscripts developed by others that we consider good and reliable, [scroll down to the next section](#top-picks). You can also find some of the [popular websites with scripts](#more-userscripts) below, but remember that whenever you download a userscript from an unknown source, you are exposing yourself to a certain risk, as some scripts may be harmful to your computer. + +#### AdGuard Extra + +Una extensión que bloquea anuncios en casos difíciles cuando el enfoque habitual basado en filtros no es suficiente. AdGuard Extra comes pre-installed in AdGuard standalone apps, except for the one for iOS, so you don't need to do anything to enable it. Sin embargo, si deseas utilizarlo junto con la extensión de navegador AdGuard o cualquier otro bloqueador de anuncios, necesitarás utilizar una extensión adicional. Learn more about this userscript and how to install it on [GitHub](https://github.com/AdguardTeam/AdGuardExtra). + +![AdGuard Extra](https://cdn.adtidy.org/content/kb/ad_blocker/general/adguard-extra.png) + +#### AdGuard Popup Blocker + +The name speaks for itself: it blocks popups — one of the most annoying types of ads on websites. Learn more about this userscript, its key features, and installation on [GitHub](https://github.com/AdguardTeam/PopupBlocker). + +![AdGuard Popup Blocker](https://cdn.adtidy.org/content/kb/ad_blocker/general/popup-blocker-installation.png) + +#### AdGuard Assistant (versión antigua) + +This custom extension is designed to control filtering directly from the browser page (manual blocking, allowlisting, etc.). + +:::note + +This version of Assistant is legacy and there is no point in using it on new systems, as it has been replaced with the full-fledged [Browser Assistant](https://adguard.com/adguard-assistant/overview.html). However, the legacy Assistant may be useful if there is no Browser Assistant for your browser. If this is your case, you can learn how to install AdGuard Assistant on [GitHub](https://github.com/AdguardTeam/AdguardAssistant). + +::: + +#### Deshabilitar AMP + +Un script que sólo está preinstalado en AdGuard para Android. Desactiva AMP (Accelerated Mobile Pages) en la página de resultados de búsqueda de Google. Learn more about this userscript and how to install it on [GitHub](https://github.com/AdguardTeam/DisableAMP). + +![Disable AMP](https://cdn.adtidy.org/content/kb/ad_blocker/general/disable-amp-installation.png) + +### Mejores opciones fuera de AdGuard{#top-picks} + +These userscripts are not developed by AdGuard, and therefore we can't give a 100% guarantee that they are safe and/or work at all times. However, in our experience they deserve a recommendation because they've all earned their good reputation. + +#### Don't track me Google + +Este script elimina la función de seguimiento de Google de los enlaces en los resultados de búsqueda de Google. Acelera la carga de los resultados de búsqueda y te permite hacer clic derecho o tocar para copiar la URL del enlace. + +Its source code is [available on GitHub](https://github.com/Rob--W/dont-track-me-google). This userscript can be downloaded from [GreasyFork](https://greasyfork.org/en/scripts/428243-don-t-track-me-google) and installed in any AdGuard CoreLibs-based app. + +#### microShield + +A userscript for people visiting Korean websites and some international websites. The microShield userscript blocks Ad-Shield ads and anti-adblocks. Its original source code is available at [asdefuser](https://github.com/seia-soto/userscripts/tree/master/sources/asdefuser) and [AdShield Defuser](https://github.com/seia-soto/adshield-defuser). This userscript can be installed in AdGuard CoreLibs-based apps, Violentmonkey, Tampermonkey, and [quoid/userscripts](https://github.com/quoid/userscripts). Learn more about microShield and how to install it on [GitHub](https://github.com/List-KR/microShield). + +### ¿Dónde conseguir más scripts de usuario?{#more-userscripts} + +Since userscripts are mainly created by enthusiasts, you should be cautious when installing them. Cualquier script de fuente desconocida conlleva un riesgo potencial. Sin embargo, existe una gran variedad de scripts interesantes que, si se instalan con cuidado y responsabilidad, pueden hacer que el uso de algunos sitios web sea más conveniente. + +Aquí describiremos algunos de los catálogos de scripts de usuario más populares. + +#### Userscript.Zone + +[Userscript.Zone](https://www.userscript.zone) is a website that allows searching for userscripts by entering a matching URL or domain. The website is easy to use and has a high level of credibility as only scripts from moderated pages are displayed. + +#### Greasy Fork + +[Greasy Fork](https://greasyfork.org/) is a userscript catalog of Stylish creators. The scripts in this catalog are moderated, so their credibility is much higher. + +#### OpenUserJS.org + +[OpenUserJS.org](https://openuserjs.org/) is an open-source userscript catalog written in nodeJS. It's not moderated, so keep an eye out for suspicious scripts. + +#### Comunidad + +If you like the idea of customizing your browser with userscripts and have questions, you can ask them on one of these websites: + +- [Stackoverflow](https://stackoverflow.com/questions/tagged/userscripts) +- [FreeNode](https://webchat.freenode.net/#greasemonkey) +- [Reddit](https://www.reddit.com/r/userscripts/) + +### Desarrollo + +#### Solicitar licencia + +If you are developing your own custom script and want to test how it works with AdGuard, you can request a beta license key for the app. + +Para obtenerlo, envía un correo electrónico a devteam@adguard.com con la siguiente información: + +**Subject:** Userscript author license request + +**Body:** Please tell us about the userscripts you are working on. + +Here is a [mailto link](mailto:devteam@adguard.com?Subject=Userscript%20author%20license%20request\&Body=Hello%2C%0A%0AMy%20userscript%28s%29%3A%20LINK). + +#### Compatibilidad + +#### Bloqueo de metadatos + +#### Propiedades compatibles + +```text +@name +@namespace +@description +@version +@match +@include +@exclude +@grant +@connect +@require +@resource +@downloadURL +@updateURL +@supportURL +@homepageURL +@homepage +@website +@source +@run-at +@noframes +@icon +@iconURL +@defaulticon +@icon64 +@icon64URL +``` + +#### Propiedades no compatibles + +Estas propiedades serán simplemente ignoradas por AdGuard. + +```text +@unwrap +``` + +#### Funciones GM compatibles + +AdGuard admite tanto las funciones GM\_ antiguas como la nueva API GM4 que utiliza objetos GM. + +#### Valores + +:::note + +Todas las funciones antiguas de Greasemonkey enumeradas están obsoletas pero aún son compatibles. + +::: + +```text +GM.info / GM_info +GM.setValue / GM_setValue +GM.getValue / GM_getValue +GM.listValues / GM_listValues +GM.deleteValue / GM_deleteValue +GM.getResourceUrl / GM_getResourceURL +GM.setClipboard / GM_setClipboard +GM.xmlHttpRequest / GM_xmlhttpRequest +GM.openInTab / GM_openInTab +GM.notification +unsafeWindow +GM_getResourceText +GM_addStyle +GM_log +``` + +[Here](https://wiki.greasespot.net/GM.info) you can find more information about Greasemonkey API. + +#### Ejemplo + +```javascript +// ==UserScript== +// @name Name as shown to the user when locale is english or unknown +// @name:ru Name as shown to the user when locale is russian +// @description Description as shown to the user when locale is english or unknown +// @description:ru Description as shown to the user when locale is russian +// @icon https://myhomepage.com/myuserscript.png +// @version 1.0.0.0 +// @downloadURL https://dl.myhomepage.org/myuserscript.user.js +// @updateURL https://dl.myhomepage.org/myuserscript.meta.js +// @homepageURL https://myhomepage.com/myuserscript +// @include * +// @exclude *://website.com/* +// @resource https://myhomepage.com/myuserscript.css +// @require https://myhomepage.com/mylibrary.js +// @grant property:settings +// @grant GM_getValue +// @grant GM_setValue +// @grant GM_deleteValue +// @grant GM_listValues +// @grant GM_getResourceText +// @grant GM_getResourceURL +// @grant GM_addStyle +// @grant GM_log +// @grant GM_setClipboard +// @grant GM_xmlhttpRequest +// @grant unsafeWindow +// @grant GM_info +// @grant GM_openInTab +// @grant GM_registerMenuCommand +// @run-at document-start +// ==/UserScript== +!function(){( + console.log("I am loaded!"); +)}(); +``` + +## Userstyles + +Userstyles allow users to customize their online experience. Whether you’re looking to change the appearance of a website or automate repetitive tasks, styles offer a world of possibilities. + +AdGuard has the option to upload or create your own userstyles. This is an advanced feature, so you will need some knowledge of HTML and CSS. + +:::info Supported apps + +Currently, two AdGuard apps allow you to create and manage userstyles: AdGuard for Windows (v7.19 or later) and AdGuard for Mac (v2.16 or later). We also plan to implement this new feature in AdGuard v4.8 for Android in the nearest future. + +::: + +This is an experimental feature, so if you encounter any problems while adding or creating a userstyle, please contact our support team at . + +### How to set up a userstyle in AdGuard + +You can download userstyles from various websites. One of the most popular userstyle websites is [https://userstyles.world/](https://userstyles.world/explore), which we will use as an example for the following instructions on how to set up the userstyle in AdGuard. + +1. Follow the link above and choose the userstyle you like + +2. Right-click the _Install_ button and choose _Copy Link Address_ + +3. Open AdGuard settings → _Extensions_ + +4. Press the [+] button and paste the userstyle link + +5. ¡Listo! + +If you’re familiar with CSS rules, you can also create the userstyles yourself. + +:::note + +We don’t support userstyles that contain `@var` or `@advanced` in the metadata. AdGuard also doesn’t support `@preprocessor` without the `default` value. + +::: + +1. Open AdGuard settings → _Extensions_ + +2. Press the [+] button and choose the _Create userstyle_ option. A new window will appear on your screen + +3. To create a userstyle, first write the title with metadata, for example + + ```CSS + /* ==UserStyle== + @name New userstyle + @version 1.0 + ==/UserStyle== */ + ``` + +4. Write the CSS part after the meta data. AdGuard supports website domain names matching (`@-moz-document domain(…), …`). For example: + + ```CSS + body { + background: gray; + } + ``` + + Or: + + ```CSS + @-moz-document domain('example.org'), + domain('example.net'), + domain('example.com') body { + background: gray; + } + ``` + +5. Once you’re finished, press _Save and Close_. Your new userstyle has been successfully added to AdGuard + +### Ejemplo + +```css +/* ==UserStyle== +@name Example userstyle +@namespace https://example.org/userstyle +@homepageURL https://example.org/userstyle +@version 1.0.0 +@license Other +@description This is an example +@author example +@preprocessor default +==/UserStyle== */ +@-moz-document regexp("https?\:\/\/(www\.)?example\.(org|com).*") { + body { + background-color: #000000 !important; + } +} +``` diff --git a/i18n/es/docusaurus-plugin-content-docs/current/general/how-to-install.md b/i18n/es/docusaurus-plugin-content-docs/current/general/how-to-install.md index 25bbb8aaf66..e21f85dc187 100644 --- a/i18n/es/docusaurus-plugin-content-docs/current/general/how-to-install.md +++ b/i18n/es/docusaurus-plugin-content-docs/current/general/how-to-install.md @@ -1,6 +1,6 @@ --- title: Cómo instalar AdGuard -sidebar_position: 8 +sidebar_position: 9 --- Dependiendo de la aplicación AdGuard o de la extensión del navegador que desee instalar, siga uno de estos enlaces para encontrar el artículo correspondiente: diff --git a/i18n/fa/docusaurus-plugin-content-docs/current/adguard-for-windows/features/extensions.md b/i18n/fa/docusaurus-plugin-content-docs/current/adguard-for-windows/features/extensions.md index 260fa0e83b3..17884a6df33 100644 --- a/i18n/fa/docusaurus-plugin-content-docs/current/adguard-for-windows/features/extensions.md +++ b/i18n/fa/docusaurus-plugin-content-docs/current/adguard-for-windows/features/extensions.md @@ -9,7 +9,7 @@ This article covers AdGuard for Windows, a multifunctional ad blocker that prote ::: -AdGuard can significantly broaden website functionality working as a [user script manager](/general/extensions). AdGuard Users can add their own scripts, as well as manage existing ones. +AdGuard can significantly extend website functionality by working as a [userscript manager](/general/extensions.md). AdGuard users can add their own scripts as well as manage existing ones. ![Extensions \*mobile\_border](https://cdn.adtidy.org/content/kb/ad_blocker/windows/overview/userscripts.png) diff --git a/i18n/fa/docusaurus-plugin-content-docs/current/general/extensions.md b/i18n/fa/docusaurus-plugin-content-docs/current/general/extensions.md new file mode 100644 index 00000000000..0cf454b4329 --- /dev/null +++ b/i18n/fa/docusaurus-plugin-content-docs/current/general/extensions.md @@ -0,0 +1,301 @@ +--- +title: Extensions +sidebar_position: 6 +--- + +## Userscripts + +Userscripts (we also call them "extensions") are, de facto, miniprograms written in JavaScript. They modify or extend the functionality of one or more websites. Many AdGuard users may be already familiar with such userscripts as AdGuard Assistant, Popup Blocker, and AdGuard Extra. + +:::note Supported apps + +AdGuard can significantly broaden website functionality by acting as a userscript manager. You can add your custom scripts or manage the existing ones in our three products: [AdGuard for Windows](/adguard-for-windows/features/extensions), [AdGuard for Android](/adguard-for-android/features/settings#userscripts), and [AdGuard for Mac](/adguard-for-mac/features/extensions). + +::: + +### Recommended AdGuard scripts + +These userscripts come directly from the AdGuard developers, and we can guarantee that they are effective and safe. For some of the userscripts developed by others that we consider good and reliable, [scroll down to the next section](#top-picks). You can also find some of the [popular websites with scripts](#more-userscripts) below, but remember that whenever you download a userscript from an unknown source, you are exposing yourself to a certain risk, as some scripts may be harmful to your computer. + +#### AdGuard Extra + +An extension that blocks ads in difficult cases when the usual filter-based approach is not enough. AdGuard Extra comes pre-installed in AdGuard standalone apps, except for the one for iOS, so you don't need to do anything to enable it. However, if you want to use it alongside AdGuard Browser Extension or any other ad blocker, you'll need to use an additional extension. Learn more about this userscript and how to install it on [GitHub](https://github.com/AdguardTeam/AdGuardExtra). + +![AdGuard Extra](https://cdn.adtidy.org/content/kb/ad_blocker/general/adguard-extra.png) + +#### AdGuard Popup Blocker + +The name speaks for itself: it blocks popups — one of the most annoying types of ads on websites. Learn more about this userscript, its key features, and installation on [GitHub](https://github.com/AdguardTeam/PopupBlocker). + +![AdGuard Popup Blocker](https://cdn.adtidy.org/content/kb/ad_blocker/general/popup-blocker-installation.png) + +#### AdGuard Assistant (legacy version) + +This custom extension is designed to control filtering directly from the browser page (manual blocking, allowlisting, etc.). + +:::note + +This version of Assistant is legacy and there is no point in using it on new systems, as it has been replaced with the full-fledged [Browser Assistant](https://adguard.com/adguard-assistant/overview.html). However, the legacy Assistant may be useful if there is no Browser Assistant for your browser. If this is your case, you can learn how to install AdGuard Assistant on [GitHub](https://github.com/AdguardTeam/AdguardAssistant). + +::: + +#### Disable AMP + +A script that is only pre-installed in AdGuard for Android. It disables AMP (Accelerated Mobile Pages) on the Google search results page. Learn more about this userscript and how to install it on [GitHub](https://github.com/AdguardTeam/DisableAMP). + +![Disable AMP](https://cdn.adtidy.org/content/kb/ad_blocker/general/disable-amp-installation.png) + +### Top picks outside AdGuard{#top-picks} + +These userscripts are not developed by AdGuard, and therefore we can't give a 100% guarantee that they are safe and/or work at all times. However, in our experience they deserve a recommendation because they've all earned their good reputation. + +#### Don't track me Google + +This script removes Google's tracking feature from the links in Google search results. It speeds up the loading of search results and allows you to right-click or tap to copy the link URL. + +Its source code is [available on GitHub](https://github.com/Rob--W/dont-track-me-google). This userscript can be downloaded from [GreasyFork](https://greasyfork.org/en/scripts/428243-don-t-track-me-google) and installed in any AdGuard CoreLibs-based app. + +#### microShield + +A userscript for people visiting Korean websites and some international websites. The microShield userscript blocks Ad-Shield ads and anti-adblocks. Its original source code is available at [asdefuser](https://github.com/seia-soto/userscripts/tree/master/sources/asdefuser) and [AdShield Defuser](https://github.com/seia-soto/adshield-defuser). This userscript can be installed in AdGuard CoreLibs-based apps, Violentmonkey, Tampermonkey, and [quoid/userscripts](https://github.com/quoid/userscripts). Learn more about microShield and how to install it on [GitHub](https://github.com/List-KR/microShield). + +### Where can you get more userscripts?{#more-userscripts} + +Since userscripts are mainly created by enthusiasts, you should be cautious when installing them. Any script from an unknown source carries a potential risk. Yet, there is a great variety of interesting scripts that, if installed carefully and responsibly, can really make using some websites more convenient. + +Here we will describe some of the most popular userscript catalogs. + +#### Userscript.Zone + +[Userscript.Zone](https://www.userscript.zone) is a website that allows searching for userscripts by entering a matching URL or domain. The website is easy to use and has a high level of credibility as only scripts from moderated pages are displayed. + +#### Greasy Fork + +[Greasy Fork](https://greasyfork.org/) is a userscript catalog of Stylish creators. The scripts in this catalog are moderated, so their credibility is much higher. + +#### OpenUserJS.org + +[OpenUserJS.org](https://openuserjs.org/) is an open-source userscript catalog written in nodeJS. It's not moderated, so keep an eye out for suspicious scripts. + +#### Community + +If you like the idea of customizing your browser with userscripts and have questions, you can ask them on one of these websites: + +- [Stackoverflow](https://stackoverflow.com/questions/tagged/userscripts) +- [FreeNode](https://webchat.freenode.net/#greasemonkey) +- [Reddit](https://www.reddit.com/r/userscripts/) + +### Development + +#### Request license + +If you are developing your own custom script and want to test how it works with AdGuard, you can request a beta license key for the app. + +To get it, please send an email to devteam@adguard.com with the following information: + +**Subject:** Userscript author license request + +**Body:** Please tell us about the userscripts you are working on. + +Here is a [mailto link](mailto:devteam@adguard.com?Subject=Userscript%20author%20license%20request\&Body=Hello%2C%0A%0AMy%20userscript%28s%29%3A%20LINK). + +#### Compatibility + +#### Metadata block + +#### Supported properties + +```text +@name +@namespace +@description +@version +@match +@include +@exclude +@grant +@connect +@require +@resource +@downloadURL +@updateURL +@supportURL +@homepageURL +@homepage +@website +@source +@run-at +@noframes +@icon +@iconURL +@defaulticon +@icon64 +@icon64URL +``` + +#### Unsupported properties + +These properties will be simply ignored by AdGuard. + +```text +@unwrap +``` + +#### Supported GM functions + +AdGuard supports both old GM\_ functions and new GM4 API that use GM object. + +#### Values + +:::note + +All listed old Greasemonkey functions are deprecated but still supported. + +::: + +```text +GM.info / GM_info +GM.setValue / GM_setValue +GM.getValue / GM_getValue +GM.listValues / GM_listValues +GM.deleteValue / GM_deleteValue +GM.getResourceUrl / GM_getResourceURL +GM.setClipboard / GM_setClipboard +GM.xmlHttpRequest / GM_xmlhttpRequest +GM.openInTab / GM_openInTab +GM.notification +unsafeWindow +GM_getResourceText +GM_addStyle +GM_log +``` + +[Here](https://wiki.greasespot.net/GM.info) you can find more information about Greasemonkey API. + +#### Example + +```javascript +// ==UserScript== +// @name Name as shown to the user when locale is english or unknown +// @name:ru Name as shown to the user when locale is russian +// @description Description as shown to the user when locale is english or unknown +// @description:ru Description as shown to the user when locale is russian +// @icon https://myhomepage.com/myuserscript.png +// @version 1.0.0.0 +// @downloadURL https://dl.myhomepage.org/myuserscript.user.js +// @updateURL https://dl.myhomepage.org/myuserscript.meta.js +// @homepageURL https://myhomepage.com/myuserscript +// @include * +// @exclude *://website.com/* +// @resource https://myhomepage.com/myuserscript.css +// @require https://myhomepage.com/mylibrary.js +// @grant property:settings +// @grant GM_getValue +// @grant GM_setValue +// @grant GM_deleteValue +// @grant GM_listValues +// @grant GM_getResourceText +// @grant GM_getResourceURL +// @grant GM_addStyle +// @grant GM_log +// @grant GM_setClipboard +// @grant GM_xmlhttpRequest +// @grant unsafeWindow +// @grant GM_info +// @grant GM_openInTab +// @grant GM_registerMenuCommand +// @run-at document-start +// ==/UserScript== +!function(){( + console.log("I am loaded!"); +)}(); +``` + +## Userstyles + +Userstyles allow users to customize their online experience. Whether you’re looking to change the appearance of a website or automate repetitive tasks, styles offer a world of possibilities. + +AdGuard has the option to upload or create your own userstyles. This is an advanced feature, so you will need some knowledge of HTML and CSS. + +:::info Supported apps + +Currently, two AdGuard apps allow you to create and manage userstyles: AdGuard for Windows (v7.19 or later) and AdGuard for Mac (v2.16 or later). We also plan to implement this new feature in AdGuard v4.8 for Android in the nearest future. + +::: + +This is an experimental feature, so if you encounter any problems while adding or creating a userstyle, please contact our support team at . + +### How to set up a userstyle in AdGuard + +You can download userstyles from various websites. One of the most popular userstyle websites is [https://userstyles.world/](https://userstyles.world/explore), which we will use as an example for the following instructions on how to set up the userstyle in AdGuard. + +1. Follow the link above and choose the userstyle you like + +2. Right-click the _Install_ button and choose _Copy Link Address_ + +3. Open AdGuard settings → _Extensions_ + +4. Press the [+] button and paste the userstyle link + +5. Done! + +If you’re familiar with CSS rules, you can also create the userstyles yourself. + +:::note + +We don’t support userstyles that contain `@var` or `@advanced` in the metadata. AdGuard also doesn’t support `@preprocessor` without the `default` value. + +::: + +1. Open AdGuard settings → _Extensions_ + +2. Press the [+] button and choose the _Create userstyle_ option. A new window will appear on your screen + +3. To create a userstyle, first write the title with metadata, for example + + ```CSS + /* ==UserStyle== + @name New userstyle + @version 1.0 + ==/UserStyle== */ + ``` + +4. Write the CSS part after the meta data. AdGuard supports website domain names matching (`@-moz-document domain(…), …`). For example: + + ```CSS + body { + background: gray; + } + ``` + + Or: + + ```CSS + @-moz-document domain('example.org'), + domain('example.net'), + domain('example.com') body { + background: gray; + } + ``` + +5. Once you’re finished, press _Save and Close_. Your new userstyle has been successfully added to AdGuard + +### Example + +```css +/* ==UserStyle== +@name Example userstyle +@namespace https://example.org/userstyle +@homepageURL https://example.org/userstyle +@version 1.0.0 +@license Other +@description This is an example +@author example +@preprocessor default +==/UserStyle== */ +@-moz-document regexp("https?\:\/\/(www\.)?example\.(org|com).*") { + body { + background-color: #000000 !important; + } +} +``` diff --git a/i18n/fa/docusaurus-plugin-content-docs/current/general/how-to-install.md b/i18n/fa/docusaurus-plugin-content-docs/current/general/how-to-install.md index bae3060668a..106a29529a8 100644 --- a/i18n/fa/docusaurus-plugin-content-docs/current/general/how-to-install.md +++ b/i18n/fa/docusaurus-plugin-content-docs/current/general/how-to-install.md @@ -1,6 +1,6 @@ --- title: How to install AdGuard -sidebar_position: 8 +sidebar_position: 9 --- Depending on which AdGuard app or browser extension you want to install, follow one of these links to find the relevant article: diff --git a/i18n/fi/docusaurus-plugin-content-docs/current/adguard-for-windows/features/extensions.md b/i18n/fi/docusaurus-plugin-content-docs/current/adguard-for-windows/features/extensions.md index 260fa0e83b3..17884a6df33 100644 --- a/i18n/fi/docusaurus-plugin-content-docs/current/adguard-for-windows/features/extensions.md +++ b/i18n/fi/docusaurus-plugin-content-docs/current/adguard-for-windows/features/extensions.md @@ -9,7 +9,7 @@ This article covers AdGuard for Windows, a multifunctional ad blocker that prote ::: -AdGuard can significantly broaden website functionality working as a [user script manager](/general/extensions). AdGuard Users can add their own scripts, as well as manage existing ones. +AdGuard can significantly extend website functionality by working as a [userscript manager](/general/extensions.md). AdGuard users can add their own scripts as well as manage existing ones. ![Extensions \*mobile\_border](https://cdn.adtidy.org/content/kb/ad_blocker/windows/overview/userscripts.png) diff --git a/i18n/fi/docusaurus-plugin-content-docs/current/general/extensions.md b/i18n/fi/docusaurus-plugin-content-docs/current/general/extensions.md new file mode 100644 index 00000000000..0cf454b4329 --- /dev/null +++ b/i18n/fi/docusaurus-plugin-content-docs/current/general/extensions.md @@ -0,0 +1,301 @@ +--- +title: Extensions +sidebar_position: 6 +--- + +## Userscripts + +Userscripts (we also call them "extensions") are, de facto, miniprograms written in JavaScript. They modify or extend the functionality of one or more websites. Many AdGuard users may be already familiar with such userscripts as AdGuard Assistant, Popup Blocker, and AdGuard Extra. + +:::note Supported apps + +AdGuard can significantly broaden website functionality by acting as a userscript manager. You can add your custom scripts or manage the existing ones in our three products: [AdGuard for Windows](/adguard-for-windows/features/extensions), [AdGuard for Android](/adguard-for-android/features/settings#userscripts), and [AdGuard for Mac](/adguard-for-mac/features/extensions). + +::: + +### Recommended AdGuard scripts + +These userscripts come directly from the AdGuard developers, and we can guarantee that they are effective and safe. For some of the userscripts developed by others that we consider good and reliable, [scroll down to the next section](#top-picks). You can also find some of the [popular websites with scripts](#more-userscripts) below, but remember that whenever you download a userscript from an unknown source, you are exposing yourself to a certain risk, as some scripts may be harmful to your computer. + +#### AdGuard Extra + +An extension that blocks ads in difficult cases when the usual filter-based approach is not enough. AdGuard Extra comes pre-installed in AdGuard standalone apps, except for the one for iOS, so you don't need to do anything to enable it. However, if you want to use it alongside AdGuard Browser Extension or any other ad blocker, you'll need to use an additional extension. Learn more about this userscript and how to install it on [GitHub](https://github.com/AdguardTeam/AdGuardExtra). + +![AdGuard Extra](https://cdn.adtidy.org/content/kb/ad_blocker/general/adguard-extra.png) + +#### AdGuard Popup Blocker + +The name speaks for itself: it blocks popups — one of the most annoying types of ads on websites. Learn more about this userscript, its key features, and installation on [GitHub](https://github.com/AdguardTeam/PopupBlocker). + +![AdGuard Popup Blocker](https://cdn.adtidy.org/content/kb/ad_blocker/general/popup-blocker-installation.png) + +#### AdGuard Assistant (legacy version) + +This custom extension is designed to control filtering directly from the browser page (manual blocking, allowlisting, etc.). + +:::note + +This version of Assistant is legacy and there is no point in using it on new systems, as it has been replaced with the full-fledged [Browser Assistant](https://adguard.com/adguard-assistant/overview.html). However, the legacy Assistant may be useful if there is no Browser Assistant for your browser. If this is your case, you can learn how to install AdGuard Assistant on [GitHub](https://github.com/AdguardTeam/AdguardAssistant). + +::: + +#### Disable AMP + +A script that is only pre-installed in AdGuard for Android. It disables AMP (Accelerated Mobile Pages) on the Google search results page. Learn more about this userscript and how to install it on [GitHub](https://github.com/AdguardTeam/DisableAMP). + +![Disable AMP](https://cdn.adtidy.org/content/kb/ad_blocker/general/disable-amp-installation.png) + +### Top picks outside AdGuard{#top-picks} + +These userscripts are not developed by AdGuard, and therefore we can't give a 100% guarantee that they are safe and/or work at all times. However, in our experience they deserve a recommendation because they've all earned their good reputation. + +#### Don't track me Google + +This script removes Google's tracking feature from the links in Google search results. It speeds up the loading of search results and allows you to right-click or tap to copy the link URL. + +Its source code is [available on GitHub](https://github.com/Rob--W/dont-track-me-google). This userscript can be downloaded from [GreasyFork](https://greasyfork.org/en/scripts/428243-don-t-track-me-google) and installed in any AdGuard CoreLibs-based app. + +#### microShield + +A userscript for people visiting Korean websites and some international websites. The microShield userscript blocks Ad-Shield ads and anti-adblocks. Its original source code is available at [asdefuser](https://github.com/seia-soto/userscripts/tree/master/sources/asdefuser) and [AdShield Defuser](https://github.com/seia-soto/adshield-defuser). This userscript can be installed in AdGuard CoreLibs-based apps, Violentmonkey, Tampermonkey, and [quoid/userscripts](https://github.com/quoid/userscripts). Learn more about microShield and how to install it on [GitHub](https://github.com/List-KR/microShield). + +### Where can you get more userscripts?{#more-userscripts} + +Since userscripts are mainly created by enthusiasts, you should be cautious when installing them. Any script from an unknown source carries a potential risk. Yet, there is a great variety of interesting scripts that, if installed carefully and responsibly, can really make using some websites more convenient. + +Here we will describe some of the most popular userscript catalogs. + +#### Userscript.Zone + +[Userscript.Zone](https://www.userscript.zone) is a website that allows searching for userscripts by entering a matching URL or domain. The website is easy to use and has a high level of credibility as only scripts from moderated pages are displayed. + +#### Greasy Fork + +[Greasy Fork](https://greasyfork.org/) is a userscript catalog of Stylish creators. The scripts in this catalog are moderated, so their credibility is much higher. + +#### OpenUserJS.org + +[OpenUserJS.org](https://openuserjs.org/) is an open-source userscript catalog written in nodeJS. It's not moderated, so keep an eye out for suspicious scripts. + +#### Community + +If you like the idea of customizing your browser with userscripts and have questions, you can ask them on one of these websites: + +- [Stackoverflow](https://stackoverflow.com/questions/tagged/userscripts) +- [FreeNode](https://webchat.freenode.net/#greasemonkey) +- [Reddit](https://www.reddit.com/r/userscripts/) + +### Development + +#### Request license + +If you are developing your own custom script and want to test how it works with AdGuard, you can request a beta license key for the app. + +To get it, please send an email to devteam@adguard.com with the following information: + +**Subject:** Userscript author license request + +**Body:** Please tell us about the userscripts you are working on. + +Here is a [mailto link](mailto:devteam@adguard.com?Subject=Userscript%20author%20license%20request\&Body=Hello%2C%0A%0AMy%20userscript%28s%29%3A%20LINK). + +#### Compatibility + +#### Metadata block + +#### Supported properties + +```text +@name +@namespace +@description +@version +@match +@include +@exclude +@grant +@connect +@require +@resource +@downloadURL +@updateURL +@supportURL +@homepageURL +@homepage +@website +@source +@run-at +@noframes +@icon +@iconURL +@defaulticon +@icon64 +@icon64URL +``` + +#### Unsupported properties + +These properties will be simply ignored by AdGuard. + +```text +@unwrap +``` + +#### Supported GM functions + +AdGuard supports both old GM\_ functions and new GM4 API that use GM object. + +#### Values + +:::note + +All listed old Greasemonkey functions are deprecated but still supported. + +::: + +```text +GM.info / GM_info +GM.setValue / GM_setValue +GM.getValue / GM_getValue +GM.listValues / GM_listValues +GM.deleteValue / GM_deleteValue +GM.getResourceUrl / GM_getResourceURL +GM.setClipboard / GM_setClipboard +GM.xmlHttpRequest / GM_xmlhttpRequest +GM.openInTab / GM_openInTab +GM.notification +unsafeWindow +GM_getResourceText +GM_addStyle +GM_log +``` + +[Here](https://wiki.greasespot.net/GM.info) you can find more information about Greasemonkey API. + +#### Example + +```javascript +// ==UserScript== +// @name Name as shown to the user when locale is english or unknown +// @name:ru Name as shown to the user when locale is russian +// @description Description as shown to the user when locale is english or unknown +// @description:ru Description as shown to the user when locale is russian +// @icon https://myhomepage.com/myuserscript.png +// @version 1.0.0.0 +// @downloadURL https://dl.myhomepage.org/myuserscript.user.js +// @updateURL https://dl.myhomepage.org/myuserscript.meta.js +// @homepageURL https://myhomepage.com/myuserscript +// @include * +// @exclude *://website.com/* +// @resource https://myhomepage.com/myuserscript.css +// @require https://myhomepage.com/mylibrary.js +// @grant property:settings +// @grant GM_getValue +// @grant GM_setValue +// @grant GM_deleteValue +// @grant GM_listValues +// @grant GM_getResourceText +// @grant GM_getResourceURL +// @grant GM_addStyle +// @grant GM_log +// @grant GM_setClipboard +// @grant GM_xmlhttpRequest +// @grant unsafeWindow +// @grant GM_info +// @grant GM_openInTab +// @grant GM_registerMenuCommand +// @run-at document-start +// ==/UserScript== +!function(){( + console.log("I am loaded!"); +)}(); +``` + +## Userstyles + +Userstyles allow users to customize their online experience. Whether you’re looking to change the appearance of a website or automate repetitive tasks, styles offer a world of possibilities. + +AdGuard has the option to upload or create your own userstyles. This is an advanced feature, so you will need some knowledge of HTML and CSS. + +:::info Supported apps + +Currently, two AdGuard apps allow you to create and manage userstyles: AdGuard for Windows (v7.19 or later) and AdGuard for Mac (v2.16 or later). We also plan to implement this new feature in AdGuard v4.8 for Android in the nearest future. + +::: + +This is an experimental feature, so if you encounter any problems while adding or creating a userstyle, please contact our support team at . + +### How to set up a userstyle in AdGuard + +You can download userstyles from various websites. One of the most popular userstyle websites is [https://userstyles.world/](https://userstyles.world/explore), which we will use as an example for the following instructions on how to set up the userstyle in AdGuard. + +1. Follow the link above and choose the userstyle you like + +2. Right-click the _Install_ button and choose _Copy Link Address_ + +3. Open AdGuard settings → _Extensions_ + +4. Press the [+] button and paste the userstyle link + +5. Done! + +If you’re familiar with CSS rules, you can also create the userstyles yourself. + +:::note + +We don’t support userstyles that contain `@var` or `@advanced` in the metadata. AdGuard also doesn’t support `@preprocessor` without the `default` value. + +::: + +1. Open AdGuard settings → _Extensions_ + +2. Press the [+] button and choose the _Create userstyle_ option. A new window will appear on your screen + +3. To create a userstyle, first write the title with metadata, for example + + ```CSS + /* ==UserStyle== + @name New userstyle + @version 1.0 + ==/UserStyle== */ + ``` + +4. Write the CSS part after the meta data. AdGuard supports website domain names matching (`@-moz-document domain(…), …`). For example: + + ```CSS + body { + background: gray; + } + ``` + + Or: + + ```CSS + @-moz-document domain('example.org'), + domain('example.net'), + domain('example.com') body { + background: gray; + } + ``` + +5. Once you’re finished, press _Save and Close_. Your new userstyle has been successfully added to AdGuard + +### Example + +```css +/* ==UserStyle== +@name Example userstyle +@namespace https://example.org/userstyle +@homepageURL https://example.org/userstyle +@version 1.0.0 +@license Other +@description This is an example +@author example +@preprocessor default +==/UserStyle== */ +@-moz-document regexp("https?\:\/\/(www\.)?example\.(org|com).*") { + body { + background-color: #000000 !important; + } +} +``` diff --git a/i18n/fi/docusaurus-plugin-content-docs/current/general/how-to-install.md b/i18n/fi/docusaurus-plugin-content-docs/current/general/how-to-install.md index bae3060668a..106a29529a8 100644 --- a/i18n/fi/docusaurus-plugin-content-docs/current/general/how-to-install.md +++ b/i18n/fi/docusaurus-plugin-content-docs/current/general/how-to-install.md @@ -1,6 +1,6 @@ --- title: How to install AdGuard -sidebar_position: 8 +sidebar_position: 9 --- Depending on which AdGuard app or browser extension you want to install, follow one of these links to find the relevant article: diff --git a/i18n/fr/docusaurus-plugin-content-docs/current/adguard-for-windows/features/extensions.md b/i18n/fr/docusaurus-plugin-content-docs/current/adguard-for-windows/features/extensions.md index 212f7421e60..57ec4f3921a 100644 --- a/i18n/fr/docusaurus-plugin-content-docs/current/adguard-for-windows/features/extensions.md +++ b/i18n/fr/docusaurus-plugin-content-docs/current/adguard-for-windows/features/extensions.md @@ -9,7 +9,7 @@ Cet article parle de AdGuard pour Windows, un bloqueur de contenus multifonction ::: -AdGuard peut accroître considérablement les fonctionnalités des sites web en agissant comme un [gestionnaire de scripts utilisateur](/general/extensions). Les utilisateurs d'AdGuard peuvent ajouter leurs propres scripts et gérer les scripts existants. +AdGuard can significantly extend website functionality by working as a [userscript manager](/general/extensions.md). AdGuard users can add their own scripts as well as manage existing ones. ![Extensions \*mobile\_border](https://cdn.adtidy.org/content/kb/ad_blocker/windows/overview/userscripts.png) diff --git a/i18n/fr/docusaurus-plugin-content-docs/current/general/extensions.md b/i18n/fr/docusaurus-plugin-content-docs/current/general/extensions.md new file mode 100644 index 00000000000..9df1a3c4ee3 --- /dev/null +++ b/i18n/fr/docusaurus-plugin-content-docs/current/general/extensions.md @@ -0,0 +1,301 @@ +--- +title: Extensions +sidebar_position: 6 +--- + +## Scripts utilisateur + +Les scripts utilisateurs ou userscripts (que nous appelons aussi "extensions") sont, en fait, des miniprogrammes écrits en JavaScript. Ils modifient ou élargissent les fonctionnalités d'un ou plusieurs sites web. De nombreux utilisateurs d'AdGuard sont peut-être déjà familiers avec des scripts utilisateur tels que AdGuard Assistant, Popup Blocker et AdGuard Extra. + +:::note Supported apps + +AdGuard peut accroître considérablement les fonctionnalités des sites web en agissant comme un gestionnaire de scripts utilisateur. You can add your custom scripts or manage the existing ones in our three products: [AdGuard for Windows](/adguard-for-windows/features/extensions), [AdGuard for Android](/adguard-for-android/features/settings#userscripts), and [AdGuard for Mac](/adguard-for-mac/features/extensions). + +::: + +### Scripts AdGuard recommandés + +Ces scripts utilisateur proviennent directement des développeurs AdGuard et nous pouvons garantir qu'ils sont efficaces et sûrs. For some of the userscripts developed by others that we consider good and reliable, [scroll down to the next section](#top-picks). You can also find some of the [popular websites with scripts](#more-userscripts) below, but remember that whenever you download a userscript from an unknown source, you are exposing yourself to a certain risk, as some scripts may be harmful to your computer. + +#### AdGuard Extra + +Une extension qui bloque les publicités dans les cas difficiles où l'approche habituelle basée sur les filtres ne suffit pas. AdGuard Extra comes pre-installed in AdGuard standalone apps, except for the one for iOS, so you don't need to do anything to enable it. Cependant, si vous souhaitez l'utiliser avec l'extension de navigateur AdGuard ou tout autre bloqueur de publicités, vous devrez utiliser une extension supplémentaire. Learn more about this userscript and how to install it on [GitHub](https://github.com/AdguardTeam/AdGuardExtra). + +![AdGuard Extra](https://cdn.adtidy.org/content/kb/ad_blocker/general/adguard-extra.png) + +#### Bloqueur AdGuard de fenêtres pop-up + +The name speaks for itself: it blocks popups — one of the most annoying types of ads on websites. Learn more about this userscript, its key features, and installation on [GitHub](https://github.com/AdguardTeam/PopupBlocker). + +![AdGuard Popup Blocker](https://cdn.adtidy.org/content/kb/ad_blocker/general/popup-blocker-installation.png) + +#### Assistant AdGuard (ancienne version) + +This custom extension is designed to control filtering directly from the browser page (manual blocking, allowlisting, etc.). + +:::note + +This version of Assistant is legacy and there is no point in using it on new systems, as it has been replaced with the full-fledged [Browser Assistant](https://adguard.com/adguard-assistant/overview.html). However, the legacy Assistant may be useful if there is no Browser Assistant for your browser. If this is your case, you can learn how to install AdGuard Assistant on [GitHub](https://github.com/AdguardTeam/AdguardAssistant). + +::: + +#### Désactiver AMP + +Un script préinstallé uniquement dans AdGuard pour Android. Il désactive AMP (Accelerated Mobile Pages - pages mobiles accélérées) sur la page de résultats de recherche Google. Learn more about this userscript and how to install it on [GitHub](https://github.com/AdguardTeam/DisableAMP). + +![Disable AMP](https://cdn.adtidy.org/content/kb/ad_blocker/general/disable-amp-installation.png) + +### Meilleurs choix en dehors d'AdGuard{#top-picks} + +These userscripts are not developed by AdGuard, and therefore we can't give a 100% guarantee that they are safe and/or work at all times. However, in our experience they deserve a recommendation because they've all earned their good reputation. + +#### Don't track me Google + +Ce script supprime la fonctionnalité de suivi de Google des liens dans les résultats de recherche Google. Il accélère le chargement des résultats de recherche et vous permet de cliquer ou d'appuyer avec le bouton droit pour copier l'URL du lien. + +Its source code is [available on GitHub](https://github.com/Rob--W/dont-track-me-google). This userscript can be downloaded from [GreasyFork](https://greasyfork.org/en/scripts/428243-don-t-track-me-google) and installed in any AdGuard CoreLibs-based app. + +#### microShield + +A userscript for people visiting Korean websites and some international websites. The microShield userscript blocks Ad-Shield ads and anti-adblocks. Its original source code is available at [asdefuser](https://github.com/seia-soto/userscripts/tree/master/sources/asdefuser) and [AdShield Defuser](https://github.com/seia-soto/adshield-defuser). This userscript can be installed in AdGuard CoreLibs-based apps, Violentmonkey, Tampermonkey, and [quoid/userscripts](https://github.com/quoid/userscripts). Learn more about microShield and how to install it on [GitHub](https://github.com/List-KR/microShield). + +### Où trouver d'autres scripts utilisateur ?{#more-userscripts} + +Since userscripts are mainly created by enthusiasts, you should be cautious when installing them. Tout script provenant d'une source inconnue comporte un risque potentiel. Pourtant, il existe une grande variété de scripts intéressants qui, s’ils sont installés avec soin et de manière responsable, peuvent réellement rendre l’utilisation de certains sites web plus pratique. + +Nous décrirons ici certains des catalogues de scripts utilisateur les plus populaires. + +#### Userscript.Zone + +[Userscript.Zone](https://www.userscript.zone) is a website that allows searching for userscripts by entering a matching URL or domain. The website is easy to use and has a high level of credibility as only scripts from moderated pages are displayed. + +#### Greasy Fork + +[Greasy Fork](https://greasyfork.org/) is a userscript catalog of Stylish creators. The scripts in this catalog are moderated, so their credibility is much higher. + +#### OpenUserJS.org + +[OpenUserJS.org](https://openuserjs.org/) is an open-source userscript catalog written in nodeJS. It's not moderated, so keep an eye out for suspicious scripts. + +#### Communauté + +If you like the idea of customizing your browser with userscripts and have questions, you can ask them on one of these websites: + +- [Stackoverflow](https://stackoverflow.com/questions/tagged/userscripts) +- [FreeNode](https://webchat.freenode.net/#greasemonkey) +- [Reddit](https://www.reddit.com/r/userscripts/) + +### Développement + +#### Demande de licence + +If you are developing your own custom script and want to test how it works with AdGuard, you can request a beta license key for the app. + +Pour l'obtenir, veuillez envoyer un email à devteam@adguard.com avec les informations suivantes : + +**Subject:** Userscript author license request + +**Body:** Please tell us about the userscripts you are working on. + +Here is a [mailto link](mailto:devteam@adguard.com?Subject=Userscript%20author%20license%20request\&Body=Hello%2C%0A%0AMy%20userscript%28s%29%3A%20LINK). + +#### Compatibilité + +#### Bloc de métadonnées + +#### Propriétés prises en charge + +```text +@name +@namespace +@description +@version +@match +@include +@exclude +@grant +@connect +@require +@resource +@downloadURL +@updateURL +@supportURL +@homepageURL +@homepage +@website +@source +@run-at +@noframes +@icon +@iconURL +@defaulticon +@icon64 +@icon64URL +``` + +#### Propriétés non prises en charge + +Ces propriétés seront simplement ignorées par AdGuard. + +```text +@unwrap +``` + +#### Fonctions GM prises en charge + +AdGuard prend en charge à la fois les anciennes fonctions GM\_ et la nouvelle API GM4 qui utilisent l'objet GM. + +#### Valeurs + +:::note + +Toutes les anciennes fonctions Greasemonkey répertoriées sont obsolètes mais toujours prises en charge. + +::: + +```text +GM.info / GM_info +GM.setValue / GM_setValue +GM.getValue / GM_getValue +GM.listValues / GM_listValues +GM.deleteValue / GM_deleteValue +GM.getResourceUrl / GM_getResourceURL +GM.setClipboard / GM_setClipboard +GM.xmlHttpRequest / GM_xmlhttpRequest +GM.openInTab / GM_openInTab +GM.notification +unsafeWindow +GM_getResourceText +GM_addStyle +GM_log +``` + +[Here](https://wiki.greasespot.net/GM.info) you can find more information about Greasemonkey API. + +#### Example + +```javascript +// ==UserScript== +// @name Name as shown to the user when locale is english or unknown +// @name:ru Name as shown to the user when locale is russian +// @description Description as shown to the user when locale is english or unknown +// @description:ru Description as shown to the user when locale is russian +// @icon https://myhomepage.com/myuserscript.png +// @version 1.0.0.0 +// @downloadURL https://dl.myhomepage.org/myuserscript.user.js +// @updateURL https://dl.myhomepage.org/myuserscript.meta.js +// @homepageURL https://myhomepage.com/myuserscript +// @include * +// @exclude *://website.com/* +// @resource https://myhomepage.com/myuserscript.css +// @require https://myhomepage.com/mylibrary.js +// @grant property:settings +// @grant GM_getValue +// @grant GM_setValue +// @grant GM_deleteValue +// @grant GM_listValues +// @grant GM_getResourceText +// @grant GM_getResourceURL +// @grant GM_addStyle +// @grant GM_log +// @grant GM_setClipboard +// @grant GM_xmlhttpRequest +// @grant unsafeWindow +// @grant GM_info +// @grant GM_openInTab +// @grant GM_registerMenuCommand +// @run-at document-start +// ==/UserScript== +!function(){( + console.log("I am loaded!"); +)}(); +``` + +## Styles utilisateur + +Userstyles allow users to customize their online experience. Whether you’re looking to change the appearance of a website or automate repetitive tasks, styles offer a world of possibilities. + +AdGuard has the option to upload or create your own userstyles. This is an advanced feature, so you will need some knowledge of HTML and CSS. + +:::info Supported apps + +Currently, two AdGuard apps allow you to create and manage userstyles: AdGuard for Windows (v7.19 or later) and AdGuard for Mac (v2.16 or later). We also plan to implement this new feature in AdGuard v4.8 for Android in the nearest future. + +::: + +This is an experimental feature, so if you encounter any problems while adding or creating a userstyle, please contact our support team at . + +### How to set up a userstyle in AdGuard + +You can download userstyles from various websites. One of the most popular userstyle websites is [https://userstyles.world/](https://userstyles.world/explore), which we will use as an example for the following instructions on how to set up the userstyle in AdGuard. + +1. Follow the link above and choose the userstyle you like + +2. Right-click the _Install_ button and choose _Copy Link Address_ + +3. Open AdGuard settings → _Extensions_ + +4. Press the [+] button and paste the userstyle link + +5. C'est fait ! + +If you’re familiar with CSS rules, you can also create the userstyles yourself. + +:::note + +We don’t support userstyles that contain `@var` or `@advanced` in the metadata. AdGuard also doesn’t support `@preprocessor` without the `default` value. + +::: + +1. Open AdGuard settings → _Extensions_ + +2. Press the [+] button and choose the _Create userstyle_ option. A new window will appear on your screen + +3. To create a userstyle, first write the title with metadata, for example + + ```CSS + /* ==UserStyle== + @name New userstyle + @version 1.0 + ==/UserStyle== */ + ``` + +4. Write the CSS part after the meta data. AdGuard supports website domain names matching (`@-moz-document domain(…), …`). For example: + + ```CSS + body { + background: gray; + } + ``` + + Or: + + ```CSS + @-moz-document domain('example.org'), + domain('example.net'), + domain('example.com') body { + background: gray; + } + ``` + +5. Once you’re finished, press _Save and Close_. Your new userstyle has been successfully added to AdGuard + +### Example + +```css +/* ==UserStyle== +@name Example userstyle +@namespace https://example.org/userstyle +@homepageURL https://example.org/userstyle +@version 1.0.0 +@license Other +@description This is an example +@author example +@preprocessor default +==/UserStyle== */ +@-moz-document regexp("https?\:\/\/(www\.)?example\.(org|com).*") { + body { + background-color: #000000 !important; + } +} +``` diff --git a/i18n/fr/docusaurus-plugin-content-docs/current/general/how-to-install.md b/i18n/fr/docusaurus-plugin-content-docs/current/general/how-to-install.md index 3e5022b291f..6a3eca6e7e5 100644 --- a/i18n/fr/docusaurus-plugin-content-docs/current/general/how-to-install.md +++ b/i18n/fr/docusaurus-plugin-content-docs/current/general/how-to-install.md @@ -1,6 +1,6 @@ --- title: Comment installer AdGuard -sidebar_position: 8 +sidebar_position: 9 --- Selon l'application AdGuard ou l'extension de navigateur que vous souhaitez installer, suivez l'un de ces liens pour trouver l'article correspondant : diff --git a/i18n/hr/docusaurus-plugin-content-docs/current/adguard-for-windows/features/extensions.md b/i18n/hr/docusaurus-plugin-content-docs/current/adguard-for-windows/features/extensions.md index 260fa0e83b3..17884a6df33 100644 --- a/i18n/hr/docusaurus-plugin-content-docs/current/adguard-for-windows/features/extensions.md +++ b/i18n/hr/docusaurus-plugin-content-docs/current/adguard-for-windows/features/extensions.md @@ -9,7 +9,7 @@ This article covers AdGuard for Windows, a multifunctional ad blocker that prote ::: -AdGuard can significantly broaden website functionality working as a [user script manager](/general/extensions). AdGuard Users can add their own scripts, as well as manage existing ones. +AdGuard can significantly extend website functionality by working as a [userscript manager](/general/extensions.md). AdGuard users can add their own scripts as well as manage existing ones. ![Extensions \*mobile\_border](https://cdn.adtidy.org/content/kb/ad_blocker/windows/overview/userscripts.png) diff --git a/i18n/hr/docusaurus-plugin-content-docs/current/general/extensions.md b/i18n/hr/docusaurus-plugin-content-docs/current/general/extensions.md new file mode 100644 index 00000000000..0cf454b4329 --- /dev/null +++ b/i18n/hr/docusaurus-plugin-content-docs/current/general/extensions.md @@ -0,0 +1,301 @@ +--- +title: Extensions +sidebar_position: 6 +--- + +## Userscripts + +Userscripts (we also call them "extensions") are, de facto, miniprograms written in JavaScript. They modify or extend the functionality of one or more websites. Many AdGuard users may be already familiar with such userscripts as AdGuard Assistant, Popup Blocker, and AdGuard Extra. + +:::note Supported apps + +AdGuard can significantly broaden website functionality by acting as a userscript manager. You can add your custom scripts or manage the existing ones in our three products: [AdGuard for Windows](/adguard-for-windows/features/extensions), [AdGuard for Android](/adguard-for-android/features/settings#userscripts), and [AdGuard for Mac](/adguard-for-mac/features/extensions). + +::: + +### Recommended AdGuard scripts + +These userscripts come directly from the AdGuard developers, and we can guarantee that they are effective and safe. For some of the userscripts developed by others that we consider good and reliable, [scroll down to the next section](#top-picks). You can also find some of the [popular websites with scripts](#more-userscripts) below, but remember that whenever you download a userscript from an unknown source, you are exposing yourself to a certain risk, as some scripts may be harmful to your computer. + +#### AdGuard Extra + +An extension that blocks ads in difficult cases when the usual filter-based approach is not enough. AdGuard Extra comes pre-installed in AdGuard standalone apps, except for the one for iOS, so you don't need to do anything to enable it. However, if you want to use it alongside AdGuard Browser Extension or any other ad blocker, you'll need to use an additional extension. Learn more about this userscript and how to install it on [GitHub](https://github.com/AdguardTeam/AdGuardExtra). + +![AdGuard Extra](https://cdn.adtidy.org/content/kb/ad_blocker/general/adguard-extra.png) + +#### AdGuard Popup Blocker + +The name speaks for itself: it blocks popups — one of the most annoying types of ads on websites. Learn more about this userscript, its key features, and installation on [GitHub](https://github.com/AdguardTeam/PopupBlocker). + +![AdGuard Popup Blocker](https://cdn.adtidy.org/content/kb/ad_blocker/general/popup-blocker-installation.png) + +#### AdGuard Assistant (legacy version) + +This custom extension is designed to control filtering directly from the browser page (manual blocking, allowlisting, etc.). + +:::note + +This version of Assistant is legacy and there is no point in using it on new systems, as it has been replaced with the full-fledged [Browser Assistant](https://adguard.com/adguard-assistant/overview.html). However, the legacy Assistant may be useful if there is no Browser Assistant for your browser. If this is your case, you can learn how to install AdGuard Assistant on [GitHub](https://github.com/AdguardTeam/AdguardAssistant). + +::: + +#### Disable AMP + +A script that is only pre-installed in AdGuard for Android. It disables AMP (Accelerated Mobile Pages) on the Google search results page. Learn more about this userscript and how to install it on [GitHub](https://github.com/AdguardTeam/DisableAMP). + +![Disable AMP](https://cdn.adtidy.org/content/kb/ad_blocker/general/disable-amp-installation.png) + +### Top picks outside AdGuard{#top-picks} + +These userscripts are not developed by AdGuard, and therefore we can't give a 100% guarantee that they are safe and/or work at all times. However, in our experience they deserve a recommendation because they've all earned their good reputation. + +#### Don't track me Google + +This script removes Google's tracking feature from the links in Google search results. It speeds up the loading of search results and allows you to right-click or tap to copy the link URL. + +Its source code is [available on GitHub](https://github.com/Rob--W/dont-track-me-google). This userscript can be downloaded from [GreasyFork](https://greasyfork.org/en/scripts/428243-don-t-track-me-google) and installed in any AdGuard CoreLibs-based app. + +#### microShield + +A userscript for people visiting Korean websites and some international websites. The microShield userscript blocks Ad-Shield ads and anti-adblocks. Its original source code is available at [asdefuser](https://github.com/seia-soto/userscripts/tree/master/sources/asdefuser) and [AdShield Defuser](https://github.com/seia-soto/adshield-defuser). This userscript can be installed in AdGuard CoreLibs-based apps, Violentmonkey, Tampermonkey, and [quoid/userscripts](https://github.com/quoid/userscripts). Learn more about microShield and how to install it on [GitHub](https://github.com/List-KR/microShield). + +### Where can you get more userscripts?{#more-userscripts} + +Since userscripts are mainly created by enthusiasts, you should be cautious when installing them. Any script from an unknown source carries a potential risk. Yet, there is a great variety of interesting scripts that, if installed carefully and responsibly, can really make using some websites more convenient. + +Here we will describe some of the most popular userscript catalogs. + +#### Userscript.Zone + +[Userscript.Zone](https://www.userscript.zone) is a website that allows searching for userscripts by entering a matching URL or domain. The website is easy to use and has a high level of credibility as only scripts from moderated pages are displayed. + +#### Greasy Fork + +[Greasy Fork](https://greasyfork.org/) is a userscript catalog of Stylish creators. The scripts in this catalog are moderated, so their credibility is much higher. + +#### OpenUserJS.org + +[OpenUserJS.org](https://openuserjs.org/) is an open-source userscript catalog written in nodeJS. It's not moderated, so keep an eye out for suspicious scripts. + +#### Community + +If you like the idea of customizing your browser with userscripts and have questions, you can ask them on one of these websites: + +- [Stackoverflow](https://stackoverflow.com/questions/tagged/userscripts) +- [FreeNode](https://webchat.freenode.net/#greasemonkey) +- [Reddit](https://www.reddit.com/r/userscripts/) + +### Development + +#### Request license + +If you are developing your own custom script and want to test how it works with AdGuard, you can request a beta license key for the app. + +To get it, please send an email to devteam@adguard.com with the following information: + +**Subject:** Userscript author license request + +**Body:** Please tell us about the userscripts you are working on. + +Here is a [mailto link](mailto:devteam@adguard.com?Subject=Userscript%20author%20license%20request\&Body=Hello%2C%0A%0AMy%20userscript%28s%29%3A%20LINK). + +#### Compatibility + +#### Metadata block + +#### Supported properties + +```text +@name +@namespace +@description +@version +@match +@include +@exclude +@grant +@connect +@require +@resource +@downloadURL +@updateURL +@supportURL +@homepageURL +@homepage +@website +@source +@run-at +@noframes +@icon +@iconURL +@defaulticon +@icon64 +@icon64URL +``` + +#### Unsupported properties + +These properties will be simply ignored by AdGuard. + +```text +@unwrap +``` + +#### Supported GM functions + +AdGuard supports both old GM\_ functions and new GM4 API that use GM object. + +#### Values + +:::note + +All listed old Greasemonkey functions are deprecated but still supported. + +::: + +```text +GM.info / GM_info +GM.setValue / GM_setValue +GM.getValue / GM_getValue +GM.listValues / GM_listValues +GM.deleteValue / GM_deleteValue +GM.getResourceUrl / GM_getResourceURL +GM.setClipboard / GM_setClipboard +GM.xmlHttpRequest / GM_xmlhttpRequest +GM.openInTab / GM_openInTab +GM.notification +unsafeWindow +GM_getResourceText +GM_addStyle +GM_log +``` + +[Here](https://wiki.greasespot.net/GM.info) you can find more information about Greasemonkey API. + +#### Example + +```javascript +// ==UserScript== +// @name Name as shown to the user when locale is english or unknown +// @name:ru Name as shown to the user when locale is russian +// @description Description as shown to the user when locale is english or unknown +// @description:ru Description as shown to the user when locale is russian +// @icon https://myhomepage.com/myuserscript.png +// @version 1.0.0.0 +// @downloadURL https://dl.myhomepage.org/myuserscript.user.js +// @updateURL https://dl.myhomepage.org/myuserscript.meta.js +// @homepageURL https://myhomepage.com/myuserscript +// @include * +// @exclude *://website.com/* +// @resource https://myhomepage.com/myuserscript.css +// @require https://myhomepage.com/mylibrary.js +// @grant property:settings +// @grant GM_getValue +// @grant GM_setValue +// @grant GM_deleteValue +// @grant GM_listValues +// @grant GM_getResourceText +// @grant GM_getResourceURL +// @grant GM_addStyle +// @grant GM_log +// @grant GM_setClipboard +// @grant GM_xmlhttpRequest +// @grant unsafeWindow +// @grant GM_info +// @grant GM_openInTab +// @grant GM_registerMenuCommand +// @run-at document-start +// ==/UserScript== +!function(){( + console.log("I am loaded!"); +)}(); +``` + +## Userstyles + +Userstyles allow users to customize their online experience. Whether you’re looking to change the appearance of a website or automate repetitive tasks, styles offer a world of possibilities. + +AdGuard has the option to upload or create your own userstyles. This is an advanced feature, so you will need some knowledge of HTML and CSS. + +:::info Supported apps + +Currently, two AdGuard apps allow you to create and manage userstyles: AdGuard for Windows (v7.19 or later) and AdGuard for Mac (v2.16 or later). We also plan to implement this new feature in AdGuard v4.8 for Android in the nearest future. + +::: + +This is an experimental feature, so if you encounter any problems while adding or creating a userstyle, please contact our support team at . + +### How to set up a userstyle in AdGuard + +You can download userstyles from various websites. One of the most popular userstyle websites is [https://userstyles.world/](https://userstyles.world/explore), which we will use as an example for the following instructions on how to set up the userstyle in AdGuard. + +1. Follow the link above and choose the userstyle you like + +2. Right-click the _Install_ button and choose _Copy Link Address_ + +3. Open AdGuard settings → _Extensions_ + +4. Press the [+] button and paste the userstyle link + +5. Done! + +If you’re familiar with CSS rules, you can also create the userstyles yourself. + +:::note + +We don’t support userstyles that contain `@var` or `@advanced` in the metadata. AdGuard also doesn’t support `@preprocessor` without the `default` value. + +::: + +1. Open AdGuard settings → _Extensions_ + +2. Press the [+] button and choose the _Create userstyle_ option. A new window will appear on your screen + +3. To create a userstyle, first write the title with metadata, for example + + ```CSS + /* ==UserStyle== + @name New userstyle + @version 1.0 + ==/UserStyle== */ + ``` + +4. Write the CSS part after the meta data. AdGuard supports website domain names matching (`@-moz-document domain(…), …`). For example: + + ```CSS + body { + background: gray; + } + ``` + + Or: + + ```CSS + @-moz-document domain('example.org'), + domain('example.net'), + domain('example.com') body { + background: gray; + } + ``` + +5. Once you’re finished, press _Save and Close_. Your new userstyle has been successfully added to AdGuard + +### Example + +```css +/* ==UserStyle== +@name Example userstyle +@namespace https://example.org/userstyle +@homepageURL https://example.org/userstyle +@version 1.0.0 +@license Other +@description This is an example +@author example +@preprocessor default +==/UserStyle== */ +@-moz-document regexp("https?\:\/\/(www\.)?example\.(org|com).*") { + body { + background-color: #000000 !important; + } +} +``` diff --git a/i18n/hr/docusaurus-plugin-content-docs/current/general/how-to-install.md b/i18n/hr/docusaurus-plugin-content-docs/current/general/how-to-install.md index bae3060668a..106a29529a8 100644 --- a/i18n/hr/docusaurus-plugin-content-docs/current/general/how-to-install.md +++ b/i18n/hr/docusaurus-plugin-content-docs/current/general/how-to-install.md @@ -1,6 +1,6 @@ --- title: How to install AdGuard -sidebar_position: 8 +sidebar_position: 9 --- Depending on which AdGuard app or browser extension you want to install, follow one of these links to find the relevant article: diff --git a/i18n/hu/docusaurus-plugin-content-docs/current/adguard-for-windows/features/extensions.md b/i18n/hu/docusaurus-plugin-content-docs/current/adguard-for-windows/features/extensions.md index 260fa0e83b3..17884a6df33 100644 --- a/i18n/hu/docusaurus-plugin-content-docs/current/adguard-for-windows/features/extensions.md +++ b/i18n/hu/docusaurus-plugin-content-docs/current/adguard-for-windows/features/extensions.md @@ -9,7 +9,7 @@ This article covers AdGuard for Windows, a multifunctional ad blocker that prote ::: -AdGuard can significantly broaden website functionality working as a [user script manager](/general/extensions). AdGuard Users can add their own scripts, as well as manage existing ones. +AdGuard can significantly extend website functionality by working as a [userscript manager](/general/extensions.md). AdGuard users can add their own scripts as well as manage existing ones. ![Extensions \*mobile\_border](https://cdn.adtidy.org/content/kb/ad_blocker/windows/overview/userscripts.png) diff --git a/i18n/hu/docusaurus-plugin-content-docs/current/general/extensions.md b/i18n/hu/docusaurus-plugin-content-docs/current/general/extensions.md new file mode 100644 index 00000000000..0cf454b4329 --- /dev/null +++ b/i18n/hu/docusaurus-plugin-content-docs/current/general/extensions.md @@ -0,0 +1,301 @@ +--- +title: Extensions +sidebar_position: 6 +--- + +## Userscripts + +Userscripts (we also call them "extensions") are, de facto, miniprograms written in JavaScript. They modify or extend the functionality of one or more websites. Many AdGuard users may be already familiar with such userscripts as AdGuard Assistant, Popup Blocker, and AdGuard Extra. + +:::note Supported apps + +AdGuard can significantly broaden website functionality by acting as a userscript manager. You can add your custom scripts or manage the existing ones in our three products: [AdGuard for Windows](/adguard-for-windows/features/extensions), [AdGuard for Android](/adguard-for-android/features/settings#userscripts), and [AdGuard for Mac](/adguard-for-mac/features/extensions). + +::: + +### Recommended AdGuard scripts + +These userscripts come directly from the AdGuard developers, and we can guarantee that they are effective and safe. For some of the userscripts developed by others that we consider good and reliable, [scroll down to the next section](#top-picks). You can also find some of the [popular websites with scripts](#more-userscripts) below, but remember that whenever you download a userscript from an unknown source, you are exposing yourself to a certain risk, as some scripts may be harmful to your computer. + +#### AdGuard Extra + +An extension that blocks ads in difficult cases when the usual filter-based approach is not enough. AdGuard Extra comes pre-installed in AdGuard standalone apps, except for the one for iOS, so you don't need to do anything to enable it. However, if you want to use it alongside AdGuard Browser Extension or any other ad blocker, you'll need to use an additional extension. Learn more about this userscript and how to install it on [GitHub](https://github.com/AdguardTeam/AdGuardExtra). + +![AdGuard Extra](https://cdn.adtidy.org/content/kb/ad_blocker/general/adguard-extra.png) + +#### AdGuard Popup Blocker + +The name speaks for itself: it blocks popups — one of the most annoying types of ads on websites. Learn more about this userscript, its key features, and installation on [GitHub](https://github.com/AdguardTeam/PopupBlocker). + +![AdGuard Popup Blocker](https://cdn.adtidy.org/content/kb/ad_blocker/general/popup-blocker-installation.png) + +#### AdGuard Assistant (legacy version) + +This custom extension is designed to control filtering directly from the browser page (manual blocking, allowlisting, etc.). + +:::note + +This version of Assistant is legacy and there is no point in using it on new systems, as it has been replaced with the full-fledged [Browser Assistant](https://adguard.com/adguard-assistant/overview.html). However, the legacy Assistant may be useful if there is no Browser Assistant for your browser. If this is your case, you can learn how to install AdGuard Assistant on [GitHub](https://github.com/AdguardTeam/AdguardAssistant). + +::: + +#### Disable AMP + +A script that is only pre-installed in AdGuard for Android. It disables AMP (Accelerated Mobile Pages) on the Google search results page. Learn more about this userscript and how to install it on [GitHub](https://github.com/AdguardTeam/DisableAMP). + +![Disable AMP](https://cdn.adtidy.org/content/kb/ad_blocker/general/disable-amp-installation.png) + +### Top picks outside AdGuard{#top-picks} + +These userscripts are not developed by AdGuard, and therefore we can't give a 100% guarantee that they are safe and/or work at all times. However, in our experience they deserve a recommendation because they've all earned their good reputation. + +#### Don't track me Google + +This script removes Google's tracking feature from the links in Google search results. It speeds up the loading of search results and allows you to right-click or tap to copy the link URL. + +Its source code is [available on GitHub](https://github.com/Rob--W/dont-track-me-google). This userscript can be downloaded from [GreasyFork](https://greasyfork.org/en/scripts/428243-don-t-track-me-google) and installed in any AdGuard CoreLibs-based app. + +#### microShield + +A userscript for people visiting Korean websites and some international websites. The microShield userscript blocks Ad-Shield ads and anti-adblocks. Its original source code is available at [asdefuser](https://github.com/seia-soto/userscripts/tree/master/sources/asdefuser) and [AdShield Defuser](https://github.com/seia-soto/adshield-defuser). This userscript can be installed in AdGuard CoreLibs-based apps, Violentmonkey, Tampermonkey, and [quoid/userscripts](https://github.com/quoid/userscripts). Learn more about microShield and how to install it on [GitHub](https://github.com/List-KR/microShield). + +### Where can you get more userscripts?{#more-userscripts} + +Since userscripts are mainly created by enthusiasts, you should be cautious when installing them. Any script from an unknown source carries a potential risk. Yet, there is a great variety of interesting scripts that, if installed carefully and responsibly, can really make using some websites more convenient. + +Here we will describe some of the most popular userscript catalogs. + +#### Userscript.Zone + +[Userscript.Zone](https://www.userscript.zone) is a website that allows searching for userscripts by entering a matching URL or domain. The website is easy to use and has a high level of credibility as only scripts from moderated pages are displayed. + +#### Greasy Fork + +[Greasy Fork](https://greasyfork.org/) is a userscript catalog of Stylish creators. The scripts in this catalog are moderated, so their credibility is much higher. + +#### OpenUserJS.org + +[OpenUserJS.org](https://openuserjs.org/) is an open-source userscript catalog written in nodeJS. It's not moderated, so keep an eye out for suspicious scripts. + +#### Community + +If you like the idea of customizing your browser with userscripts and have questions, you can ask them on one of these websites: + +- [Stackoverflow](https://stackoverflow.com/questions/tagged/userscripts) +- [FreeNode](https://webchat.freenode.net/#greasemonkey) +- [Reddit](https://www.reddit.com/r/userscripts/) + +### Development + +#### Request license + +If you are developing your own custom script and want to test how it works with AdGuard, you can request a beta license key for the app. + +To get it, please send an email to devteam@adguard.com with the following information: + +**Subject:** Userscript author license request + +**Body:** Please tell us about the userscripts you are working on. + +Here is a [mailto link](mailto:devteam@adguard.com?Subject=Userscript%20author%20license%20request\&Body=Hello%2C%0A%0AMy%20userscript%28s%29%3A%20LINK). + +#### Compatibility + +#### Metadata block + +#### Supported properties + +```text +@name +@namespace +@description +@version +@match +@include +@exclude +@grant +@connect +@require +@resource +@downloadURL +@updateURL +@supportURL +@homepageURL +@homepage +@website +@source +@run-at +@noframes +@icon +@iconURL +@defaulticon +@icon64 +@icon64URL +``` + +#### Unsupported properties + +These properties will be simply ignored by AdGuard. + +```text +@unwrap +``` + +#### Supported GM functions + +AdGuard supports both old GM\_ functions and new GM4 API that use GM object. + +#### Values + +:::note + +All listed old Greasemonkey functions are deprecated but still supported. + +::: + +```text +GM.info / GM_info +GM.setValue / GM_setValue +GM.getValue / GM_getValue +GM.listValues / GM_listValues +GM.deleteValue / GM_deleteValue +GM.getResourceUrl / GM_getResourceURL +GM.setClipboard / GM_setClipboard +GM.xmlHttpRequest / GM_xmlhttpRequest +GM.openInTab / GM_openInTab +GM.notification +unsafeWindow +GM_getResourceText +GM_addStyle +GM_log +``` + +[Here](https://wiki.greasespot.net/GM.info) you can find more information about Greasemonkey API. + +#### Example + +```javascript +// ==UserScript== +// @name Name as shown to the user when locale is english or unknown +// @name:ru Name as shown to the user when locale is russian +// @description Description as shown to the user when locale is english or unknown +// @description:ru Description as shown to the user when locale is russian +// @icon https://myhomepage.com/myuserscript.png +// @version 1.0.0.0 +// @downloadURL https://dl.myhomepage.org/myuserscript.user.js +// @updateURL https://dl.myhomepage.org/myuserscript.meta.js +// @homepageURL https://myhomepage.com/myuserscript +// @include * +// @exclude *://website.com/* +// @resource https://myhomepage.com/myuserscript.css +// @require https://myhomepage.com/mylibrary.js +// @grant property:settings +// @grant GM_getValue +// @grant GM_setValue +// @grant GM_deleteValue +// @grant GM_listValues +// @grant GM_getResourceText +// @grant GM_getResourceURL +// @grant GM_addStyle +// @grant GM_log +// @grant GM_setClipboard +// @grant GM_xmlhttpRequest +// @grant unsafeWindow +// @grant GM_info +// @grant GM_openInTab +// @grant GM_registerMenuCommand +// @run-at document-start +// ==/UserScript== +!function(){( + console.log("I am loaded!"); +)}(); +``` + +## Userstyles + +Userstyles allow users to customize their online experience. Whether you’re looking to change the appearance of a website or automate repetitive tasks, styles offer a world of possibilities. + +AdGuard has the option to upload or create your own userstyles. This is an advanced feature, so you will need some knowledge of HTML and CSS. + +:::info Supported apps + +Currently, two AdGuard apps allow you to create and manage userstyles: AdGuard for Windows (v7.19 or later) and AdGuard for Mac (v2.16 or later). We also plan to implement this new feature in AdGuard v4.8 for Android in the nearest future. + +::: + +This is an experimental feature, so if you encounter any problems while adding or creating a userstyle, please contact our support team at . + +### How to set up a userstyle in AdGuard + +You can download userstyles from various websites. One of the most popular userstyle websites is [https://userstyles.world/](https://userstyles.world/explore), which we will use as an example for the following instructions on how to set up the userstyle in AdGuard. + +1. Follow the link above and choose the userstyle you like + +2. Right-click the _Install_ button and choose _Copy Link Address_ + +3. Open AdGuard settings → _Extensions_ + +4. Press the [+] button and paste the userstyle link + +5. Done! + +If you’re familiar with CSS rules, you can also create the userstyles yourself. + +:::note + +We don’t support userstyles that contain `@var` or `@advanced` in the metadata. AdGuard also doesn’t support `@preprocessor` without the `default` value. + +::: + +1. Open AdGuard settings → _Extensions_ + +2. Press the [+] button and choose the _Create userstyle_ option. A new window will appear on your screen + +3. To create a userstyle, first write the title with metadata, for example + + ```CSS + /* ==UserStyle== + @name New userstyle + @version 1.0 + ==/UserStyle== */ + ``` + +4. Write the CSS part after the meta data. AdGuard supports website domain names matching (`@-moz-document domain(…), …`). For example: + + ```CSS + body { + background: gray; + } + ``` + + Or: + + ```CSS + @-moz-document domain('example.org'), + domain('example.net'), + domain('example.com') body { + background: gray; + } + ``` + +5. Once you’re finished, press _Save and Close_. Your new userstyle has been successfully added to AdGuard + +### Example + +```css +/* ==UserStyle== +@name Example userstyle +@namespace https://example.org/userstyle +@homepageURL https://example.org/userstyle +@version 1.0.0 +@license Other +@description This is an example +@author example +@preprocessor default +==/UserStyle== */ +@-moz-document regexp("https?\:\/\/(www\.)?example\.(org|com).*") { + body { + background-color: #000000 !important; + } +} +``` diff --git a/i18n/hu/docusaurus-plugin-content-docs/current/general/how-to-install.md b/i18n/hu/docusaurus-plugin-content-docs/current/general/how-to-install.md index bae3060668a..106a29529a8 100644 --- a/i18n/hu/docusaurus-plugin-content-docs/current/general/how-to-install.md +++ b/i18n/hu/docusaurus-plugin-content-docs/current/general/how-to-install.md @@ -1,6 +1,6 @@ --- title: How to install AdGuard -sidebar_position: 8 +sidebar_position: 9 --- Depending on which AdGuard app or browser extension you want to install, follow one of these links to find the relevant article: diff --git a/i18n/it/docusaurus-plugin-content-docs/current/adguard-for-windows/features/extensions.md b/i18n/it/docusaurus-plugin-content-docs/current/adguard-for-windows/features/extensions.md index 9bf54936cbc..e58013f5828 100644 --- a/i18n/it/docusaurus-plugin-content-docs/current/adguard-for-windows/features/extensions.md +++ b/i18n/it/docusaurus-plugin-content-docs/current/adguard-for-windows/features/extensions.md @@ -9,7 +9,7 @@ Questo articolo riguarda AdGuard per Windows, un blocco annunci multifunzionale ::: -AdGuard può ampliare significativamente la funzionalità del sito web, operando da [gestore degli script dell'utente](/general/extensions). Gli Utenti di AdGuard possono aggiungere i propri script, nonché gestire quelli esistenti. +AdGuard can significantly extend website functionality by working as a [userscript manager](/general/extensions.md). AdGuard users can add their own scripts as well as manage existing ones. ![Estensioni \*mobile\_border](https://cdn.adtidy.org/content/kb/ad_blocker/windows/overview/userscripts.png) diff --git a/i18n/it/docusaurus-plugin-content-docs/current/general/extensions.md b/i18n/it/docusaurus-plugin-content-docs/current/general/extensions.md new file mode 100644 index 00000000000..af5f2e9fc40 --- /dev/null +++ b/i18n/it/docusaurus-plugin-content-docs/current/general/extensions.md @@ -0,0 +1,301 @@ +--- +title: Estensioni +sidebar_position: 6 +--- + +## Script utente + +Gli userscript (li chiamiamo anche "estensioni") sono, di fatto, miniprogrammi scritti in JavaScript. Essi, modificano o estendono la funzionalità di uno o più siti web. Molti utenti di AdGuard potrebbero già essere a conoscenza di certi userscript, come AdGuard Assistant, Popup Blocker e AdGuard Extra. + +:::note Supported apps + +AdGuard può ampliare significativamente la funzionalità del sito web, agendo da gestore di userscript. You can add your custom scripts or manage the existing ones in our three products: [AdGuard for Windows](/adguard-for-windows/features/extensions), [AdGuard for Android](/adguard-for-android/features/settings#userscripts), and [AdGuard for Mac](/adguard-for-mac/features/extensions). + +::: + +### Script di AdGuard consigliati + +Questi script utente provengono direttamente dagli sviluppatori di AdGuard e possiamo garantire che siano efficienti e sicuri. For some of the userscripts developed by others that we consider good and reliable, [scroll down to the next section](#top-picks). You can also find some of the [popular websites with scripts](#more-userscripts) below, but remember that whenever you download a userscript from an unknown source, you are exposing yourself to a certain risk, as some scripts may be harmful to your computer. + +#### AdGuard Extra + +C'è un'estensione che blocca gli annunci in casi difficili, quando il solito approccio basato sui filtri non è sufficiente. AdGuard Extra comes pre-installed in AdGuard standalone apps, except for the one for iOS, so you don't need to do anything to enable it. Tuttavia, se desideri utilizzarla insieme all'Estensione di browser AdGuard o qualsiasi altro bloccatore di annunci, dovrai utilizzare un'ulteriore estensione. Learn more about this userscript and how to install it on [GitHub](https://github.com/AdguardTeam/AdGuardExtra). + +![AdGuard Extra](https://cdn.adtidy.org/content/kb/ad_blocker/general/adguard-extra.png) + +#### AdGuard Popup Blocker + +The name speaks for itself: it blocks popups — one of the most annoying types of ads on websites. Learn more about this userscript, its key features, and installation on [GitHub](https://github.com/AdguardTeam/PopupBlocker). + +![AdGuard Popup Blocker](https://cdn.adtidy.org/content/kb/ad_blocker/general/popup-blocker-installation.png) + +#### AdGuard Assistant (versione ereditaria) + +This custom extension is designed to control filtering directly from the browser page (manual blocking, allowlisting, etc.). + +:::note + +This version of Assistant is legacy and there is no point in using it on new systems, as it has been replaced with the full-fledged [Browser Assistant](https://adguard.com/adguard-assistant/overview.html). However, the legacy Assistant may be useful if there is no Browser Assistant for your browser. If this is your case, you can learn how to install AdGuard Assistant on [GitHub](https://github.com/AdguardTeam/AdguardAssistant). + +::: + +#### Disable AMP + +Uno script preinstallato soltanto su AdGuard per Android. Disabilita AMP (Pagine Mobili Accelerate) sulla pagina dei risultati di ricerca di Google. Learn more about this userscript and how to install it on [GitHub](https://github.com/AdguardTeam/DisableAMP). + +![Disable AMP](https://cdn.adtidy.org/content/kb/ad_blocker/general/disable-amp-installation.png) + +### Le migliori scelte al di fuori di AdGuard{#top-picks} + +These userscripts are not developed by AdGuard, and therefore we can't give a 100% guarantee that they are safe and/or work at all times. However, in our experience they deserve a recommendation because they've all earned their good reputation. + +#### Don't track me Google + +Questo script rimuove la funzionalità di monitoraggio di Google dai collegamenti nei risultati di ricerca di Google. Accelera il caricamento dei risultati di ricerca e consente di fare clic con il pulsante destro del mouse o toccare per copiare l'URL del collegamento. + +Its source code is [available on GitHub](https://github.com/Rob--W/dont-track-me-google). This userscript can be downloaded from [GreasyFork](https://greasyfork.org/en/scripts/428243-don-t-track-me-google) and installed in any AdGuard CoreLibs-based app. + +#### microShield + +A userscript for people visiting Korean websites and some international websites. The microShield userscript blocks Ad-Shield ads and anti-adblocks. Its original source code is available at [asdefuser](https://github.com/seia-soto/userscripts/tree/master/sources/asdefuser) and [AdShield Defuser](https://github.com/seia-soto/adshield-defuser). This userscript can be installed in AdGuard CoreLibs-based apps, Violentmonkey, Tampermonkey, and [quoid/userscripts](https://github.com/quoid/userscripts). Learn more about microShield and how to install it on [GitHub](https://github.com/List-KR/microShield). + +### Dove puoi ottenere altri userscript?{#more-userscripts} + +Since userscripts are mainly created by enthusiasts, you should be cautious when installing them. Qualsiasi script proveniente da una fonte sconosciuta comporta un potenziale rischio. Tuttavia, esiste una grande varietà di script interessanti che, se installati con attenzione e responsabilità, possono davvero rendere più conveniente l'utilizzo di alcuni siti web. + +Qui, descriveremo alcuni dei cataloghi di userscript più popolari. + +#### Userscript.Zone + +[Userscript.Zone](https://www.userscript.zone) is a website that allows searching for userscripts by entering a matching URL or domain. The website is easy to use and has a high level of credibility as only scripts from moderated pages are displayed. + +#### Greasy Fork + +[Greasy Fork](https://greasyfork.org/) is a userscript catalog of Stylish creators. The scripts in this catalog are moderated, so their credibility is much higher. + +#### OpenUserJS.org + +[OpenUserJS.org](https://openuserjs.org/) is an open-source userscript catalog written in nodeJS. It's not moderated, so keep an eye out for suspicious scripts. + +#### Comunità + +If you like the idea of customizing your browser with userscripts and have questions, you can ask them on one of these websites: + +- [Stackoverflow](https://stackoverflow.com/questions/tagged/userscripts) +- [FreeNode](https://webchat.freenode.net/#greasemonkey) +- [Reddit](https://www.reddit.com/r/userscripts/) + +### Sviluppo + +#### Richiedi la licenza + +If you are developing your own custom script and want to test how it works with AdGuard, you can request a beta license key for the app. + +Per ottenerla, sei pregato di inviare un'email a devteam@adguard.com con le seguenti informazioni: + +**Subject:** Userscript author license request + +**Body:** Please tell us about the userscripts you are working on. + +Here is a [mailto link](mailto:devteam@adguard.com?Subject=Userscript%20author%20license%20request\&Body=Hello%2C%0A%0AMy%20userscript%28s%29%3A%20LINK). + +#### Compatibilità + +#### Blocco dei metadati + +#### Proprietà supportate + +```text +@name +@namespace +@description +@version +@match +@include +@exclude +@grant +@connect +@require +@resource +@downloadURL +@updateURL +@supportURL +@homepageURL +@homepage +@website +@source +@run-at +@noframes +@icon +@iconURL +@defaulticon +@icon64 +@icon64URL +``` + +#### Proprietà non supportate + +Queste proprietà saranno semplicemente ignorate da AdGuard. + +```text +@unwrap +``` + +#### Funzioni GM supportate + +AdGuard supporta sia le vecchie funzionalità GM\_ che la nuova API GM4, che utilizza l'oggetto GM. + +#### Valori + +:::note + +Tutte le funzionalità di Greasemonkey elencate sono deprecate, ma ancora supportate. + +::: + +```text +GM.info / GM_info +GM.setValue / GM_setValue +GM.getValue / GM_getValue +GM.listValues / GM_listValues +GM.deleteValue / GM_deleteValue +GM.getResourceUrl / GM_getResourceURL +GM.setClipboard / GM_setClipboard +GM.xmlHttpRequest / GM_xmlhttpRequest +GM.openInTab / GM_openInTab +GM.notification +unsafeWindow +GM_getResourceText +GM_addStyle +GM_log +``` + +[Here](https://wiki.greasespot.net/GM.info) you can find more information about Greasemonkey API. + +#### Esempio + +```javascript +// ==UserScript== +// @name Name as shown to the user when locale is english or unknown +// @name:ru Name as shown to the user when locale is russian +// @description Description as shown to the user when locale is english or unknown +// @description:ru Description as shown to the user when locale is russian +// @icon https://myhomepage.com/myuserscript.png +// @version 1.0.0.0 +// @downloadURL https://dl.myhomepage.org/myuserscript.user.js +// @updateURL https://dl.myhomepage.org/myuserscript.meta.js +// @homepageURL https://myhomepage.com/myuserscript +// @include * +// @exclude *://website.com/* +// @resource https://myhomepage.com/myuserscript.css +// @require https://myhomepage.com/mylibrary.js +// @grant property:settings +// @grant GM_getValue +// @grant GM_setValue +// @grant GM_deleteValue +// @grant GM_listValues +// @grant GM_getResourceText +// @grant GM_getResourceURL +// @grant GM_addStyle +// @grant GM_log +// @grant GM_setClipboard +// @grant GM_xmlhttpRequest +// @grant unsafeWindow +// @grant GM_info +// @grant GM_openInTab +// @grant GM_registerMenuCommand +// @run-at document-start +// ==/UserScript== +!function(){( + console.log("I am loaded!"); +)}(); +``` + +## Stili utente + +Userstyles allow users to customize their online experience. Whether you’re looking to change the appearance of a website or automate repetitive tasks, styles offer a world of possibilities. + +AdGuard has the option to upload or create your own userstyles. This is an advanced feature, so you will need some knowledge of HTML and CSS. + +:::info Supported apps + +Currently, two AdGuard apps allow you to create and manage userstyles: AdGuard for Windows (v7.19 or later) and AdGuard for Mac (v2.16 or later). We also plan to implement this new feature in AdGuard v4.8 for Android in the nearest future. + +::: + +This is an experimental feature, so if you encounter any problems while adding or creating a userstyle, please contact our support team at . + +### How to set up a userstyle in AdGuard + +You can download userstyles from various websites. One of the most popular userstyle websites is [https://userstyles.world/](https://userstyles.world/explore), which we will use as an example for the following instructions on how to set up the userstyle in AdGuard. + +1. Follow the link above and choose the userstyle you like + +2. Right-click the _Install_ button and choose _Copy Link Address_ + +3. Open AdGuard settings → _Extensions_ + +4. Press the [+] button and paste the userstyle link + +5. Fatto! + +If you’re familiar with CSS rules, you can also create the userstyles yourself. + +:::note + +We don’t support userstyles that contain `@var` or `@advanced` in the metadata. AdGuard also doesn’t support `@preprocessor` without the `default` value. + +::: + +1. Open AdGuard settings → _Extensions_ + +2. Press the [+] button and choose the _Create userstyle_ option. A new window will appear on your screen + +3. To create a userstyle, first write the title with metadata, for example + + ```CSS + /* ==UserStyle== + @name New userstyle + @version 1.0 + ==/UserStyle== */ + ``` + +4. Write the CSS part after the meta data. AdGuard supports website domain names matching (`@-moz-document domain(…), …`). For example: + + ```CSS + body { + background: gray; + } + ``` + + Or: + + ```CSS + @-moz-document domain('example.org'), + domain('example.net'), + domain('example.com') body { + background: gray; + } + ``` + +5. Once you’re finished, press _Save and Close_. Your new userstyle has been successfully added to AdGuard + +### Esempio + +```css +/* ==UserStyle== +@name Example userstyle +@namespace https://example.org/userstyle +@homepageURL https://example.org/userstyle +@version 1.0.0 +@license Other +@description This is an example +@author example +@preprocessor default +==/UserStyle== */ +@-moz-document regexp("https?\:\/\/(www\.)?example\.(org|com).*") { + body { + background-color: #000000 !important; + } +} +``` diff --git a/i18n/it/docusaurus-plugin-content-docs/current/general/how-to-install.md b/i18n/it/docusaurus-plugin-content-docs/current/general/how-to-install.md index 06a9d0c8624..297fff52c61 100644 --- a/i18n/it/docusaurus-plugin-content-docs/current/general/how-to-install.md +++ b/i18n/it/docusaurus-plugin-content-docs/current/general/how-to-install.md @@ -1,6 +1,6 @@ --- title: Come installare AdGuard -sidebar_position: 8 +sidebar_position: 9 --- A seconda di quale app o estensione del browser di AdGuard desideri installare, segui uno di questi link per trovare l'articolo rilevante: diff --git a/i18n/ja/docusaurus-plugin-content-docs/current/adguard-for-windows/features/extensions.md b/i18n/ja/docusaurus-plugin-content-docs/current/adguard-for-windows/features/extensions.md index 50a0b1ff7e4..f40516a0eaa 100644 --- a/i18n/ja/docusaurus-plugin-content-docs/current/adguard-for-windows/features/extensions.md +++ b/i18n/ja/docusaurus-plugin-content-docs/current/adguard-for-windows/features/extensions.md @@ -9,7 +9,7 @@ sidebar_position: 3 ::: -AdGuard は[ユーザースクリプトマネージャ](/general/extensions)として、ウェブサイトの機能を大幅に拡張することができます。 AdGuard のユーザーは、独自のスクリプトを追加したり、既存のスクリプトを管理したりできます。 +AdGuard can significantly extend website functionality by working as a [userscript manager](/general/extensions.md). AdGuard users can add their own scripts as well as manage existing ones. ![拡張機能画面 \*mobile\_border](https://cdn.adtidy.org/content/kb/ad_blocker/windows/overview/userscripts.png) diff --git a/i18n/ja/docusaurus-plugin-content-docs/current/general/extensions.md b/i18n/ja/docusaurus-plugin-content-docs/current/general/extensions.md new file mode 100644 index 00000000000..0796b1e1a17 --- /dev/null +++ b/i18n/ja/docusaurus-plugin-content-docs/current/general/extensions.md @@ -0,0 +1,301 @@ +--- +title: 拡張機能 +sidebar_position: 6 +--- + +## ユーザースクリプト + +ユーザースクリプト（私たちは "エクステンション"とも呼んでいます）は、事実上、JavaScriptで書かれたミニプログラムです。 ユーザースクリプトは1つまたは複数のウェブサイトの機能を変更または拡張します。 AdGuardユーザーの多くは、「AdGuard アシスタント」「ポップアップブロッカー」「AdGuard Extra」などのユーザースクリプトをすでにご存知かもしれません。 + +:::note Supported apps + +AdGuard はユーザースクリプトマネージャとして、ウェブサイトの機能を大幅に拡張することができます。 You can add your custom scripts or manage the existing ones in our three products: [AdGuard for Windows](/adguard-for-windows/features/extensions), [AdGuard for Android](/adguard-for-android/features/settings#userscripts), and [AdGuard for Mac](/adguard-for-mac/features/extensions). + +::: + +### お勧めのAdGuardスクリプト + +これらのユーザースクリプトはAdGuardの開発者から直接提供されたもので、効果的で安全です。 For some of the userscripts developed by others that we consider good and reliable, [scroll down to the next section](#top-picks). You can also find some of the [popular websites with scripts](#more-userscripts) below, but remember that whenever you download a userscript from an unknown source, you are exposing yourself to a certain risk, as some scripts may be harmful to your computer. + +#### AdGuard Extra + +通常のフィルタベースアプローチでは不十分な場合に、広告をブロックしてくれる拡張機能。 AdGuard Extra comes pre-installed in AdGuard standalone apps, except for the one for iOS, so you don't need to do anything to enable it. ただし、AdGuard ブラウザ拡張機能やその他の広告ブロッカーと一緒に使用したい場合は、追加の拡張機能を使用する必要があります。 Learn more about this userscript and how to install it on [GitHub](https://github.com/AdguardTeam/AdGuardExtra). + +![AdGuard Extra](https://cdn.adtidy.org/content/kb/ad_blocker/general/adguard-extra.png) + +#### AdGuard ポップアップブロッカー + +The name speaks for itself: it blocks popups — one of the most annoying types of ads on websites. Learn more about this userscript, its key features, and installation on [GitHub](https://github.com/AdguardTeam/PopupBlocker). + +![AdGuard Popup Blocker](https://cdn.adtidy.org/content/kb/ad_blocker/general/popup-blocker-installation.png) + +#### AdGuard アシスタント (レガシー版) + +This custom extension is designed to control filtering directly from the browser page (manual blocking, allowlisting, etc.). + +:::note + +This version of Assistant is legacy and there is no point in using it on new systems, as it has been replaced with the full-fledged [Browser Assistant](https://adguard.com/adguard-assistant/overview.html). However, the legacy Assistant may be useful if there is no Browser Assistant for your browser. If this is your case, you can learn how to install AdGuard Assistant on [GitHub](https://github.com/AdguardTeam/AdguardAssistant). + +::: + +#### AMPを無効化 + +Android版AdGuardにのみプリインストールされているスクリプト。 Google 検索結果ページで AMP (Accelerated Mobile Pages) を無効にします。 Learn more about this userscript and how to install it on [GitHub](https://github.com/AdguardTeam/DisableAMP). + +![Disable AMP](https://cdn.adtidy.org/content/kb/ad_blocker/general/disable-amp-installation.png) + +### AdGuard以外でおすすめのスクリプト + +These userscripts are not developed by AdGuard, and therefore we can't give a 100% guarantee that they are safe and/or work at all times. However, in our experience they deserve a recommendation because they've all earned their good reputation. + +#### Don't track me Google + +このスクリプトは、Googleの検索結果のリンクからGoogleのトラッキング機能を削除します。 検索結果の読み込みを高速化し、右クリックやタップでリンクURLをコピーできるようにします。 + +Its source code is [available on GitHub](https://github.com/Rob--W/dont-track-me-google). This userscript can be downloaded from [GreasyFork](https://greasyfork.org/en/scripts/428243-don-t-track-me-google) and installed in any AdGuard CoreLibs-based app. + +#### microShield + +A userscript for people visiting Korean websites and some international websites. The microShield userscript blocks Ad-Shield ads and anti-adblocks. Its original source code is available at [asdefuser](https://github.com/seia-soto/userscripts/tree/master/sources/asdefuser) and [AdShield Defuser](https://github.com/seia-soto/adshield-defuser). This userscript can be installed in AdGuard CoreLibs-based apps, Violentmonkey, Tampermonkey, and [quoid/userscripts](https://github.com/quoid/userscripts). Learn more about microShield and how to install it on [GitHub](https://github.com/List-KR/microShield). + +### さらに多くのユーザースクリプトはどこで入手できますか？ + +Since userscripts are mainly created by enthusiasts, you should be cautious when installing them. 未知のソースからのスクリプトは、潜在的なリスクを伴います。 しかし、注意深く責任を持ってインストールすれば、ウェブサイトの利用をより便利にしてくれる興味深いスクリプトは実に多種多様です。 + +以下で、最も人気なユーザースクリプト・カタログのいくつかをご紹介します。 + +#### Userscript.Zone + +[Userscript.Zone](https://www.userscript.zone) is a website that allows searching for userscripts by entering a matching URL or domain. The website is easy to use and has a high level of credibility as only scripts from moderated pages are displayed. + +#### Greasy Fork + +[Greasy Fork](https://greasyfork.org/) is a userscript catalog of Stylish creators. The scripts in this catalog are moderated, so their credibility is much higher. + +#### OpenUserJS.org + +[OpenUserJS.org](https://openuserjs.org/) is an open-source userscript catalog written in nodeJS. It's not moderated, so keep an eye out for suspicious scripts. + +#### コミュニティ + +If you like the idea of customizing your browser with userscripts and have questions, you can ask them on one of these websites: + +- [Stackoverflow](https://stackoverflow.com/questions/tagged/userscripts) +- [FreeNode](https://webchat.freenode.net/#greasemonkey) +- [Reddit](https://www.reddit.com/r/userscripts/) + +### 開発者向け + +#### AdGuardライセンスをリクエストする + +If you are developing your own custom script and want to test how it works with AdGuard, you can request a beta license key for the app. + +ご希望の方は、以下の情報を明記の上、devteam@adguard.com にご連絡ください: + +**Subject:** Userscript author license request + +**Body:** Please tell us about the userscripts you are working on. + +Here is a [mailto link](mailto:devteam@adguard.com?Subject=Userscript%20author%20license%20request\&Body=Hello%2C%0A%0AMy%20userscript%28s%29%3A%20LINK). + +#### 互換性 + +#### Metadata block + +#### Supported properties + +```text +@name +@namespace +@description +@version +@match +@include +@exclude +@grant +@connect +@require +@resource +@downloadURL +@updateURL +@supportURL +@homepageURL +@homepage +@website +@source +@run-at +@noframes +@icon +@iconURL +@defaulticon +@icon64 +@icon64URL +``` + +#### Unsupported properties + +これらのプロパティは、AdGuardによって無視されます: + +```text +@unwrap +``` + +#### Supported GM functions + +AdGuard は、古い GM\_ 関数と、GM オブジェクトを使用する新しい GM4 API の両方をサポートしています。 + +#### Values + +:::note + +All listed old Greasemonkey functions are deprecated but still supported. + +::: + +```text +GM.info / GM_info +GM.setValue / GM_setValue +GM.getValue / GM_getValue +GM.listValues / GM_listValues +GM.deleteValue / GM_deleteValue +GM.getResourceUrl / GM_getResourceURL +GM.setClipboard / GM_setClipboard +GM.xmlHttpRequest / GM_xmlhttpRequest +GM.openInTab / GM_openInTab +GM.notification +unsafeWindow +GM_getResourceText +GM_addStyle +GM_log +``` + +[Here](https://wiki.greasespot.net/GM.info) you can find more information about Greasemonkey API. + +#### Example + +```javascript +// ==UserScript== +// @name Name as shown to the user when locale is english or unknown +// @name:ru Name as shown to the user when locale is russian +// @description Description as shown to the user when locale is english or unknown +// @description:ru Description as shown to the user when locale is russian +// @icon https://myhomepage.com/myuserscript.png +// @version 1.0.0.0 +// @downloadURL https://dl.myhomepage.org/myuserscript.user.js +// @updateURL https://dl.myhomepage.org/myuserscript.meta.js +// @homepageURL https://myhomepage.com/myuserscript +// @include * +// @exclude *://website.com/* +// @resource https://myhomepage.com/myuserscript.css +// @require https://myhomepage.com/mylibrary.js +// @grant property:settings +// @grant GM_getValue +// @grant GM_setValue +// @grant GM_deleteValue +// @grant GM_listValues +// @grant GM_getResourceText +// @grant GM_getResourceURL +// @grant GM_addStyle +// @grant GM_log +// @grant GM_setClipboard +// @grant GM_xmlhttpRequest +// @grant unsafeWindow +// @grant GM_info +// @grant GM_openInTab +// @grant GM_registerMenuCommand +// @run-at document-start +// ==/UserScript== +!function(){( + console.log("I am loaded!"); +)}(); +``` + +## ユーザースタイル + +Userstyles allow users to customize their online experience. Whether you’re looking to change the appearance of a website or automate repetitive tasks, styles offer a world of possibilities. + +AdGuard has the option to upload or create your own userstyles. This is an advanced feature, so you will need some knowledge of HTML and CSS. + +:::info Supported apps + +Currently, two AdGuard apps allow you to create and manage userstyles: AdGuard for Windows (v7.19 or later) and AdGuard for Mac (v2.16 or later). We also plan to implement this new feature in AdGuard v4.8 for Android in the nearest future. + +::: + +This is an experimental feature, so if you encounter any problems while adding or creating a userstyle, please contact our support team at . + +### How to set up a userstyle in AdGuard + +You can download userstyles from various websites. One of the most popular userstyle websites is [https://userstyles.world/](https://userstyles.world/explore), which we will use as an example for the following instructions on how to set up the userstyle in AdGuard. + +1. Follow the link above and choose the userstyle you like + +2. Right-click the _Install_ button and choose _Copy Link Address_ + +3. Open AdGuard settings → _Extensions_ + +4. Press the [+] button and paste the userstyle link + +5. 完了です！ + +If you’re familiar with CSS rules, you can also create the userstyles yourself. + +:::note + +We don’t support userstyles that contain `@var` or `@advanced` in the metadata. AdGuard also doesn’t support `@preprocessor` without the `default` value. + +::: + +1. Open AdGuard settings → _Extensions_ + +2. Press the [+] button and choose the _Create userstyle_ option. A new window will appear on your screen + +3. To create a userstyle, first write the title with metadata, for example + + ```CSS + /* ==UserStyle== + @name New userstyle + @version 1.0 + ==/UserStyle== */ + ``` + +4. Write the CSS part after the meta data. AdGuard supports website domain names matching (`@-moz-document domain(…), …`). For example: + + ```CSS + body { + background: gray; + } + ``` + + Or: + + ```CSS + @-moz-document domain('example.org'), + domain('example.net'), + domain('example.com') body { + background: gray; + } + ``` + +5. Once you’re finished, press _Save and Close_. Your new userstyle has been successfully added to AdGuard + +### Example + +```css +/* ==UserStyle== +@name Example userstyle +@namespace https://example.org/userstyle +@homepageURL https://example.org/userstyle +@version 1.0.0 +@license Other +@description This is an example +@author example +@preprocessor default +==/UserStyle== */ +@-moz-document regexp("https?\:\/\/(www\.)?example\.(org|com).*") { + body { + background-color: #000000 !important; + } +} +``` diff --git a/i18n/ja/docusaurus-plugin-content-docs/current/general/how-to-install.md b/i18n/ja/docusaurus-plugin-content-docs/current/general/how-to-install.md index 4010c6b3c25..32a20cc559a 100644 --- a/i18n/ja/docusaurus-plugin-content-docs/current/general/how-to-install.md +++ b/i18n/ja/docusaurus-plugin-content-docs/current/general/how-to-install.md @@ -1,6 +1,6 @@ --- title: AdGuard のインストール方法 -sidebar_position: 8 +sidebar_position: 9 --- インストールしたいAdGuardアプリ・ブラウザ拡張機能に応じて、以下のリンクから関連記事をご覧ください。 diff --git a/i18n/ko/docusaurus-plugin-content-docs/current/adguard-for-windows/features/extensions.md b/i18n/ko/docusaurus-plugin-content-docs/current/adguard-for-windows/features/extensions.md index 32776dd1894..26b9311f874 100644 --- a/i18n/ko/docusaurus-plugin-content-docs/current/adguard-for-windows/features/extensions.md +++ b/i18n/ko/docusaurus-plugin-content-docs/current/adguard-for-windows/features/extensions.md @@ -9,7 +9,7 @@ sidebar_position: 3 ::: -AdGuard는 [유저스크립트 관리자](/general/extensions) 역할을 수행하여 웹사이트 기능을 크게 확장할 수 있습니다. AdGuard 사용자는 자체 스크립트를 추가할 수 있을 뿐만 아니라 기존 스크립트를 관리할 수도 있습니다. +AdGuard can significantly extend website functionality by working as a [userscript manager](/general/extensions.md). AdGuard users can add their own scripts as well as manage existing ones. ![확장 프로그램 \*mobile\_border](https://cdn.adtidy.org/content/kb/ad_blocker/windows/overview/userscripts.png) diff --git a/i18n/ko/docusaurus-plugin-content-docs/current/general/extensions.md b/i18n/ko/docusaurus-plugin-content-docs/current/general/extensions.md new file mode 100644 index 00000000000..b1d4fb148c9 --- /dev/null +++ b/i18n/ko/docusaurus-plugin-content-docs/current/general/extensions.md @@ -0,0 +1,301 @@ +--- +title: 확장 프로그램 +sidebar_position: 6 +--- + +## 유저스크립트 + +유저스크립트('확장 프로그램'이라고도 함)는 사실상 자바스크립트로 작성된 미니 프로그램입니다. 하나 이상의 웹사이트의 기능을 수정하거나 확장합니다. 많은 AdGuard 사용자는 이미 AdGuard 어시스턴트, 팝업 차단기 및 AdGuard Extra와 같은 유저스크립트에 익숙할 것입니다. + +:::note Supported apps + +AdGuard는 유저스크립트 관리자 역할을 수행하여 웹사이트 기능을 크게 확장할 수 있습니다. You can add your custom scripts or manage the existing ones in our three products: [AdGuard for Windows](/adguard-for-windows/features/extensions), [AdGuard for Android](/adguard-for-android/features/settings#userscripts), and [AdGuard for Mac](/adguard-for-mac/features/extensions). + +::: + +### 권장 AdGuard 스크립트 + +이러한 유저스크립트는 AdGuard에서 개발되었습니다. 효과적이고 안전하게 작동한다는 것을 보장할 수 있습니다. For some of the userscripts developed by others that we consider good and reliable, [scroll down to the next section](#top-picks). You can also find some of the [popular websites with scripts](#more-userscripts) below, but remember that whenever you download a userscript from an unknown source, you are exposing yourself to a certain risk, as some scripts may be harmful to your computer. + +#### AdGuard Extra + +일반적인 필터 기반 접근 방식으로는 충분하지 않은 어려운 경우에 광고를 차단하는 확장 프로그램입니다. AdGuard Extra comes pre-installed in AdGuard standalone apps, except for the one for iOS, so you don't need to do anything to enable it. 하지만 AdGuard 브라우저 확장 프로그램이나 다른 광고 차단기와 함께 사용하려면 추가 확장 프로그램을 사용해야 합니다. Learn more about this userscript and how to install it on [GitHub](https://github.com/AdguardTeam/AdGuardExtra). + +![AdGuard Extra](https://cdn.adtidy.org/content/kb/ad_blocker/general/adguard-extra.png) + +#### AdGuard 팝업 차단기 + +The name speaks for itself: it blocks popups — one of the most annoying types of ads on websites. Learn more about this userscript, its key features, and installation on [GitHub](https://github.com/AdguardTeam/PopupBlocker). + +![AdGuard Popup Blocker](https://cdn.adtidy.org/content/kb/ad_blocker/general/popup-blocker-installation.png) + +#### AdGuard 어시스턴트(이전 버전) + +This custom extension is designed to control filtering directly from the browser page (manual blocking, allowlisting, etc.). + +:::note + +This version of Assistant is legacy and there is no point in using it on new systems, as it has been replaced with the full-fledged [Browser Assistant](https://adguard.com/adguard-assistant/overview.html). However, the legacy Assistant may be useful if there is no Browser Assistant for your browser. If this is your case, you can learn how to install AdGuard Assistant on [GitHub](https://github.com/AdguardTeam/AdguardAssistant). + +::: + +#### AMP 비활성화 + +Android용 AdGuard에만 사전 설치된 스크립트입니다. Google 검색 결과 페이지에서 AMP(가속화된 모바일 페이지)를 비활성화합니다. Learn more about this userscript and how to install it on [GitHub](https://github.com/AdguardTeam/DisableAMP). + +![Disable AMP](https://cdn.adtidy.org/content/kb/ad_blocker/general/disable-amp-installation.png) + +### AdGuard 외부에서 추천하는 제품{#top-picks} + +These userscripts are not developed by AdGuard, and therefore we can't give a 100% guarantee that they are safe and/or work at all times. However, in our experience they deserve a recommendation because they've all earned their good reputation. + +#### Don't track me Google + +이 스크립트는 Google 검색 결과의 링크에서 Google의 추적 기능을 제거합니다. 검색 결과 로딩 속도가 빨라지고 마우스 오른쪽 버튼을 클릭하거나 탭하여 링크 URL을 복사할 수 있습니다. + +Its source code is [available on GitHub](https://github.com/Rob--W/dont-track-me-google). This userscript can be downloaded from [GreasyFork](https://greasyfork.org/en/scripts/428243-don-t-track-me-google) and installed in any AdGuard CoreLibs-based app. + +#### microShield + +A userscript for people visiting Korean websites and some international websites. The microShield userscript blocks Ad-Shield ads and anti-adblocks. Its original source code is available at [asdefuser](https://github.com/seia-soto/userscripts/tree/master/sources/asdefuser) and [AdShield Defuser](https://github.com/seia-soto/adshield-defuser). This userscript can be installed in AdGuard CoreLibs-based apps, Violentmonkey, Tampermonkey, and [quoid/userscripts](https://github.com/quoid/userscripts). Learn more about microShield and how to install it on [GitHub](https://github.com/List-KR/microShield). + +### 더 많은 유저스크립트는 어디서 구할 수 있나요?{#more-userscripts} + +Since userscripts are mainly created by enthusiasts, you should be cautious when installing them. 출처를 알 수 없는 스크립트는 잠재적인 위험을 수반합니다. 하지만 신중하게 설치하면 일부 웹사이트를 더 편리하게 사용할 수 있는 흥미로운 스크립트가 많이 있습니다. + +아래에서 가장 인기 있는 일부 유저스크립트 카탈로그에 대해 설명합니다. + +#### Userscript.Zone + +[Userscript.Zone](https://www.userscript.zone) is a website that allows searching for userscripts by entering a matching URL or domain. The website is easy to use and has a high level of credibility as only scripts from moderated pages are displayed. + +#### Greasy Fork + +[Greasy Fork](https://greasyfork.org/) is a userscript catalog of Stylish creators. The scripts in this catalog are moderated, so their credibility is much higher. + +#### OpenUserJS.org + +[OpenUserJS.org](https://openuserjs.org/) is an open-source userscript catalog written in nodeJS. It's not moderated, so keep an eye out for suspicious scripts. + +#### 커뮤니티 + +If you like the idea of customizing your browser with userscripts and have questions, you can ask them on one of these websites: + +- [Stackoverflow](https://stackoverflow.com/questions/tagged/userscripts) +- [FreeNode](https://webchat.freenode.net/#greasemonkey) +- [Reddit](https://www.reddit.com/r/userscripts/) + +### 개발 + +#### 라이선스 요청 + +If you are developing your own custom script and want to test how it works with AdGuard, you can request a beta license key for the app. + +라이선스 키를 받으려면 다음 정보를 포함하여 devteam@adguard.com으로 이메일을 보내주십시오. + +**Subject:** Userscript author license request + +**Body:** Please tell us about the userscripts you are working on. + +Here is a [mailto link](mailto:devteam@adguard.com?Subject=Userscript%20author%20license%20request\&Body=Hello%2C%0A%0AMy%20userscript%28s%29%3A%20LINK). + +#### 호환성 + +#### 메타데이터 블록 + +#### 지원되는 속성 + +```text +@name +@namespace +@description +@version +@match +@include +@exclude +@grant +@connect +@require +@resource +@downloadURL +@updateURL +@supportURL +@homepageURL +@homepage +@website +@source +@run-at +@noframes +@icon +@iconURL +@defaulticon +@icon64 +@icon64URL +``` + +#### 지원되지 않는 속성 + +이러한 속성은 AdGuard에서 무시됩니다. + +```text +@unwrap +``` + +#### 지원되는 GM 기능 + +AdGuard는 기존 GM\_ 기능과 GM 개체를 사용하는 새로운 GM4 API를 모두 지원합니다. + +#### 값 + +:::note + +나열된 모든 이전 Greasemonkey 기능은 더 이상 사용되지 않지만 여전히 지원됩니다. + +::: + +```text +GM.info / GM_info +GM.setValue / GM_setValue +GM.getValue / GM_getValue +GM.listValues / GM_listValues +GM.deleteValue / GM_deleteValue +GM.getResourceUrl / GM_getResourceURL +GM.setClipboard / GM_setClipboard +GM.xmlHttpRequest / GM_xmlhttpRequest +GM.openInTab / GM_openInTab +GM.notification +unsafeWindow +GM_getResourceText +GM_addStyle +GM_log +``` + +[Here](https://wiki.greasespot.net/GM.info) you can find more information about Greasemonkey API. + +#### Example + +```javascript +// ==UserScript== +// @name 로캘이 영어이거나 알 수 없는 경우 사용자에게 표시되는 이름 +// @name:ru 로캘이 러시아어일 때 사용자에게 표시되는 이름 +// @description 로캘이 영어이거나 알 수 없는 경우 사용자에게 표시되는 설명 +// @description:ru 로캘이 러시아어일 때 사용자에게 표시되는 설명 +// @icon https://myhomepage.com/myuserscript.png +// @version 1.0.0.0 +// @downloadURL https://dl.myhomepage.org/myuserscript.user.js +// @updateURL https://dl.myhomepage.org/myuserscript.meta.js +// @homepageURL https://myhomepage.com/myuserscript +// @include * +// @exclude *://website.com/* +// @resource https://myhomepage.com/myuserscript.css +// @require https://myhomepage.com/mylibrary.js +// @grant 속성:설정 +// @grant GM_getValue +// @grant GM_setValue +// @grant GM_deleteValue +// @grant GM_listValues +// @grant GM_getResourceText +// @grant GM_getResourceURL +// @grant GM_addStyle +// @grant GM_log +// @grant GM_setClipboard +// @grant GM_xmlhttpRequest +// @grant unsafeWindow +// @grant GM_info +// @grant GM_openInTab +// @grant GM_registerMenuCommand +// @run-at document-start +// ==/UserScript== +!function(){( + console.log("I am loaded!"); +)}(); +``` + +## 유저스타일 + +Userstyles allow users to customize their online experience. Whether you’re looking to change the appearance of a website or automate repetitive tasks, styles offer a world of possibilities. + +AdGuard has the option to upload or create your own userstyles. This is an advanced feature, so you will need some knowledge of HTML and CSS. + +:::info Supported apps + +Currently, two AdGuard apps allow you to create and manage userstyles: AdGuard for Windows (v7.19 or later) and AdGuard for Mac (v2.16 or later). We also plan to implement this new feature in AdGuard v4.8 for Android in the nearest future. + +::: + +This is an experimental feature, so if you encounter any problems while adding or creating a userstyle, please contact our support team at . + +### How to set up a userstyle in AdGuard + +You can download userstyles from various websites. One of the most popular userstyle websites is [https://userstyles.world/](https://userstyles.world/explore), which we will use as an example for the following instructions on how to set up the userstyle in AdGuard. + +1. Follow the link above and choose the userstyle you like + +2. Right-click the _Install_ button and choose _Copy Link Address_ + +3. Open AdGuard settings → _Extensions_ + +4. Press the [+] button and paste the userstyle link + +5. 끝! + +If you’re familiar with CSS rules, you can also create the userstyles yourself. + +:::note + +We don’t support userstyles that contain `@var` or `@advanced` in the metadata. AdGuard also doesn’t support `@preprocessor` without the `default` value. + +::: + +1. Open AdGuard settings → _Extensions_ + +2. Press the [+] button and choose the _Create userstyle_ option. A new window will appear on your screen + +3. To create a userstyle, first write the title with metadata, for example + + ```CSS + /* ==UserStyle== + @name New userstyle + @version 1.0 + ==/UserStyle== */ + ``` + +4. Write the CSS part after the meta data. AdGuard supports website domain names matching (`@-moz-document domain(…), …`). For example: + + ```CSS + body { + background: gray; + } + ``` + + Or: + + ```CSS + @-moz-document domain('example.org'), + domain('example.net'), + domain('example.com') body { + background: gray; + } + ``` + +5. Once you’re finished, press _Save and Close_. Your new userstyle has been successfully added to AdGuard + +### Example + +```css +/* ==UserStyle== +@name Example userstyle +@namespace https://example.org/userstyle +@homepageURL https://example.org/userstyle +@version 1.0.0 +@license Other +@description This is an example +@author example +@preprocessor default +==/UserStyle== */ +@-moz-document regexp("https?\:\/\/(www\.)?example\.(org|com).*") { + body { + background-color: #000000 !important; + } +} +``` diff --git a/i18n/ko/docusaurus-plugin-content-docs/current/general/how-to-install.md b/i18n/ko/docusaurus-plugin-content-docs/current/general/how-to-install.md index b842f3b982c..b4472bdfa94 100644 --- a/i18n/ko/docusaurus-plugin-content-docs/current/general/how-to-install.md +++ b/i18n/ko/docusaurus-plugin-content-docs/current/general/how-to-install.md @@ -1,6 +1,6 @@ --- title: AdGuard를 설치하는 방법 -sidebar_position: 8 +sidebar_position: 9 --- 설치하려는 AdGuard 앱 또는 확장 프로그램에 따라 다음 링크 중 하나를 클릭하여 관련 지침을 따르세요. diff --git a/i18n/nl/docusaurus-plugin-content-docs/current/adguard-for-windows/features/extensions.md b/i18n/nl/docusaurus-plugin-content-docs/current/adguard-for-windows/features/extensions.md index 260fa0e83b3..17884a6df33 100644 --- a/i18n/nl/docusaurus-plugin-content-docs/current/adguard-for-windows/features/extensions.md +++ b/i18n/nl/docusaurus-plugin-content-docs/current/adguard-for-windows/features/extensions.md @@ -9,7 +9,7 @@ This article covers AdGuard for Windows, a multifunctional ad blocker that prote ::: -AdGuard can significantly broaden website functionality working as a [user script manager](/general/extensions). AdGuard Users can add their own scripts, as well as manage existing ones. +AdGuard can significantly extend website functionality by working as a [userscript manager](/general/extensions.md). AdGuard users can add their own scripts as well as manage existing ones. ![Extensions \*mobile\_border](https://cdn.adtidy.org/content/kb/ad_blocker/windows/overview/userscripts.png) diff --git a/i18n/nl/docusaurus-plugin-content-docs/current/general/extensions.md b/i18n/nl/docusaurus-plugin-content-docs/current/general/extensions.md new file mode 100644 index 00000000000..0cf454b4329 --- /dev/null +++ b/i18n/nl/docusaurus-plugin-content-docs/current/general/extensions.md @@ -0,0 +1,301 @@ +--- +title: Extensions +sidebar_position: 6 +--- + +## Userscripts + +Userscripts (we also call them "extensions") are, de facto, miniprograms written in JavaScript. They modify or extend the functionality of one or more websites. Many AdGuard users may be already familiar with such userscripts as AdGuard Assistant, Popup Blocker, and AdGuard Extra. + +:::note Supported apps + +AdGuard can significantly broaden website functionality by acting as a userscript manager. You can add your custom scripts or manage the existing ones in our three products: [AdGuard for Windows](/adguard-for-windows/features/extensions), [AdGuard for Android](/adguard-for-android/features/settings#userscripts), and [AdGuard for Mac](/adguard-for-mac/features/extensions). + +::: + +### Recommended AdGuard scripts + +These userscripts come directly from the AdGuard developers, and we can guarantee that they are effective and safe. For some of the userscripts developed by others that we consider good and reliable, [scroll down to the next section](#top-picks). You can also find some of the [popular websites with scripts](#more-userscripts) below, but remember that whenever you download a userscript from an unknown source, you are exposing yourself to a certain risk, as some scripts may be harmful to your computer. + +#### AdGuard Extra + +An extension that blocks ads in difficult cases when the usual filter-based approach is not enough. AdGuard Extra comes pre-installed in AdGuard standalone apps, except for the one for iOS, so you don't need to do anything to enable it. However, if you want to use it alongside AdGuard Browser Extension or any other ad blocker, you'll need to use an additional extension. Learn more about this userscript and how to install it on [GitHub](https://github.com/AdguardTeam/AdGuardExtra). + +![AdGuard Extra](https://cdn.adtidy.org/content/kb/ad_blocker/general/adguard-extra.png) + +#### AdGuard Popup Blocker + +The name speaks for itself: it blocks popups — one of the most annoying types of ads on websites. Learn more about this userscript, its key features, and installation on [GitHub](https://github.com/AdguardTeam/PopupBlocker). + +![AdGuard Popup Blocker](https://cdn.adtidy.org/content/kb/ad_blocker/general/popup-blocker-installation.png) + +#### AdGuard Assistant (legacy version) + +This custom extension is designed to control filtering directly from the browser page (manual blocking, allowlisting, etc.). + +:::note + +This version of Assistant is legacy and there is no point in using it on new systems, as it has been replaced with the full-fledged [Browser Assistant](https://adguard.com/adguard-assistant/overview.html). However, the legacy Assistant may be useful if there is no Browser Assistant for your browser. If this is your case, you can learn how to install AdGuard Assistant on [GitHub](https://github.com/AdguardTeam/AdguardAssistant). + +::: + +#### Disable AMP + +A script that is only pre-installed in AdGuard for Android. It disables AMP (Accelerated Mobile Pages) on the Google search results page. Learn more about this userscript and how to install it on [GitHub](https://github.com/AdguardTeam/DisableAMP). + +![Disable AMP](https://cdn.adtidy.org/content/kb/ad_blocker/general/disable-amp-installation.png) + +### Top picks outside AdGuard{#top-picks} + +These userscripts are not developed by AdGuard, and therefore we can't give a 100% guarantee that they are safe and/or work at all times. However, in our experience they deserve a recommendation because they've all earned their good reputation. + +#### Don't track me Google + +This script removes Google's tracking feature from the links in Google search results. It speeds up the loading of search results and allows you to right-click or tap to copy the link URL. + +Its source code is [available on GitHub](https://github.com/Rob--W/dont-track-me-google). This userscript can be downloaded from [GreasyFork](https://greasyfork.org/en/scripts/428243-don-t-track-me-google) and installed in any AdGuard CoreLibs-based app. + +#### microShield + +A userscript for people visiting Korean websites and some international websites. The microShield userscript blocks Ad-Shield ads and anti-adblocks. Its original source code is available at [asdefuser](https://github.com/seia-soto/userscripts/tree/master/sources/asdefuser) and [AdShield Defuser](https://github.com/seia-soto/adshield-defuser). This userscript can be installed in AdGuard CoreLibs-based apps, Violentmonkey, Tampermonkey, and [quoid/userscripts](https://github.com/quoid/userscripts). Learn more about microShield and how to install it on [GitHub](https://github.com/List-KR/microShield). + +### Where can you get more userscripts?{#more-userscripts} + +Since userscripts are mainly created by enthusiasts, you should be cautious when installing them. Any script from an unknown source carries a potential risk. Yet, there is a great variety of interesting scripts that, if installed carefully and responsibly, can really make using some websites more convenient. + +Here we will describe some of the most popular userscript catalogs. + +#### Userscript.Zone + +[Userscript.Zone](https://www.userscript.zone) is a website that allows searching for userscripts by entering a matching URL or domain. The website is easy to use and has a high level of credibility as only scripts from moderated pages are displayed. + +#### Greasy Fork + +[Greasy Fork](https://greasyfork.org/) is a userscript catalog of Stylish creators. The scripts in this catalog are moderated, so their credibility is much higher. + +#### OpenUserJS.org + +[OpenUserJS.org](https://openuserjs.org/) is an open-source userscript catalog written in nodeJS. It's not moderated, so keep an eye out for suspicious scripts. + +#### Community + +If you like the idea of customizing your browser with userscripts and have questions, you can ask them on one of these websites: + +- [Stackoverflow](https://stackoverflow.com/questions/tagged/userscripts) +- [FreeNode](https://webchat.freenode.net/#greasemonkey) +- [Reddit](https://www.reddit.com/r/userscripts/) + +### Development + +#### Request license + +If you are developing your own custom script and want to test how it works with AdGuard, you can request a beta license key for the app. + +To get it, please send an email to devteam@adguard.com with the following information: + +**Subject:** Userscript author license request + +**Body:** Please tell us about the userscripts you are working on. + +Here is a [mailto link](mailto:devteam@adguard.com?Subject=Userscript%20author%20license%20request\&Body=Hello%2C%0A%0AMy%20userscript%28s%29%3A%20LINK). + +#### Compatibility + +#### Metadata block + +#### Supported properties + +```text +@name +@namespace +@description +@version +@match +@include +@exclude +@grant +@connect +@require +@resource +@downloadURL +@updateURL +@supportURL +@homepageURL +@homepage +@website +@source +@run-at +@noframes +@icon +@iconURL +@defaulticon +@icon64 +@icon64URL +``` + +#### Unsupported properties + +These properties will be simply ignored by AdGuard. + +```text +@unwrap +``` + +#### Supported GM functions + +AdGuard supports both old GM\_ functions and new GM4 API that use GM object. + +#### Values + +:::note + +All listed old Greasemonkey functions are deprecated but still supported. + +::: + +```text +GM.info / GM_info +GM.setValue / GM_setValue +GM.getValue / GM_getValue +GM.listValues / GM_listValues +GM.deleteValue / GM_deleteValue +GM.getResourceUrl / GM_getResourceURL +GM.setClipboard / GM_setClipboard +GM.xmlHttpRequest / GM_xmlhttpRequest +GM.openInTab / GM_openInTab +GM.notification +unsafeWindow +GM_getResourceText +GM_addStyle +GM_log +``` + +[Here](https://wiki.greasespot.net/GM.info) you can find more information about Greasemonkey API. + +#### Example + +```javascript +// ==UserScript== +// @name Name as shown to the user when locale is english or unknown +// @name:ru Name as shown to the user when locale is russian +// @description Description as shown to the user when locale is english or unknown +// @description:ru Description as shown to the user when locale is russian +// @icon https://myhomepage.com/myuserscript.png +// @version 1.0.0.0 +// @downloadURL https://dl.myhomepage.org/myuserscript.user.js +// @updateURL https://dl.myhomepage.org/myuserscript.meta.js +// @homepageURL https://myhomepage.com/myuserscript +// @include * +// @exclude *://website.com/* +// @resource https://myhomepage.com/myuserscript.css +// @require https://myhomepage.com/mylibrary.js +// @grant property:settings +// @grant GM_getValue +// @grant GM_setValue +// @grant GM_deleteValue +// @grant GM_listValues +// @grant GM_getResourceText +// @grant GM_getResourceURL +// @grant GM_addStyle +// @grant GM_log +// @grant GM_setClipboard +// @grant GM_xmlhttpRequest +// @grant unsafeWindow +// @grant GM_info +// @grant GM_openInTab +// @grant GM_registerMenuCommand +// @run-at document-start +// ==/UserScript== +!function(){( + console.log("I am loaded!"); +)}(); +``` + +## Userstyles + +Userstyles allow users to customize their online experience. Whether you’re looking to change the appearance of a website or automate repetitive tasks, styles offer a world of possibilities. + +AdGuard has the option to upload or create your own userstyles. This is an advanced feature, so you will need some knowledge of HTML and CSS. + +:::info Supported apps + +Currently, two AdGuard apps allow you to create and manage userstyles: AdGuard for Windows (v7.19 or later) and AdGuard for Mac (v2.16 or later). We also plan to implement this new feature in AdGuard v4.8 for Android in the nearest future. + +::: + +This is an experimental feature, so if you encounter any problems while adding or creating a userstyle, please contact our support team at . + +### How to set up a userstyle in AdGuard + +You can download userstyles from various websites. One of the most popular userstyle websites is [https://userstyles.world/](https://userstyles.world/explore), which we will use as an example for the following instructions on how to set up the userstyle in AdGuard. + +1. Follow the link above and choose the userstyle you like + +2. Right-click the _Install_ button and choose _Copy Link Address_ + +3. Open AdGuard settings → _Extensions_ + +4. Press the [+] button and paste the userstyle link + +5. Done! + +If you’re familiar with CSS rules, you can also create the userstyles yourself. + +:::note + +We don’t support userstyles that contain `@var` or `@advanced` in the metadata. AdGuard also doesn’t support `@preprocessor` without the `default` value. + +::: + +1. Open AdGuard settings → _Extensions_ + +2. Press the [+] button and choose the _Create userstyle_ option. A new window will appear on your screen + +3. To create a userstyle, first write the title with metadata, for example + + ```CSS + /* ==UserStyle== + @name New userstyle + @version 1.0 + ==/UserStyle== */ + ``` + +4. Write the CSS part after the meta data. AdGuard supports website domain names matching (`@-moz-document domain(…), …`). For example: + + ```CSS + body { + background: gray; + } + ``` + + Or: + + ```CSS + @-moz-document domain('example.org'), + domain('example.net'), + domain('example.com') body { + background: gray; + } + ``` + +5. Once you’re finished, press _Save and Close_. Your new userstyle has been successfully added to AdGuard + +### Example + +```css +/* ==UserStyle== +@name Example userstyle +@namespace https://example.org/userstyle +@homepageURL https://example.org/userstyle +@version 1.0.0 +@license Other +@description This is an example +@author example +@preprocessor default +==/UserStyle== */ +@-moz-document regexp("https?\:\/\/(www\.)?example\.(org|com).*") { + body { + background-color: #000000 !important; + } +} +``` diff --git a/i18n/nl/docusaurus-plugin-content-docs/current/general/how-to-install.md b/i18n/nl/docusaurus-plugin-content-docs/current/general/how-to-install.md index bae3060668a..106a29529a8 100644 --- a/i18n/nl/docusaurus-plugin-content-docs/current/general/how-to-install.md +++ b/i18n/nl/docusaurus-plugin-content-docs/current/general/how-to-install.md @@ -1,6 +1,6 @@ --- title: How to install AdGuard -sidebar_position: 8 +sidebar_position: 9 --- Depending on which AdGuard app or browser extension you want to install, follow one of these links to find the relevant article: diff --git a/i18n/no/docusaurus-plugin-content-docs/current/adguard-for-windows/features/extensions.md b/i18n/no/docusaurus-plugin-content-docs/current/adguard-for-windows/features/extensions.md index 260fa0e83b3..17884a6df33 100644 --- a/i18n/no/docusaurus-plugin-content-docs/current/adguard-for-windows/features/extensions.md +++ b/i18n/no/docusaurus-plugin-content-docs/current/adguard-for-windows/features/extensions.md @@ -9,7 +9,7 @@ This article covers AdGuard for Windows, a multifunctional ad blocker that prote ::: -AdGuard can significantly broaden website functionality working as a [user script manager](/general/extensions). AdGuard Users can add their own scripts, as well as manage existing ones. +AdGuard can significantly extend website functionality by working as a [userscript manager](/general/extensions.md). AdGuard users can add their own scripts as well as manage existing ones. ![Extensions \*mobile\_border](https://cdn.adtidy.org/content/kb/ad_blocker/windows/overview/userscripts.png) diff --git a/i18n/no/docusaurus-plugin-content-docs/current/general/extensions.md b/i18n/no/docusaurus-plugin-content-docs/current/general/extensions.md new file mode 100644 index 00000000000..0cf454b4329 --- /dev/null +++ b/i18n/no/docusaurus-plugin-content-docs/current/general/extensions.md @@ -0,0 +1,301 @@ +--- +title: Extensions +sidebar_position: 6 +--- + +## Userscripts + +Userscripts (we also call them "extensions") are, de facto, miniprograms written in JavaScript. They modify or extend the functionality of one or more websites. Many AdGuard users may be already familiar with such userscripts as AdGuard Assistant, Popup Blocker, and AdGuard Extra. + +:::note Supported apps + +AdGuard can significantly broaden website functionality by acting as a userscript manager. You can add your custom scripts or manage the existing ones in our three products: [AdGuard for Windows](/adguard-for-windows/features/extensions), [AdGuard for Android](/adguard-for-android/features/settings#userscripts), and [AdGuard for Mac](/adguard-for-mac/features/extensions). + +::: + +### Recommended AdGuard scripts + +These userscripts come directly from the AdGuard developers, and we can guarantee that they are effective and safe. For some of the userscripts developed by others that we consider good and reliable, [scroll down to the next section](#top-picks). You can also find some of the [popular websites with scripts](#more-userscripts) below, but remember that whenever you download a userscript from an unknown source, you are exposing yourself to a certain risk, as some scripts may be harmful to your computer. + +#### AdGuard Extra + +An extension that blocks ads in difficult cases when the usual filter-based approach is not enough. AdGuard Extra comes pre-installed in AdGuard standalone apps, except for the one for iOS, so you don't need to do anything to enable it. However, if you want to use it alongside AdGuard Browser Extension or any other ad blocker, you'll need to use an additional extension. Learn more about this userscript and how to install it on [GitHub](https://github.com/AdguardTeam/AdGuardExtra). + +![AdGuard Extra](https://cdn.adtidy.org/content/kb/ad_blocker/general/adguard-extra.png) + +#### AdGuard Popup Blocker + +The name speaks for itself: it blocks popups — one of the most annoying types of ads on websites. Learn more about this userscript, its key features, and installation on [GitHub](https://github.com/AdguardTeam/PopupBlocker). + +![AdGuard Popup Blocker](https://cdn.adtidy.org/content/kb/ad_blocker/general/popup-blocker-installation.png) + +#### AdGuard Assistant (legacy version) + +This custom extension is designed to control filtering directly from the browser page (manual blocking, allowlisting, etc.). + +:::note + +This version of Assistant is legacy and there is no point in using it on new systems, as it has been replaced with the full-fledged [Browser Assistant](https://adguard.com/adguard-assistant/overview.html). However, the legacy Assistant may be useful if there is no Browser Assistant for your browser. If this is your case, you can learn how to install AdGuard Assistant on [GitHub](https://github.com/AdguardTeam/AdguardAssistant). + +::: + +#### Disable AMP + +A script that is only pre-installed in AdGuard for Android. It disables AMP (Accelerated Mobile Pages) on the Google search results page. Learn more about this userscript and how to install it on [GitHub](https://github.com/AdguardTeam/DisableAMP). + +![Disable AMP](https://cdn.adtidy.org/content/kb/ad_blocker/general/disable-amp-installation.png) + +### Top picks outside AdGuard{#top-picks} + +These userscripts are not developed by AdGuard, and therefore we can't give a 100% guarantee that they are safe and/or work at all times. However, in our experience they deserve a recommendation because they've all earned their good reputation. + +#### Don't track me Google + +This script removes Google's tracking feature from the links in Google search results. It speeds up the loading of search results and allows you to right-click or tap to copy the link URL. + +Its source code is [available on GitHub](https://github.com/Rob--W/dont-track-me-google). This userscript can be downloaded from [GreasyFork](https://greasyfork.org/en/scripts/428243-don-t-track-me-google) and installed in any AdGuard CoreLibs-based app. + +#### microShield + +A userscript for people visiting Korean websites and some international websites. The microShield userscript blocks Ad-Shield ads and anti-adblocks. Its original source code is available at [asdefuser](https://github.com/seia-soto/userscripts/tree/master/sources/asdefuser) and [AdShield Defuser](https://github.com/seia-soto/adshield-defuser). This userscript can be installed in AdGuard CoreLibs-based apps, Violentmonkey, Tampermonkey, and [quoid/userscripts](https://github.com/quoid/userscripts). Learn more about microShield and how to install it on [GitHub](https://github.com/List-KR/microShield). + +### Where can you get more userscripts?{#more-userscripts} + +Since userscripts are mainly created by enthusiasts, you should be cautious when installing them. Any script from an unknown source carries a potential risk. Yet, there is a great variety of interesting scripts that, if installed carefully and responsibly, can really make using some websites more convenient. + +Here we will describe some of the most popular userscript catalogs. + +#### Userscript.Zone + +[Userscript.Zone](https://www.userscript.zone) is a website that allows searching for userscripts by entering a matching URL or domain. The website is easy to use and has a high level of credibility as only scripts from moderated pages are displayed. + +#### Greasy Fork + +[Greasy Fork](https://greasyfork.org/) is a userscript catalog of Stylish creators. The scripts in this catalog are moderated, so their credibility is much higher. + +#### OpenUserJS.org + +[OpenUserJS.org](https://openuserjs.org/) is an open-source userscript catalog written in nodeJS. It's not moderated, so keep an eye out for suspicious scripts. + +#### Community + +If you like the idea of customizing your browser with userscripts and have questions, you can ask them on one of these websites: + +- [Stackoverflow](https://stackoverflow.com/questions/tagged/userscripts) +- [FreeNode](https://webchat.freenode.net/#greasemonkey) +- [Reddit](https://www.reddit.com/r/userscripts/) + +### Development + +#### Request license + +If you are developing your own custom script and want to test how it works with AdGuard, you can request a beta license key for the app. + +To get it, please send an email to devteam@adguard.com with the following information: + +**Subject:** Userscript author license request + +**Body:** Please tell us about the userscripts you are working on. + +Here is a [mailto link](mailto:devteam@adguard.com?Subject=Userscript%20author%20license%20request\&Body=Hello%2C%0A%0AMy%20userscript%28s%29%3A%20LINK). + +#### Compatibility + +#### Metadata block + +#### Supported properties + +```text +@name +@namespace +@description +@version +@match +@include +@exclude +@grant +@connect +@require +@resource +@downloadURL +@updateURL +@supportURL +@homepageURL +@homepage +@website +@source +@run-at +@noframes +@icon +@iconURL +@defaulticon +@icon64 +@icon64URL +``` + +#### Unsupported properties + +These properties will be simply ignored by AdGuard. + +```text +@unwrap +``` + +#### Supported GM functions + +AdGuard supports both old GM\_ functions and new GM4 API that use GM object. + +#### Values + +:::note + +All listed old Greasemonkey functions are deprecated but still supported. + +::: + +```text +GM.info / GM_info +GM.setValue / GM_setValue +GM.getValue / GM_getValue +GM.listValues / GM_listValues +GM.deleteValue / GM_deleteValue +GM.getResourceUrl / GM_getResourceURL +GM.setClipboard / GM_setClipboard +GM.xmlHttpRequest / GM_xmlhttpRequest +GM.openInTab / GM_openInTab +GM.notification +unsafeWindow +GM_getResourceText +GM_addStyle +GM_log +``` + +[Here](https://wiki.greasespot.net/GM.info) you can find more information about Greasemonkey API. + +#### Example + +```javascript +// ==UserScript== +// @name Name as shown to the user when locale is english or unknown +// @name:ru Name as shown to the user when locale is russian +// @description Description as shown to the user when locale is english or unknown +// @description:ru Description as shown to the user when locale is russian +// @icon https://myhomepage.com/myuserscript.png +// @version 1.0.0.0 +// @downloadURL https://dl.myhomepage.org/myuserscript.user.js +// @updateURL https://dl.myhomepage.org/myuserscript.meta.js +// @homepageURL https://myhomepage.com/myuserscript +// @include * +// @exclude *://website.com/* +// @resource https://myhomepage.com/myuserscript.css +// @require https://myhomepage.com/mylibrary.js +// @grant property:settings +// @grant GM_getValue +// @grant GM_setValue +// @grant GM_deleteValue +// @grant GM_listValues +// @grant GM_getResourceText +// @grant GM_getResourceURL +// @grant GM_addStyle +// @grant GM_log +// @grant GM_setClipboard +// @grant GM_xmlhttpRequest +// @grant unsafeWindow +// @grant GM_info +// @grant GM_openInTab +// @grant GM_registerMenuCommand +// @run-at document-start +// ==/UserScript== +!function(){( + console.log("I am loaded!"); +)}(); +``` + +## Userstyles + +Userstyles allow users to customize their online experience. Whether you’re looking to change the appearance of a website or automate repetitive tasks, styles offer a world of possibilities. + +AdGuard has the option to upload or create your own userstyles. This is an advanced feature, so you will need some knowledge of HTML and CSS. + +:::info Supported apps + +Currently, two AdGuard apps allow you to create and manage userstyles: AdGuard for Windows (v7.19 or later) and AdGuard for Mac (v2.16 or later). We also plan to implement this new feature in AdGuard v4.8 for Android in the nearest future. + +::: + +This is an experimental feature, so if you encounter any problems while adding or creating a userstyle, please contact our support team at . + +### How to set up a userstyle in AdGuard + +You can download userstyles from various websites. One of the most popular userstyle websites is [https://userstyles.world/](https://userstyles.world/explore), which we will use as an example for the following instructions on how to set up the userstyle in AdGuard. + +1. Follow the link above and choose the userstyle you like + +2. Right-click the _Install_ button and choose _Copy Link Address_ + +3. Open AdGuard settings → _Extensions_ + +4. Press the [+] button and paste the userstyle link + +5. Done! + +If you’re familiar with CSS rules, you can also create the userstyles yourself. + +:::note + +We don’t support userstyles that contain `@var` or `@advanced` in the metadata. AdGuard also doesn’t support `@preprocessor` without the `default` value. + +::: + +1. Open AdGuard settings → _Extensions_ + +2. Press the [+] button and choose the _Create userstyle_ option. A new window will appear on your screen + +3. To create a userstyle, first write the title with metadata, for example + + ```CSS + /* ==UserStyle== + @name New userstyle + @version 1.0 + ==/UserStyle== */ + ``` + +4. Write the CSS part after the meta data. AdGuard supports website domain names matching (`@-moz-document domain(…), …`). For example: + + ```CSS + body { + background: gray; + } + ``` + + Or: + + ```CSS + @-moz-document domain('example.org'), + domain('example.net'), + domain('example.com') body { + background: gray; + } + ``` + +5. Once you’re finished, press _Save and Close_. Your new userstyle has been successfully added to AdGuard + +### Example + +```css +/* ==UserStyle== +@name Example userstyle +@namespace https://example.org/userstyle +@homepageURL https://example.org/userstyle +@version 1.0.0 +@license Other +@description This is an example +@author example +@preprocessor default +==/UserStyle== */ +@-moz-document regexp("https?\:\/\/(www\.)?example\.(org|com).*") { + body { + background-color: #000000 !important; + } +} +``` diff --git a/i18n/no/docusaurus-plugin-content-docs/current/general/how-to-install.md b/i18n/no/docusaurus-plugin-content-docs/current/general/how-to-install.md index bae3060668a..106a29529a8 100644 --- a/i18n/no/docusaurus-plugin-content-docs/current/general/how-to-install.md +++ b/i18n/no/docusaurus-plugin-content-docs/current/general/how-to-install.md @@ -1,6 +1,6 @@ --- title: How to install AdGuard -sidebar_position: 8 +sidebar_position: 9 --- Depending on which AdGuard app or browser extension you want to install, follow one of these links to find the relevant article: diff --git a/i18n/pl/docusaurus-plugin-content-docs/current/adguard-for-windows/features/extensions.md b/i18n/pl/docusaurus-plugin-content-docs/current/adguard-for-windows/features/extensions.md index 260fa0e83b3..17884a6df33 100644 --- a/i18n/pl/docusaurus-plugin-content-docs/current/adguard-for-windows/features/extensions.md +++ b/i18n/pl/docusaurus-plugin-content-docs/current/adguard-for-windows/features/extensions.md @@ -9,7 +9,7 @@ This article covers AdGuard for Windows, a multifunctional ad blocker that prote ::: -AdGuard can significantly broaden website functionality working as a [user script manager](/general/extensions). AdGuard Users can add their own scripts, as well as manage existing ones. +AdGuard can significantly extend website functionality by working as a [userscript manager](/general/extensions.md). AdGuard users can add their own scripts as well as manage existing ones. ![Extensions \*mobile\_border](https://cdn.adtidy.org/content/kb/ad_blocker/windows/overview/userscripts.png) diff --git a/i18n/pl/docusaurus-plugin-content-docs/current/general/extensions.md b/i18n/pl/docusaurus-plugin-content-docs/current/general/extensions.md new file mode 100644 index 00000000000..0cf454b4329 --- /dev/null +++ b/i18n/pl/docusaurus-plugin-content-docs/current/general/extensions.md @@ -0,0 +1,301 @@ +--- +title: Extensions +sidebar_position: 6 +--- + +## Userscripts + +Userscripts (we also call them "extensions") are, de facto, miniprograms written in JavaScript. They modify or extend the functionality of one or more websites. Many AdGuard users may be already familiar with such userscripts as AdGuard Assistant, Popup Blocker, and AdGuard Extra. + +:::note Supported apps + +AdGuard can significantly broaden website functionality by acting as a userscript manager. You can add your custom scripts or manage the existing ones in our three products: [AdGuard for Windows](/adguard-for-windows/features/extensions), [AdGuard for Android](/adguard-for-android/features/settings#userscripts), and [AdGuard for Mac](/adguard-for-mac/features/extensions). + +::: + +### Recommended AdGuard scripts + +These userscripts come directly from the AdGuard developers, and we can guarantee that they are effective and safe. For some of the userscripts developed by others that we consider good and reliable, [scroll down to the next section](#top-picks). You can also find some of the [popular websites with scripts](#more-userscripts) below, but remember that whenever you download a userscript from an unknown source, you are exposing yourself to a certain risk, as some scripts may be harmful to your computer. + +#### AdGuard Extra + +An extension that blocks ads in difficult cases when the usual filter-based approach is not enough. AdGuard Extra comes pre-installed in AdGuard standalone apps, except for the one for iOS, so you don't need to do anything to enable it. However, if you want to use it alongside AdGuard Browser Extension or any other ad blocker, you'll need to use an additional extension. Learn more about this userscript and how to install it on [GitHub](https://github.com/AdguardTeam/AdGuardExtra). + +![AdGuard Extra](https://cdn.adtidy.org/content/kb/ad_blocker/general/adguard-extra.png) + +#### AdGuard Popup Blocker + +The name speaks for itself: it blocks popups — one of the most annoying types of ads on websites. Learn more about this userscript, its key features, and installation on [GitHub](https://github.com/AdguardTeam/PopupBlocker). + +![AdGuard Popup Blocker](https://cdn.adtidy.org/content/kb/ad_blocker/general/popup-blocker-installation.png) + +#### AdGuard Assistant (legacy version) + +This custom extension is designed to control filtering directly from the browser page (manual blocking, allowlisting, etc.). + +:::note + +This version of Assistant is legacy and there is no point in using it on new systems, as it has been replaced with the full-fledged [Browser Assistant](https://adguard.com/adguard-assistant/overview.html). However, the legacy Assistant may be useful if there is no Browser Assistant for your browser. If this is your case, you can learn how to install AdGuard Assistant on [GitHub](https://github.com/AdguardTeam/AdguardAssistant). + +::: + +#### Disable AMP + +A script that is only pre-installed in AdGuard for Android. It disables AMP (Accelerated Mobile Pages) on the Google search results page. Learn more about this userscript and how to install it on [GitHub](https://github.com/AdguardTeam/DisableAMP). + +![Disable AMP](https://cdn.adtidy.org/content/kb/ad_blocker/general/disable-amp-installation.png) + +### Top picks outside AdGuard{#top-picks} + +These userscripts are not developed by AdGuard, and therefore we can't give a 100% guarantee that they are safe and/or work at all times. However, in our experience they deserve a recommendation because they've all earned their good reputation. + +#### Don't track me Google + +This script removes Google's tracking feature from the links in Google search results. It speeds up the loading of search results and allows you to right-click or tap to copy the link URL. + +Its source code is [available on GitHub](https://github.com/Rob--W/dont-track-me-google). This userscript can be downloaded from [GreasyFork](https://greasyfork.org/en/scripts/428243-don-t-track-me-google) and installed in any AdGuard CoreLibs-based app. + +#### microShield + +A userscript for people visiting Korean websites and some international websites. The microShield userscript blocks Ad-Shield ads and anti-adblocks. Its original source code is available at [asdefuser](https://github.com/seia-soto/userscripts/tree/master/sources/asdefuser) and [AdShield Defuser](https://github.com/seia-soto/adshield-defuser). This userscript can be installed in AdGuard CoreLibs-based apps, Violentmonkey, Tampermonkey, and [quoid/userscripts](https://github.com/quoid/userscripts). Learn more about microShield and how to install it on [GitHub](https://github.com/List-KR/microShield). + +### Where can you get more userscripts?{#more-userscripts} + +Since userscripts are mainly created by enthusiasts, you should be cautious when installing them. Any script from an unknown source carries a potential risk. Yet, there is a great variety of interesting scripts that, if installed carefully and responsibly, can really make using some websites more convenient. + +Here we will describe some of the most popular userscript catalogs. + +#### Userscript.Zone + +[Userscript.Zone](https://www.userscript.zone) is a website that allows searching for userscripts by entering a matching URL or domain. The website is easy to use and has a high level of credibility as only scripts from moderated pages are displayed. + +#### Greasy Fork + +[Greasy Fork](https://greasyfork.org/) is a userscript catalog of Stylish creators. The scripts in this catalog are moderated, so their credibility is much higher. + +#### OpenUserJS.org + +[OpenUserJS.org](https://openuserjs.org/) is an open-source userscript catalog written in nodeJS. It's not moderated, so keep an eye out for suspicious scripts. + +#### Community + +If you like the idea of customizing your browser with userscripts and have questions, you can ask them on one of these websites: + +- [Stackoverflow](https://stackoverflow.com/questions/tagged/userscripts) +- [FreeNode](https://webchat.freenode.net/#greasemonkey) +- [Reddit](https://www.reddit.com/r/userscripts/) + +### Development + +#### Request license + +If you are developing your own custom script and want to test how it works with AdGuard, you can request a beta license key for the app. + +To get it, please send an email to devteam@adguard.com with the following information: + +**Subject:** Userscript author license request + +**Body:** Please tell us about the userscripts you are working on. + +Here is a [mailto link](mailto:devteam@adguard.com?Subject=Userscript%20author%20license%20request\&Body=Hello%2C%0A%0AMy%20userscript%28s%29%3A%20LINK). + +#### Compatibility + +#### Metadata block + +#### Supported properties + +```text +@name +@namespace +@description +@version +@match +@include +@exclude +@grant +@connect +@require +@resource +@downloadURL +@updateURL +@supportURL +@homepageURL +@homepage +@website +@source +@run-at +@noframes +@icon +@iconURL +@defaulticon +@icon64 +@icon64URL +``` + +#### Unsupported properties + +These properties will be simply ignored by AdGuard. + +```text +@unwrap +``` + +#### Supported GM functions + +AdGuard supports both old GM\_ functions and new GM4 API that use GM object. + +#### Values + +:::note + +All listed old Greasemonkey functions are deprecated but still supported. + +::: + +```text +GM.info / GM_info +GM.setValue / GM_setValue +GM.getValue / GM_getValue +GM.listValues / GM_listValues +GM.deleteValue / GM_deleteValue +GM.getResourceUrl / GM_getResourceURL +GM.setClipboard / GM_setClipboard +GM.xmlHttpRequest / GM_xmlhttpRequest +GM.openInTab / GM_openInTab +GM.notification +unsafeWindow +GM_getResourceText +GM_addStyle +GM_log +``` + +[Here](https://wiki.greasespot.net/GM.info) you can find more information about Greasemonkey API. + +#### Example + +```javascript +// ==UserScript== +// @name Name as shown to the user when locale is english or unknown +// @name:ru Name as shown to the user when locale is russian +// @description Description as shown to the user when locale is english or unknown +// @description:ru Description as shown to the user when locale is russian +// @icon https://myhomepage.com/myuserscript.png +// @version 1.0.0.0 +// @downloadURL https://dl.myhomepage.org/myuserscript.user.js +// @updateURL https://dl.myhomepage.org/myuserscript.meta.js +// @homepageURL https://myhomepage.com/myuserscript +// @include * +// @exclude *://website.com/* +// @resource https://myhomepage.com/myuserscript.css +// @require https://myhomepage.com/mylibrary.js +// @grant property:settings +// @grant GM_getValue +// @grant GM_setValue +// @grant GM_deleteValue +// @grant GM_listValues +// @grant GM_getResourceText +// @grant GM_getResourceURL +// @grant GM_addStyle +// @grant GM_log +// @grant GM_setClipboard +// @grant GM_xmlhttpRequest +// @grant unsafeWindow +// @grant GM_info +// @grant GM_openInTab +// @grant GM_registerMenuCommand +// @run-at document-start +// ==/UserScript== +!function(){( + console.log("I am loaded!"); +)}(); +``` + +## Userstyles + +Userstyles allow users to customize their online experience. Whether you’re looking to change the appearance of a website or automate repetitive tasks, styles offer a world of possibilities. + +AdGuard has the option to upload or create your own userstyles. This is an advanced feature, so you will need some knowledge of HTML and CSS. + +:::info Supported apps + +Currently, two AdGuard apps allow you to create and manage userstyles: AdGuard for Windows (v7.19 or later) and AdGuard for Mac (v2.16 or later). We also plan to implement this new feature in AdGuard v4.8 for Android in the nearest future. + +::: + +This is an experimental feature, so if you encounter any problems while adding or creating a userstyle, please contact our support team at . + +### How to set up a userstyle in AdGuard + +You can download userstyles from various websites. One of the most popular userstyle websites is [https://userstyles.world/](https://userstyles.world/explore), which we will use as an example for the following instructions on how to set up the userstyle in AdGuard. + +1. Follow the link above and choose the userstyle you like + +2. Right-click the _Install_ button and choose _Copy Link Address_ + +3. Open AdGuard settings → _Extensions_ + +4. Press the [+] button and paste the userstyle link + +5. Done! + +If you’re familiar with CSS rules, you can also create the userstyles yourself. + +:::note + +We don’t support userstyles that contain `@var` or `@advanced` in the metadata. AdGuard also doesn’t support `@preprocessor` without the `default` value. + +::: + +1. Open AdGuard settings → _Extensions_ + +2. Press the [+] button and choose the _Create userstyle_ option. A new window will appear on your screen + +3. To create a userstyle, first write the title with metadata, for example + + ```CSS + /* ==UserStyle== + @name New userstyle + @version 1.0 + ==/UserStyle== */ + ``` + +4. Write the CSS part after the meta data. AdGuard supports website domain names matching (`@-moz-document domain(…), …`). For example: + + ```CSS + body { + background: gray; + } + ``` + + Or: + + ```CSS + @-moz-document domain('example.org'), + domain('example.net'), + domain('example.com') body { + background: gray; + } + ``` + +5. Once you’re finished, press _Save and Close_. Your new userstyle has been successfully added to AdGuard + +### Example + +```css +/* ==UserStyle== +@name Example userstyle +@namespace https://example.org/userstyle +@homepageURL https://example.org/userstyle +@version 1.0.0 +@license Other +@description This is an example +@author example +@preprocessor default +==/UserStyle== */ +@-moz-document regexp("https?\:\/\/(www\.)?example\.(org|com).*") { + body { + background-color: #000000 !important; + } +} +``` diff --git a/i18n/pl/docusaurus-plugin-content-docs/current/general/how-to-install.md b/i18n/pl/docusaurus-plugin-content-docs/current/general/how-to-install.md index bae3060668a..106a29529a8 100644 --- a/i18n/pl/docusaurus-plugin-content-docs/current/general/how-to-install.md +++ b/i18n/pl/docusaurus-plugin-content-docs/current/general/how-to-install.md @@ -1,6 +1,6 @@ --- title: How to install AdGuard -sidebar_position: 8 +sidebar_position: 9 --- Depending on which AdGuard app or browser extension you want to install, follow one of these links to find the relevant article: diff --git a/i18n/pt-BR/docusaurus-plugin-content-docs/current/adguard-for-windows/features/extensions.md b/i18n/pt-BR/docusaurus-plugin-content-docs/current/adguard-for-windows/features/extensions.md index f167a43dd1b..261ade100c1 100644 --- a/i18n/pt-BR/docusaurus-plugin-content-docs/current/adguard-for-windows/features/extensions.md +++ b/i18n/pt-BR/docusaurus-plugin-content-docs/current/adguard-for-windows/features/extensions.md @@ -9,7 +9,7 @@ Este artigo aborda o AdGuard para Windows, um bloqueador de anúncios multifunci ::: -O AdGuard pode ampliar significativamente a funcionalidade de um site funcionando como um [gerenciador de scripts de usuário](/general/extensions). Os usuários do AdGuard podem adicionar seus próprios scripts, bem como gerenciar os existentes. +AdGuard can significantly extend website functionality by working as a [userscript manager](/general/extensions.md). AdGuard users can add their own scripts as well as manage existing ones. ![Extensões \*mobile\_border](https://cdn.adtidy.org/content/kb/ad_blocker/windows/overview/userscripts.png) diff --git a/i18n/pt-BR/docusaurus-plugin-content-docs/current/general/extensions.md b/i18n/pt-BR/docusaurus-plugin-content-docs/current/general/extensions.md new file mode 100644 index 00000000000..1d09d9f24a9 --- /dev/null +++ b/i18n/pt-BR/docusaurus-plugin-content-docs/current/general/extensions.md @@ -0,0 +1,301 @@ +--- +title: Extensões +sidebar_position: 6 +--- + +## Userscripts + +Userscripts (também chamados de "extensões") são, na verdade, miniprogramas escritos em JavaScript. Eles modificam ou ampliam a funcionalidade de um ou mais websites. Muitos usuários do AdGuard já podem estar familiarizados com scripts de usuário como o Assistente AdGuard, o Bloqueador de pop-ups e o AdGuard Extra. + +:::note Supported apps + +O AdGuard pode ampliar significativamente a funcionalidade de sites, agindo como um gerenciador de userscripts. You can add your custom scripts or manage the existing ones in our three products: [AdGuard for Windows](/adguard-for-windows/features/extensions), [AdGuard for Android](/adguard-for-android/features/settings#userscripts), and [AdGuard for Mac](/adguard-for-mac/features/extensions). + +::: + +### Scripts recomendados do AdGuard + +Esses scripts de usuário vêm diretamente dos desenvolvedores do AdGuard e podemos garantir que são eficazes e seguros. For some of the userscripts developed by others that we consider good and reliable, [scroll down to the next section](#top-picks). You can also find some of the [popular websites with scripts](#more-userscripts) below, but remember that whenever you download a userscript from an unknown source, you are exposing yourself to a certain risk, as some scripts may be harmful to your computer. + +#### AdGuard Extra + +Uma extensão que bloqueia anúncios em casos difíceis, quando a abordagem usual baseada em filtros não é suficiente. AdGuard Extra comes pre-installed in AdGuard standalone apps, except for the one for iOS, so you don't need to do anything to enable it. No entanto, se quiser usá-lo junto com a extensão do navegador AdGuard ou qualquer outro bloqueador de anúncios, você precisará usar uma extensão adicional. Learn more about this userscript and how to install it on [GitHub](https://github.com/AdguardTeam/AdGuardExtra). + +![AdGuard Extra](https://cdn.adtidy.org/content/kb/ad_blocker/general/adguard-extra.png) + +#### Bloqueador de pop-ups do AdGuard + +The name speaks for itself: it blocks popups — one of the most annoying types of ads on websites. Learn more about this userscript, its key features, and installation on [GitHub](https://github.com/AdguardTeam/PopupBlocker). + +![AdGuard Popup Blocker](https://cdn.adtidy.org/content/kb/ad_blocker/general/popup-blocker-installation.png) + +#### Assistente AdGuard (versão antiga) + +This custom extension is designed to control filtering directly from the browser page (manual blocking, allowlisting, etc.). + +:::note + +This version of Assistant is legacy and there is no point in using it on new systems, as it has been replaced with the full-fledged [Browser Assistant](https://adguard.com/adguard-assistant/overview.html). However, the legacy Assistant may be useful if there is no Browser Assistant for your browser. If this is your case, you can learn how to install AdGuard Assistant on [GitHub](https://github.com/AdguardTeam/AdguardAssistant). + +::: + +#### Desativar AMP + +Um script pré-instalado apenas no AdGuard para Android. Ele desativa o AMP (Accelerated Mobile Pages) na página de resultados de pesquisa do Google. Learn more about this userscript and how to install it on [GitHub](https://github.com/AdguardTeam/DisableAMP). + +![Disable AMP](https://cdn.adtidy.org/content/kb/ad_blocker/general/disable-amp-installation.png) + +### Principais opções fora do AdGuard{#top-picks} + +These userscripts are not developed by AdGuard, and therefore we can't give a 100% guarantee that they are safe and/or work at all times. However, in our experience they deserve a recommendation because they've all earned their good reputation. + +#### Don't track me Google + +Este script remove o recurso de rastreamento do Google dos links nos resultados de pesquisa do Google. Ele acelera o carregamento dos resultados da pesquisa e permite clicar com o botão direito ou tocar para copiar o link do URL. + +Its source code is [available on GitHub](https://github.com/Rob--W/dont-track-me-google). This userscript can be downloaded from [GreasyFork](https://greasyfork.org/en/scripts/428243-don-t-track-me-google) and installed in any AdGuard CoreLibs-based app. + +#### microShield + +A userscript for people visiting Korean websites and some international websites. The microShield userscript blocks Ad-Shield ads and anti-adblocks. Its original source code is available at [asdefuser](https://github.com/seia-soto/userscripts/tree/master/sources/asdefuser) and [AdShield Defuser](https://github.com/seia-soto/adshield-defuser). This userscript can be installed in AdGuard CoreLibs-based apps, Violentmonkey, Tampermonkey, and [quoid/userscripts](https://github.com/quoid/userscripts). Learn more about microShield and how to install it on [GitHub](https://github.com/List-KR/microShield). + +### Onde obter mais userscripts?{#more-userscripts} + +Since userscripts are mainly created by enthusiasts, you should be cautious when installing them. Qualquer script de fonte desconhecida acarreta um risco potencial. No entanto, há uma grande variedade de scripts interessantes que, se instalados com cuidado e responsabilidade, podem realmente tornar o uso de alguns sites mais conveniente. + +Aqui descreveremos alguns dos catálogos de userscript mais populares. + +#### Userscript.Zone + +[Userscript.Zone](https://www.userscript.zone) is a website that allows searching for userscripts by entering a matching URL or domain. The website is easy to use and has a high level of credibility as only scripts from moderated pages are displayed. + +#### Greasy Fork + +[Greasy Fork](https://greasyfork.org/) is a userscript catalog of Stylish creators. The scripts in this catalog are moderated, so their credibility is much higher. + +#### OpenUserJS.org + +[OpenUserJS.org](https://openuserjs.org/) is an open-source userscript catalog written in nodeJS. It's not moderated, so keep an eye out for suspicious scripts. + +#### Comunidade + +If you like the idea of customizing your browser with userscripts and have questions, you can ask them on one of these websites: + +- [Stackoverflow](https://stackoverflow.com/questions/tagged/userscripts) +- [FreeNode](https://webchat.freenode.net/#greasemonkey) +- [Reddit](https://www.reddit.com/r/userscripts/) + +### Desenvolvimento + +#### Solicitar licença + +If you are developing your own custom script and want to test how it works with AdGuard, you can request a beta license key for the app. + +Para obtê-la, envie um email para devteam@adguard.com com as seguintes informações: + +**Subject:** Userscript author license request + +**Body:** Please tell us about the userscripts you are working on. + +Here is a [mailto link](mailto:devteam@adguard.com?Subject=Userscript%20author%20license%20request\&Body=Hello%2C%0A%0AMy%20userscript%28s%29%3A%20LINK). + +#### Compatibilidade + +#### Bloqueio de metadados + +#### Propriedades compatíveis + +```text +@name +@namespace +@description +@version +@match +@include +@exclude +@grant +@connect +@require +@resource +@downloadURL +@updateURL +@supportURL +@homepageURL +@homepage +@website +@source +@run-at +@noframes +@icon +@iconURL +@defaulticon +@icon64 +@icon64URL +``` + +#### Propriedades não compatíveis + +Essas propriedades serão simplesmente ignoradas pelo AdGuard. + +```text +@unwrap +``` + +#### Funções GM compatíveis + +O AdGuard oferece suporte às antigas funções GM\_ e à nova API GM4 que usa o objeto GM. + +#### Valores + +:::note + +Todas as funções antigas do Greasemonkey listadas estão obsoletas, mas ainda são suportadas. + +::: + +```text +GM.info / GM_info +GM.setValue / GM_setValue +GM.getValue / GM_getValue +GM.listValues / GM_listValues +GM.deleteValue / GM_deleteValue +GM.getResourceUrl / GM_getResourceURL +GM.setClipboard / GM_setClipboard +GM.xmlHttpRequest / GM_xmlhttpRequest +GM.openInTab / GM_openInTab +GM.notification +unsafeWindow +GM_getResourceText +GM_addStyle +GM_log +``` + +[Here](https://wiki.greasespot.net/GM.info) you can find more information about Greasemonkey API. + +#### Exemplo + +```javascript +// ==UserScript== +// @name Name as shown to the user when locale is english or unknown +// @name:ru Name as shown to the user when locale is russian +// @description Description as shown to the user when locale is english or unknown +// @description:ru Description as shown to the user when locale is russian +// @icon https://myhomepage.com/myuserscript.png +// @version 1.0.0.0 +// @downloadURL https://dl.myhomepage.org/myuserscript.user.js +// @updateURL https://dl.myhomepage.org/myuserscript.meta.js +// @homepageURL https://myhomepage.com/myuserscript +// @include * +// @exclude *://website.com/* +// @resource https://myhomepage.com/myuserscript.css +// @require https://myhomepage.com/mylibrary.js +// @grant property:settings +// @grant GM_getValue +// @grant GM_setValue +// @grant GM_deleteValue +// @grant GM_listValues +// @grant GM_getResourceText +// @grant GM_getResourceURL +// @grant GM_addStyle +// @grant GM_log +// @grant GM_setClipboard +// @grant GM_xmlhttpRequest +// @grant unsafeWindow +// @grant GM_info +// @grant GM_openInTab +// @grant GM_registerMenuCommand +// @run-at document-start +// ==/UserScript== +!function(){( + console.log("I am loaded!"); +)}(); +``` + +## Userstyles + +Userstyles allow users to customize their online experience. Whether you’re looking to change the appearance of a website or automate repetitive tasks, styles offer a world of possibilities. + +AdGuard has the option to upload or create your own userstyles. This is an advanced feature, so you will need some knowledge of HTML and CSS. + +:::info Supported apps + +Currently, two AdGuard apps allow you to create and manage userstyles: AdGuard for Windows (v7.19 or later) and AdGuard for Mac (v2.16 or later). We also plan to implement this new feature in AdGuard v4.8 for Android in the nearest future. + +::: + +This is an experimental feature, so if you encounter any problems while adding or creating a userstyle, please contact our support team at . + +### How to set up a userstyle in AdGuard + +You can download userstyles from various websites. One of the most popular userstyle websites is [https://userstyles.world/](https://userstyles.world/explore), which we will use as an example for the following instructions on how to set up the userstyle in AdGuard. + +1. Follow the link above and choose the userstyle you like + +2. Right-click the _Install_ button and choose _Copy Link Address_ + +3. Open AdGuard settings → _Extensions_ + +4. Press the [+] button and paste the userstyle link + +5. Pronto! + +If you’re familiar with CSS rules, you can also create the userstyles yourself. + +:::note + +We don’t support userstyles that contain `@var` or `@advanced` in the metadata. AdGuard also doesn’t support `@preprocessor` without the `default` value. + +::: + +1. Open AdGuard settings → _Extensions_ + +2. Press the [+] button and choose the _Create userstyle_ option. A new window will appear on your screen + +3. To create a userstyle, first write the title with metadata, for example + + ```CSS + /* ==UserStyle== + @name New userstyle + @version 1.0 + ==/UserStyle== */ + ``` + +4. Write the CSS part after the meta data. AdGuard supports website domain names matching (`@-moz-document domain(…), …`). For example: + + ```CSS + body { + background: gray; + } + ``` + + Or: + + ```CSS + @-moz-document domain('example.org'), + domain('example.net'), + domain('example.com') body { + background: gray; + } + ``` + +5. Once you’re finished, press _Save and Close_. Your new userstyle has been successfully added to AdGuard + +### Exemplo + +```css +/* ==UserStyle== +@name Example userstyle +@namespace https://example.org/userstyle +@homepageURL https://example.org/userstyle +@version 1.0.0 +@license Other +@description This is an example +@author example +@preprocessor default +==/UserStyle== */ +@-moz-document regexp("https?\:\/\/(www\.)?example\.(org|com).*") { + body { + background-color: #000000 !important; + } +} +``` diff --git a/i18n/pt-BR/docusaurus-plugin-content-docs/current/general/how-to-install.md b/i18n/pt-BR/docusaurus-plugin-content-docs/current/general/how-to-install.md index a519528cd4e..e7e6b5e31b6 100644 --- a/i18n/pt-BR/docusaurus-plugin-content-docs/current/general/how-to-install.md +++ b/i18n/pt-BR/docusaurus-plugin-content-docs/current/general/how-to-install.md @@ -1,6 +1,6 @@ --- title: How to install AdGuard -sidebar_position: 8 +sidebar_position: 9 --- Depending on which AdGuard app or browser extension you want to install, follow one of these links to find the relevant article: diff --git a/i18n/pt/docusaurus-plugin-content-docs/current/adguard-for-windows/features/extensions.md b/i18n/pt/docusaurus-plugin-content-docs/current/adguard-for-windows/features/extensions.md index 148c96e1679..bfe88077574 100644 --- a/i18n/pt/docusaurus-plugin-content-docs/current/adguard-for-windows/features/extensions.md +++ b/i18n/pt/docusaurus-plugin-content-docs/current/adguard-for-windows/features/extensions.md @@ -9,7 +9,7 @@ Este artigo aborda o AdGuard para Windows, um bloqueador de anúncios multifunci ::: -AdGuard can significantly broaden website functionality working as a [user script manager](/general/extensions). AdGuard Users can add their own scripts, as well as manage existing ones. +AdGuard can significantly extend website functionality by working as a [userscript manager](/general/extensions.md). AdGuard users can add their own scripts as well as manage existing ones. ![Extensions \*mobile\_border](https://cdn.adtidy.org/content/kb/ad_blocker/windows/overview/userscripts.png) diff --git a/i18n/pt/docusaurus-plugin-content-docs/current/general/extensions.md b/i18n/pt/docusaurus-plugin-content-docs/current/general/extensions.md new file mode 100644 index 00000000000..0cf454b4329 --- /dev/null +++ b/i18n/pt/docusaurus-plugin-content-docs/current/general/extensions.md @@ -0,0 +1,301 @@ +--- +title: Extensions +sidebar_position: 6 +--- + +## Userscripts + +Userscripts (we also call them "extensions") are, de facto, miniprograms written in JavaScript. They modify or extend the functionality of one or more websites. Many AdGuard users may be already familiar with such userscripts as AdGuard Assistant, Popup Blocker, and AdGuard Extra. + +:::note Supported apps + +AdGuard can significantly broaden website functionality by acting as a userscript manager. You can add your custom scripts or manage the existing ones in our three products: [AdGuard for Windows](/adguard-for-windows/features/extensions), [AdGuard for Android](/adguard-for-android/features/settings#userscripts), and [AdGuard for Mac](/adguard-for-mac/features/extensions). + +::: + +### Recommended AdGuard scripts + +These userscripts come directly from the AdGuard developers, and we can guarantee that they are effective and safe. For some of the userscripts developed by others that we consider good and reliable, [scroll down to the next section](#top-picks). You can also find some of the [popular websites with scripts](#more-userscripts) below, but remember that whenever you download a userscript from an unknown source, you are exposing yourself to a certain risk, as some scripts may be harmful to your computer. + +#### AdGuard Extra + +An extension that blocks ads in difficult cases when the usual filter-based approach is not enough. AdGuard Extra comes pre-installed in AdGuard standalone apps, except for the one for iOS, so you don't need to do anything to enable it. However, if you want to use it alongside AdGuard Browser Extension or any other ad blocker, you'll need to use an additional extension. Learn more about this userscript and how to install it on [GitHub](https://github.com/AdguardTeam/AdGuardExtra). + +![AdGuard Extra](https://cdn.adtidy.org/content/kb/ad_blocker/general/adguard-extra.png) + +#### AdGuard Popup Blocker + +The name speaks for itself: it blocks popups — one of the most annoying types of ads on websites. Learn more about this userscript, its key features, and installation on [GitHub](https://github.com/AdguardTeam/PopupBlocker). + +![AdGuard Popup Blocker](https://cdn.adtidy.org/content/kb/ad_blocker/general/popup-blocker-installation.png) + +#### AdGuard Assistant (legacy version) + +This custom extension is designed to control filtering directly from the browser page (manual blocking, allowlisting, etc.). + +:::note + +This version of Assistant is legacy and there is no point in using it on new systems, as it has been replaced with the full-fledged [Browser Assistant](https://adguard.com/adguard-assistant/overview.html). However, the legacy Assistant may be useful if there is no Browser Assistant for your browser. If this is your case, you can learn how to install AdGuard Assistant on [GitHub](https://github.com/AdguardTeam/AdguardAssistant). + +::: + +#### Disable AMP + +A script that is only pre-installed in AdGuard for Android. It disables AMP (Accelerated Mobile Pages) on the Google search results page. Learn more about this userscript and how to install it on [GitHub](https://github.com/AdguardTeam/DisableAMP). + +![Disable AMP](https://cdn.adtidy.org/content/kb/ad_blocker/general/disable-amp-installation.png) + +### Top picks outside AdGuard{#top-picks} + +These userscripts are not developed by AdGuard, and therefore we can't give a 100% guarantee that they are safe and/or work at all times. However, in our experience they deserve a recommendation because they've all earned their good reputation. + +#### Don't track me Google + +This script removes Google's tracking feature from the links in Google search results. It speeds up the loading of search results and allows you to right-click or tap to copy the link URL. + +Its source code is [available on GitHub](https://github.com/Rob--W/dont-track-me-google). This userscript can be downloaded from [GreasyFork](https://greasyfork.org/en/scripts/428243-don-t-track-me-google) and installed in any AdGuard CoreLibs-based app. + +#### microShield + +A userscript for people visiting Korean websites and some international websites. The microShield userscript blocks Ad-Shield ads and anti-adblocks. Its original source code is available at [asdefuser](https://github.com/seia-soto/userscripts/tree/master/sources/asdefuser) and [AdShield Defuser](https://github.com/seia-soto/adshield-defuser). This userscript can be installed in AdGuard CoreLibs-based apps, Violentmonkey, Tampermonkey, and [quoid/userscripts](https://github.com/quoid/userscripts). Learn more about microShield and how to install it on [GitHub](https://github.com/List-KR/microShield). + +### Where can you get more userscripts?{#more-userscripts} + +Since userscripts are mainly created by enthusiasts, you should be cautious when installing them. Any script from an unknown source carries a potential risk. Yet, there is a great variety of interesting scripts that, if installed carefully and responsibly, can really make using some websites more convenient. + +Here we will describe some of the most popular userscript catalogs. + +#### Userscript.Zone + +[Userscript.Zone](https://www.userscript.zone) is a website that allows searching for userscripts by entering a matching URL or domain. The website is easy to use and has a high level of credibility as only scripts from moderated pages are displayed. + +#### Greasy Fork + +[Greasy Fork](https://greasyfork.org/) is a userscript catalog of Stylish creators. The scripts in this catalog are moderated, so their credibility is much higher. + +#### OpenUserJS.org + +[OpenUserJS.org](https://openuserjs.org/) is an open-source userscript catalog written in nodeJS. It's not moderated, so keep an eye out for suspicious scripts. + +#### Community + +If you like the idea of customizing your browser with userscripts and have questions, you can ask them on one of these websites: + +- [Stackoverflow](https://stackoverflow.com/questions/tagged/userscripts) +- [FreeNode](https://webchat.freenode.net/#greasemonkey) +- [Reddit](https://www.reddit.com/r/userscripts/) + +### Development + +#### Request license + +If you are developing your own custom script and want to test how it works with AdGuard, you can request a beta license key for the app. + +To get it, please send an email to devteam@adguard.com with the following information: + +**Subject:** Userscript author license request + +**Body:** Please tell us about the userscripts you are working on. + +Here is a [mailto link](mailto:devteam@adguard.com?Subject=Userscript%20author%20license%20request\&Body=Hello%2C%0A%0AMy%20userscript%28s%29%3A%20LINK). + +#### Compatibility + +#### Metadata block + +#### Supported properties + +```text +@name +@namespace +@description +@version +@match +@include +@exclude +@grant +@connect +@require +@resource +@downloadURL +@updateURL +@supportURL +@homepageURL +@homepage +@website +@source +@run-at +@noframes +@icon +@iconURL +@defaulticon +@icon64 +@icon64URL +``` + +#### Unsupported properties + +These properties will be simply ignored by AdGuard. + +```text +@unwrap +``` + +#### Supported GM functions + +AdGuard supports both old GM\_ functions and new GM4 API that use GM object. + +#### Values + +:::note + +All listed old Greasemonkey functions are deprecated but still supported. + +::: + +```text +GM.info / GM_info +GM.setValue / GM_setValue +GM.getValue / GM_getValue +GM.listValues / GM_listValues +GM.deleteValue / GM_deleteValue +GM.getResourceUrl / GM_getResourceURL +GM.setClipboard / GM_setClipboard +GM.xmlHttpRequest / GM_xmlhttpRequest +GM.openInTab / GM_openInTab +GM.notification +unsafeWindow +GM_getResourceText +GM_addStyle +GM_log +``` + +[Here](https://wiki.greasespot.net/GM.info) you can find more information about Greasemonkey API. + +#### Example + +```javascript +// ==UserScript== +// @name Name as shown to the user when locale is english or unknown +// @name:ru Name as shown to the user when locale is russian +// @description Description as shown to the user when locale is english or unknown +// @description:ru Description as shown to the user when locale is russian +// @icon https://myhomepage.com/myuserscript.png +// @version 1.0.0.0 +// @downloadURL https://dl.myhomepage.org/myuserscript.user.js +// @updateURL https://dl.myhomepage.org/myuserscript.meta.js +// @homepageURL https://myhomepage.com/myuserscript +// @include * +// @exclude *://website.com/* +// @resource https://myhomepage.com/myuserscript.css +// @require https://myhomepage.com/mylibrary.js +// @grant property:settings +// @grant GM_getValue +// @grant GM_setValue +// @grant GM_deleteValue +// @grant GM_listValues +// @grant GM_getResourceText +// @grant GM_getResourceURL +// @grant GM_addStyle +// @grant GM_log +// @grant GM_setClipboard +// @grant GM_xmlhttpRequest +// @grant unsafeWindow +// @grant GM_info +// @grant GM_openInTab +// @grant GM_registerMenuCommand +// @run-at document-start +// ==/UserScript== +!function(){( + console.log("I am loaded!"); +)}(); +``` + +## Userstyles + +Userstyles allow users to customize their online experience. Whether you’re looking to change the appearance of a website or automate repetitive tasks, styles offer a world of possibilities. + +AdGuard has the option to upload or create your own userstyles. This is an advanced feature, so you will need some knowledge of HTML and CSS. + +:::info Supported apps + +Currently, two AdGuard apps allow you to create and manage userstyles: AdGuard for Windows (v7.19 or later) and AdGuard for Mac (v2.16 or later). We also plan to implement this new feature in AdGuard v4.8 for Android in the nearest future. + +::: + +This is an experimental feature, so if you encounter any problems while adding or creating a userstyle, please contact our support team at . + +### How to set up a userstyle in AdGuard + +You can download userstyles from various websites. One of the most popular userstyle websites is [https://userstyles.world/](https://userstyles.world/explore), which we will use as an example for the following instructions on how to set up the userstyle in AdGuard. + +1. Follow the link above and choose the userstyle you like + +2. Right-click the _Install_ button and choose _Copy Link Address_ + +3. Open AdGuard settings → _Extensions_ + +4. Press the [+] button and paste the userstyle link + +5. Done! + +If you’re familiar with CSS rules, you can also create the userstyles yourself. + +:::note + +We don’t support userstyles that contain `@var` or `@advanced` in the metadata. AdGuard also doesn’t support `@preprocessor` without the `default` value. + +::: + +1. Open AdGuard settings → _Extensions_ + +2. Press the [+] button and choose the _Create userstyle_ option. A new window will appear on your screen + +3. To create a userstyle, first write the title with metadata, for example + + ```CSS + /* ==UserStyle== + @name New userstyle + @version 1.0 + ==/UserStyle== */ + ``` + +4. Write the CSS part after the meta data. AdGuard supports website domain names matching (`@-moz-document domain(…), …`). For example: + + ```CSS + body { + background: gray; + } + ``` + + Or: + + ```CSS + @-moz-document domain('example.org'), + domain('example.net'), + domain('example.com') body { + background: gray; + } + ``` + +5. Once you’re finished, press _Save and Close_. Your new userstyle has been successfully added to AdGuard + +### Example + +```css +/* ==UserStyle== +@name Example userstyle +@namespace https://example.org/userstyle +@homepageURL https://example.org/userstyle +@version 1.0.0 +@license Other +@description This is an example +@author example +@preprocessor default +==/UserStyle== */ +@-moz-document regexp("https?\:\/\/(www\.)?example\.(org|com).*") { + body { + background-color: #000000 !important; + } +} +``` diff --git a/i18n/pt/docusaurus-plugin-content-docs/current/general/how-to-install.md b/i18n/pt/docusaurus-plugin-content-docs/current/general/how-to-install.md index bae3060668a..106a29529a8 100644 --- a/i18n/pt/docusaurus-plugin-content-docs/current/general/how-to-install.md +++ b/i18n/pt/docusaurus-plugin-content-docs/current/general/how-to-install.md @@ -1,6 +1,6 @@ --- title: How to install AdGuard -sidebar_position: 8 +sidebar_position: 9 --- Depending on which AdGuard app or browser extension you want to install, follow one of these links to find the relevant article: diff --git a/i18n/ro/docusaurus-plugin-content-docs/current/adguard-for-windows/features/extensions.md b/i18n/ro/docusaurus-plugin-content-docs/current/adguard-for-windows/features/extensions.md index 260fa0e83b3..17884a6df33 100644 --- a/i18n/ro/docusaurus-plugin-content-docs/current/adguard-for-windows/features/extensions.md +++ b/i18n/ro/docusaurus-plugin-content-docs/current/adguard-for-windows/features/extensions.md @@ -9,7 +9,7 @@ This article covers AdGuard for Windows, a multifunctional ad blocker that prote ::: -AdGuard can significantly broaden website functionality working as a [user script manager](/general/extensions). AdGuard Users can add their own scripts, as well as manage existing ones. +AdGuard can significantly extend website functionality by working as a [userscript manager](/general/extensions.md). AdGuard users can add their own scripts as well as manage existing ones. ![Extensions \*mobile\_border](https://cdn.adtidy.org/content/kb/ad_blocker/windows/overview/userscripts.png) diff --git a/i18n/ro/docusaurus-plugin-content-docs/current/general/extensions.md b/i18n/ro/docusaurus-plugin-content-docs/current/general/extensions.md new file mode 100644 index 00000000000..0cf454b4329 --- /dev/null +++ b/i18n/ro/docusaurus-plugin-content-docs/current/general/extensions.md @@ -0,0 +1,301 @@ +--- +title: Extensions +sidebar_position: 6 +--- + +## Userscripts + +Userscripts (we also call them "extensions") are, de facto, miniprograms written in JavaScript. They modify or extend the functionality of one or more websites. Many AdGuard users may be already familiar with such userscripts as AdGuard Assistant, Popup Blocker, and AdGuard Extra. + +:::note Supported apps + +AdGuard can significantly broaden website functionality by acting as a userscript manager. You can add your custom scripts or manage the existing ones in our three products: [AdGuard for Windows](/adguard-for-windows/features/extensions), [AdGuard for Android](/adguard-for-android/features/settings#userscripts), and [AdGuard for Mac](/adguard-for-mac/features/extensions). + +::: + +### Recommended AdGuard scripts + +These userscripts come directly from the AdGuard developers, and we can guarantee that they are effective and safe. For some of the userscripts developed by others that we consider good and reliable, [scroll down to the next section](#top-picks). You can also find some of the [popular websites with scripts](#more-userscripts) below, but remember that whenever you download a userscript from an unknown source, you are exposing yourself to a certain risk, as some scripts may be harmful to your computer. + +#### AdGuard Extra + +An extension that blocks ads in difficult cases when the usual filter-based approach is not enough. AdGuard Extra comes pre-installed in AdGuard standalone apps, except for the one for iOS, so you don't need to do anything to enable it. However, if you want to use it alongside AdGuard Browser Extension or any other ad blocker, you'll need to use an additional extension. Learn more about this userscript and how to install it on [GitHub](https://github.com/AdguardTeam/AdGuardExtra). + +![AdGuard Extra](https://cdn.adtidy.org/content/kb/ad_blocker/general/adguard-extra.png) + +#### AdGuard Popup Blocker + +The name speaks for itself: it blocks popups — one of the most annoying types of ads on websites. Learn more about this userscript, its key features, and installation on [GitHub](https://github.com/AdguardTeam/PopupBlocker). + +![AdGuard Popup Blocker](https://cdn.adtidy.org/content/kb/ad_blocker/general/popup-blocker-installation.png) + +#### AdGuard Assistant (legacy version) + +This custom extension is designed to control filtering directly from the browser page (manual blocking, allowlisting, etc.). + +:::note + +This version of Assistant is legacy and there is no point in using it on new systems, as it has been replaced with the full-fledged [Browser Assistant](https://adguard.com/adguard-assistant/overview.html). However, the legacy Assistant may be useful if there is no Browser Assistant for your browser. If this is your case, you can learn how to install AdGuard Assistant on [GitHub](https://github.com/AdguardTeam/AdguardAssistant). + +::: + +#### Disable AMP + +A script that is only pre-installed in AdGuard for Android. It disables AMP (Accelerated Mobile Pages) on the Google search results page. Learn more about this userscript and how to install it on [GitHub](https://github.com/AdguardTeam/DisableAMP). + +![Disable AMP](https://cdn.adtidy.org/content/kb/ad_blocker/general/disable-amp-installation.png) + +### Top picks outside AdGuard{#top-picks} + +These userscripts are not developed by AdGuard, and therefore we can't give a 100% guarantee that they are safe and/or work at all times. However, in our experience they deserve a recommendation because they've all earned their good reputation. + +#### Don't track me Google + +This script removes Google's tracking feature from the links in Google search results. It speeds up the loading of search results and allows you to right-click or tap to copy the link URL. + +Its source code is [available on GitHub](https://github.com/Rob--W/dont-track-me-google). This userscript can be downloaded from [GreasyFork](https://greasyfork.org/en/scripts/428243-don-t-track-me-google) and installed in any AdGuard CoreLibs-based app. + +#### microShield + +A userscript for people visiting Korean websites and some international websites. The microShield userscript blocks Ad-Shield ads and anti-adblocks. Its original source code is available at [asdefuser](https://github.com/seia-soto/userscripts/tree/master/sources/asdefuser) and [AdShield Defuser](https://github.com/seia-soto/adshield-defuser). This userscript can be installed in AdGuard CoreLibs-based apps, Violentmonkey, Tampermonkey, and [quoid/userscripts](https://github.com/quoid/userscripts). Learn more about microShield and how to install it on [GitHub](https://github.com/List-KR/microShield). + +### Where can you get more userscripts?{#more-userscripts} + +Since userscripts are mainly created by enthusiasts, you should be cautious when installing them. Any script from an unknown source carries a potential risk. Yet, there is a great variety of interesting scripts that, if installed carefully and responsibly, can really make using some websites more convenient. + +Here we will describe some of the most popular userscript catalogs. + +#### Userscript.Zone + +[Userscript.Zone](https://www.userscript.zone) is a website that allows searching for userscripts by entering a matching URL or domain. The website is easy to use and has a high level of credibility as only scripts from moderated pages are displayed. + +#### Greasy Fork + +[Greasy Fork](https://greasyfork.org/) is a userscript catalog of Stylish creators. The scripts in this catalog are moderated, so their credibility is much higher. + +#### OpenUserJS.org + +[OpenUserJS.org](https://openuserjs.org/) is an open-source userscript catalog written in nodeJS. It's not moderated, so keep an eye out for suspicious scripts. + +#### Community + +If you like the idea of customizing your browser with userscripts and have questions, you can ask them on one of these websites: + +- [Stackoverflow](https://stackoverflow.com/questions/tagged/userscripts) +- [FreeNode](https://webchat.freenode.net/#greasemonkey) +- [Reddit](https://www.reddit.com/r/userscripts/) + +### Development + +#### Request license + +If you are developing your own custom script and want to test how it works with AdGuard, you can request a beta license key for the app. + +To get it, please send an email to devteam@adguard.com with the following information: + +**Subject:** Userscript author license request + +**Body:** Please tell us about the userscripts you are working on. + +Here is a [mailto link](mailto:devteam@adguard.com?Subject=Userscript%20author%20license%20request\&Body=Hello%2C%0A%0AMy%20userscript%28s%29%3A%20LINK). + +#### Compatibility + +#### Metadata block + +#### Supported properties + +```text +@name +@namespace +@description +@version +@match +@include +@exclude +@grant +@connect +@require +@resource +@downloadURL +@updateURL +@supportURL +@homepageURL +@homepage +@website +@source +@run-at +@noframes +@icon +@iconURL +@defaulticon +@icon64 +@icon64URL +``` + +#### Unsupported properties + +These properties will be simply ignored by AdGuard. + +```text +@unwrap +``` + +#### Supported GM functions + +AdGuard supports both old GM\_ functions and new GM4 API that use GM object. + +#### Values + +:::note + +All listed old Greasemonkey functions are deprecated but still supported. + +::: + +```text +GM.info / GM_info +GM.setValue / GM_setValue +GM.getValue / GM_getValue +GM.listValues / GM_listValues +GM.deleteValue / GM_deleteValue +GM.getResourceUrl / GM_getResourceURL +GM.setClipboard / GM_setClipboard +GM.xmlHttpRequest / GM_xmlhttpRequest +GM.openInTab / GM_openInTab +GM.notification +unsafeWindow +GM_getResourceText +GM_addStyle +GM_log +``` + +[Here](https://wiki.greasespot.net/GM.info) you can find more information about Greasemonkey API. + +#### Example + +```javascript +// ==UserScript== +// @name Name as shown to the user when locale is english or unknown +// @name:ru Name as shown to the user when locale is russian +// @description Description as shown to the user when locale is english or unknown +// @description:ru Description as shown to the user when locale is russian +// @icon https://myhomepage.com/myuserscript.png +// @version 1.0.0.0 +// @downloadURL https://dl.myhomepage.org/myuserscript.user.js +// @updateURL https://dl.myhomepage.org/myuserscript.meta.js +// @homepageURL https://myhomepage.com/myuserscript +// @include * +// @exclude *://website.com/* +// @resource https://myhomepage.com/myuserscript.css +// @require https://myhomepage.com/mylibrary.js +// @grant property:settings +// @grant GM_getValue +// @grant GM_setValue +// @grant GM_deleteValue +// @grant GM_listValues +// @grant GM_getResourceText +// @grant GM_getResourceURL +// @grant GM_addStyle +// @grant GM_log +// @grant GM_setClipboard +// @grant GM_xmlhttpRequest +// @grant unsafeWindow +// @grant GM_info +// @grant GM_openInTab +// @grant GM_registerMenuCommand +// @run-at document-start +// ==/UserScript== +!function(){( + console.log("I am loaded!"); +)}(); +``` + +## Userstyles + +Userstyles allow users to customize their online experience. Whether you’re looking to change the appearance of a website or automate repetitive tasks, styles offer a world of possibilities. + +AdGuard has the option to upload or create your own userstyles. This is an advanced feature, so you will need some knowledge of HTML and CSS. + +:::info Supported apps + +Currently, two AdGuard apps allow you to create and manage userstyles: AdGuard for Windows (v7.19 or later) and AdGuard for Mac (v2.16 or later). We also plan to implement this new feature in AdGuard v4.8 for Android in the nearest future. + +::: + +This is an experimental feature, so if you encounter any problems while adding or creating a userstyle, please contact our support team at . + +### How to set up a userstyle in AdGuard + +You can download userstyles from various websites. One of the most popular userstyle websites is [https://userstyles.world/](https://userstyles.world/explore), which we will use as an example for the following instructions on how to set up the userstyle in AdGuard. + +1. Follow the link above and choose the userstyle you like + +2. Right-click the _Install_ button and choose _Copy Link Address_ + +3. Open AdGuard settings → _Extensions_ + +4. Press the [+] button and paste the userstyle link + +5. Done! + +If you’re familiar with CSS rules, you can also create the userstyles yourself. + +:::note + +We don’t support userstyles that contain `@var` or `@advanced` in the metadata. AdGuard also doesn’t support `@preprocessor` without the `default` value. + +::: + +1. Open AdGuard settings → _Extensions_ + +2. Press the [+] button and choose the _Create userstyle_ option. A new window will appear on your screen + +3. To create a userstyle, first write the title with metadata, for example + + ```CSS + /* ==UserStyle== + @name New userstyle + @version 1.0 + ==/UserStyle== */ + ``` + +4. Write the CSS part after the meta data. AdGuard supports website domain names matching (`@-moz-document domain(…), …`). For example: + + ```CSS + body { + background: gray; + } + ``` + + Or: + + ```CSS + @-moz-document domain('example.org'), + domain('example.net'), + domain('example.com') body { + background: gray; + } + ``` + +5. Once you’re finished, press _Save and Close_. Your new userstyle has been successfully added to AdGuard + +### Example + +```css +/* ==UserStyle== +@name Example userstyle +@namespace https://example.org/userstyle +@homepageURL https://example.org/userstyle +@version 1.0.0 +@license Other +@description This is an example +@author example +@preprocessor default +==/UserStyle== */ +@-moz-document regexp("https?\:\/\/(www\.)?example\.(org|com).*") { + body { + background-color: #000000 !important; + } +} +``` diff --git a/i18n/ro/docusaurus-plugin-content-docs/current/general/how-to-install.md b/i18n/ro/docusaurus-plugin-content-docs/current/general/how-to-install.md index bae3060668a..106a29529a8 100644 --- a/i18n/ro/docusaurus-plugin-content-docs/current/general/how-to-install.md +++ b/i18n/ro/docusaurus-plugin-content-docs/current/general/how-to-install.md @@ -1,6 +1,6 @@ --- title: How to install AdGuard -sidebar_position: 8 +sidebar_position: 9 --- Depending on which AdGuard app or browser extension you want to install, follow one of these links to find the relevant article: diff --git a/i18n/ru/docusaurus-plugin-content-docs/current/adguard-for-windows/features/extensions.md b/i18n/ru/docusaurus-plugin-content-docs/current/adguard-for-windows/features/extensions.md index 19f8c1d65d3..b1abe4927f8 100644 --- a/i18n/ru/docusaurus-plugin-content-docs/current/adguard-for-windows/features/extensions.md +++ b/i18n/ru/docusaurus-plugin-content-docs/current/adguard-for-windows/features/extensions.md @@ -9,7 +9,7 @@ sidebar_position: 3 ::: -AdGuard может значительно расширить функциональность сайта, работая в качестве [менеджера пользовательских скриптов](/general/extensions). Пользователи AdGuard могут добавлять собственные скрипты, а также управлять существующими. +AdGuard can significantly extend website functionality by working as a [userscript manager](/general/extensions.md). AdGuard users can add their own scripts as well as manage existing ones. ![Extensions \*mobile\_border](https://cdn.adtidy.org/content/kb/ad_blocker/windows/overview/userscripts.png) diff --git a/i18n/ru/docusaurus-plugin-content-docs/current/general/extensions.md b/i18n/ru/docusaurus-plugin-content-docs/current/general/extensions.md new file mode 100644 index 00000000000..467aac420ce --- /dev/null +++ b/i18n/ru/docusaurus-plugin-content-docs/current/general/extensions.md @@ -0,0 +1,301 @@ +--- +title: Расширения +sidebar_position: 6 +--- + +## Пользовательские скрипты + +Пользовательские скрипты (мы также называем их «‎расширениями»‎) — это мини-программы, написанные на языке JavaScript. Они модифицируют или расширяют функциональность одного или нескольких сайтов. Многие пользователи AdGuard уже наверняка знакомы с такими расширениями, как Помощник AdGuard, Блокировщик всплывающей рекламы и AdGuard Extra. + +:::note Supported apps + +AdGuard может значительно расширять функциональность сайтов, работая как менеджер пользовательских скриптов. You can add your custom scripts or manage the existing ones in our three products: [AdGuard for Windows](/adguard-for-windows/features/extensions), [AdGuard for Android](/adguard-for-android/features/settings#userscripts), and [AdGuard for Mac](/adguard-for-mac/features/extensions). + +::: + +### Рекомендуемые скрипты AdGuard + +Эти пользовательские скрипты разработаны в AdGuard, и мы можем гарантировать, что они эффективны и безопасны. For some of the userscripts developed by others that we consider good and reliable, [scroll down to the next section](#top-picks). You can also find some of the [popular websites with scripts](#more-userscripts) below, but remember that whenever you download a userscript from an unknown source, you are exposing yourself to a certain risk, as some scripts may be harmful to your computer. + +#### AdGuard Extra + +Расширение, которое блокирует рекламу в сложных случаях, когда привычного подхода, основанного на фильтрах, недостаточно. AdGuard Extra comes pre-installed in AdGuard standalone apps, except for the one for iOS, so you don't need to do anything to enable it. Однако, если вы хотите использовать его вместе с Браузерным расширением AdGuard или любым другим блокировщиком рекламы, вам понадобится дополнительное расширение. Learn more about this userscript and how to install it on [GitHub](https://github.com/AdguardTeam/AdGuardExtra). + +![AdGuard Extra](https://cdn.adtidy.org/content/kb/ad_blocker/general/adguard-extra.png) + +#### Блокировщик всплывающих окон + +The name speaks for itself: it blocks popups — one of the most annoying types of ads on websites. Learn more about this userscript, its key features, and installation on [GitHub](https://github.com/AdguardTeam/PopupBlocker). + +![AdGuard Popup Blocker](https://cdn.adtidy.org/content/kb/ad_blocker/general/popup-blocker-installation.png) + +#### Помощник AdGuard (устаревшая версия) + +This custom extension is designed to control filtering directly from the browser page (manual blocking, allowlisting, etc.). + +:::note + +This version of Assistant is legacy and there is no point in using it on new systems, as it has been replaced with the full-fledged [Browser Assistant](https://adguard.com/adguard-assistant/overview.html). However, the legacy Assistant may be useful if there is no Browser Assistant for your browser. If this is your case, you can learn how to install AdGuard Assistant on [GitHub](https://github.com/AdguardTeam/AdguardAssistant). + +::: + +#### Отключить AMP + +Скрипт, который предустановлен только в AdGuard для Android. Он отключает AMP (Accelerated Mobile Pages или «ускоренные мобильные страницы») на странице результатов поиска Google. Learn more about this userscript and how to install it on [GitHub](https://github.com/AdguardTeam/DisableAMP). + +![Disable AMP](https://cdn.adtidy.org/content/kb/ad_blocker/general/disable-amp-installation.png) + +### Лучшие варианты вне AdGuard{#top-picks} + +These userscripts are not developed by AdGuard, and therefore we can't give a 100% guarantee that they are safe and/or work at all times. However, in our experience they deserve a recommendation because they've all earned their good reputation. + +#### Don't track me Google + +Этот скрипт удаляет функцию отслеживания Google из ссылок в результатах поиска Google. Это ускоряет загрузку результатов поиска и позволяет скопировать URL-адрес ссылки, щёлкнув по нему правой кнопкой мыши или нажав на него. + +Its source code is [available on GitHub](https://github.com/Rob--W/dont-track-me-google). This userscript can be downloaded from [GreasyFork](https://greasyfork.org/en/scripts/428243-don-t-track-me-google) and installed in any AdGuard CoreLibs-based app. + +#### microShield + +A userscript for people visiting Korean websites and some international websites. The microShield userscript blocks Ad-Shield ads and anti-adblocks. Its original source code is available at [asdefuser](https://github.com/seia-soto/userscripts/tree/master/sources/asdefuser) and [AdShield Defuser](https://github.com/seia-soto/adshield-defuser). This userscript can be installed in AdGuard CoreLibs-based apps, Violentmonkey, Tampermonkey, and [quoid/userscripts](https://github.com/quoid/userscripts). Learn more about microShield and how to install it on [GitHub](https://github.com/List-KR/microShield). + +### Где взять больше пользовательских скриптов{#more-userscripts} + +Since userscripts are mainly created by enthusiasts, you should be cautious when installing them. Любой скрипт из неизвестного источника несёт в себе потенциальный риск. Тем не менее, существует огромное количество интересных скриптов, которые, если установить их аккуратно и ответственно, могут действительно сделать использование некоторых сайтов более удобным. + +Здесь мы опишем несколько популярных каталогов пользовательских скриптов. + +#### Userscript.Zone + +[Userscript.Zone](https://www.userscript.zone) is a website that allows searching for userscripts by entering a matching URL or domain. The website is easy to use and has a high level of credibility as only scripts from moderated pages are displayed. + +#### Greasy Fork + +[Greasy Fork](https://greasyfork.org/) is a userscript catalog of Stylish creators. The scripts in this catalog are moderated, so their credibility is much higher. + +#### OpenUserJS.org + +[OpenUserJS.org](https://openuserjs.org/) is an open-source userscript catalog written in nodeJS. It's not moderated, so keep an eye out for suspicious scripts. + +#### Сообщество + +If you like the idea of customizing your browser with userscripts and have questions, you can ask them on one of these websites: + +- [Stackoverflow](https://stackoverflow.com/questions/tagged/userscripts) +- [FreeNode](https://webchat.freenode.net/#greasemonkey) +- [Reddit](https://www.reddit.com/r/userscripts/) + +### Разработка + +#### Запросить лицензию + +If you are developing your own custom script and want to test how it works with AdGuard, you can request a beta license key for the app. + +Для этого отправьте нам сообщение devteam@adguard.com со следующей информацией: + +**Subject:** Userscript author license request + +**Body:** Please tell us about the userscripts you are working on. + +Here is a [mailto link](mailto:devteam@adguard.com?Subject=Userscript%20author%20license%20request\&Body=Hello%2C%0A%0AMy%20userscript%28s%29%3A%20LINK). + +#### Совместимость + +#### Блок метаданных + +#### Поддерживаемые свойства + +```text +@name +@namespace +@description +@version +@match +@include +@exclude +@grant +@connect +@require +@resource +@downloadURL +@updateURL +@supportURL +@homepageURL +@homepage +@website +@source +@run-at +@noframes +@icon +@iconURL +@defaulticon +@icon64 +@icon64URL +``` + +#### Неподдерживаемые свойства + +AdGuard проигнорирует эти свойства. + +```text +@unwrap +``` + +#### Поддерживаемые функции GM + +AdGuard поддерживает как старые функции GM\_, так и новый GM4 API, использующий объект GM. + +#### Значения + +:::note + +Все перечисленные функции Greasemonkey устарели, но всё ещё поддерживаются. + +::: + +```text +GM.info / GM_info +GM.setValue / GM_setValue +GM.getValue / GM_getValue +GM.listValues / GM_listValues +GM.deleteValue / GM_deleteValue +GM.getResourceUrl / GM_getResourceURL +GM.setClipboard / GM_setClipboard +GM.xmlHttpRequest / GM_xmlhttpRequest +GM.openInTab / GM_openInTab +GM.notification +unsafeWindow +GM_getResourceText +GM_addStyle +GM_log +``` + +[Here](https://wiki.greasespot.net/GM.info) you can find more information about Greasemonkey API. + +#### Пример + +```javascript +// ==UserScript== +// @name Имя, которое показывается пользователю, если локаль английская или неизвестна +// @name:ru Имя, которое показывается пользователю, если локаль русская +// @description Описание, которое показывается пользователю, если локаль английская или неизвестна +// @description:ru Описание, которое показывается пользователю, если локаль русская +// @icon https://myhomepage.com/myuserscript.png +// @version 1.0.0.0 +// @downloadURL https://dl.myhomepage.org/myuserscript.user.js +// @updateURL https://dl.myhomepage.org/myuserscript.meta.js +// @homepageURL https://myhomepage. com/myuserscript +// @include * +// @exclude *://website.com/* +// @resource https://myhomepage.com/myuserscript.css +// @require https://myhomepage. com/mylibrary.js +// @grant свойство: настройки +// @grant GM_getValue +// @grant GM_setValue +// @grant GM_deleteValue +// @grant GM_listValues +// @grant GM_getResourceText +// @grant GM_getResourceURL +// @grant GM_addStyle +// @grant GM_log +// @grant GM_setClipboard +// @grant GM_xmlhttpRequest +// @grant unsafeWindow +// @grant GM_info +// @grant GM_openInTab +// @grant GM_registerMenuCommand +// @run-at document-start +// ==/UserScript== +! function(){( + console.log("I am loaded!"); +)}(); +``` + +## Пользовательские стили + +Userstyles allow users to customize their online experience. Whether you’re looking to change the appearance of a website or automate repetitive tasks, styles offer a world of possibilities. + +AdGuard has the option to upload or create your own userstyles. This is an advanced feature, so you will need some knowledge of HTML and CSS. + +:::info Supported apps + +Currently, two AdGuard apps allow you to create and manage userstyles: AdGuard for Windows (v7.19 or later) and AdGuard for Mac (v2.16 or later). We also plan to implement this new feature in AdGuard v4.8 for Android in the nearest future. + +::: + +This is an experimental feature, so if you encounter any problems while adding or creating a userstyle, please contact our support team at . + +### How to set up a userstyle in AdGuard + +You can download userstyles from various websites. One of the most popular userstyle websites is [https://userstyles.world/](https://userstyles.world/explore), which we will use as an example for the following instructions on how to set up the userstyle in AdGuard. + +1. Follow the link above and choose the userstyle you like + +2. Right-click the _Install_ button and choose _Copy Link Address_ + +3. Open AdGuard settings → _Extensions_ + +4. Press the [+] button and paste the userstyle link + +5. Готово! + +If you’re familiar with CSS rules, you can also create the userstyles yourself. + +:::note + +We don’t support userstyles that contain `@var` or `@advanced` in the metadata. AdGuard also doesn’t support `@preprocessor` without the `default` value. + +::: + +1. Open AdGuard settings → _Extensions_ + +2. Press the [+] button and choose the _Create userstyle_ option. A new window will appear on your screen + +3. To create a userstyle, first write the title with metadata, for example + + ```CSS + /* ==UserStyle== + @name New userstyle + @version 1.0 + ==/UserStyle== */ + ``` + +4. Write the CSS part after the meta data. AdGuard supports website domain names matching (`@-moz-document domain(…), …`). Например: + + ```CSS + body { + background: gray; + } + ``` + + Or: + + ```CSS + @-moz-document domain('example.org'), + domain('example.net'), + domain('example.com') body { + background: gray; + } + ``` + +5. Once you’re finished, press _Save and Close_. Your new userstyle has been successfully added to AdGuard + +### Пример + +```css +/* ==UserStyle== +@name Example userstyle +@namespace https://example.org/userstyle +@homepageURL https://example.org/userstyle +@version 1.0.0 +@license Other +@description This is an example +@author example +@preprocessor default +==/UserStyle== */ +@-moz-document regexp("https?\:\/\/(www\.)?example\.(org|com).*") { + body { + background-color: #000000 !important; + } +} +``` diff --git a/i18n/ru/docusaurus-plugin-content-docs/current/general/how-to-install.md b/i18n/ru/docusaurus-plugin-content-docs/current/general/how-to-install.md index 3cb909f4404..a6c4014b4d3 100644 --- a/i18n/ru/docusaurus-plugin-content-docs/current/general/how-to-install.md +++ b/i18n/ru/docusaurus-plugin-content-docs/current/general/how-to-install.md @@ -1,6 +1,6 @@ --- title: Как установить AdGuard -sidebar_position: 8 +sidebar_position: 9 --- В зависимости от того, какое приложение или браузерное расширение AdGuard вы хотите установить, перейдите по одной из этих ссылок и найдите соответствующую инструкцию: diff --git a/i18n/sk/docusaurus-plugin-content-docs/current/adguard-for-windows/features/extensions.md b/i18n/sk/docusaurus-plugin-content-docs/current/adguard-for-windows/features/extensions.md index 260fa0e83b3..17884a6df33 100644 --- a/i18n/sk/docusaurus-plugin-content-docs/current/adguard-for-windows/features/extensions.md +++ b/i18n/sk/docusaurus-plugin-content-docs/current/adguard-for-windows/features/extensions.md @@ -9,7 +9,7 @@ This article covers AdGuard for Windows, a multifunctional ad blocker that prote ::: -AdGuard can significantly broaden website functionality working as a [user script manager](/general/extensions). AdGuard Users can add their own scripts, as well as manage existing ones. +AdGuard can significantly extend website functionality by working as a [userscript manager](/general/extensions.md). AdGuard users can add their own scripts as well as manage existing ones. ![Extensions \*mobile\_border](https://cdn.adtidy.org/content/kb/ad_blocker/windows/overview/userscripts.png) diff --git a/i18n/sk/docusaurus-plugin-content-docs/current/general/extensions.md b/i18n/sk/docusaurus-plugin-content-docs/current/general/extensions.md new file mode 100644 index 00000000000..0cf454b4329 --- /dev/null +++ b/i18n/sk/docusaurus-plugin-content-docs/current/general/extensions.md @@ -0,0 +1,301 @@ +--- +title: Extensions +sidebar_position: 6 +--- + +## Userscripts + +Userscripts (we also call them "extensions") are, de facto, miniprograms written in JavaScript. They modify or extend the functionality of one or more websites. Many AdGuard users may be already familiar with such userscripts as AdGuard Assistant, Popup Blocker, and AdGuard Extra. + +:::note Supported apps + +AdGuard can significantly broaden website functionality by acting as a userscript manager. You can add your custom scripts or manage the existing ones in our three products: [AdGuard for Windows](/adguard-for-windows/features/extensions), [AdGuard for Android](/adguard-for-android/features/settings#userscripts), and [AdGuard for Mac](/adguard-for-mac/features/extensions). + +::: + +### Recommended AdGuard scripts + +These userscripts come directly from the AdGuard developers, and we can guarantee that they are effective and safe. For some of the userscripts developed by others that we consider good and reliable, [scroll down to the next section](#top-picks). You can also find some of the [popular websites with scripts](#more-userscripts) below, but remember that whenever you download a userscript from an unknown source, you are exposing yourself to a certain risk, as some scripts may be harmful to your computer. + +#### AdGuard Extra + +An extension that blocks ads in difficult cases when the usual filter-based approach is not enough. AdGuard Extra comes pre-installed in AdGuard standalone apps, except for the one for iOS, so you don't need to do anything to enable it. However, if you want to use it alongside AdGuard Browser Extension or any other ad blocker, you'll need to use an additional extension. Learn more about this userscript and how to install it on [GitHub](https://github.com/AdguardTeam/AdGuardExtra). + +![AdGuard Extra](https://cdn.adtidy.org/content/kb/ad_blocker/general/adguard-extra.png) + +#### AdGuard Popup Blocker + +The name speaks for itself: it blocks popups — one of the most annoying types of ads on websites. Learn more about this userscript, its key features, and installation on [GitHub](https://github.com/AdguardTeam/PopupBlocker). + +![AdGuard Popup Blocker](https://cdn.adtidy.org/content/kb/ad_blocker/general/popup-blocker-installation.png) + +#### AdGuard Assistant (legacy version) + +This custom extension is designed to control filtering directly from the browser page (manual blocking, allowlisting, etc.). + +:::note + +This version of Assistant is legacy and there is no point in using it on new systems, as it has been replaced with the full-fledged [Browser Assistant](https://adguard.com/adguard-assistant/overview.html). However, the legacy Assistant may be useful if there is no Browser Assistant for your browser. If this is your case, you can learn how to install AdGuard Assistant on [GitHub](https://github.com/AdguardTeam/AdguardAssistant). + +::: + +#### Disable AMP + +A script that is only pre-installed in AdGuard for Android. It disables AMP (Accelerated Mobile Pages) on the Google search results page. Learn more about this userscript and how to install it on [GitHub](https://github.com/AdguardTeam/DisableAMP). + +![Disable AMP](https://cdn.adtidy.org/content/kb/ad_blocker/general/disable-amp-installation.png) + +### Top picks outside AdGuard{#top-picks} + +These userscripts are not developed by AdGuard, and therefore we can't give a 100% guarantee that they are safe and/or work at all times. However, in our experience they deserve a recommendation because they've all earned their good reputation. + +#### Don't track me Google + +This script removes Google's tracking feature from the links in Google search results. It speeds up the loading of search results and allows you to right-click or tap to copy the link URL. + +Its source code is [available on GitHub](https://github.com/Rob--W/dont-track-me-google). This userscript can be downloaded from [GreasyFork](https://greasyfork.org/en/scripts/428243-don-t-track-me-google) and installed in any AdGuard CoreLibs-based app. + +#### microShield + +A userscript for people visiting Korean websites and some international websites. The microShield userscript blocks Ad-Shield ads and anti-adblocks. Its original source code is available at [asdefuser](https://github.com/seia-soto/userscripts/tree/master/sources/asdefuser) and [AdShield Defuser](https://github.com/seia-soto/adshield-defuser). This userscript can be installed in AdGuard CoreLibs-based apps, Violentmonkey, Tampermonkey, and [quoid/userscripts](https://github.com/quoid/userscripts). Learn more about microShield and how to install it on [GitHub](https://github.com/List-KR/microShield). + +### Where can you get more userscripts?{#more-userscripts} + +Since userscripts are mainly created by enthusiasts, you should be cautious when installing them. Any script from an unknown source carries a potential risk. Yet, there is a great variety of interesting scripts that, if installed carefully and responsibly, can really make using some websites more convenient. + +Here we will describe some of the most popular userscript catalogs. + +#### Userscript.Zone + +[Userscript.Zone](https://www.userscript.zone) is a website that allows searching for userscripts by entering a matching URL or domain. The website is easy to use and has a high level of credibility as only scripts from moderated pages are displayed. + +#### Greasy Fork + +[Greasy Fork](https://greasyfork.org/) is a userscript catalog of Stylish creators. The scripts in this catalog are moderated, so their credibility is much higher. + +#### OpenUserJS.org + +[OpenUserJS.org](https://openuserjs.org/) is an open-source userscript catalog written in nodeJS. It's not moderated, so keep an eye out for suspicious scripts. + +#### Community + +If you like the idea of customizing your browser with userscripts and have questions, you can ask them on one of these websites: + +- [Stackoverflow](https://stackoverflow.com/questions/tagged/userscripts) +- [FreeNode](https://webchat.freenode.net/#greasemonkey) +- [Reddit](https://www.reddit.com/r/userscripts/) + +### Development + +#### Request license + +If you are developing your own custom script and want to test how it works with AdGuard, you can request a beta license key for the app. + +To get it, please send an email to devteam@adguard.com with the following information: + +**Subject:** Userscript author license request + +**Body:** Please tell us about the userscripts you are working on. + +Here is a [mailto link](mailto:devteam@adguard.com?Subject=Userscript%20author%20license%20request\&Body=Hello%2C%0A%0AMy%20userscript%28s%29%3A%20LINK). + +#### Compatibility + +#### Metadata block + +#### Supported properties + +```text +@name +@namespace +@description +@version +@match +@include +@exclude +@grant +@connect +@require +@resource +@downloadURL +@updateURL +@supportURL +@homepageURL +@homepage +@website +@source +@run-at +@noframes +@icon +@iconURL +@defaulticon +@icon64 +@icon64URL +``` + +#### Unsupported properties + +These properties will be simply ignored by AdGuard. + +```text +@unwrap +``` + +#### Supported GM functions + +AdGuard supports both old GM\_ functions and new GM4 API that use GM object. + +#### Values + +:::note + +All listed old Greasemonkey functions are deprecated but still supported. + +::: + +```text +GM.info / GM_info +GM.setValue / GM_setValue +GM.getValue / GM_getValue +GM.listValues / GM_listValues +GM.deleteValue / GM_deleteValue +GM.getResourceUrl / GM_getResourceURL +GM.setClipboard / GM_setClipboard +GM.xmlHttpRequest / GM_xmlhttpRequest +GM.openInTab / GM_openInTab +GM.notification +unsafeWindow +GM_getResourceText +GM_addStyle +GM_log +``` + +[Here](https://wiki.greasespot.net/GM.info) you can find more information about Greasemonkey API. + +#### Example + +```javascript +// ==UserScript== +// @name Name as shown to the user when locale is english or unknown +// @name:ru Name as shown to the user when locale is russian +// @description Description as shown to the user when locale is english or unknown +// @description:ru Description as shown to the user when locale is russian +// @icon https://myhomepage.com/myuserscript.png +// @version 1.0.0.0 +// @downloadURL https://dl.myhomepage.org/myuserscript.user.js +// @updateURL https://dl.myhomepage.org/myuserscript.meta.js +// @homepageURL https://myhomepage.com/myuserscript +// @include * +// @exclude *://website.com/* +// @resource https://myhomepage.com/myuserscript.css +// @require https://myhomepage.com/mylibrary.js +// @grant property:settings +// @grant GM_getValue +// @grant GM_setValue +// @grant GM_deleteValue +// @grant GM_listValues +// @grant GM_getResourceText +// @grant GM_getResourceURL +// @grant GM_addStyle +// @grant GM_log +// @grant GM_setClipboard +// @grant GM_xmlhttpRequest +// @grant unsafeWindow +// @grant GM_info +// @grant GM_openInTab +// @grant GM_registerMenuCommand +// @run-at document-start +// ==/UserScript== +!function(){( + console.log("I am loaded!"); +)}(); +``` + +## Userstyles + +Userstyles allow users to customize their online experience. Whether you’re looking to change the appearance of a website or automate repetitive tasks, styles offer a world of possibilities. + +AdGuard has the option to upload or create your own userstyles. This is an advanced feature, so you will need some knowledge of HTML and CSS. + +:::info Supported apps + +Currently, two AdGuard apps allow you to create and manage userstyles: AdGuard for Windows (v7.19 or later) and AdGuard for Mac (v2.16 or later). We also plan to implement this new feature in AdGuard v4.8 for Android in the nearest future. + +::: + +This is an experimental feature, so if you encounter any problems while adding or creating a userstyle, please contact our support team at . + +### How to set up a userstyle in AdGuard + +You can download userstyles from various websites. One of the most popular userstyle websites is [https://userstyles.world/](https://userstyles.world/explore), which we will use as an example for the following instructions on how to set up the userstyle in AdGuard. + +1. Follow the link above and choose the userstyle you like + +2. Right-click the _Install_ button and choose _Copy Link Address_ + +3. Open AdGuard settings → _Extensions_ + +4. Press the [+] button and paste the userstyle link + +5. Done! + +If you’re familiar with CSS rules, you can also create the userstyles yourself. + +:::note + +We don’t support userstyles that contain `@var` or `@advanced` in the metadata. AdGuard also doesn’t support `@preprocessor` without the `default` value. + +::: + +1. Open AdGuard settings → _Extensions_ + +2. Press the [+] button and choose the _Create userstyle_ option. A new window will appear on your screen + +3. To create a userstyle, first write the title with metadata, for example + + ```CSS + /* ==UserStyle== + @name New userstyle + @version 1.0 + ==/UserStyle== */ + ``` + +4. Write the CSS part after the meta data. AdGuard supports website domain names matching (`@-moz-document domain(…), …`). For example: + + ```CSS + body { + background: gray; + } + ``` + + Or: + + ```CSS + @-moz-document domain('example.org'), + domain('example.net'), + domain('example.com') body { + background: gray; + } + ``` + +5. Once you’re finished, press _Save and Close_. Your new userstyle has been successfully added to AdGuard + +### Example + +```css +/* ==UserStyle== +@name Example userstyle +@namespace https://example.org/userstyle +@homepageURL https://example.org/userstyle +@version 1.0.0 +@license Other +@description This is an example +@author example +@preprocessor default +==/UserStyle== */ +@-moz-document regexp("https?\:\/\/(www\.)?example\.(org|com).*") { + body { + background-color: #000000 !important; + } +} +``` diff --git a/i18n/sk/docusaurus-plugin-content-docs/current/general/how-to-install.md b/i18n/sk/docusaurus-plugin-content-docs/current/general/how-to-install.md index bae3060668a..106a29529a8 100644 --- a/i18n/sk/docusaurus-plugin-content-docs/current/general/how-to-install.md +++ b/i18n/sk/docusaurus-plugin-content-docs/current/general/how-to-install.md @@ -1,6 +1,6 @@ --- title: How to install AdGuard -sidebar_position: 8 +sidebar_position: 9 --- Depending on which AdGuard app or browser extension you want to install, follow one of these links to find the relevant article: diff --git a/i18n/sl/docusaurus-plugin-content-docs/current/adguard-for-windows/features/extensions.md b/i18n/sl/docusaurus-plugin-content-docs/current/adguard-for-windows/features/extensions.md index 260fa0e83b3..17884a6df33 100644 --- a/i18n/sl/docusaurus-plugin-content-docs/current/adguard-for-windows/features/extensions.md +++ b/i18n/sl/docusaurus-plugin-content-docs/current/adguard-for-windows/features/extensions.md @@ -9,7 +9,7 @@ This article covers AdGuard for Windows, a multifunctional ad blocker that prote ::: -AdGuard can significantly broaden website functionality working as a [user script manager](/general/extensions). AdGuard Users can add their own scripts, as well as manage existing ones. +AdGuard can significantly extend website functionality by working as a [userscript manager](/general/extensions.md). AdGuard users can add their own scripts as well as manage existing ones. ![Extensions \*mobile\_border](https://cdn.adtidy.org/content/kb/ad_blocker/windows/overview/userscripts.png) diff --git a/i18n/sl/docusaurus-plugin-content-docs/current/general/extensions.md b/i18n/sl/docusaurus-plugin-content-docs/current/general/extensions.md new file mode 100644 index 00000000000..0cf454b4329 --- /dev/null +++ b/i18n/sl/docusaurus-plugin-content-docs/current/general/extensions.md @@ -0,0 +1,301 @@ +--- +title: Extensions +sidebar_position: 6 +--- + +## Userscripts + +Userscripts (we also call them "extensions") are, de facto, miniprograms written in JavaScript. They modify or extend the functionality of one or more websites. Many AdGuard users may be already familiar with such userscripts as AdGuard Assistant, Popup Blocker, and AdGuard Extra. + +:::note Supported apps + +AdGuard can significantly broaden website functionality by acting as a userscript manager. You can add your custom scripts or manage the existing ones in our three products: [AdGuard for Windows](/adguard-for-windows/features/extensions), [AdGuard for Android](/adguard-for-android/features/settings#userscripts), and [AdGuard for Mac](/adguard-for-mac/features/extensions). + +::: + +### Recommended AdGuard scripts + +These userscripts come directly from the AdGuard developers, and we can guarantee that they are effective and safe. For some of the userscripts developed by others that we consider good and reliable, [scroll down to the next section](#top-picks). You can also find some of the [popular websites with scripts](#more-userscripts) below, but remember that whenever you download a userscript from an unknown source, you are exposing yourself to a certain risk, as some scripts may be harmful to your computer. + +#### AdGuard Extra + +An extension that blocks ads in difficult cases when the usual filter-based approach is not enough. AdGuard Extra comes pre-installed in AdGuard standalone apps, except for the one for iOS, so you don't need to do anything to enable it. However, if you want to use it alongside AdGuard Browser Extension or any other ad blocker, you'll need to use an additional extension. Learn more about this userscript and how to install it on [GitHub](https://github.com/AdguardTeam/AdGuardExtra). + +![AdGuard Extra](https://cdn.adtidy.org/content/kb/ad_blocker/general/adguard-extra.png) + +#### AdGuard Popup Blocker + +The name speaks for itself: it blocks popups — one of the most annoying types of ads on websites. Learn more about this userscript, its key features, and installation on [GitHub](https://github.com/AdguardTeam/PopupBlocker). + +![AdGuard Popup Blocker](https://cdn.adtidy.org/content/kb/ad_blocker/general/popup-blocker-installation.png) + +#### AdGuard Assistant (legacy version) + +This custom extension is designed to control filtering directly from the browser page (manual blocking, allowlisting, etc.). + +:::note + +This version of Assistant is legacy and there is no point in using it on new systems, as it has been replaced with the full-fledged [Browser Assistant](https://adguard.com/adguard-assistant/overview.html). However, the legacy Assistant may be useful if there is no Browser Assistant for your browser. If this is your case, you can learn how to install AdGuard Assistant on [GitHub](https://github.com/AdguardTeam/AdguardAssistant). + +::: + +#### Disable AMP + +A script that is only pre-installed in AdGuard for Android. It disables AMP (Accelerated Mobile Pages) on the Google search results page. Learn more about this userscript and how to install it on [GitHub](https://github.com/AdguardTeam/DisableAMP). + +![Disable AMP](https://cdn.adtidy.org/content/kb/ad_blocker/general/disable-amp-installation.png) + +### Top picks outside AdGuard{#top-picks} + +These userscripts are not developed by AdGuard, and therefore we can't give a 100% guarantee that they are safe and/or work at all times. However, in our experience they deserve a recommendation because they've all earned their good reputation. + +#### Don't track me Google + +This script removes Google's tracking feature from the links in Google search results. It speeds up the loading of search results and allows you to right-click or tap to copy the link URL. + +Its source code is [available on GitHub](https://github.com/Rob--W/dont-track-me-google). This userscript can be downloaded from [GreasyFork](https://greasyfork.org/en/scripts/428243-don-t-track-me-google) and installed in any AdGuard CoreLibs-based app. + +#### microShield + +A userscript for people visiting Korean websites and some international websites. The microShield userscript blocks Ad-Shield ads and anti-adblocks. Its original source code is available at [asdefuser](https://github.com/seia-soto/userscripts/tree/master/sources/asdefuser) and [AdShield Defuser](https://github.com/seia-soto/adshield-defuser). This userscript can be installed in AdGuard CoreLibs-based apps, Violentmonkey, Tampermonkey, and [quoid/userscripts](https://github.com/quoid/userscripts). Learn more about microShield and how to install it on [GitHub](https://github.com/List-KR/microShield). + +### Where can you get more userscripts?{#more-userscripts} + +Since userscripts are mainly created by enthusiasts, you should be cautious when installing them. Any script from an unknown source carries a potential risk. Yet, there is a great variety of interesting scripts that, if installed carefully and responsibly, can really make using some websites more convenient. + +Here we will describe some of the most popular userscript catalogs. + +#### Userscript.Zone + +[Userscript.Zone](https://www.userscript.zone) is a website that allows searching for userscripts by entering a matching URL or domain. The website is easy to use and has a high level of credibility as only scripts from moderated pages are displayed. + +#### Greasy Fork + +[Greasy Fork](https://greasyfork.org/) is a userscript catalog of Stylish creators. The scripts in this catalog are moderated, so their credibility is much higher. + +#### OpenUserJS.org + +[OpenUserJS.org](https://openuserjs.org/) is an open-source userscript catalog written in nodeJS. It's not moderated, so keep an eye out for suspicious scripts. + +#### Community + +If you like the idea of customizing your browser with userscripts and have questions, you can ask them on one of these websites: + +- [Stackoverflow](https://stackoverflow.com/questions/tagged/userscripts) +- [FreeNode](https://webchat.freenode.net/#greasemonkey) +- [Reddit](https://www.reddit.com/r/userscripts/) + +### Development + +#### Request license + +If you are developing your own custom script and want to test how it works with AdGuard, you can request a beta license key for the app. + +To get it, please send an email to devteam@adguard.com with the following information: + +**Subject:** Userscript author license request + +**Body:** Please tell us about the userscripts you are working on. + +Here is a [mailto link](mailto:devteam@adguard.com?Subject=Userscript%20author%20license%20request\&Body=Hello%2C%0A%0AMy%20userscript%28s%29%3A%20LINK). + +#### Compatibility + +#### Metadata block + +#### Supported properties + +```text +@name +@namespace +@description +@version +@match +@include +@exclude +@grant +@connect +@require +@resource +@downloadURL +@updateURL +@supportURL +@homepageURL +@homepage +@website +@source +@run-at +@noframes +@icon +@iconURL +@defaulticon +@icon64 +@icon64URL +``` + +#### Unsupported properties + +These properties will be simply ignored by AdGuard. + +```text +@unwrap +``` + +#### Supported GM functions + +AdGuard supports both old GM\_ functions and new GM4 API that use GM object. + +#### Values + +:::note + +All listed old Greasemonkey functions are deprecated but still supported. + +::: + +```text +GM.info / GM_info +GM.setValue / GM_setValue +GM.getValue / GM_getValue +GM.listValues / GM_listValues +GM.deleteValue / GM_deleteValue +GM.getResourceUrl / GM_getResourceURL +GM.setClipboard / GM_setClipboard +GM.xmlHttpRequest / GM_xmlhttpRequest +GM.openInTab / GM_openInTab +GM.notification +unsafeWindow +GM_getResourceText +GM_addStyle +GM_log +``` + +[Here](https://wiki.greasespot.net/GM.info) you can find more information about Greasemonkey API. + +#### Example + +```javascript +// ==UserScript== +// @name Name as shown to the user when locale is english or unknown +// @name:ru Name as shown to the user when locale is russian +// @description Description as shown to the user when locale is english or unknown +// @description:ru Description as shown to the user when locale is russian +// @icon https://myhomepage.com/myuserscript.png +// @version 1.0.0.0 +// @downloadURL https://dl.myhomepage.org/myuserscript.user.js +// @updateURL https://dl.myhomepage.org/myuserscript.meta.js +// @homepageURL https://myhomepage.com/myuserscript +// @include * +// @exclude *://website.com/* +// @resource https://myhomepage.com/myuserscript.css +// @require https://myhomepage.com/mylibrary.js +// @grant property:settings +// @grant GM_getValue +// @grant GM_setValue +// @grant GM_deleteValue +// @grant GM_listValues +// @grant GM_getResourceText +// @grant GM_getResourceURL +// @grant GM_addStyle +// @grant GM_log +// @grant GM_setClipboard +// @grant GM_xmlhttpRequest +// @grant unsafeWindow +// @grant GM_info +// @grant GM_openInTab +// @grant GM_registerMenuCommand +// @run-at document-start +// ==/UserScript== +!function(){( + console.log("I am loaded!"); +)}(); +``` + +## Userstyles + +Userstyles allow users to customize their online experience. Whether you’re looking to change the appearance of a website or automate repetitive tasks, styles offer a world of possibilities. + +AdGuard has the option to upload or create your own userstyles. This is an advanced feature, so you will need some knowledge of HTML and CSS. + +:::info Supported apps + +Currently, two AdGuard apps allow you to create and manage userstyles: AdGuard for Windows (v7.19 or later) and AdGuard for Mac (v2.16 or later). We also plan to implement this new feature in AdGuard v4.8 for Android in the nearest future. + +::: + +This is an experimental feature, so if you encounter any problems while adding or creating a userstyle, please contact our support team at . + +### How to set up a userstyle in AdGuard + +You can download userstyles from various websites. One of the most popular userstyle websites is [https://userstyles.world/](https://userstyles.world/explore), which we will use as an example for the following instructions on how to set up the userstyle in AdGuard. + +1. Follow the link above and choose the userstyle you like + +2. Right-click the _Install_ button and choose _Copy Link Address_ + +3. Open AdGuard settings → _Extensions_ + +4. Press the [+] button and paste the userstyle link + +5. Done! + +If you’re familiar with CSS rules, you can also create the userstyles yourself. + +:::note + +We don’t support userstyles that contain `@var` or `@advanced` in the metadata. AdGuard also doesn’t support `@preprocessor` without the `default` value. + +::: + +1. Open AdGuard settings → _Extensions_ + +2. Press the [+] button and choose the _Create userstyle_ option. A new window will appear on your screen + +3. To create a userstyle, first write the title with metadata, for example + + ```CSS + /* ==UserStyle== + @name New userstyle + @version 1.0 + ==/UserStyle== */ + ``` + +4. Write the CSS part after the meta data. AdGuard supports website domain names matching (`@-moz-document domain(…), …`). For example: + + ```CSS + body { + background: gray; + } + ``` + + Or: + + ```CSS + @-moz-document domain('example.org'), + domain('example.net'), + domain('example.com') body { + background: gray; + } + ``` + +5. Once you’re finished, press _Save and Close_. Your new userstyle has been successfully added to AdGuard + +### Example + +```css +/* ==UserStyle== +@name Example userstyle +@namespace https://example.org/userstyle +@homepageURL https://example.org/userstyle +@version 1.0.0 +@license Other +@description This is an example +@author example +@preprocessor default +==/UserStyle== */ +@-moz-document regexp("https?\:\/\/(www\.)?example\.(org|com).*") { + body { + background-color: #000000 !important; + } +} +``` diff --git a/i18n/sl/docusaurus-plugin-content-docs/current/general/how-to-install.md b/i18n/sl/docusaurus-plugin-content-docs/current/general/how-to-install.md index bae3060668a..106a29529a8 100644 --- a/i18n/sl/docusaurus-plugin-content-docs/current/general/how-to-install.md +++ b/i18n/sl/docusaurus-plugin-content-docs/current/general/how-to-install.md @@ -1,6 +1,6 @@ --- title: How to install AdGuard -sidebar_position: 8 +sidebar_position: 9 --- Depending on which AdGuard app or browser extension you want to install, follow one of these links to find the relevant article: diff --git a/i18n/sv/docusaurus-plugin-content-docs/current/adguard-for-windows/features/extensions.md b/i18n/sv/docusaurus-plugin-content-docs/current/adguard-for-windows/features/extensions.md index 260fa0e83b3..17884a6df33 100644 --- a/i18n/sv/docusaurus-plugin-content-docs/current/adguard-for-windows/features/extensions.md +++ b/i18n/sv/docusaurus-plugin-content-docs/current/adguard-for-windows/features/extensions.md @@ -9,7 +9,7 @@ This article covers AdGuard for Windows, a multifunctional ad blocker that prote ::: -AdGuard can significantly broaden website functionality working as a [user script manager](/general/extensions). AdGuard Users can add their own scripts, as well as manage existing ones. +AdGuard can significantly extend website functionality by working as a [userscript manager](/general/extensions.md). AdGuard users can add their own scripts as well as manage existing ones. ![Extensions \*mobile\_border](https://cdn.adtidy.org/content/kb/ad_blocker/windows/overview/userscripts.png) diff --git a/i18n/sv/docusaurus-plugin-content-docs/current/general/extensions.md b/i18n/sv/docusaurus-plugin-content-docs/current/general/extensions.md new file mode 100644 index 00000000000..0cf454b4329 --- /dev/null +++ b/i18n/sv/docusaurus-plugin-content-docs/current/general/extensions.md @@ -0,0 +1,301 @@ +--- +title: Extensions +sidebar_position: 6 +--- + +## Userscripts + +Userscripts (we also call them "extensions") are, de facto, miniprograms written in JavaScript. They modify or extend the functionality of one or more websites. Many AdGuard users may be already familiar with such userscripts as AdGuard Assistant, Popup Blocker, and AdGuard Extra. + +:::note Supported apps + +AdGuard can significantly broaden website functionality by acting as a userscript manager. You can add your custom scripts or manage the existing ones in our three products: [AdGuard for Windows](/adguard-for-windows/features/extensions), [AdGuard for Android](/adguard-for-android/features/settings#userscripts), and [AdGuard for Mac](/adguard-for-mac/features/extensions). + +::: + +### Recommended AdGuard scripts + +These userscripts come directly from the AdGuard developers, and we can guarantee that they are effective and safe. For some of the userscripts developed by others that we consider good and reliable, [scroll down to the next section](#top-picks). You can also find some of the [popular websites with scripts](#more-userscripts) below, but remember that whenever you download a userscript from an unknown source, you are exposing yourself to a certain risk, as some scripts may be harmful to your computer. + +#### AdGuard Extra + +An extension that blocks ads in difficult cases when the usual filter-based approach is not enough. AdGuard Extra comes pre-installed in AdGuard standalone apps, except for the one for iOS, so you don't need to do anything to enable it. However, if you want to use it alongside AdGuard Browser Extension or any other ad blocker, you'll need to use an additional extension. Learn more about this userscript and how to install it on [GitHub](https://github.com/AdguardTeam/AdGuardExtra). + +![AdGuard Extra](https://cdn.adtidy.org/content/kb/ad_blocker/general/adguard-extra.png) + +#### AdGuard Popup Blocker + +The name speaks for itself: it blocks popups — one of the most annoying types of ads on websites. Learn more about this userscript, its key features, and installation on [GitHub](https://github.com/AdguardTeam/PopupBlocker). + +![AdGuard Popup Blocker](https://cdn.adtidy.org/content/kb/ad_blocker/general/popup-blocker-installation.png) + +#### AdGuard Assistant (legacy version) + +This custom extension is designed to control filtering directly from the browser page (manual blocking, allowlisting, etc.). + +:::note + +This version of Assistant is legacy and there is no point in using it on new systems, as it has been replaced with the full-fledged [Browser Assistant](https://adguard.com/adguard-assistant/overview.html). However, the legacy Assistant may be useful if there is no Browser Assistant for your browser. If this is your case, you can learn how to install AdGuard Assistant on [GitHub](https://github.com/AdguardTeam/AdguardAssistant). + +::: + +#### Disable AMP + +A script that is only pre-installed in AdGuard for Android. It disables AMP (Accelerated Mobile Pages) on the Google search results page. Learn more about this userscript and how to install it on [GitHub](https://github.com/AdguardTeam/DisableAMP). + +![Disable AMP](https://cdn.adtidy.org/content/kb/ad_blocker/general/disable-amp-installation.png) + +### Top picks outside AdGuard{#top-picks} + +These userscripts are not developed by AdGuard, and therefore we can't give a 100% guarantee that they are safe and/or work at all times. However, in our experience they deserve a recommendation because they've all earned their good reputation. + +#### Don't track me Google + +This script removes Google's tracking feature from the links in Google search results. It speeds up the loading of search results and allows you to right-click or tap to copy the link URL. + +Its source code is [available on GitHub](https://github.com/Rob--W/dont-track-me-google). This userscript can be downloaded from [GreasyFork](https://greasyfork.org/en/scripts/428243-don-t-track-me-google) and installed in any AdGuard CoreLibs-based app. + +#### microShield + +A userscript for people visiting Korean websites and some international websites. The microShield userscript blocks Ad-Shield ads and anti-adblocks. Its original source code is available at [asdefuser](https://github.com/seia-soto/userscripts/tree/master/sources/asdefuser) and [AdShield Defuser](https://github.com/seia-soto/adshield-defuser). This userscript can be installed in AdGuard CoreLibs-based apps, Violentmonkey, Tampermonkey, and [quoid/userscripts](https://github.com/quoid/userscripts). Learn more about microShield and how to install it on [GitHub](https://github.com/List-KR/microShield). + +### Where can you get more userscripts?{#more-userscripts} + +Since userscripts are mainly created by enthusiasts, you should be cautious when installing them. Any script from an unknown source carries a potential risk. Yet, there is a great variety of interesting scripts that, if installed carefully and responsibly, can really make using some websites more convenient. + +Here we will describe some of the most popular userscript catalogs. + +#### Userscript.Zone + +[Userscript.Zone](https://www.userscript.zone) is a website that allows searching for userscripts by entering a matching URL or domain. The website is easy to use and has a high level of credibility as only scripts from moderated pages are displayed. + +#### Greasy Fork + +[Greasy Fork](https://greasyfork.org/) is a userscript catalog of Stylish creators. The scripts in this catalog are moderated, so their credibility is much higher. + +#### OpenUserJS.org + +[OpenUserJS.org](https://openuserjs.org/) is an open-source userscript catalog written in nodeJS. It's not moderated, so keep an eye out for suspicious scripts. + +#### Community + +If you like the idea of customizing your browser with userscripts and have questions, you can ask them on one of these websites: + +- [Stackoverflow](https://stackoverflow.com/questions/tagged/userscripts) +- [FreeNode](https://webchat.freenode.net/#greasemonkey) +- [Reddit](https://www.reddit.com/r/userscripts/) + +### Development + +#### Request license + +If you are developing your own custom script and want to test how it works with AdGuard, you can request a beta license key for the app. + +To get it, please send an email to devteam@adguard.com with the following information: + +**Subject:** Userscript author license request + +**Body:** Please tell us about the userscripts you are working on. + +Here is a [mailto link](mailto:devteam@adguard.com?Subject=Userscript%20author%20license%20request\&Body=Hello%2C%0A%0AMy%20userscript%28s%29%3A%20LINK). + +#### Compatibility + +#### Metadata block + +#### Supported properties + +```text +@name +@namespace +@description +@version +@match +@include +@exclude +@grant +@connect +@require +@resource +@downloadURL +@updateURL +@supportURL +@homepageURL +@homepage +@website +@source +@run-at +@noframes +@icon +@iconURL +@defaulticon +@icon64 +@icon64URL +``` + +#### Unsupported properties + +These properties will be simply ignored by AdGuard. + +```text +@unwrap +``` + +#### Supported GM functions + +AdGuard supports both old GM\_ functions and new GM4 API that use GM object. + +#### Values + +:::note + +All listed old Greasemonkey functions are deprecated but still supported. + +::: + +```text +GM.info / GM_info +GM.setValue / GM_setValue +GM.getValue / GM_getValue +GM.listValues / GM_listValues +GM.deleteValue / GM_deleteValue +GM.getResourceUrl / GM_getResourceURL +GM.setClipboard / GM_setClipboard +GM.xmlHttpRequest / GM_xmlhttpRequest +GM.openInTab / GM_openInTab +GM.notification +unsafeWindow +GM_getResourceText +GM_addStyle +GM_log +``` + +[Here](https://wiki.greasespot.net/GM.info) you can find more information about Greasemonkey API. + +#### Example + +```javascript +// ==UserScript== +// @name Name as shown to the user when locale is english or unknown +// @name:ru Name as shown to the user when locale is russian +// @description Description as shown to the user when locale is english or unknown +// @description:ru Description as shown to the user when locale is russian +// @icon https://myhomepage.com/myuserscript.png +// @version 1.0.0.0 +// @downloadURL https://dl.myhomepage.org/myuserscript.user.js +// @updateURL https://dl.myhomepage.org/myuserscript.meta.js +// @homepageURL https://myhomepage.com/myuserscript +// @include * +// @exclude *://website.com/* +// @resource https://myhomepage.com/myuserscript.css +// @require https://myhomepage.com/mylibrary.js +// @grant property:settings +// @grant GM_getValue +// @grant GM_setValue +// @grant GM_deleteValue +// @grant GM_listValues +// @grant GM_getResourceText +// @grant GM_getResourceURL +// @grant GM_addStyle +// @grant GM_log +// @grant GM_setClipboard +// @grant GM_xmlhttpRequest +// @grant unsafeWindow +// @grant GM_info +// @grant GM_openInTab +// @grant GM_registerMenuCommand +// @run-at document-start +// ==/UserScript== +!function(){( + console.log("I am loaded!"); +)}(); +``` + +## Userstyles + +Userstyles allow users to customize their online experience. Whether you’re looking to change the appearance of a website or automate repetitive tasks, styles offer a world of possibilities. + +AdGuard has the option to upload or create your own userstyles. This is an advanced feature, so you will need some knowledge of HTML and CSS. + +:::info Supported apps + +Currently, two AdGuard apps allow you to create and manage userstyles: AdGuard for Windows (v7.19 or later) and AdGuard for Mac (v2.16 or later). We also plan to implement this new feature in AdGuard v4.8 for Android in the nearest future. + +::: + +This is an experimental feature, so if you encounter any problems while adding or creating a userstyle, please contact our support team at . + +### How to set up a userstyle in AdGuard + +You can download userstyles from various websites. One of the most popular userstyle websites is [https://userstyles.world/](https://userstyles.world/explore), which we will use as an example for the following instructions on how to set up the userstyle in AdGuard. + +1. Follow the link above and choose the userstyle you like + +2. Right-click the _Install_ button and choose _Copy Link Address_ + +3. Open AdGuard settings → _Extensions_ + +4. Press the [+] button and paste the userstyle link + +5. Done! + +If you’re familiar with CSS rules, you can also create the userstyles yourself. + +:::note + +We don’t support userstyles that contain `@var` or `@advanced` in the metadata. AdGuard also doesn’t support `@preprocessor` without the `default` value. + +::: + +1. Open AdGuard settings → _Extensions_ + +2. Press the [+] button and choose the _Create userstyle_ option. A new window will appear on your screen + +3. To create a userstyle, first write the title with metadata, for example + + ```CSS + /* ==UserStyle== + @name New userstyle + @version 1.0 + ==/UserStyle== */ + ``` + +4. Write the CSS part after the meta data. AdGuard supports website domain names matching (`@-moz-document domain(…), …`). For example: + + ```CSS + body { + background: gray; + } + ``` + + Or: + + ```CSS + @-moz-document domain('example.org'), + domain('example.net'), + domain('example.com') body { + background: gray; + } + ``` + +5. Once you’re finished, press _Save and Close_. Your new userstyle has been successfully added to AdGuard + +### Example + +```css +/* ==UserStyle== +@name Example userstyle +@namespace https://example.org/userstyle +@homepageURL https://example.org/userstyle +@version 1.0.0 +@license Other +@description This is an example +@author example +@preprocessor default +==/UserStyle== */ +@-moz-document regexp("https?\:\/\/(www\.)?example\.(org|com).*") { + body { + background-color: #000000 !important; + } +} +``` diff --git a/i18n/sv/docusaurus-plugin-content-docs/current/general/how-to-install.md b/i18n/sv/docusaurus-plugin-content-docs/current/general/how-to-install.md index bae3060668a..106a29529a8 100644 --- a/i18n/sv/docusaurus-plugin-content-docs/current/general/how-to-install.md +++ b/i18n/sv/docusaurus-plugin-content-docs/current/general/how-to-install.md @@ -1,6 +1,6 @@ --- title: How to install AdGuard -sidebar_position: 8 +sidebar_position: 9 --- Depending on which AdGuard app or browser extension you want to install, follow one of these links to find the relevant article: diff --git a/i18n/ta/docusaurus-plugin-content-docs/current/adguard-for-windows/features/extensions.md b/i18n/ta/docusaurus-plugin-content-docs/current/adguard-for-windows/features/extensions.md index 260fa0e83b3..17884a6df33 100644 --- a/i18n/ta/docusaurus-plugin-content-docs/current/adguard-for-windows/features/extensions.md +++ b/i18n/ta/docusaurus-plugin-content-docs/current/adguard-for-windows/features/extensions.md @@ -9,7 +9,7 @@ This article covers AdGuard for Windows, a multifunctional ad blocker that prote ::: -AdGuard can significantly broaden website functionality working as a [user script manager](/general/extensions). AdGuard Users can add their own scripts, as well as manage existing ones. +AdGuard can significantly extend website functionality by working as a [userscript manager](/general/extensions.md). AdGuard users can add their own scripts as well as manage existing ones. ![Extensions \*mobile\_border](https://cdn.adtidy.org/content/kb/ad_blocker/windows/overview/userscripts.png) diff --git a/i18n/ta/docusaurus-plugin-content-docs/current/general/extensions.md b/i18n/ta/docusaurus-plugin-content-docs/current/general/extensions.md new file mode 100644 index 00000000000..0cf454b4329 --- /dev/null +++ b/i18n/ta/docusaurus-plugin-content-docs/current/general/extensions.md @@ -0,0 +1,301 @@ +--- +title: Extensions +sidebar_position: 6 +--- + +## Userscripts + +Userscripts (we also call them "extensions") are, de facto, miniprograms written in JavaScript. They modify or extend the functionality of one or more websites. Many AdGuard users may be already familiar with such userscripts as AdGuard Assistant, Popup Blocker, and AdGuard Extra. + +:::note Supported apps + +AdGuard can significantly broaden website functionality by acting as a userscript manager. You can add your custom scripts or manage the existing ones in our three products: [AdGuard for Windows](/adguard-for-windows/features/extensions), [AdGuard for Android](/adguard-for-android/features/settings#userscripts), and [AdGuard for Mac](/adguard-for-mac/features/extensions). + +::: + +### Recommended AdGuard scripts + +These userscripts come directly from the AdGuard developers, and we can guarantee that they are effective and safe. For some of the userscripts developed by others that we consider good and reliable, [scroll down to the next section](#top-picks). You can also find some of the [popular websites with scripts](#more-userscripts) below, but remember that whenever you download a userscript from an unknown source, you are exposing yourself to a certain risk, as some scripts may be harmful to your computer. + +#### AdGuard Extra + +An extension that blocks ads in difficult cases when the usual filter-based approach is not enough. AdGuard Extra comes pre-installed in AdGuard standalone apps, except for the one for iOS, so you don't need to do anything to enable it. However, if you want to use it alongside AdGuard Browser Extension or any other ad blocker, you'll need to use an additional extension. Learn more about this userscript and how to install it on [GitHub](https://github.com/AdguardTeam/AdGuardExtra). + +![AdGuard Extra](https://cdn.adtidy.org/content/kb/ad_blocker/general/adguard-extra.png) + +#### AdGuard Popup Blocker + +The name speaks for itself: it blocks popups — one of the most annoying types of ads on websites. Learn more about this userscript, its key features, and installation on [GitHub](https://github.com/AdguardTeam/PopupBlocker). + +![AdGuard Popup Blocker](https://cdn.adtidy.org/content/kb/ad_blocker/general/popup-blocker-installation.png) + +#### AdGuard Assistant (legacy version) + +This custom extension is designed to control filtering directly from the browser page (manual blocking, allowlisting, etc.). + +:::note + +This version of Assistant is legacy and there is no point in using it on new systems, as it has been replaced with the full-fledged [Browser Assistant](https://adguard.com/adguard-assistant/overview.html). However, the legacy Assistant may be useful if there is no Browser Assistant for your browser. If this is your case, you can learn how to install AdGuard Assistant on [GitHub](https://github.com/AdguardTeam/AdguardAssistant). + +::: + +#### Disable AMP + +A script that is only pre-installed in AdGuard for Android. It disables AMP (Accelerated Mobile Pages) on the Google search results page. Learn more about this userscript and how to install it on [GitHub](https://github.com/AdguardTeam/DisableAMP). + +![Disable AMP](https://cdn.adtidy.org/content/kb/ad_blocker/general/disable-amp-installation.png) + +### Top picks outside AdGuard{#top-picks} + +These userscripts are not developed by AdGuard, and therefore we can't give a 100% guarantee that they are safe and/or work at all times. However, in our experience they deserve a recommendation because they've all earned their good reputation. + +#### Don't track me Google + +This script removes Google's tracking feature from the links in Google search results. It speeds up the loading of search results and allows you to right-click or tap to copy the link URL. + +Its source code is [available on GitHub](https://github.com/Rob--W/dont-track-me-google). This userscript can be downloaded from [GreasyFork](https://greasyfork.org/en/scripts/428243-don-t-track-me-google) and installed in any AdGuard CoreLibs-based app. + +#### microShield + +A userscript for people visiting Korean websites and some international websites. The microShield userscript blocks Ad-Shield ads and anti-adblocks. Its original source code is available at [asdefuser](https://github.com/seia-soto/userscripts/tree/master/sources/asdefuser) and [AdShield Defuser](https://github.com/seia-soto/adshield-defuser). This userscript can be installed in AdGuard CoreLibs-based apps, Violentmonkey, Tampermonkey, and [quoid/userscripts](https://github.com/quoid/userscripts). Learn more about microShield and how to install it on [GitHub](https://github.com/List-KR/microShield). + +### Where can you get more userscripts?{#more-userscripts} + +Since userscripts are mainly created by enthusiasts, you should be cautious when installing them. Any script from an unknown source carries a potential risk. Yet, there is a great variety of interesting scripts that, if installed carefully and responsibly, can really make using some websites more convenient. + +Here we will describe some of the most popular userscript catalogs. + +#### Userscript.Zone + +[Userscript.Zone](https://www.userscript.zone) is a website that allows searching for userscripts by entering a matching URL or domain. The website is easy to use and has a high level of credibility as only scripts from moderated pages are displayed. + +#### Greasy Fork + +[Greasy Fork](https://greasyfork.org/) is a userscript catalog of Stylish creators. The scripts in this catalog are moderated, so their credibility is much higher. + +#### OpenUserJS.org + +[OpenUserJS.org](https://openuserjs.org/) is an open-source userscript catalog written in nodeJS. It's not moderated, so keep an eye out for suspicious scripts. + +#### Community + +If you like the idea of customizing your browser with userscripts and have questions, you can ask them on one of these websites: + +- [Stackoverflow](https://stackoverflow.com/questions/tagged/userscripts) +- [FreeNode](https://webchat.freenode.net/#greasemonkey) +- [Reddit](https://www.reddit.com/r/userscripts/) + +### Development + +#### Request license + +If you are developing your own custom script and want to test how it works with AdGuard, you can request a beta license key for the app. + +To get it, please send an email to devteam@adguard.com with the following information: + +**Subject:** Userscript author license request + +**Body:** Please tell us about the userscripts you are working on. + +Here is a [mailto link](mailto:devteam@adguard.com?Subject=Userscript%20author%20license%20request\&Body=Hello%2C%0A%0AMy%20userscript%28s%29%3A%20LINK). + +#### Compatibility + +#### Metadata block + +#### Supported properties + +```text +@name +@namespace +@description +@version +@match +@include +@exclude +@grant +@connect +@require +@resource +@downloadURL +@updateURL +@supportURL +@homepageURL +@homepage +@website +@source +@run-at +@noframes +@icon +@iconURL +@defaulticon +@icon64 +@icon64URL +``` + +#### Unsupported properties + +These properties will be simply ignored by AdGuard. + +```text +@unwrap +``` + +#### Supported GM functions + +AdGuard supports both old GM\_ functions and new GM4 API that use GM object. + +#### Values + +:::note + +All listed old Greasemonkey functions are deprecated but still supported. + +::: + +```text +GM.info / GM_info +GM.setValue / GM_setValue +GM.getValue / GM_getValue +GM.listValues / GM_listValues +GM.deleteValue / GM_deleteValue +GM.getResourceUrl / GM_getResourceURL +GM.setClipboard / GM_setClipboard +GM.xmlHttpRequest / GM_xmlhttpRequest +GM.openInTab / GM_openInTab +GM.notification +unsafeWindow +GM_getResourceText +GM_addStyle +GM_log +``` + +[Here](https://wiki.greasespot.net/GM.info) you can find more information about Greasemonkey API. + +#### Example + +```javascript +// ==UserScript== +// @name Name as shown to the user when locale is english or unknown +// @name:ru Name as shown to the user when locale is russian +// @description Description as shown to the user when locale is english or unknown +// @description:ru Description as shown to the user when locale is russian +// @icon https://myhomepage.com/myuserscript.png +// @version 1.0.0.0 +// @downloadURL https://dl.myhomepage.org/myuserscript.user.js +// @updateURL https://dl.myhomepage.org/myuserscript.meta.js +// @homepageURL https://myhomepage.com/myuserscript +// @include * +// @exclude *://website.com/* +// @resource https://myhomepage.com/myuserscript.css +// @require https://myhomepage.com/mylibrary.js +// @grant property:settings +// @grant GM_getValue +// @grant GM_setValue +// @grant GM_deleteValue +// @grant GM_listValues +// @grant GM_getResourceText +// @grant GM_getResourceURL +// @grant GM_addStyle +// @grant GM_log +// @grant GM_setClipboard +// @grant GM_xmlhttpRequest +// @grant unsafeWindow +// @grant GM_info +// @grant GM_openInTab +// @grant GM_registerMenuCommand +// @run-at document-start +// ==/UserScript== +!function(){( + console.log("I am loaded!"); +)}(); +``` + +## Userstyles + +Userstyles allow users to customize their online experience. Whether you’re looking to change the appearance of a website or automate repetitive tasks, styles offer a world of possibilities. + +AdGuard has the option to upload or create your own userstyles. This is an advanced feature, so you will need some knowledge of HTML and CSS. + +:::info Supported apps + +Currently, two AdGuard apps allow you to create and manage userstyles: AdGuard for Windows (v7.19 or later) and AdGuard for Mac (v2.16 or later). We also plan to implement this new feature in AdGuard v4.8 for Android in the nearest future. + +::: + +This is an experimental feature, so if you encounter any problems while adding or creating a userstyle, please contact our support team at . + +### How to set up a userstyle in AdGuard + +You can download userstyles from various websites. One of the most popular userstyle websites is [https://userstyles.world/](https://userstyles.world/explore), which we will use as an example for the following instructions on how to set up the userstyle in AdGuard. + +1. Follow the link above and choose the userstyle you like + +2. Right-click the _Install_ button and choose _Copy Link Address_ + +3. Open AdGuard settings → _Extensions_ + +4. Press the [+] button and paste the userstyle link + +5. Done! + +If you’re familiar with CSS rules, you can also create the userstyles yourself. + +:::note + +We don’t support userstyles that contain `@var` or `@advanced` in the metadata. AdGuard also doesn’t support `@preprocessor` without the `default` value. + +::: + +1. Open AdGuard settings → _Extensions_ + +2. Press the [+] button and choose the _Create userstyle_ option. A new window will appear on your screen + +3. To create a userstyle, first write the title with metadata, for example + + ```CSS + /* ==UserStyle== + @name New userstyle + @version 1.0 + ==/UserStyle== */ + ``` + +4. Write the CSS part after the meta data. AdGuard supports website domain names matching (`@-moz-document domain(…), …`). For example: + + ```CSS + body { + background: gray; + } + ``` + + Or: + + ```CSS + @-moz-document domain('example.org'), + domain('example.net'), + domain('example.com') body { + background: gray; + } + ``` + +5. Once you’re finished, press _Save and Close_. Your new userstyle has been successfully added to AdGuard + +### Example + +```css +/* ==UserStyle== +@name Example userstyle +@namespace https://example.org/userstyle +@homepageURL https://example.org/userstyle +@version 1.0.0 +@license Other +@description This is an example +@author example +@preprocessor default +==/UserStyle== */ +@-moz-document regexp("https?\:\/\/(www\.)?example\.(org|com).*") { + body { + background-color: #000000 !important; + } +} +``` diff --git a/i18n/ta/docusaurus-plugin-content-docs/current/general/how-to-install.md b/i18n/ta/docusaurus-plugin-content-docs/current/general/how-to-install.md index bae3060668a..106a29529a8 100644 --- a/i18n/ta/docusaurus-plugin-content-docs/current/general/how-to-install.md +++ b/i18n/ta/docusaurus-plugin-content-docs/current/general/how-to-install.md @@ -1,6 +1,6 @@ --- title: How to install AdGuard -sidebar_position: 8 +sidebar_position: 9 --- Depending on which AdGuard app or browser extension you want to install, follow one of these links to find the relevant article: diff --git a/i18n/tr/docusaurus-plugin-content-docs/current/adguard-browser-extension/mv3-version.md b/i18n/tr/docusaurus-plugin-content-docs/current/adguard-browser-extension/mv3-version.md index 5f4d337e055..1e44be1ad80 100644 --- a/i18n/tr/docusaurus-plugin-content-docs/current/adguard-browser-extension/mv3-version.md +++ b/i18n/tr/docusaurus-plugin-content-docs/current/adguard-browser-extension/mv3-version.md @@ -55,7 +55,7 @@ The maximum number of simultaneously enabled filters is **50**. **Dynamic rules:** a strict cap of **5,000** rules is imposed, which includes a maximum of 1,000 regex rules. -If this limit is exceeded, only **5,000 converted rules** will be applied in the following order: first Allowlist, then User rules, Custom filters, and finally — Quick Fixes filter. +Bu limit aşılırsa, yalnızca **5,000 dönüştürülmüş kural** aşağıdaki sırayla uygulanacaktır: önce İzin listesi, ardından Kullanıcı kuralları, Özel filtreler ve nihayet — Hızlı Çözümler filtresi. > **Converted rules** are rules that have been transformed > to [DNR format] using the [declarative converter][github-declarative-converter]. diff --git a/i18n/tr/docusaurus-plugin-content-docs/current/adguard-for-windows/features/extensions.md b/i18n/tr/docusaurus-plugin-content-docs/current/adguard-for-windows/features/extensions.md index 40764a643b8..ea161bae31f 100644 --- a/i18n/tr/docusaurus-plugin-content-docs/current/adguard-for-windows/features/extensions.md +++ b/i18n/tr/docusaurus-plugin-content-docs/current/adguard-for-windows/features/extensions.md @@ -9,7 +9,7 @@ Bu makale, cihazınızı sistem düzeyinde koruyan çok işlevli bir reklam enge ::: -AdGuard can significantly broaden website functionality working as a [user script manager](/general/extensions). AdGuard Kullanıcıları kendi betiklerini ekleyebilir ve mevcut olanları yönetebilir. +AdGuard can significantly extend website functionality by working as a [userscript manager](/general/extensions.md). AdGuard users can add their own scripts as well as manage existing ones. ![Extensions \*mobile\_border](https://cdn.adtidy.org/content/kb/ad_blocker/windows/overview/userscripts.png) diff --git a/i18n/tr/docusaurus-plugin-content-docs/current/general/extensions.md b/i18n/tr/docusaurus-plugin-content-docs/current/general/extensions.md new file mode 100644 index 00000000000..c5eadc288eb --- /dev/null +++ b/i18n/tr/docusaurus-plugin-content-docs/current/general/extensions.md @@ -0,0 +1,301 @@ +--- +title: Uzantılar +sidebar_position: 6 +--- + +## Kullanıcı Betikleri + +Userscripts (we also call them "extensions") are, de facto, miniprograms written in JavaScript. They modify or extend the functionality of one or more websites. Many AdGuard users may be already familiar with such userscripts as AdGuard Assistant, Popup Blocker, and AdGuard Extra. + +:::note Supported apps + +AdGuard can significantly broaden website functionality by acting as a userscript manager. You can add your custom scripts or manage the existing ones in our three products: [AdGuard for Windows](/adguard-for-windows/features/extensions), [AdGuard for Android](/adguard-for-android/features/settings#userscripts), and [AdGuard for Mac](/adguard-for-mac/features/extensions). + +::: + +### Recommended AdGuard scripts + +These userscripts come directly from the AdGuard developers, and we can guarantee that they are effective and safe. For some of the userscripts developed by others that we consider good and reliable, [scroll down to the next section](#top-picks). You can also find some of the [popular websites with scripts](#more-userscripts) below, but remember that whenever you download a userscript from an unknown source, you are exposing yourself to a certain risk, as some scripts may be harmful to your computer. + +#### AdGuard Extra + +Normal filtre tabanlı yaklaşımın yeterli olmadığı zor durumlarda reklamları engelleyen bir uzantı. AdGuard Extra comes pre-installed in AdGuard standalone apps, except for the one for iOS, so you don't need to do anything to enable it. However, if you want to use it alongside AdGuard Browser Extension or any other ad blocker, you'll need to use an additional extension. Learn more about this userscript and how to install it on [GitHub](https://github.com/AdguardTeam/AdGuardExtra). + +![AdGuard Extra](https://cdn.adtidy.org/content/kb/ad_blocker/general/adguard-extra.png) + +#### AdGuard Açılır Pencere Engelleyici + +The name speaks for itself: it blocks popups — one of the most annoying types of ads on websites. Learn more about this userscript, its key features, and installation on [GitHub](https://github.com/AdguardTeam/PopupBlocker). + +![AdGuard Popup Blocker](https://cdn.adtidy.org/content/kb/ad_blocker/general/popup-blocker-installation.png) + +#### AdGuard Assistant (legacy version) + +This custom extension is designed to control filtering directly from the browser page (manual blocking, allowlisting, etc.). + +:::note + +This version of Assistant is legacy and there is no point in using it on new systems, as it has been replaced with the full-fledged [Browser Assistant](https://adguard.com/adguard-assistant/overview.html). However, the legacy Assistant may be useful if there is no Browser Assistant for your browser. If this is your case, you can learn how to install AdGuard Assistant on [GitHub](https://github.com/AdguardTeam/AdguardAssistant). + +::: + +#### AMP'yi devre dışı bırak + +Yalnızca Android için AdGuard'da önceden yüklenmiş olan bir betik. Google arama sonuçları sayfasında AMP'yi (Hızlandırılmış Mobil Sayfalar) devre dışı bırakır. Learn more about this userscript and how to install it on [GitHub](https://github.com/AdguardTeam/DisableAMP). + +![Disable AMP](https://cdn.adtidy.org/content/kb/ad_blocker/general/disable-amp-installation.png) + +### AdGuard dışında en çok tercih edilenler{#top-picks} + +These userscripts are not developed by AdGuard, and therefore we can't give a 100% guarantee that they are safe and/or work at all times. However, in our experience they deserve a recommendation because they've all earned their good reputation. + +#### Don't track me Google + +This script removes Google's tracking feature from the links in Google search results. It speeds up the loading of search results and allows you to right-click or tap to copy the link URL. + +Its source code is [available on GitHub](https://github.com/Rob--W/dont-track-me-google). This userscript can be downloaded from [GreasyFork](https://greasyfork.org/en/scripts/428243-don-t-track-me-google) and installed in any AdGuard CoreLibs-based app. + +#### microShield + +A userscript for people visiting Korean websites and some international websites. The microShield userscript blocks Ad-Shield ads and anti-adblocks. Its original source code is available at [asdefuser](https://github.com/seia-soto/userscripts/tree/master/sources/asdefuser) and [AdShield Defuser](https://github.com/seia-soto/adshield-defuser). This userscript can be installed in AdGuard CoreLibs-based apps, Violentmonkey, Tampermonkey, and [quoid/userscripts](https://github.com/quoid/userscripts). Learn more about microShield and how to install it on [GitHub](https://github.com/List-KR/microShield). + +### Where can you get more userscripts?{#more-userscripts} + +Since userscripts are mainly created by enthusiasts, you should be cautious when installing them. Any script from an unknown source carries a potential risk. Yet, there is a great variety of interesting scripts that, if installed carefully and responsibly, can really make using some websites more convenient. + +Here we will describe some of the most popular userscript catalogs. + +#### Userscript.Zone + +[Userscript.Zone](https://www.userscript.zone) is a website that allows searching for userscripts by entering a matching URL or domain. The website is easy to use and has a high level of credibility as only scripts from moderated pages are displayed. + +#### Greasy Fork + +[Greasy Fork](https://greasyfork.org/) is a userscript catalog of Stylish creators. The scripts in this catalog are moderated, so their credibility is much higher. + +#### OpenUserJS.org + +[OpenUserJS.org](https://openuserjs.org/) is an open-source userscript catalog written in nodeJS. It's not moderated, so keep an eye out for suspicious scripts. + +#### Community + +If you like the idea of customizing your browser with userscripts and have questions, you can ask them on one of these websites: + +- [Stackoverflow](https://stackoverflow.com/questions/tagged/userscripts) +- [FreeNode](https://webchat.freenode.net/#greasemonkey) +- [Reddit](https://www.reddit.com/r/userscripts/) + +### Development + +#### Lisans talep et + +If you are developing your own custom script and want to test how it works with AdGuard, you can request a beta license key for the app. + +To get it, please send an email to devteam@adguard.com with the following information: + +**Subject:** Userscript author license request + +**Body:** Please tell us about the userscripts you are working on. + +Here is a [mailto link](mailto:devteam@adguard.com?Subject=Userscript%20author%20license%20request\&Body=Hello%2C%0A%0AMy%20userscript%28s%29%3A%20LINK). + +#### Compatibility + +#### Metadata block + +#### Supported properties + +```text +@name +@namespace +@description +@version +@match +@include +@exclude +@grant +@connect +@require +@resource +@downloadURL +@updateURL +@supportURL +@homepageURL +@homepage +@website +@source +@run-at +@noframes +@icon +@iconURL +@defaulticon +@icon64 +@icon64URL +``` + +#### Unsupported properties + +These properties will be simply ignored by AdGuard. + +```text +@unwrap +``` + +#### Supported GM functions + +AdGuard supports both old GM\_ functions and new GM4 API that use GM object. + +#### Values + +:::note + +All listed old Greasemonkey functions are deprecated but still supported. + +::: + +```text +GM.info / GM_info +GM.setValue / GM_setValue +GM.getValue / GM_getValue +GM.listValues / GM_listValues +GM.deleteValue / GM_deleteValue +GM.getResourceUrl / GM_getResourceURL +GM.setClipboard / GM_setClipboard +GM.xmlHttpRequest / GM_xmlhttpRequest +GM.openInTab / GM_openInTab +GM.notification +unsafeWindow +GM_getResourceText +GM_addStyle +GM_log +``` + +[Here](https://wiki.greasespot.net/GM.info) you can find more information about Greasemonkey API. + +#### Örnek + +```javascript +// ==UserScript== +// @name Name as shown to the user when locale is english or unknown +// @name:ru Name as shown to the user when locale is russian +// @description Description as shown to the user when locale is english or unknown +// @description:ru Description as shown to the user when locale is russian +// @icon https://myhomepage.com/myuserscript.png +// @version 1.0.0.0 +// @downloadURL https://dl.myhomepage.org/myuserscript.user.js +// @updateURL https://dl.myhomepage.org/myuserscript.meta.js +// @homepageURL https://myhomepage.com/myuserscript +// @include * +// @exclude *://website.com/* +// @resource https://myhomepage.com/myuserscript.css +// @require https://myhomepage.com/mylibrary.js +// @grant property:settings +// @grant GM_getValue +// @grant GM_setValue +// @grant GM_deleteValue +// @grant GM_listValues +// @grant GM_getResourceText +// @grant GM_getResourceURL +// @grant GM_addStyle +// @grant GM_log +// @grant GM_setClipboard +// @grant GM_xmlhttpRequest +// @grant unsafeWindow +// @grant GM_info +// @grant GM_openInTab +// @grant GM_registerMenuCommand +// @run-at document-start +// ==/UserScript== +!function(){( + console.log("I am loaded!"); +)}(); +``` + +## Kullanıcı stilleri + +Userstyles allow users to customize their online experience. Whether you’re looking to change the appearance of a website or automate repetitive tasks, styles offer a world of possibilities. + +AdGuard has the option to upload or create your own userstyles. This is an advanced feature, so you will need some knowledge of HTML and CSS. + +:::info Supported apps + +Currently, two AdGuard apps allow you to create and manage userstyles: AdGuard for Windows (v7.19 or later) and AdGuard for Mac (v2.16 or later). We also plan to implement this new feature in AdGuard v4.8 for Android in the nearest future. + +::: + +This is an experimental feature, so if you encounter any problems while adding or creating a userstyle, please contact our support team at . + +### How to set up a userstyle in AdGuard + +You can download userstyles from various websites. One of the most popular userstyle websites is [https://userstyles.world/](https://userstyles.world/explore), which we will use as an example for the following instructions on how to set up the userstyle in AdGuard. + +1. Follow the link above and choose the userstyle you like + +2. Right-click the _Install_ button and choose _Copy Link Address_ + +3. Open AdGuard settings → _Extensions_ + +4. Press the [+] button and paste the userstyle link + +5. Tamamlandı! + +If you’re familiar with CSS rules, you can also create the userstyles yourself. + +:::note + +We don’t support userstyles that contain `@var` or `@advanced` in the metadata. AdGuard also doesn’t support `@preprocessor` without the `default` value. + +::: + +1. Open AdGuard settings → _Extensions_ + +2. Press the [+] button and choose the _Create userstyle_ option. A new window will appear on your screen + +3. To create a userstyle, first write the title with metadata, for example + + ```CSS + /* ==UserStyle== + @name New userstyle + @version 1.0 + ==/UserStyle== */ + ``` + +4. Write the CSS part after the meta data. AdGuard supports website domain names matching (`@-moz-document domain(…), …`). Örneğin: + + ```CSS + body { + background: gray; + } + ``` + + Or: + + ```CSS + @-moz-document domain('example.org'), + domain('example.net'), + domain('example.com') body { + background: gray; + } + ``` + +5. Once you’re finished, press _Save and Close_. Your new userstyle has been successfully added to AdGuard + +### Örnek + +```css +/* ==UserStyle== +@name Example userstyle +@namespace https://example.org/userstyle +@homepageURL https://example.org/userstyle +@version 1.0.0 +@license Other +@description This is an example +@author example +@preprocessor default +==/UserStyle== */ +@-moz-document regexp("https?\:\/\/(www\.)?example\.(org|com).*") { + body { + background-color: #000000 !important; + } +} +``` diff --git a/i18n/tr/docusaurus-plugin-content-docs/current/general/how-to-install.md b/i18n/tr/docusaurus-plugin-content-docs/current/general/how-to-install.md index a16a67d3467..2a54efde143 100644 --- a/i18n/tr/docusaurus-plugin-content-docs/current/general/how-to-install.md +++ b/i18n/tr/docusaurus-plugin-content-docs/current/general/how-to-install.md @@ -1,6 +1,6 @@ --- title: How to install AdGuard -sidebar_position: 8 +sidebar_position: 9 --- Depending on which AdGuard app or browser extension you want to install, follow one of these links to find the relevant article: diff --git a/i18n/uk/docusaurus-plugin-content-docs/current/adguard-for-windows/features/extensions.md b/i18n/uk/docusaurus-plugin-content-docs/current/adguard-for-windows/features/extensions.md index 260fa0e83b3..17884a6df33 100644 --- a/i18n/uk/docusaurus-plugin-content-docs/current/adguard-for-windows/features/extensions.md +++ b/i18n/uk/docusaurus-plugin-content-docs/current/adguard-for-windows/features/extensions.md @@ -9,7 +9,7 @@ This article covers AdGuard for Windows, a multifunctional ad blocker that prote ::: -AdGuard can significantly broaden website functionality working as a [user script manager](/general/extensions). AdGuard Users can add their own scripts, as well as manage existing ones. +AdGuard can significantly extend website functionality by working as a [userscript manager](/general/extensions.md). AdGuard users can add their own scripts as well as manage existing ones. ![Extensions \*mobile\_border](https://cdn.adtidy.org/content/kb/ad_blocker/windows/overview/userscripts.png) diff --git a/i18n/uk/docusaurus-plugin-content-docs/current/general/extensions.md b/i18n/uk/docusaurus-plugin-content-docs/current/general/extensions.md new file mode 100644 index 00000000000..0cf454b4329 --- /dev/null +++ b/i18n/uk/docusaurus-plugin-content-docs/current/general/extensions.md @@ -0,0 +1,301 @@ +--- +title: Extensions +sidebar_position: 6 +--- + +## Userscripts + +Userscripts (we also call them "extensions") are, de facto, miniprograms written in JavaScript. They modify or extend the functionality of one or more websites. Many AdGuard users may be already familiar with such userscripts as AdGuard Assistant, Popup Blocker, and AdGuard Extra. + +:::note Supported apps + +AdGuard can significantly broaden website functionality by acting as a userscript manager. You can add your custom scripts or manage the existing ones in our three products: [AdGuard for Windows](/adguard-for-windows/features/extensions), [AdGuard for Android](/adguard-for-android/features/settings#userscripts), and [AdGuard for Mac](/adguard-for-mac/features/extensions). + +::: + +### Recommended AdGuard scripts + +These userscripts come directly from the AdGuard developers, and we can guarantee that they are effective and safe. For some of the userscripts developed by others that we consider good and reliable, [scroll down to the next section](#top-picks). You can also find some of the [popular websites with scripts](#more-userscripts) below, but remember that whenever you download a userscript from an unknown source, you are exposing yourself to a certain risk, as some scripts may be harmful to your computer. + +#### AdGuard Extra + +An extension that blocks ads in difficult cases when the usual filter-based approach is not enough. AdGuard Extra comes pre-installed in AdGuard standalone apps, except for the one for iOS, so you don't need to do anything to enable it. However, if you want to use it alongside AdGuard Browser Extension or any other ad blocker, you'll need to use an additional extension. Learn more about this userscript and how to install it on [GitHub](https://github.com/AdguardTeam/AdGuardExtra). + +![AdGuard Extra](https://cdn.adtidy.org/content/kb/ad_blocker/general/adguard-extra.png) + +#### AdGuard Popup Blocker + +The name speaks for itself: it blocks popups — one of the most annoying types of ads on websites. Learn more about this userscript, its key features, and installation on [GitHub](https://github.com/AdguardTeam/PopupBlocker). + +![AdGuard Popup Blocker](https://cdn.adtidy.org/content/kb/ad_blocker/general/popup-blocker-installation.png) + +#### AdGuard Assistant (legacy version) + +This custom extension is designed to control filtering directly from the browser page (manual blocking, allowlisting, etc.). + +:::note + +This version of Assistant is legacy and there is no point in using it on new systems, as it has been replaced with the full-fledged [Browser Assistant](https://adguard.com/adguard-assistant/overview.html). However, the legacy Assistant may be useful if there is no Browser Assistant for your browser. If this is your case, you can learn how to install AdGuard Assistant on [GitHub](https://github.com/AdguardTeam/AdguardAssistant). + +::: + +#### Disable AMP + +A script that is only pre-installed in AdGuard for Android. It disables AMP (Accelerated Mobile Pages) on the Google search results page. Learn more about this userscript and how to install it on [GitHub](https://github.com/AdguardTeam/DisableAMP). + +![Disable AMP](https://cdn.adtidy.org/content/kb/ad_blocker/general/disable-amp-installation.png) + +### Top picks outside AdGuard{#top-picks} + +These userscripts are not developed by AdGuard, and therefore we can't give a 100% guarantee that they are safe and/or work at all times. However, in our experience they deserve a recommendation because they've all earned their good reputation. + +#### Don't track me Google + +This script removes Google's tracking feature from the links in Google search results. It speeds up the loading of search results and allows you to right-click or tap to copy the link URL. + +Its source code is [available on GitHub](https://github.com/Rob--W/dont-track-me-google). This userscript can be downloaded from [GreasyFork](https://greasyfork.org/en/scripts/428243-don-t-track-me-google) and installed in any AdGuard CoreLibs-based app. + +#### microShield + +A userscript for people visiting Korean websites and some international websites. The microShield userscript blocks Ad-Shield ads and anti-adblocks. Its original source code is available at [asdefuser](https://github.com/seia-soto/userscripts/tree/master/sources/asdefuser) and [AdShield Defuser](https://github.com/seia-soto/adshield-defuser). This userscript can be installed in AdGuard CoreLibs-based apps, Violentmonkey, Tampermonkey, and [quoid/userscripts](https://github.com/quoid/userscripts). Learn more about microShield and how to install it on [GitHub](https://github.com/List-KR/microShield). + +### Where can you get more userscripts?{#more-userscripts} + +Since userscripts are mainly created by enthusiasts, you should be cautious when installing them. Any script from an unknown source carries a potential risk. Yet, there is a great variety of interesting scripts that, if installed carefully and responsibly, can really make using some websites more convenient. + +Here we will describe some of the most popular userscript catalogs. + +#### Userscript.Zone + +[Userscript.Zone](https://www.userscript.zone) is a website that allows searching for userscripts by entering a matching URL or domain. The website is easy to use and has a high level of credibility as only scripts from moderated pages are displayed. + +#### Greasy Fork + +[Greasy Fork](https://greasyfork.org/) is a userscript catalog of Stylish creators. The scripts in this catalog are moderated, so their credibility is much higher. + +#### OpenUserJS.org + +[OpenUserJS.org](https://openuserjs.org/) is an open-source userscript catalog written in nodeJS. It's not moderated, so keep an eye out for suspicious scripts. + +#### Community + +If you like the idea of customizing your browser with userscripts and have questions, you can ask them on one of these websites: + +- [Stackoverflow](https://stackoverflow.com/questions/tagged/userscripts) +- [FreeNode](https://webchat.freenode.net/#greasemonkey) +- [Reddit](https://www.reddit.com/r/userscripts/) + +### Development + +#### Request license + +If you are developing your own custom script and want to test how it works with AdGuard, you can request a beta license key for the app. + +To get it, please send an email to devteam@adguard.com with the following information: + +**Subject:** Userscript author license request + +**Body:** Please tell us about the userscripts you are working on. + +Here is a [mailto link](mailto:devteam@adguard.com?Subject=Userscript%20author%20license%20request\&Body=Hello%2C%0A%0AMy%20userscript%28s%29%3A%20LINK). + +#### Compatibility + +#### Metadata block + +#### Supported properties + +```text +@name +@namespace +@description +@version +@match +@include +@exclude +@grant +@connect +@require +@resource +@downloadURL +@updateURL +@supportURL +@homepageURL +@homepage +@website +@source +@run-at +@noframes +@icon +@iconURL +@defaulticon +@icon64 +@icon64URL +``` + +#### Unsupported properties + +These properties will be simply ignored by AdGuard. + +```text +@unwrap +``` + +#### Supported GM functions + +AdGuard supports both old GM\_ functions and new GM4 API that use GM object. + +#### Values + +:::note + +All listed old Greasemonkey functions are deprecated but still supported. + +::: + +```text +GM.info / GM_info +GM.setValue / GM_setValue +GM.getValue / GM_getValue +GM.listValues / GM_listValues +GM.deleteValue / GM_deleteValue +GM.getResourceUrl / GM_getResourceURL +GM.setClipboard / GM_setClipboard +GM.xmlHttpRequest / GM_xmlhttpRequest +GM.openInTab / GM_openInTab +GM.notification +unsafeWindow +GM_getResourceText +GM_addStyle +GM_log +``` + +[Here](https://wiki.greasespot.net/GM.info) you can find more information about Greasemonkey API. + +#### Example + +```javascript +// ==UserScript== +// @name Name as shown to the user when locale is english or unknown +// @name:ru Name as shown to the user when locale is russian +// @description Description as shown to the user when locale is english or unknown +// @description:ru Description as shown to the user when locale is russian +// @icon https://myhomepage.com/myuserscript.png +// @version 1.0.0.0 +// @downloadURL https://dl.myhomepage.org/myuserscript.user.js +// @updateURL https://dl.myhomepage.org/myuserscript.meta.js +// @homepageURL https://myhomepage.com/myuserscript +// @include * +// @exclude *://website.com/* +// @resource https://myhomepage.com/myuserscript.css +// @require https://myhomepage.com/mylibrary.js +// @grant property:settings +// @grant GM_getValue +// @grant GM_setValue +// @grant GM_deleteValue +// @grant GM_listValues +// @grant GM_getResourceText +// @grant GM_getResourceURL +// @grant GM_addStyle +// @grant GM_log +// @grant GM_setClipboard +// @grant GM_xmlhttpRequest +// @grant unsafeWindow +// @grant GM_info +// @grant GM_openInTab +// @grant GM_registerMenuCommand +// @run-at document-start +// ==/UserScript== +!function(){( + console.log("I am loaded!"); +)}(); +``` + +## Userstyles + +Userstyles allow users to customize their online experience. Whether you’re looking to change the appearance of a website or automate repetitive tasks, styles offer a world of possibilities. + +AdGuard has the option to upload or create your own userstyles. This is an advanced feature, so you will need some knowledge of HTML and CSS. + +:::info Supported apps + +Currently, two AdGuard apps allow you to create and manage userstyles: AdGuard for Windows (v7.19 or later) and AdGuard for Mac (v2.16 or later). We also plan to implement this new feature in AdGuard v4.8 for Android in the nearest future. + +::: + +This is an experimental feature, so if you encounter any problems while adding or creating a userstyle, please contact our support team at . + +### How to set up a userstyle in AdGuard + +You can download userstyles from various websites. One of the most popular userstyle websites is [https://userstyles.world/](https://userstyles.world/explore), which we will use as an example for the following instructions on how to set up the userstyle in AdGuard. + +1. Follow the link above and choose the userstyle you like + +2. Right-click the _Install_ button and choose _Copy Link Address_ + +3. Open AdGuard settings → _Extensions_ + +4. Press the [+] button and paste the userstyle link + +5. Done! + +If you’re familiar with CSS rules, you can also create the userstyles yourself. + +:::note + +We don’t support userstyles that contain `@var` or `@advanced` in the metadata. AdGuard also doesn’t support `@preprocessor` without the `default` value. + +::: + +1. Open AdGuard settings → _Extensions_ + +2. Press the [+] button and choose the _Create userstyle_ option. A new window will appear on your screen + +3. To create a userstyle, first write the title with metadata, for example + + ```CSS + /* ==UserStyle== + @name New userstyle + @version 1.0 + ==/UserStyle== */ + ``` + +4. Write the CSS part after the meta data. AdGuard supports website domain names matching (`@-moz-document domain(…), …`). For example: + + ```CSS + body { + background: gray; + } + ``` + + Or: + + ```CSS + @-moz-document domain('example.org'), + domain('example.net'), + domain('example.com') body { + background: gray; + } + ``` + +5. Once you’re finished, press _Save and Close_. Your new userstyle has been successfully added to AdGuard + +### Example + +```css +/* ==UserStyle== +@name Example userstyle +@namespace https://example.org/userstyle +@homepageURL https://example.org/userstyle +@version 1.0.0 +@license Other +@description This is an example +@author example +@preprocessor default +==/UserStyle== */ +@-moz-document regexp("https?\:\/\/(www\.)?example\.(org|com).*") { + body { + background-color: #000000 !important; + } +} +``` diff --git a/i18n/uk/docusaurus-plugin-content-docs/current/general/how-to-install.md b/i18n/uk/docusaurus-plugin-content-docs/current/general/how-to-install.md index bae3060668a..106a29529a8 100644 --- a/i18n/uk/docusaurus-plugin-content-docs/current/general/how-to-install.md +++ b/i18n/uk/docusaurus-plugin-content-docs/current/general/how-to-install.md @@ -1,6 +1,6 @@ --- title: How to install AdGuard -sidebar_position: 8 +sidebar_position: 9 --- Depending on which AdGuard app or browser extension you want to install, follow one of these links to find the relevant article: diff --git a/i18n/vi/docusaurus-plugin-content-docs/current/adguard-for-windows/features/extensions.md b/i18n/vi/docusaurus-plugin-content-docs/current/adguard-for-windows/features/extensions.md index 260fa0e83b3..17884a6df33 100644 --- a/i18n/vi/docusaurus-plugin-content-docs/current/adguard-for-windows/features/extensions.md +++ b/i18n/vi/docusaurus-plugin-content-docs/current/adguard-for-windows/features/extensions.md @@ -9,7 +9,7 @@ This article covers AdGuard for Windows, a multifunctional ad blocker that prote ::: -AdGuard can significantly broaden website functionality working as a [user script manager](/general/extensions). AdGuard Users can add their own scripts, as well as manage existing ones. +AdGuard can significantly extend website functionality by working as a [userscript manager](/general/extensions.md). AdGuard users can add their own scripts as well as manage existing ones. ![Extensions \*mobile\_border](https://cdn.adtidy.org/content/kb/ad_blocker/windows/overview/userscripts.png) diff --git a/i18n/vi/docusaurus-plugin-content-docs/current/general/extensions.md b/i18n/vi/docusaurus-plugin-content-docs/current/general/extensions.md new file mode 100644 index 00000000000..0cf454b4329 --- /dev/null +++ b/i18n/vi/docusaurus-plugin-content-docs/current/general/extensions.md @@ -0,0 +1,301 @@ +--- +title: Extensions +sidebar_position: 6 +--- + +## Userscripts + +Userscripts (we also call them "extensions") are, de facto, miniprograms written in JavaScript. They modify or extend the functionality of one or more websites. Many AdGuard users may be already familiar with such userscripts as AdGuard Assistant, Popup Blocker, and AdGuard Extra. + +:::note Supported apps + +AdGuard can significantly broaden website functionality by acting as a userscript manager. You can add your custom scripts or manage the existing ones in our three products: [AdGuard for Windows](/adguard-for-windows/features/extensions), [AdGuard for Android](/adguard-for-android/features/settings#userscripts), and [AdGuard for Mac](/adguard-for-mac/features/extensions). + +::: + +### Recommended AdGuard scripts + +These userscripts come directly from the AdGuard developers, and we can guarantee that they are effective and safe. For some of the userscripts developed by others that we consider good and reliable, [scroll down to the next section](#top-picks). You can also find some of the [popular websites with scripts](#more-userscripts) below, but remember that whenever you download a userscript from an unknown source, you are exposing yourself to a certain risk, as some scripts may be harmful to your computer. + +#### AdGuard Extra + +An extension that blocks ads in difficult cases when the usual filter-based approach is not enough. AdGuard Extra comes pre-installed in AdGuard standalone apps, except for the one for iOS, so you don't need to do anything to enable it. However, if you want to use it alongside AdGuard Browser Extension or any other ad blocker, you'll need to use an additional extension. Learn more about this userscript and how to install it on [GitHub](https://github.com/AdguardTeam/AdGuardExtra). + +![AdGuard Extra](https://cdn.adtidy.org/content/kb/ad_blocker/general/adguard-extra.png) + +#### AdGuard Popup Blocker + +The name speaks for itself: it blocks popups — one of the most annoying types of ads on websites. Learn more about this userscript, its key features, and installation on [GitHub](https://github.com/AdguardTeam/PopupBlocker). + +![AdGuard Popup Blocker](https://cdn.adtidy.org/content/kb/ad_blocker/general/popup-blocker-installation.png) + +#### AdGuard Assistant (legacy version) + +This custom extension is designed to control filtering directly from the browser page (manual blocking, allowlisting, etc.). + +:::note + +This version of Assistant is legacy and there is no point in using it on new systems, as it has been replaced with the full-fledged [Browser Assistant](https://adguard.com/adguard-assistant/overview.html). However, the legacy Assistant may be useful if there is no Browser Assistant for your browser. If this is your case, you can learn how to install AdGuard Assistant on [GitHub](https://github.com/AdguardTeam/AdguardAssistant). + +::: + +#### Disable AMP + +A script that is only pre-installed in AdGuard for Android. It disables AMP (Accelerated Mobile Pages) on the Google search results page. Learn more about this userscript and how to install it on [GitHub](https://github.com/AdguardTeam/DisableAMP). + +![Disable AMP](https://cdn.adtidy.org/content/kb/ad_blocker/general/disable-amp-installation.png) + +### Top picks outside AdGuard{#top-picks} + +These userscripts are not developed by AdGuard, and therefore we can't give a 100% guarantee that they are safe and/or work at all times. However, in our experience they deserve a recommendation because they've all earned their good reputation. + +#### Don't track me Google + +This script removes Google's tracking feature from the links in Google search results. It speeds up the loading of search results and allows you to right-click or tap to copy the link URL. + +Its source code is [available on GitHub](https://github.com/Rob--W/dont-track-me-google). This userscript can be downloaded from [GreasyFork](https://greasyfork.org/en/scripts/428243-don-t-track-me-google) and installed in any AdGuard CoreLibs-based app. + +#### microShield + +A userscript for people visiting Korean websites and some international websites. The microShield userscript blocks Ad-Shield ads and anti-adblocks. Its original source code is available at [asdefuser](https://github.com/seia-soto/userscripts/tree/master/sources/asdefuser) and [AdShield Defuser](https://github.com/seia-soto/adshield-defuser). This userscript can be installed in AdGuard CoreLibs-based apps, Violentmonkey, Tampermonkey, and [quoid/userscripts](https://github.com/quoid/userscripts). Learn more about microShield and how to install it on [GitHub](https://github.com/List-KR/microShield). + +### Where can you get more userscripts?{#more-userscripts} + +Since userscripts are mainly created by enthusiasts, you should be cautious when installing them. Any script from an unknown source carries a potential risk. Yet, there is a great variety of interesting scripts that, if installed carefully and responsibly, can really make using some websites more convenient. + +Here we will describe some of the most popular userscript catalogs. + +#### Userscript.Zone + +[Userscript.Zone](https://www.userscript.zone) is a website that allows searching for userscripts by entering a matching URL or domain. The website is easy to use and has a high level of credibility as only scripts from moderated pages are displayed. + +#### Greasy Fork + +[Greasy Fork](https://greasyfork.org/) is a userscript catalog of Stylish creators. The scripts in this catalog are moderated, so their credibility is much higher. + +#### OpenUserJS.org + +[OpenUserJS.org](https://openuserjs.org/) is an open-source userscript catalog written in nodeJS. It's not moderated, so keep an eye out for suspicious scripts. + +#### Community + +If you like the idea of customizing your browser with userscripts and have questions, you can ask them on one of these websites: + +- [Stackoverflow](https://stackoverflow.com/questions/tagged/userscripts) +- [FreeNode](https://webchat.freenode.net/#greasemonkey) +- [Reddit](https://www.reddit.com/r/userscripts/) + +### Development + +#### Request license + +If you are developing your own custom script and want to test how it works with AdGuard, you can request a beta license key for the app. + +To get it, please send an email to devteam@adguard.com with the following information: + +**Subject:** Userscript author license request + +**Body:** Please tell us about the userscripts you are working on. + +Here is a [mailto link](mailto:devteam@adguard.com?Subject=Userscript%20author%20license%20request\&Body=Hello%2C%0A%0AMy%20userscript%28s%29%3A%20LINK). + +#### Compatibility + +#### Metadata block + +#### Supported properties + +```text +@name +@namespace +@description +@version +@match +@include +@exclude +@grant +@connect +@require +@resource +@downloadURL +@updateURL +@supportURL +@homepageURL +@homepage +@website +@source +@run-at +@noframes +@icon +@iconURL +@defaulticon +@icon64 +@icon64URL +``` + +#### Unsupported properties + +These properties will be simply ignored by AdGuard. + +```text +@unwrap +``` + +#### Supported GM functions + +AdGuard supports both old GM\_ functions and new GM4 API that use GM object. + +#### Values + +:::note + +All listed old Greasemonkey functions are deprecated but still supported. + +::: + +```text +GM.info / GM_info +GM.setValue / GM_setValue +GM.getValue / GM_getValue +GM.listValues / GM_listValues +GM.deleteValue / GM_deleteValue +GM.getResourceUrl / GM_getResourceURL +GM.setClipboard / GM_setClipboard +GM.xmlHttpRequest / GM_xmlhttpRequest +GM.openInTab / GM_openInTab +GM.notification +unsafeWindow +GM_getResourceText +GM_addStyle +GM_log +``` + +[Here](https://wiki.greasespot.net/GM.info) you can find more information about Greasemonkey API. + +#### Example + +```javascript +// ==UserScript== +// @name Name as shown to the user when locale is english or unknown +// @name:ru Name as shown to the user when locale is russian +// @description Description as shown to the user when locale is english or unknown +// @description:ru Description as shown to the user when locale is russian +// @icon https://myhomepage.com/myuserscript.png +// @version 1.0.0.0 +// @downloadURL https://dl.myhomepage.org/myuserscript.user.js +// @updateURL https://dl.myhomepage.org/myuserscript.meta.js +// @homepageURL https://myhomepage.com/myuserscript +// @include * +// @exclude *://website.com/* +// @resource https://myhomepage.com/myuserscript.css +// @require https://myhomepage.com/mylibrary.js +// @grant property:settings +// @grant GM_getValue +// @grant GM_setValue +// @grant GM_deleteValue +// @grant GM_listValues +// @grant GM_getResourceText +// @grant GM_getResourceURL +// @grant GM_addStyle +// @grant GM_log +// @grant GM_setClipboard +// @grant GM_xmlhttpRequest +// @grant unsafeWindow +// @grant GM_info +// @grant GM_openInTab +// @grant GM_registerMenuCommand +// @run-at document-start +// ==/UserScript== +!function(){( + console.log("I am loaded!"); +)}(); +``` + +## Userstyles + +Userstyles allow users to customize their online experience. Whether you’re looking to change the appearance of a website or automate repetitive tasks, styles offer a world of possibilities. + +AdGuard has the option to upload or create your own userstyles. This is an advanced feature, so you will need some knowledge of HTML and CSS. + +:::info Supported apps + +Currently, two AdGuard apps allow you to create and manage userstyles: AdGuard for Windows (v7.19 or later) and AdGuard for Mac (v2.16 or later). We also plan to implement this new feature in AdGuard v4.8 for Android in the nearest future. + +::: + +This is an experimental feature, so if you encounter any problems while adding or creating a userstyle, please contact our support team at . + +### How to set up a userstyle in AdGuard + +You can download userstyles from various websites. One of the most popular userstyle websites is [https://userstyles.world/](https://userstyles.world/explore), which we will use as an example for the following instructions on how to set up the userstyle in AdGuard. + +1. Follow the link above and choose the userstyle you like + +2. Right-click the _Install_ button and choose _Copy Link Address_ + +3. Open AdGuard settings → _Extensions_ + +4. Press the [+] button and paste the userstyle link + +5. Done! + +If you’re familiar with CSS rules, you can also create the userstyles yourself. + +:::note + +We don’t support userstyles that contain `@var` or `@advanced` in the metadata. AdGuard also doesn’t support `@preprocessor` without the `default` value. + +::: + +1. Open AdGuard settings → _Extensions_ + +2. Press the [+] button and choose the _Create userstyle_ option. A new window will appear on your screen + +3. To create a userstyle, first write the title with metadata, for example + + ```CSS + /* ==UserStyle== + @name New userstyle + @version 1.0 + ==/UserStyle== */ + ``` + +4. Write the CSS part after the meta data. AdGuard supports website domain names matching (`@-moz-document domain(…), …`). For example: + + ```CSS + body { + background: gray; + } + ``` + + Or: + + ```CSS + @-moz-document domain('example.org'), + domain('example.net'), + domain('example.com') body { + background: gray; + } + ``` + +5. Once you’re finished, press _Save and Close_. Your new userstyle has been successfully added to AdGuard + +### Example + +```css +/* ==UserStyle== +@name Example userstyle +@namespace https://example.org/userstyle +@homepageURL https://example.org/userstyle +@version 1.0.0 +@license Other +@description This is an example +@author example +@preprocessor default +==/UserStyle== */ +@-moz-document regexp("https?\:\/\/(www\.)?example\.(org|com).*") { + body { + background-color: #000000 !important; + } +} +``` diff --git a/i18n/vi/docusaurus-plugin-content-docs/current/general/how-to-install.md b/i18n/vi/docusaurus-plugin-content-docs/current/general/how-to-install.md index bae3060668a..106a29529a8 100644 --- a/i18n/vi/docusaurus-plugin-content-docs/current/general/how-to-install.md +++ b/i18n/vi/docusaurus-plugin-content-docs/current/general/how-to-install.md @@ -1,6 +1,6 @@ --- title: How to install AdGuard -sidebar_position: 8 +sidebar_position: 9 --- Depending on which AdGuard app or browser extension you want to install, follow one of these links to find the relevant article: diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/adguard-for-windows/features/extensions.md b/i18n/zh-CN/docusaurus-plugin-content-docs/current/adguard-for-windows/features/extensions.md index 016a2ab3556..226096feea2 100644 --- a/i18n/zh-CN/docusaurus-plugin-content-docs/current/adguard-for-windows/features/extensions.md +++ b/i18n/zh-CN/docusaurus-plugin-content-docs/current/adguard-for-windows/features/extensions.md @@ -9,7 +9,7 @@ sidebar_position: 3 ::: -AdGuard 可作为[用户脚本管理器](/general/extensions)以显著扩展网站功能。 AdGuard 用户可以添加自己的脚本，也可以管理现有脚本。 +AdGuard can significantly extend website functionality by working as a [userscript manager](/general/extensions.md). AdGuard users can add their own scripts as well as manage existing ones. ![扩展 \*mobile\_border](https://cdn.adtidy.org/content/kb/ad_blocker/windows/overview/userscripts.png) diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/general/extensions.md b/i18n/zh-CN/docusaurus-plugin-content-docs/current/general/extensions.md new file mode 100644 index 00000000000..bc2b0a6737f --- /dev/null +++ b/i18n/zh-CN/docusaurus-plugin-content-docs/current/general/extensions.md @@ -0,0 +1,301 @@ +--- +title: 浏览器扩展 +sidebar_position: 6 +--- + +## 用户脚本 + +用户脚本（我们也称之为「扩展」）实质上是用 JavaScript 编写的小程序。 用户脚本修改或扩展一个或多个网站的功能。 许多 AdGuard 用户已经熟悉 AdGuard 助手、弹窗拦截器和 AdGuard Extra 等用户脚本。 + +:::note Supported apps + +AdGuard 可作为用户脚本管理器以显著扩展网站功能。 You can add your custom scripts or manage the existing ones in our three products: [AdGuard for Windows](/adguard-for-windows/features/extensions), [AdGuard for Android](/adguard-for-android/features/settings#userscripts), and [AdGuard for Mac](/adguard-for-mac/features/extensions). + +::: + +### 推荐的 AdGuard 脚本 + +AdGuard 开发人员创建这些用户脚本，我们可以保证它们有效且安全。 For some of the userscripts developed by others that we consider good and reliable, [scroll down to the next section](#top-picks). You can also find some of the [popular websites with scripts](#more-userscripts) below, but remember that whenever you download a userscript from an unknown source, you are exposing yourself to a certain risk, as some scripts may be harmful to your computer. + +#### AdGuard Extra + +该扩展可以在通常的过滤方法无法解决问题的情况下屏蔽广告。 AdGuard Extra comes pre-installed in AdGuard standalone apps, except for the one for iOS, so you don't need to do anything to enable it. 不过，如果有用户想将 AdGuard Extra 与 AdGuard 浏览器扩展或其他广告拦截器一起使用，需要使用一个额外的扩展。 Learn more about this userscript and how to install it on [GitHub](https://github.com/AdguardTeam/AdGuardExtra). + +![AdGuard Extra](https://cdn.adtidy.org/content/kb/ad_blocker/general/adguard-extra.png) + +#### AdGuard 弹窗拦截器 + +The name speaks for itself: it blocks popups — one of the most annoying types of ads on websites. Learn more about this userscript, its key features, and installation on [GitHub](https://github.com/AdguardTeam/PopupBlocker). + +![AdGuard Popup Blocker](https://cdn.adtidy.org/content/kb/ad_blocker/general/popup-blocker-installation.png) + +#### AdGuard 助手（旧版） + +This custom extension is designed to control filtering directly from the browser page (manual blocking, allowlisting, etc.). + +:::note + +This version of Assistant is legacy and there is no point in using it on new systems, as it has been replaced with the full-fledged [Browser Assistant](https://adguard.com/adguard-assistant/overview.html). However, the legacy Assistant may be useful if there is no Browser Assistant for your browser. If this is your case, you can learn how to install AdGuard Assistant on [GitHub](https://github.com/AdguardTeam/AdguardAssistant). + +::: + +#### 禁用 AMP + +这是一个仅在 Android 版 AdGuard 中预安装的脚本。 它禁用 Google 搜索结果页面上的 AMP（加速移动页面）。 Learn more about this userscript and how to install it on [GitHub](https://github.com/AdguardTeam/DisableAMP). + +![Disable AMP](https://cdn.adtidy.org/content/kb/ad_blocker/general/disable-amp-installation.png) + +### AdGuard 以外的最佳脚本选择{#top-picks} + +These userscripts are not developed by AdGuard, and therefore we can't give a 100% guarantee that they are safe and/or work at all times. However, in our experience they deserve a recommendation because they've all earned their good reputation. + +#### Don't track me Google + +该脚本移除 Google 搜索结果中链接的 Google 跟踪功能。 它加快搜索结果的加载速度，允许用户右键单击或点击复制链接 URL。 + +Its source code is [available on GitHub](https://github.com/Rob--W/dont-track-me-google). This userscript can be downloaded from [GreasyFork](https://greasyfork.org/en/scripts/428243-don-t-track-me-google) and installed in any AdGuard CoreLibs-based app. + +#### microShield + +A userscript for people visiting Korean websites and some international websites. The microShield userscript blocks Ad-Shield ads and anti-adblocks. Its original source code is available at [asdefuser](https://github.com/seia-soto/userscripts/tree/master/sources/asdefuser) and [AdShield Defuser](https://github.com/seia-soto/adshield-defuser). This userscript can be installed in AdGuard CoreLibs-based apps, Violentmonkey, Tampermonkey, and [quoid/userscripts](https://github.com/quoid/userscripts). Learn more about microShield and how to install it on [GitHub](https://github.com/List-KR/microShield). + +### 在哪里查看更多自定义脚本{#more-userscripts} + +Since userscripts are mainly created by enthusiasts, you should be cautious when installing them. 任何来源不明的脚本都有潜在风险。 不过，也有大量有用的脚本。如果认真负责地选择，确实可以使网页更易于浏览。 + +下面我们将介绍一些最常用的用户脚本。 + +#### Userscript.Zone + +[Userscript.Zone](https://www.userscript.zone) is a website that allows searching for userscripts by entering a matching URL or domain. The website is easy to use and has a high level of credibility as only scripts from moderated pages are displayed. + +#### Greasy Fork + +[Greasy Fork](https://greasyfork.org/) is a userscript catalog of Stylish creators. The scripts in this catalog are moderated, so their credibility is much higher. + +#### OpenUserJS.org + +[OpenUserJS.org](https://openuserjs.org/) is an open-source userscript catalog written in nodeJS. It's not moderated, so keep an eye out for suspicious scripts. + +#### 社区 + +If you like the idea of customizing your browser with userscripts and have questions, you can ask them on one of these websites: + +- [Stackoverflow](https://stackoverflow.com/questions/tagged/userscripts) +- [FreeNode](https://webchat.freenode.net/#greasemonkey) +- [Reddit](https://www.reddit.com/r/userscripts/) + +### 开发 + +#### 申请许可证 + +If you are developing your own custom script and want to test how it works with AdGuard, you can request a beta license key for the app. + +要获取许可证，请发送电子邮件至 devteam@adguard.com 并附上以下信息： + +**Subject:** Userscript author license request + +**Body:** Please tell us about the userscripts you are working on. + +Here is a [mailto link](mailto:devteam@adguard.com?Subject=Userscript%20author%20license%20request\&Body=Hello%2C%0A%0AMy%20userscript%28s%29%3A%20LINK). + +#### 兼容性 + +#### 元数据块 + +#### 支持的属性 + +```text +@name +@namespace +@description +@version +@match +@include +@exclude +@grant +@connect +@require +@resource +@downloadURL +@updateURL +@supportURL +@homepageURL +@homepage +@website +@source +@run-at +@noframes +@icon +@iconURL +@defaulticon +@icon64 +@icon64URL +``` + +#### 不支持的属性 + +AdGuard 将忽略这些属性。 + +```text +@unwrap +``` + +#### 支持的 GM 函数 + +AdGuard 同时支持旧的 GM\_ 函数和使用 GM 对象的新 GM4 API。 + +#### 数值 + +:::note + +所有列出的旧 Greasemonkey 函数都已过时，但仍受支持。 + +::: + +```text +GM.info / GM_info +GM.setValue / GM_setValue +GM.getValue / GM_getValue +GM.listValues / GM_listValues +GM.deleteValue / GM_deleteValue +GM.getResourceUrl / GM_getResourceURL +GM.setClipboard / GM_setClipboard +GM.xmlHttpRequest / GM_xmlhttpRequest +GM.openInTab / GM_openInTab +GM.notification +unsafeWindow +GM_getResourceText +GM_addStyle +GM_log +``` + +[Here](https://wiki.greasespot.net/GM.info) you can find more information about Greasemonkey API. + +#### 示例 + +```javascript +// ==UserScript== +// @name Name as shown to the user when locale is english or unknown +// @name:ru Name as shown to the user when locale is russian +// @description Description as shown to the user when locale is english or unknown +// @description:ru Description as shown to the user when locale is russian +// @icon https://myhomepage.com/myuserscript.png +// @version 1.0.0.0 +// @downloadURL https://dl.myhomepage.org/myuserscript.user.js +// @updateURL https://dl.myhomepage.org/myuserscript.meta.js +// @homepageURL https://myhomepage.com/myuserscript +// @include * +// @exclude *://website.com/* +// @resource https://myhomepage.com/myuserscript.css +// @require https://myhomepage.com/mylibrary.js +// @grant property:settings +// @grant GM_getValue +// @grant GM_setValue +// @grant GM_deleteValue +// @grant GM_listValues +// @grant GM_getResourceText +// @grant GM_getResourceURL +// @grant GM_addStyle +// @grant GM_log +// @grant GM_setClipboard +// @grant GM_xmlhttpRequest +// @grant unsafeWindow +// @grant GM_info +// @grant GM_openInTab +// @grant GM_registerMenuCommand +// @run-at document-start +// ==/UserScript== +!function(){( + console.log("I am loaded!"); +)}(); +``` + +## 用户样式 + +Userstyles allow users to customize their online experience. Whether you’re looking to change the appearance of a website or automate repetitive tasks, styles offer a world of possibilities. + +AdGuard has the option to upload or create your own userstyles. This is an advanced feature, so you will need some knowledge of HTML and CSS. + +:::info Supported apps + +Currently, two AdGuard apps allow you to create and manage userstyles: AdGuard for Windows (v7.19 or later) and AdGuard for Mac (v2.16 or later). We also plan to implement this new feature in AdGuard v4.8 for Android in the nearest future. + +::: + +This is an experimental feature, so if you encounter any problems while adding or creating a userstyle, please contact our support team at . + +### How to set up a userstyle in AdGuard + +You can download userstyles from various websites. One of the most popular userstyle websites is [https://userstyles.world/](https://userstyles.world/explore), which we will use as an example for the following instructions on how to set up the userstyle in AdGuard. + +1. Follow the link above and choose the userstyle you like + +2. Right-click the _Install_ button and choose _Copy Link Address_ + +3. Open AdGuard settings → _Extensions_ + +4. Press the [+] button and paste the userstyle link + +5. 完成！ + +If you’re familiar with CSS rules, you can also create the userstyles yourself. + +:::note + +We don’t support userstyles that contain `@var` or `@advanced` in the metadata. AdGuard also doesn’t support `@preprocessor` without the `default` value. + +::: + +1. Open AdGuard settings → _Extensions_ + +2. Press the [+] button and choose the _Create userstyle_ option. A new window will appear on your screen + +3. To create a userstyle, first write the title with metadata, for example + + ```CSS + /* ==UserStyle== + @name New userstyle + @version 1.0 + ==/UserStyle== */ + ``` + +4. Write the CSS part after the meta data. AdGuard supports website domain names matching (`@-moz-document domain(…), …`). For example: + + ```CSS + body { + background: gray; + } + ``` + + Or: + + ```CSS + @-moz-document domain('example.org'), + domain('example.net'), + domain('example.com') body { + background: gray; + } + ``` + +5. Once you’re finished, press _Save and Close_. Your new userstyle has been successfully added to AdGuard + +### 示例 + +```css +/* ==UserStyle== +@name Example userstyle +@namespace https://example.org/userstyle +@homepageURL https://example.org/userstyle +@version 1.0.0 +@license Other +@description This is an example +@author example +@preprocessor default +==/UserStyle== */ +@-moz-document regexp("https?\:\/\/(www\.)?example\.(org|com).*") { + body { + background-color: #000000 !important; + } +} +``` diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/general/how-to-install.md b/i18n/zh-CN/docusaurus-plugin-content-docs/current/general/how-to-install.md index 69e203cc655..70c6f007a71 100644 --- a/i18n/zh-CN/docusaurus-plugin-content-docs/current/general/how-to-install.md +++ b/i18n/zh-CN/docusaurus-plugin-content-docs/current/general/how-to-install.md @@ -1,6 +1,6 @@ --- title: 如何安装 AdGuard -sidebar_position: 8 +sidebar_position: 9 --- 根据您想安装的 AdGuard 应用程序或浏览器扩展，请按照以下不同的链接找到相关文章： diff --git a/i18n/zh-TW/docusaurus-plugin-content-docs/current/adguard-for-windows/features/extensions.md b/i18n/zh-TW/docusaurus-plugin-content-docs/current/adguard-for-windows/features/extensions.md index 260fa0e83b3..17884a6df33 100644 --- a/i18n/zh-TW/docusaurus-plugin-content-docs/current/adguard-for-windows/features/extensions.md +++ b/i18n/zh-TW/docusaurus-plugin-content-docs/current/adguard-for-windows/features/extensions.md @@ -9,7 +9,7 @@ This article covers AdGuard for Windows, a multifunctional ad blocker that prote ::: -AdGuard can significantly broaden website functionality working as a [user script manager](/general/extensions). AdGuard Users can add their own scripts, as well as manage existing ones. +AdGuard can significantly extend website functionality by working as a [userscript manager](/general/extensions.md). AdGuard users can add their own scripts as well as manage existing ones. ![Extensions \*mobile\_border](https://cdn.adtidy.org/content/kb/ad_blocker/windows/overview/userscripts.png) diff --git a/i18n/zh-TW/docusaurus-plugin-content-docs/current/general/extensions.md b/i18n/zh-TW/docusaurus-plugin-content-docs/current/general/extensions.md new file mode 100644 index 00000000000..0cf454b4329 --- /dev/null +++ b/i18n/zh-TW/docusaurus-plugin-content-docs/current/general/extensions.md @@ -0,0 +1,301 @@ +--- +title: Extensions +sidebar_position: 6 +--- + +## Userscripts + +Userscripts (we also call them "extensions") are, de facto, miniprograms written in JavaScript. They modify or extend the functionality of one or more websites. Many AdGuard users may be already familiar with such userscripts as AdGuard Assistant, Popup Blocker, and AdGuard Extra. + +:::note Supported apps + +AdGuard can significantly broaden website functionality by acting as a userscript manager. You can add your custom scripts or manage the existing ones in our three products: [AdGuard for Windows](/adguard-for-windows/features/extensions), [AdGuard for Android](/adguard-for-android/features/settings#userscripts), and [AdGuard for Mac](/adguard-for-mac/features/extensions). + +::: + +### Recommended AdGuard scripts + +These userscripts come directly from the AdGuard developers, and we can guarantee that they are effective and safe. For some of the userscripts developed by others that we consider good and reliable, [scroll down to the next section](#top-picks). You can also find some of the [popular websites with scripts](#more-userscripts) below, but remember that whenever you download a userscript from an unknown source, you are exposing yourself to a certain risk, as some scripts may be harmful to your computer. + +#### AdGuard Extra + +An extension that blocks ads in difficult cases when the usual filter-based approach is not enough. AdGuard Extra comes pre-installed in AdGuard standalone apps, except for the one for iOS, so you don't need to do anything to enable it. However, if you want to use it alongside AdGuard Browser Extension or any other ad blocker, you'll need to use an additional extension. Learn more about this userscript and how to install it on [GitHub](https://github.com/AdguardTeam/AdGuardExtra). + +![AdGuard Extra](https://cdn.adtidy.org/content/kb/ad_blocker/general/adguard-extra.png) + +#### AdGuard Popup Blocker + +The name speaks for itself: it blocks popups — one of the most annoying types of ads on websites. Learn more about this userscript, its key features, and installation on [GitHub](https://github.com/AdguardTeam/PopupBlocker). + +![AdGuard Popup Blocker](https://cdn.adtidy.org/content/kb/ad_blocker/general/popup-blocker-installation.png) + +#### AdGuard Assistant (legacy version) + +This custom extension is designed to control filtering directly from the browser page (manual blocking, allowlisting, etc.). + +:::note + +This version of Assistant is legacy and there is no point in using it on new systems, as it has been replaced with the full-fledged [Browser Assistant](https://adguard.com/adguard-assistant/overview.html). However, the legacy Assistant may be useful if there is no Browser Assistant for your browser. If this is your case, you can learn how to install AdGuard Assistant on [GitHub](https://github.com/AdguardTeam/AdguardAssistant). + +::: + +#### Disable AMP + +A script that is only pre-installed in AdGuard for Android. It disables AMP (Accelerated Mobile Pages) on the Google search results page. Learn more about this userscript and how to install it on [GitHub](https://github.com/AdguardTeam/DisableAMP). + +![Disable AMP](https://cdn.adtidy.org/content/kb/ad_blocker/general/disable-amp-installation.png) + +### Top picks outside AdGuard{#top-picks} + +These userscripts are not developed by AdGuard, and therefore we can't give a 100% guarantee that they are safe and/or work at all times. However, in our experience they deserve a recommendation because they've all earned their good reputation. + +#### Don't track me Google + +This script removes Google's tracking feature from the links in Google search results. It speeds up the loading of search results and allows you to right-click or tap to copy the link URL. + +Its source code is [available on GitHub](https://github.com/Rob--W/dont-track-me-google). This userscript can be downloaded from [GreasyFork](https://greasyfork.org/en/scripts/428243-don-t-track-me-google) and installed in any AdGuard CoreLibs-based app. + +#### microShield + +A userscript for people visiting Korean websites and some international websites. The microShield userscript blocks Ad-Shield ads and anti-adblocks. Its original source code is available at [asdefuser](https://github.com/seia-soto/userscripts/tree/master/sources/asdefuser) and [AdShield Defuser](https://github.com/seia-soto/adshield-defuser). This userscript can be installed in AdGuard CoreLibs-based apps, Violentmonkey, Tampermonkey, and [quoid/userscripts](https://github.com/quoid/userscripts). Learn more about microShield and how to install it on [GitHub](https://github.com/List-KR/microShield). + +### Where can you get more userscripts?{#more-userscripts} + +Since userscripts are mainly created by enthusiasts, you should be cautious when installing them. Any script from an unknown source carries a potential risk. Yet, there is a great variety of interesting scripts that, if installed carefully and responsibly, can really make using some websites more convenient. + +Here we will describe some of the most popular userscript catalogs. + +#### Userscript.Zone + +[Userscript.Zone](https://www.userscript.zone) is a website that allows searching for userscripts by entering a matching URL or domain. The website is easy to use and has a high level of credibility as only scripts from moderated pages are displayed. + +#### Greasy Fork + +[Greasy Fork](https://greasyfork.org/) is a userscript catalog of Stylish creators. The scripts in this catalog are moderated, so their credibility is much higher. + +#### OpenUserJS.org + +[OpenUserJS.org](https://openuserjs.org/) is an open-source userscript catalog written in nodeJS. It's not moderated, so keep an eye out for suspicious scripts. + +#### Community + +If you like the idea of customizing your browser with userscripts and have questions, you can ask them on one of these websites: + +- [Stackoverflow](https://stackoverflow.com/questions/tagged/userscripts) +- [FreeNode](https://webchat.freenode.net/#greasemonkey) +- [Reddit](https://www.reddit.com/r/userscripts/) + +### Development + +#### Request license + +If you are developing your own custom script and want to test how it works with AdGuard, you can request a beta license key for the app. + +To get it, please send an email to devteam@adguard.com with the following information: + +**Subject:** Userscript author license request + +**Body:** Please tell us about the userscripts you are working on. + +Here is a [mailto link](mailto:devteam@adguard.com?Subject=Userscript%20author%20license%20request\&Body=Hello%2C%0A%0AMy%20userscript%28s%29%3A%20LINK). + +#### Compatibility + +#### Metadata block + +#### Supported properties + +```text +@name +@namespace +@description +@version +@match +@include +@exclude +@grant +@connect +@require +@resource +@downloadURL +@updateURL +@supportURL +@homepageURL +@homepage +@website +@source +@run-at +@noframes +@icon +@iconURL +@defaulticon +@icon64 +@icon64URL +``` + +#### Unsupported properties + +These properties will be simply ignored by AdGuard. + +```text +@unwrap +``` + +#### Supported GM functions + +AdGuard supports both old GM\_ functions and new GM4 API that use GM object. + +#### Values + +:::note + +All listed old Greasemonkey functions are deprecated but still supported. + +::: + +```text +GM.info / GM_info +GM.setValue / GM_setValue +GM.getValue / GM_getValue +GM.listValues / GM_listValues +GM.deleteValue / GM_deleteValue +GM.getResourceUrl / GM_getResourceURL +GM.setClipboard / GM_setClipboard +GM.xmlHttpRequest / GM_xmlhttpRequest +GM.openInTab / GM_openInTab +GM.notification +unsafeWindow +GM_getResourceText +GM_addStyle +GM_log +``` + +[Here](https://wiki.greasespot.net/GM.info) you can find more information about Greasemonkey API. + +#### Example + +```javascript +// ==UserScript== +// @name Name as shown to the user when locale is english or unknown +// @name:ru Name as shown to the user when locale is russian +// @description Description as shown to the user when locale is english or unknown +// @description:ru Description as shown to the user when locale is russian +// @icon https://myhomepage.com/myuserscript.png +// @version 1.0.0.0 +// @downloadURL https://dl.myhomepage.org/myuserscript.user.js +// @updateURL https://dl.myhomepage.org/myuserscript.meta.js +// @homepageURL https://myhomepage.com/myuserscript +// @include * +// @exclude *://website.com/* +// @resource https://myhomepage.com/myuserscript.css +// @require https://myhomepage.com/mylibrary.js +// @grant property:settings +// @grant GM_getValue +// @grant GM_setValue +// @grant GM_deleteValue +// @grant GM_listValues +// @grant GM_getResourceText +// @grant GM_getResourceURL +// @grant GM_addStyle +// @grant GM_log +// @grant GM_setClipboard +// @grant GM_xmlhttpRequest +// @grant unsafeWindow +// @grant GM_info +// @grant GM_openInTab +// @grant GM_registerMenuCommand +// @run-at document-start +// ==/UserScript== +!function(){( + console.log("I am loaded!"); +)}(); +``` + +## Userstyles + +Userstyles allow users to customize their online experience. Whether you’re looking to change the appearance of a website or automate repetitive tasks, styles offer a world of possibilities. + +AdGuard has the option to upload or create your own userstyles. This is an advanced feature, so you will need some knowledge of HTML and CSS. + +:::info Supported apps + +Currently, two AdGuard apps allow you to create and manage userstyles: AdGuard for Windows (v7.19 or later) and AdGuard for Mac (v2.16 or later). We also plan to implement this new feature in AdGuard v4.8 for Android in the nearest future. + +::: + +This is an experimental feature, so if you encounter any problems while adding or creating a userstyle, please contact our support team at . + +### How to set up a userstyle in AdGuard + +You can download userstyles from various websites. One of the most popular userstyle websites is [https://userstyles.world/](https://userstyles.world/explore), which we will use as an example for the following instructions on how to set up the userstyle in AdGuard. + +1. Follow the link above and choose the userstyle you like + +2. Right-click the _Install_ button and choose _Copy Link Address_ + +3. Open AdGuard settings → _Extensions_ + +4. Press the [+] button and paste the userstyle link + +5. Done! + +If you’re familiar with CSS rules, you can also create the userstyles yourself. + +:::note + +We don’t support userstyles that contain `@var` or `@advanced` in the metadata. AdGuard also doesn’t support `@preprocessor` without the `default` value. + +::: + +1. Open AdGuard settings → _Extensions_ + +2. Press the [+] button and choose the _Create userstyle_ option. A new window will appear on your screen + +3. To create a userstyle, first write the title with metadata, for example + + ```CSS + /* ==UserStyle== + @name New userstyle + @version 1.0 + ==/UserStyle== */ + ``` + +4. Write the CSS part after the meta data. AdGuard supports website domain names matching (`@-moz-document domain(…), …`). For example: + + ```CSS + body { + background: gray; + } + ``` + + Or: + + ```CSS + @-moz-document domain('example.org'), + domain('example.net'), + domain('example.com') body { + background: gray; + } + ``` + +5. Once you’re finished, press _Save and Close_. Your new userstyle has been successfully added to AdGuard + +### Example + +```css +/* ==UserStyle== +@name Example userstyle +@namespace https://example.org/userstyle +@homepageURL https://example.org/userstyle +@version 1.0.0 +@license Other +@description This is an example +@author example +@preprocessor default +==/UserStyle== */ +@-moz-document regexp("https?\:\/\/(www\.)?example\.(org|com).*") { + body { + background-color: #000000 !important; + } +} +``` diff --git a/i18n/zh-TW/docusaurus-plugin-content-docs/current/general/how-to-install.md b/i18n/zh-TW/docusaurus-plugin-content-docs/current/general/how-to-install.md index bae3060668a..106a29529a8 100644 --- a/i18n/zh-TW/docusaurus-plugin-content-docs/current/general/how-to-install.md +++ b/i18n/zh-TW/docusaurus-plugin-content-docs/current/general/how-to-install.md @@ -1,6 +1,6 @@ --- title: How to install AdGuard -sidebar_position: 8 +sidebar_position: 9 --- Depending on which AdGuard app or browser extension you want to install, follow one of these links to find the relevant article: