Merge pull request #5 from torounit/fix/ui

Clarify term scheduling UI labels and expand README

Author: torounit

.wordpress-org/icon.svg

@@ -14,15 +14,37 @@ Automatically set and unset the term when the time is up.
 
 ## Description
 
-Automatically set and unset the term when the time is up.
+Schedule Terms lets you reserve a date and time for a category, tag, or any other taxonomy term to be attached to or detached from a post, instead of editing the post manually when the time comes.
+
+It's useful for things like:
+
+* Featuring a post in a "Sale" or "Campaign" category only during a specific period, and removing it automatically afterwards.
+* Adding a "New" tag to a post for a limited time after publishing.
+* Hiding a post from a "Featured" listing taxonomy once a promotion ends.
 
-Check the "use schedule" checkbox in the category or tag management screen. You can set a time for each post to be added or removed from the category or tag.
+Once scheduling is enabled for a taxonomy, a "Schedule Terms" panel appears in the post editor for every term in that taxonomy, with separate "Attach" and "Detach" date/time fields. WordPress' own cron system checks the schedule and updates the post's terms automatically when the time arrives, so there's nothing else to do once a schedule is set.
 
 ### Usage
 
-1. Go to category,tag or custom taxonomy management screen.
-2. Check the "Use scheduling" checkbox.
-3. Goto edit post screen then set datetime in "Schedule Terms" panel.
+1. Go to the category, tag, or custom taxonomy management screen.
+2. Check the "Enable scheduling" checkbox when adding or editing a term (or via Quick Edit) to turn scheduling on for that term.
+3. Open a post in the block editor and find the "Schedule Terms" panel in the document sidebar.
+4. Set the "Attach" date/time to have the term automatically added to the post at that time, and/or the "Detach" date/time to have it automatically removed.
+5. Save or update the post. The term will be attached/detached automatically once the scheduled time passes.
+
+### FAQ
+
+**Does the term get attached/detached even if I don't edit the post again?**
+
+Yes. Scheduling is handled by WordPress cron, so the post doesn't need to be opened or saved again after the schedule is set.
+
+**What happens if I leave both the "Attach" and "Detach" fields empty?**
+
+Nothing is scheduled for that term on that post; the term is only added or removed when you do so manually, as usual.
+
+**Can I use this with a custom taxonomy?**
+
+Yes, scheduling can be enabled for any taxonomy that is shown in the admin UI (`show_ui` is true), not just categories and tags.
 
 ## Screenshots
 

README.md

@@ -1,10 +1,10 @@
 {
-	"name": "hamworks/schedule-terms",
+	"name": "torounit/schedule-terms",
 	"license": "GPL-2.0-or-later",
 	"authors": [
 		{
 			"name": "Hiroshi Urabe",
-			"email": "urabe@ham.works"
+			"email": "mail@torounit.com"
 		}
 	],
 	"require": {

composer.json

@@ -44,7 +44,7 @@ class Term_UI extends UI {
 	public function __construct( $file, string $meta_key ) {
 		$this->meta_key = $meta_key;
 		$this->labels   = array(
-			'singular' => esc_html__( 'Use scheduling', 'schedule-posts' ),
+			'singular' => esc_html__( 'Enable scheduling', 'schedule-posts' ),
 		);
 
 		parent::__construct( $file );
@@ -103,14 +103,15 @@ protected function form_field( $term = null ) {
 			: '';
 
 		?>
-		<input
-			type="checkbox"
-			name="term-<?php echo esc_attr( $this->meta_key ); ?>"
-			id="term-<?php echo esc_attr( $this->meta_key ); ?>"
-			<?php checked( (bool) $value, true, true ); ?>
-		/>
+
 		<label for="term-<?php echo esc_attr( $this->meta_key ); ?>">
-			<?php esc_html_e( 'Use automatic term attach / detach.', 'schedule-posts' ); ?>
+			<input
+				type="checkbox"
+				name="term-<?php echo esc_attr( $this->meta_key ); ?>"
+				id="term-<?php echo esc_attr( $this->meta_key ); ?>"
+				<?php checked( (bool) $value, true, true ); ?>
+			/>
+			<?php esc_html_e( 'Automatically attach or detach this term on schedule.', 'schedule-posts' ); ?>
 		</label>
 		<?php
 	}
@@ -121,7 +122,7 @@ protected function form_field( $term = null ) {
 	protected function quick_edit_form_field() {
 		?>
 		<input type="checkbox" name="term-<?php echo esc_attr( $this->meta_key ); ?>">
-		<?php esc_html_e( 'Use automatic term attach / detach.', 'schedule-posts' ); ?>
+		<?php esc_html_e( 'Automatically attach or detach this term on schedule.', 'schedule-posts' ); ?>
 		<?php
 	}
 }

includes/Term_UI.php

@@ -1,8 +1,8 @@
 {
-	"name": "@hamworks/schedule-terms",
+	"name": "@torounit/schedule-terms",
 	"version": "1.3.2",
 	"private": true,
-	"author": "HIroshi Urabe <mail@torounit.com> (https://torounit.com)",
+	"author": "Hiroshi Urabe <mail@torounit.com> (https://torounit.com)",
 	"license": "GPL-2.0+",
 	"scripts": {
 		"wp-env": "wp-env",
@@ -22,7 +22,7 @@
 	},
 	"repository": {
 		"type": "git",
-		"url": "https://github.com/team-hamworks/schedule-terms.git"
+		"url": "https://github.com/torounit/schedule-terms.git"
 	},
 	"devDependencies": {
 		"@wordpress/scripts": "^32.4.1",

package.json

@@ -1,10 +1,10 @@
 <?php
 /**
  * Plugin Name:     Schedule Terms
- * Plugin URI:      https://github.com/hamworks/schedule-terms
+ * Plugin URI:      https://github.com/torounit/schedule-terms
  * Description:     Automatically set and unset the term when the time is up.
  * Author:          Toro_Unit, HAMWORKS
- * Author URI:      https://ham.works
+ * Author URI:      https://torounit.com/
  * License:         GPLv2 or later
  * License URI:     https://www.gnu.org/licenses/gpl-2.0.html
  * Text Domain:     schedule-terms