update screenshots and documentation for v6.0.0 alpha 1

.markdownlint.json

@@ -0,0 +1,4 @@
+{
+ "MD013": false,
+ "MD024": false
+}

CHANGELOG.md

@@ -1,5 +1,25 @@
 # DeviantArt Filter Changelog
 
+## Version 6.0.0 Alpha 1 (April 14, 2020)
+
+*(**Tote**: This entry may be updated and/or replaced with future version 6.0.0 alpha/beta/final/etc release information.)*
+
+### New Features
+
+- **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.
+- **New Management Page**. The management page has been completely rewritten using more modern frameworks.
+- **Filter by Title**. Tag filters have been replaced with keyword filters, which apply to both tags and titles for all deviations.
+- **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.
+- **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.
+
+### Known issues
+
+- **Filters are not validated**. When creating/updating filters, no restrictions or validations are implemented to help prevent invalid filters from being created.
+- **Options are missing**. There are currently no configurable options for DeviantArt Filter v6.0.0.
+ - **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.
+ - **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).
+ - **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.
+
 ## Version 5.1 (February 6, 2019)
 
 ### New Features

README.md

@@ -1,9 +1,6 @@
-[<img align="right" src="https://travis-ci.com/rthaut/deviantART-Filter.svg?branch=master" alt="Build Status"/>](https://travis-ci.com/rthaut/deviantART-Filter)
-[<img align="right" src="https://badges.renovateapi.com/github/rthaut/deviantART-Filter" alt="Renovate Status"/>](https://renovatebot.com/)
+# DeviantArt Filter 6.0.0 Alpha 1
 
-# DeviantArt Filter 5.1.2
-
-> Allows configurable filtering/removal of deviations by user, tag, and/or category on DeviantArt
+> Allows configurable filtering/removal of deviations by user, keyword, and/or category on DeviantArt
 
 ## Table of Contents
 
@@ -14,31 +11,17 @@
 - [Options](#options)
 - [Screenshots](#screenshots)
 
-_(TOC generated by [verb](https://github.com/verbose/verb) using [markdown-toc](https://github.com/jonschlinkert/markdown-toc))_
-
 ## Overview
 
-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.
+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.
 
 ![DeviantArt Filter Promotional Image](/screenshots/Promo.png?raw=true)
 
 * * *
 
 ## Installation
 
-| Web Browser | Information | Download Link | Documentation |
-| ----------- | ----------- | ------------- | ------------- |
-| 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) |
-| 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) |
-| Microsoft Edge | _Coming Soon ([#40](https://github.com/rthaut/deviantART-Filter/issues/40))_ | _N/A_ | _N/A_ |
-
-[chrome-url]: https://chrome.google.com/webstore/detail/deviantart-filter/odlmamilbohnpnoomjclomghphbajikp
-[chrome-image-download]: https://img.shields.io/chrome-web-store/d/odlmamilbohnpnoomjclomghphbajikp.svg
-[chrome-image-version]: https://img.shields.io/chrome-web-store/v/odlmamilbohnpnoomjclomghphbajikp.svg
-
-[firefox-url]: https://addons.mozilla.org/en-US/firefox/addon/deviantart-filter/
-[firefox-image-download]: https://img.shields.io/amo/d/deviantart-filter.svg
-[firefox-image-version]: https://img.shields.io/amo/v/deviantart-filter.svg
+***Find the latest alpha/beta builds on the [releases](https://github.com/rthaut/deviantART-Filter/releases) page.***
 
 * * *
 
@@ -56,48 +39,52 @@ This permission is used to apply filters to DeviantArt pages and to add the quic
 
 ### Access browsing history
 
-The History permission is used to remove the DeviantArt Filter Management Panel/Screen from your browser's history.
+The History permission is used to remove the DeviantArt Filter Management Page from your browser's history.
 
 ### Display notifications to you
 
 The Notifications permission is used to display a notification message when upgrading from version 4.x to version 5.x.
 
 ### Access browser tabs
 
-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.
+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.
 
 * * *
 
 ## Usage
 
-### Opening the Management Panel/Screen
+### Opening the Management Page
 
 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)
 2. The configuration screen will open automatically when you click the icon.
 
 ### Creating and Removing Filters
 
-#### You can filter deviations by artist, category, and/or tag through the management panel/screen
+#### You can filter deviations by artist, category, and/or keyword through the management page
 
-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.
-2. To create a new filter, use the form at the top of the tab.
- - For users, enter their username.
- - For tags, enter a single tag (*no spaces*), then choose if the tag should use wildcard matching.
- - For categories, select the parent category, then (optionally) select sub-categories.
-3. Use the table that is displayed below the form to view all of your existing filters.
+1. After opening the [Management Page](#dashboard), navigate to any of the Manage [Users](#manage-users)/[Keywords](#manage-keywords)/[Categories](#manage-categories) views.
+2. Use the table that is displayed to view all of your existing filters.
  - You can sort the table by clicking the heading of any column.
- - You can page through your filters using the pagination controls in the lower-left corner.
- - You can choose how many filters are displayed per page using the controls in the lower-right corner.
-4. To remove a filter, click the `Remove Filter` button next to the filter you want to remove.
+ - You can page through your filters using the pagination controls below the table.
+3. To create a new filter, use the plus icon (:heavy_plus_sign:) above the table to the right of the search bar.
+ - For users, enter their username.
+ - For keywords, enter a single keyword (*no spaces*), then choose if the keyword should use wildcard matching by checking the wildcard checkbox.
+ - For categories, select the category path from the menu (you can type in the field to filter results).
+4. To change an existing filter, like the pencil icon (:pencil2:) next to the filter you want to change.
+ - Click the checkmark icon (:heavy_check_mark:) to the left of the filter you are changing to **save** your change(s).
+ - Click the multiplication icon (:heavy_multiplication_x:) next to the left of the filter you are changing to **discard** your change(s).
+5. To remove a filter, click the trash can button next to the filter you want to remove.
+ - Click the checkmark icon (:heavy_check_mark:) to the left of the filter you are removing to **confirm**.
+ - Click the multiplication icon (:heavy_multiplication_x:) next to the left of the filter you are changing to **cancel**.
 
 ### Exporting/Importing Filters
 
 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.
 
-1. After [opening the Management Panel/Screen](#opening-the-management-panelscreen), navigate to the [Import/Export Filters](#importexport-filters-page) tab.
+1. After [opening the Management Page](#opening-the-management-page), navigate to the [Import/Export Filters](#importexport-filters) view.
 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).
 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.
- - 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).
+ - 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.
 
 ### Quick Hiding Users While Browsing
 
@@ -109,72 +96,28 @@ DeviantArt Filter allows you to export and import filters from a JSON file. This
 
 ## Options
 
-Options for DeviantArt filtered are configured through the [Management Panel/Screen](#opening-the-management-panelscreen) on the [Options](#options-page) tab.
-
-### Use Placeholders for Filtered Deviations
-
-`When enabled, a placeholder image is displayed instead of the actual thumbnail for filtered deviations. Disable this setting to completely remove filtered deviation thumbnails.`
-
-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.
-
-### Background/Logo/Text Color for Placeholders
-
-`Set a custom color for the background/logo/text of the placeholder shown in place of filtered deviations.`
-
-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.
-
-### Management Panel Type
-
-`Specifies where/how the main management panel is displayed when clicking the DeviantArt Filter logo by the address bar.`
-
-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.
-
-### Metadata Batch Size
-
-`Specifies the number of deviations for which to load metadata at a time. Setting this value to a lower number may improve browsing performance.`
-
-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.
-
-### Number of Days to Cache Metadata
-
-`Specifies the number of days to cache metadata (for tags and categories) locally for deviations. Set this value to disable local caching completely.`
-
-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.
-
-### Show Metadata Debug Indicators
-
-`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.`
-
-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.
+*Options are currently **not** available in DeviantArt Filter v6.0.0*
 
 * * *
 
 ## Screenshots
 
-### Options Page
-
-![Screenshot of the DeviantArt Filter Options Page](/screenshots/Options.png?raw=true)
-
-### Manage Users Page
-
-![Screenshot of the DeviantArt Filter Manage Users Page](/screenshots/Users.png?raw=true)
-
-### Manage Tags Page
+### Dashboard
 
-![Screenshot of the DeviantArt Filter Manage Tags Page](/screenshots/Tags.png?raw=true)
+![Screenshot of the DeviantArt Filter Dashboard](/screenshots/Dashboard.png?raw=true)
 
-### Manage Categories Page
+### Manage Users
 
-![Screenshot of the DeviantArt Filter Manage Categories Page](/screenshots/Categories.png?raw=true)
+![Screenshot of the DeviantArt Filter Manage Users](/screenshots/Users.png?raw=true)
 
-### Import/Export Filters Page
+### Manage Keywords
 
-![Screenshot of the DeviantArt Filter Import/Export Page](/screenshots/Import-Export.png?raw=true)
+![Screenshot of the DeviantArt Filter Manage Keywords](/screenshots/Keywords.png?raw=true)
 
-### Browse Page with Placeholders Enabled
+### Manage Categories
 
-![Screenshot of DeviantArt with placeholders enabled for filtered deviations](/screenshots/Placeholders.png?raw=true)
+![Screenshot of the DeviantArt Filter Manage Categories](/screenshots/Categories.png?raw=true)
 
-### Browse Page with Placeholders Disabled
+### Import/Export Filters
 
-![Screenshot of DeviantArt with placeholders disabled for filtered deviations](/screenshots/No-Placeholders.png?raw=true)
+![Screenshot of the DeviantArt Filter Import/Export](/screenshots/Import-Export.png?raw=true)