Skip to content

Commit b901510

Browse files
committed
📝 Update help
- Status badge colors - Domain frame mode - YouTube pre-censored caption filtering option
1 parent 5fd6b46 commit b901510

File tree

1 file changed

+15
-5
lines changed

1 file changed

+15
-5
lines changed

src/static/optionPage.html

Lines changed: 15 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -685,10 +685,11 @@ <h3 id="general-settings">General Settings</h3>
685685
<li>You can also choose your theme by clicking the sun/moon icon in the menu.</li>
686686
</ul>
687687
</li>
688-
<li><strong>Show number of filtered words</strong>: Show a counter on the extension button with the number of filtered words on the current page.<ul>
689-
<li><strong>Blue</strong>: Normal mode</li>
690-
<li><strong>Red</strong>: Advanced mode</li>
691-
<li><strong>Green</strong>: Audio Muting mode (Shows even when no words have been filtered)</li>
688+
<li><strong>Show number of filtered words</strong>: Show a counter on the extension button with the number of filtered words on the current page. It also serves as a status for the current tab:<ul>
689+
<li>🟦 Blue: Normal mode <em>(only visible when there has been at least 1 word filtered on the current tab)</em></li>
690+
<li>🟥 Red: Advanced/Deep mode enabled</li>
691+
<li>🟪 Purple: Audio supported on page, actively watching for supported captions/subtitles</li>
692+
<li>🟩 Green: Audio supported on page, supported captions have been found</li>
692693
</ul>
693694
</li>
694695
<li><strong>Show summary of filtered words</strong>: Show a summary of the words filtered on the current page.</li>
@@ -733,6 +734,11 @@ <h3 id="domain-mode">Domain Mode:</h3>
733734
<li><strong>Normal: <em>(default)</em></strong> Filter all domains unless specifically disabled</li>
734735
<li><strong>Minimal:</strong> Only filter pages that are specifically enabled</li>
735736
</ul>
737+
<h3 id="frame-mode">Frame Mode:</h3>
738+
<ul>
739+
<li><strong>Filter all frames <em>(default)</em></strong>: Filter all frames, unless disabled for a specific domain</li>
740+
<li><strong>Don&#39;t filter all frames</strong>: Only filter frames when enabled for a specific domain</li>
741+
</ul>
736742
<h3 id="domains-1">Domains:</h3>
737743
<p>Adjust the domain list for the currently selected mode. To match google.com and all its sub-domains, simply add <code>google.com</code>. If you want to just match Gmail, you can add <code>mail.google.com</code>.</p>
738744
<p>When browsing a web page, you can also toggle the filter for the current domain from the context (right-click) menu, or using the extension&#39;s Popup menu.</p>
@@ -771,6 +777,7 @@ <h1 id="audio">Audio</h1>
771777
<li><strong>Only mute audio</strong> - This will disable the text filter, and only perform filtering/muting on supported video sites.
772778
This mode will disable the text filter everywhere, and only mute audio (and filter subtitles) on supported sites.</li>
773779
<li><strong>Require subtitles to be showing</strong> - This setting is only for sites using the &quot;cue&quot; mode, and will only filter when subtitles are set to &quot;showing&quot; for the current video. If enabled, this typically means there is a manual step involved in turning on the subtitles (varies by site) to enable audio muting through the filter.</li>
780+
<li><strong>Mute pre-censored captions on YouTube</strong> - YouTube sometimes pre-censors profanity in auto-generated captions and replaces them with <code>[ _ ]</code>. When enabled, this option will attempt to mute those words. <em>(The default on)</em></li>
774781
<li><strong>YouTube Minimum Muting</strong> - Set a minimum amount of time (in seconds) that the filter will mute matched words in a YouTube video using auto-generated subtitles. <em>(The default is 0)</em></li>
775782
<li><strong>Custom Sites</strong> - Add support for <a href="https://github.com/richardfrost/AdvancedProfanityFilter/wiki/Audio#custom-audio-sites-advanced">Custom Audio Muting Sites</a>.</li>
776783
</ul>
@@ -802,9 +809,11 @@ <h1 id="stats">Stats</h1>
802809
<p>The &quot;Remove words&quot; feature, found under the stats table, allows the user to specify a threshold for removing words that don&#39;t get filtered often. To use the feature, provide a number and all words that have been filtered less than that number can be removed. This can be helpful to help clear words from your wordlist that may not be necessary.</p>
803810
<p><em>TIP: Before making batch changes it&#39;s recommended to save a backup, which you can do from the prompt before confirming the action.</em></p>
804811
<h1 id="popup">Popup</h1>
805-
<p>The popup provides access to some quick settings:</p>
812+
<p>The popup provides access to some quick details and settings:</p>
806813
<ul>
814+
<li><strong>Audio Status</strong> - Shows either &quot;Watching for captions&quot; or &quot;Muting active&quot; depending on the current tab&#39;s status. <em>(Only available on supported audio pages)</em></li>
807815
<li><strong>Domain Toggle</strong> - Switch to turn the filter on/off for the current domain.</li>
816+
<li><strong>Audio Muting Status</strong> - Status line for pages which support audio muting.</li>
808817
<li><strong>Advanced Mode</strong> - Switch Advanced Mode on/off for the current domain.</li>
809818
<li><strong>Filter</strong> - Change the filter mode. <strong>This is a global setting and affects all pages.</strong></li>
810819
<li><strong>Text Wordlist</strong> - Change the active wordlist for text for the current domain (Only when wordlists are enabled)</li>
@@ -820,6 +829,7 @@ <h1 id="context-menu">Context Menu</h1>
820829
<li><strong>Toggle for tab</strong> - Turn the filter on/off for the current tab (any domain)</li>
821830
<li><strong>Toggle for domain</strong> - Turn the filter on/off for the current domain</li>
822831
<li><strong>Toggle advanced for domain</strong> - Switch the Advanced Mode on/off for the current domain</li>
832+
<li><strong>Toggle frames for domain</strong> - Switch filtering frames on/off for the current domain</li>
823833
<li><strong>Options</strong> - Open the options page</li>
824834
</ul>
825835
</div>

0 commit comments

Comments
 (0)