Skip to content

Commit f86bab0

Browse files
committed
update screenshots and documentation for v6.0.0 alpha 1
1 parent a082d88 commit f86bab0

20 files changed

Lines changed: 58 additions & 91 deletions

.markdownlint.json

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
{
2+
"MD013": false,
3+
"MD024": false
4+
}

CHANGELOG.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,25 @@
11
# DeviantArt Filter Changelog
22

3+
## Version 6.0.0 Alpha 1 (April 14, 2020)
4+
5+
*(**Tote**: This entry may be updated and/or replaced with future version 6.0.0 alpha/beta/final/etc release information.)*
6+
7+
### New Features
8+
9+
- **Eclipse Support**. DeviantArt Filter now supports [the new site (a.k.a Eclipse)](https://www.deviantarteclipse.com/). It also supports the "classic" site fore users who are not yet using Eclipse.
10+
- **New Management Page**. The management page has been completely rewritten using more modern frameworks.
11+
- **Filter by Title**. Tag filters have been replaced with keyword filters, which apply to both tags and titles for all deviations.
12+
- **Quick Filter Tag Context Menu**. A new context (right-click) menu is available on all tag links; use this to quickly create a keyword filter for the linked tag.
13+
- **Faster Metadata Lookup**. DeviantArt Filter v6+ uses faster APIs to load metadata (tags and categories) while you browse, so filters should apply faster than they did in v5.x.
14+
15+
### Known issues
16+
17+
- **Filters are not validated**. When creating/updating filters, no restrictions or validations are implemented to help prevent invalid filters from being created.
18+
- **Options are missing**. There are currently no configurable options for DeviantArt Filter v6.0.0.
19+
- **Placeholders**: Placeholders cannot be disabled for the new Eclipse site, as the Eclipse layout calculates grid positions for each thumbnail, and removing an item from the grid breaks the layout. The ability to turn off placeholders may be re-implemented for the classic site in the future, but there are currently no plans to bring it back.
20+
- **Placeholder Colors**: The colors for placeholders cannot currently be adjusted, but are instead hard-coded for each site theme (dark/light/green for Eclipse, and classic).
21+
- **Metadata Caching**: DeviantArt Filter v6.0.0 does not currently cache metadata like v5.x did; it metadata caching is re-implemented, the corresponding options will be brought back to allow users to disable/configure the caching behavior.
22+
323
## Version 5.1 (February 6, 2019)
424

525
### New Features

README.md

Lines changed: 34 additions & 91 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,6 @@
1-
[<img align="right" src="https://travis-ci.com/rthaut/deviantART-Filter.svg?branch=master" alt="Build Status"/>](https://travis-ci.com/rthaut/deviantART-Filter)
2-
[<img align="right" src="https://badges.renovateapi.com/github/rthaut/deviantART-Filter" alt="Renovate Status"/>](https://renovatebot.com/)
1+
# DeviantArt Filter 6.0.0 Alpha 1
32

4-
# DeviantArt Filter 5.1.2
5-
6-
> Allows configurable filtering/removal of deviations by user, tag, and/or category on DeviantArt
3+
> Allows configurable filtering/removal of deviations by user, keyword, and/or category on DeviantArt
74
85
## Table of Contents
96

@@ -14,31 +11,17 @@
1411
- [Options](#options)
1512
- [Screenshots](#screenshots)
1613

17-
_(TOC generated by [verb](https://github.com/verbose/verb) using [markdown-toc](https://github.com/jonschlinkert/markdown-toc))_
18-
1914
## Overview
2015

21-
Have you ever want to block/filter deviations (a.k.a. submissions) while browsing [DeviantArt](https://www.deviantart.com)? **Well now you can!** Simply [install DeviantArt Filter](#installation) in your web browser of choice and start filtering by user, tag, and/or category.
16+
Have you ever want to block/filter deviations (a.k.a. submissions) while browsing [DeviantArt](https://www.deviantart.com)? **Well now you can!** Simply [install DeviantArt Filter](#installation) in your web browser of choice and start filtering by user, keyword, and/or category.
2217

2318
![DeviantArt Filter Promotional Image](/screenshots/Promo.png?raw=true)
2419

2520
* * *
2621

2722
## Installation
2823

29-
| Web Browser | Information | Download Link | Documentation |
30-
| ----------- | ----------- | ------------- | ------------- |
31-
| Google Chrome | [![Chrome Web Store][chrome-image-version]][chrome-url] [![Chrome Web Store][chrome-image-download]][chrome-url] | [Download from the Chrome Web Store][chrome-url] | [README for Chrome](/docs/chrome/README.md#readme) |
32-
| Mozilla Firefox | [![Mozilla Add-on][firefox-image-version]][firefox-url] [![Mozilla Add-on][firefox-image-download]][firefox-url] | [Download from Mozilla Add-ons][firefox-url] | [README for Firefox](/docs/firefox/README.md#readme) |
33-
| Microsoft Edge | _Coming Soon ([#40](https://github.com/rthaut/deviantART-Filter/issues/40))_ | _N/A_ | _N/A_ |
34-
35-
[chrome-url]: https://chrome.google.com/webstore/detail/deviantart-filter/odlmamilbohnpnoomjclomghphbajikp
36-
[chrome-image-download]: https://img.shields.io/chrome-web-store/d/odlmamilbohnpnoomjclomghphbajikp.svg
37-
[chrome-image-version]: https://img.shields.io/chrome-web-store/v/odlmamilbohnpnoomjclomghphbajikp.svg
38-
39-
[firefox-url]: https://addons.mozilla.org/en-US/firefox/addon/deviantart-filter/
40-
[firefox-image-download]: https://img.shields.io/amo/d/deviantart-filter.svg
41-
[firefox-image-version]: https://img.shields.io/amo/v/deviantart-filter.svg
24+
***Find the latest alpha/beta builds on the [releases](https://github.com/rthaut/deviantART-Filter/releases) page.***
4225

4326
* * *
4427

@@ -56,48 +39,52 @@ This permission is used to apply filters to DeviantArt pages and to add the quic
5639

5740
### Access browsing history
5841

59-
The History permission is used to remove the DeviantArt Filter Management Panel/Screen from your browser's history.
42+
The History permission is used to remove the DeviantArt Filter Management Page from your browser's history.
6043

6144
### Display notifications to you
6245

6346
The Notifications permission is used to display a notification message when upgrading from version 4.x to version 5.x.
6447

6548
### Access browser tabs
6649

67-
The Tabs permission is used to apply filter changes from the Management Panel/Screen to all open DeviantArt tabs, to enable/disable the DeviantArt Filter icon, and to switch to the Management Panel/Screen (if it is already open) when clicking the DeviantArt Filter icon.
50+
The Tabs permission is used to apply filter changes from the Management Page to all open DeviantArt tabs, to enable/disable the DeviantArt Filter icon, and to switch to the Management Page (if it is already open) when clicking the DeviantArt Filter icon.
6851

6952
* * *
7053

7154
## Usage
7255

73-
### Opening the Management Panel/Screen
56+
### Opening the Management Page
7457

7558
1. While on [DeviantArt](https://www.deviantart.com), click the red logo that appears on the right side of the address bar. ![DeviantArt Filter Page Action Demo](/screenshots/Page-Action-Demo.png?raw=true)
7659
2. The configuration screen will open automatically when you click the icon.
7760

7861
### Creating and Removing Filters
7962

80-
#### You can filter deviations by artist, category, and/or tag through the management panel/screen
63+
#### You can filter deviations by artist, category, and/or keyword through the management page
8164

82-
1. After [opening the Management Panel/Screen](#opening-the-management-panelscreen), navigate to any of the Manage [Users](#manage-users-page)/[Tags](#manage-tags-page)/[Categories](#manage-categories-page) tabs.
83-
2. To create a new filter, use the form at the top of the tab.
84-
- For users, enter their username.
85-
- For tags, enter a single tag (*no spaces*), then choose if the tag should use wildcard matching.
86-
- For categories, select the parent category, then (optionally) select sub-categories.
87-
3. Use the table that is displayed below the form to view all of your existing filters.
65+
1. After opening the [Management Page](#dashboard), navigate to any of the Manage [Users](#manage-users)/[Keywords](#manage-keywords)/[Categories](#manage-categories) views.
66+
2. Use the table that is displayed to view all of your existing filters.
8867
- You can sort the table by clicking the heading of any column.
89-
- You can page through your filters using the pagination controls in the lower-left corner.
90-
- You can choose how many filters are displayed per page using the controls in the lower-right corner.
91-
4. To remove a filter, click the `Remove Filter` button next to the filter you want to remove.
68+
- You can page through your filters using the pagination controls below the table.
69+
3. To create a new filter, use the plus icon (:heavy_plus_sign:) above the table to the right of the search bar.
70+
- For users, enter their username.
71+
- For keywords, enter a single keyword (*no spaces*), then choose if the keyword should use wildcard matching by checking the wildcard checkbox.
72+
- For categories, select the category path from the menu (you can type in the field to filter results).
73+
4. To change an existing filter, like the pencil icon (:pencil2:) next to the filter you want to change.
74+
- Click the checkmark icon (:heavy_check_mark:) to the left of the filter you are changing to **save** your change(s).
75+
- Click the multiplication icon (:heavy_multiplication_x:) next to the left of the filter you are changing to **discard** your change(s).
76+
5. To remove a filter, click the trash can button next to the filter you want to remove.
77+
- Click the checkmark icon (:heavy_check_mark:) to the left of the filter you are removing to **confirm**.
78+
- Click the multiplication icon (:heavy_multiplication_x:) next to the left of the filter you are changing to **cancel**.
9279

9380
### Exporting/Importing Filters
9481

9582
DeviantArt Filter allows you to export and import filters from a JSON file. This is mostly for keeping your filters in sync between browsers/computers, but is handy for backup purposes as well.
9683

97-
1. After [opening the Management Panel/Screen](#opening-the-management-panelscreen), navigate to the [Import/Export Filters](#importexport-filters-page) tab.
84+
1. After [opening the Management Page](#opening-the-management-page), navigate to the [Import/Export Filters](#importexport-filters) view.
9885
2. To export your current filters to a JSON file, click the `Export Filter Data` button, then open/save the file when prompted (it will use your browser's native download functionality).
9986
3. To import filters from a JSON file, either drag and drop the file onto the designated box, or click the box to open a File Browser dialog and select your JSON file.
100-
- After the import has finished, a table showing the results of the import will be displayed. This includes how many filters were imported successfully, as well as how many filters failed to import (either because they were invalid or were duplicate).
87+
- After the import has finished, a table showing the results of the import will be displayed. This includes how many filters were imported successfully, as well as how many filters failed to import and how many were duplicates.
10188

10289
### Quick Hiding Users While Browsing
10390

@@ -109,72 +96,28 @@ DeviantArt Filter allows you to export and import filters from a JSON file. This
10996

11097
## Options
11198

112-
Options for DeviantArt filtered are configured through the [Management Panel/Screen](#opening-the-management-panelscreen) on the [Options](#options-page) tab.
113-
114-
### Use Placeholders for Filtered Deviations
115-
116-
`When enabled, a placeholder image is displayed instead of the actual thumbnail for filtered deviations. Disable this setting to completely remove filtered deviation thumbnails.`
117-
118-
If you want to see/know when a deviation was filtered (and why), enable this option (it is enabled by default). This will show a placeholder instead of the deviation's thumbnail (similar to Mature Content that is blocked). If you would rather just completely hide deviations matching any of your filters, disable this option, and the thumbnails will be removed entirely.
119-
120-
### Background/Logo/Text Color for Placeholders
121-
122-
`Set a custom color for the background/logo/text of the placeholder shown in place of filtered deviations.`
123-
124-
Use these three options to control the style of the placeholders that are inserted for filtered deviations. These settings are ignored when placeholders are disabled altogether.
125-
126-
### Management Panel Type
127-
128-
`Specifies where/how the main management panel is displayed when clicking the DeviantArt Filter logo by the address bar.`
129-
130-
This option allows you to control if the DeviantArt Filter Management page is opened in a new tab in your current browser window, or if a new popup window is opened. The default behavior for this option is to use a new tab in the current window.
131-
132-
### Metadata Batch Size
133-
134-
`Specifies the number of deviations for which to load metadata at a time. Setting this value to a lower number may improve browsing performance.`
135-
136-
This option limits how much metadata (used for category and tag filters) is loaded at once. The default is 96, which means that metadata for up to 96 deviations is retrieved for deviations on the page and loaded for the tag and category filters to use. Lowering this number may improve browsing performance, so you can try different values for this option to see if you notice any improvements.
137-
138-
### Number of Days to Cache Metadata
139-
140-
`Specifies the number of days to cache metadata (for tags and categories) locally for deviations. Set this value to disable local caching completely.`
141-
142-
By default, DeviantArt Filter caches the metadata for deviations while browsing [DeviantArt](https://www.deviantart.com) on your computer. This is done so that your category and tag filters can be applied more quickly on subsequent visits, as retrieving metadata for each page of deviations takes 2-5 seconds on an average internet connection. You can disable the local cache completely by setting this option to `0`, but this will cause a noticeable delay before tag and category filters are applied. You can also increase this setting, although setting a value that is too large may cause performance issues.
143-
144-
### Show Metadata Debug Indicators
145-
146-
`When enabled, deviation thumbnails with missing metadata (for tags and categories) have a red outline, and deviations with metadata have a green outline. This is primarily for debugging, but can be a neat visual for curious people.`
147-
148-
This setting, as the description states, is primarily for troubleshooting and debugging. It is used simply to show which deviations have loaded metadata (i.e. their tags and which category they are in). Because metadata has to be fetched from DeviantArt's API, your tag and category filters cannot be applied until that metadata is loaded. The outlines (green for loaded, red for NOT loaded), can help you see why your filters may not seem to be working.
99+
*Options are currently **not** available in DeviantArt Filter v6.0.0*
149100

150101
* * *
151102

152103
## Screenshots
153104

154-
### Options Page
155-
156-
![Screenshot of the DeviantArt Filter Options Page](/screenshots/Options.png?raw=true)
157-
158-
### Manage Users Page
159-
160-
![Screenshot of the DeviantArt Filter Manage Users Page](/screenshots/Users.png?raw=true)
161-
162-
### Manage Tags Page
105+
### Dashboard
163106

164-
![Screenshot of the DeviantArt Filter Manage Tags Page](/screenshots/Tags.png?raw=true)
107+
![Screenshot of the DeviantArt Filter Dashboard](/screenshots/Dashboard.png?raw=true)
165108

166-
### Manage Categories Page
109+
### Manage Users
167110

168-
![Screenshot of the DeviantArt Filter Manage Categories Page](/screenshots/Categories.png?raw=true)
111+
![Screenshot of the DeviantArt Filter Manage Users](/screenshots/Users.png?raw=true)
169112

170-
### Import/Export Filters Page
113+
### Manage Keywords
171114

172-
![Screenshot of the DeviantArt Filter Import/Export Page](/screenshots/Import-Export.png?raw=true)
115+
![Screenshot of the DeviantArt Filter Manage Keywords](/screenshots/Keywords.png?raw=true)
173116

174-
### Browse Page with Placeholders Enabled
117+
### Manage Categories
175118

176-
![Screenshot of DeviantArt with placeholders enabled for filtered deviations](/screenshots/Placeholders.png?raw=true)
119+
![Screenshot of the DeviantArt Filter Manage Categories](/screenshots/Categories.png?raw=true)
177120

178-
### Browse Page with Placeholders Disabled
121+
### Import/Export Filters
179122

180-
![Screenshot of DeviantArt with placeholders disabled for filtered deviations](/screenshots/No-Placeholders.png?raw=true)
123+
![Screenshot of the DeviantArt Filter Import/Export](/screenshots/Import-Export.png?raw=true)

screenshots/Categories.png

-10.5 KB
Loading

screenshots/Dashboard.png

16.5 KB
Loading
-533 KB
Binary file not shown.

screenshots/Import-Export.png

-5.63 KB
Loading

screenshots/Keywords.png

21.2 KB
Loading

screenshots/No-Placeholders.png

-1.23 MB
Binary file not shown.

screenshots/Options.png

-48.5 KB
Binary file not shown.

0 commit comments

Comments
 (0)