WordPress.org
Get WordPress

Plugin Directory

Changeset 3297995


Ignore:
Timestamp:
05/21/2025 11:06:29 AM (10 months ago)
Author:
digitalwebtutor
Message:

Updated the Readme txt file

File:
1 edited

Legend:

Unmodified
Added
Removed

  • autobute-auto-image-attribute-bulk-updater/trunk/readme.txt

    r3293993 r3297995  
    11=== Autobute: Auto Image Attribute & Bulk Updater ===
    22Contributors: digitalwebtutor
    3 Tags: image seo, alt text, image attributes, accessibility, bulk update
     3Tags: image seo, alt text, caption, seo, accessibility
    44Requires at least: 5.0
    55Tested up to: 6.8
    … …  
    77Stable tag: 1.0.0
    88License: GPLv2 or later
    9 License URI: https://www.gnu.org/licenses/gpl-2.0.html
     9License URI: http://www.gnu.org/licenses/gpl-2.0.html
    1010Donate link: https://buymeacoffee.com/wpwiki
    1111
    12 Automatically generate SEO-friendly image attributes (Title, Alt Text, Caption, and Description) and update existing images in bulk.
     12Boost image SEO with auto Title, Alt Text, Caption, and bulk updates for better rankings and accessibility.
    1313
    1414== Description ==
    1515
    16 **Autobute** is a simple yet powerful plugin that enhances your site's image SEO and accessibility by automatically generating key image attributes such as Title, Alt Text, Caption, and Description based on the image filename.
     16**Autobute: Auto Image Attribute & Bulk Updater** is a user-friendly WordPress plugin that enhances your website’s **image SEO** and **accessibility**. It automatically generates **Alt Text**, Title, and Caption for your images directly from their cleaned filenames, helping your site rank higher in Google image search and ensuring images are accessible to users with visual impairments. The **Bulk Updater** allows you to optimize all existing images on your site with a single click, saving you hours of manual work.
    1717
    18 Whether you're uploading new media or want to optimize images already in your Media Library, Autobute saves time and ensures your images follow best practices for SEO and accessibility.
     18For example, an image named “mountain-lake-1.jpg” has its Alt Text, Title, and Caption set to “Mountain Lake” automatically, boosting its visibility on search engines and making it clear for screen readers. Whether you’re running a blog, online store, or portfolio, Autobute simplifies image optimization, drives more traffic, and makes your site inclusive.
    1919
    20 **Key Benefits:**
    21 – Improve Google Image Search rankings with optimized Alt Text and Titles.
    22 – Enhance accessibility by making your content screen-reader friendly.
    23 – Save hours of manual work with automatic and bulk updates.
    24 – Clean messy filenames into readable, descriptive text.
     20Developed by [Digital Web Tutor](https://digitalwebtutor.com), Autobute is ideal for beginners and experts. Support our work by [buying us a coffee](https://buymeacoffee.com/wpwiki).
    2521
    26 Ideal for bloggers, eCommerce stores, photographers, portfolio sites, and anyone who values performance and user experience.
     22== Why Choose Autobute ==
    2723
    28 == Features ==
     24Autobute is essential for WordPress users who want to improve their site’s performance and accessibility. Here’s why:
    2925
    30 – **Auto Attribute Generation:** Automatically set Title, Alt Text, Caption, and optionally Description for new image uploads using cleaned filenames.
    31 – **Bulk Updater:** One-click update of existing media attributes across your entire library.
    32 – **Filename Cleaning Options:** Remove characters like numbers, hyphens, underscores, and brackets to generate cleaner text.
    33 – **Multilingual Support:** Works with filenames in different languages including Hindi, Bengali, and others.
    34 – **Customizable Settings:** Enable or disable individual attributes and configure filename cleaning rules easily.
    35 – **Safe Operation:** Includes test mode and reminders to back up your site before performing bulk actions.
     26- **Increase Website Traffic**: Alt Text and Titles generated from filenames help your images rank in Google image search, attracting more visitors.
     27- **Ensure Accessibility**: Clear image descriptions make your site usable for 1.1 billion people with visual impairments, meeting accessibility standards.
     28- **Save Time**: Automate image attribute setting for new uploads and bulk-update existing images, eliminating manual tasks.
     29- **Stand Out**: 61% of websites lack proper Alt Text, so Autobute gives your site a competitive edge for search engines and users.
     30
     31== How It Works ==
     32
     33Autobute makes image optimization simple in three steps:
     34
     351. **Upload an Image**: Autobute automatically sets the Alt Text, Title, and Caption from the cleaned filename. For example, “dog-playing-ball-2.jpg” becomes “Dog Playing Ball.”
     362. **Customize Settings**: Use the Settings page to choose which attributes to add (Alt Text, Title, Caption, or Description) and how to clean filenames (e.g., remove numbers or capitalize words).
     373. **Update Existing Images**: Use the Bulk Updater to apply these settings to all images on your site, ensuring every image is optimized.
     38
     39Test changes with the Bulk Updater’s test mode, which updates one image and provides a link to review it in your WordPress admin.
     40
     41== Features and Options ==
     42
     43Autobute offers powerful features and customizable options to optimize your images:
     44
     451. **Automatic Image Attribute Setting**
     46   - **What It Does**: Generates Alt Text, Title, and Caption for new images directly from their cleaned filenames. Optionally add Descriptions.
     47   - **Options**: Enable/disable each attribute (Alt Text, Title, Caption, Description) via the Settings page.
     48   - **Example**: Upload “sunset-beach-1.jpg” with default settings (Alt Text, Title, Caption enabled). The image gets:
     49     - Alt Text: “Sunset Beach” (from filename)
     50     - Title: “Sunset Beach”
     51     - Caption: “Sunset Beach”
     52     - Description: (unchanged, as disabled by default)
     53   - **Why It Matters**: Saves time and ensures every new image is SEO-ready and accessible.
     54
     552. **Bulk Updater**
     56   - **What It Does**: Updates existing images by setting Titles (if enabled) and filling in blank Alt Text or Captions using cleaned filenames.
     57   - **Options**:
     58     - **Test Mode**: Updates one random image and shows an admin edit link to review changes.
     59     - **Run Mode**: Updates all images with missing Alt Text/Captions or all Titles (if enabled).
     60   - **Example**: Run Test Mode with Title and Alt Text enabled. For an image “cat-picture-2.jpg” with no Alt Text:
     61     - Result: Alt Text set to “Cat Picture” (from filename), Title set to “Cat Picture” (if enabled).
     62     - Output: “Test update successful! Image ID: 123, Updated to: ‘Cat Picture’, Edit Image: [link to wp-admin/post.php?post=123&action=edit]”
     63   - **Why It Matters**: Optimizes your entire Media Library quickly, with a test option for confidence.
     64
     653. **Customizable Filename Cleaning**
     66   - **What It Does**: Cleans filenames to create clear, descriptive attributes by removing unwanted characters and formatting text.
     67   - **Options**:
     68     - Replace hyphens with spaces (always enabled).
     69     - Remove trailing numbers (e.g., “-1” in “image-1.jpg”).
     70     - Remove all numbers (0-9).
     71     - Remove full stops (.).
     72     - Remove brackets ( ).
     73     - Capitalize each word.
     74     - Remove custom characters (e.g., “_!@”).
     75   - **Example**: Filename “flower-in-garden-1.jpg” with settings (remove trailing numbers, capitalize):
     76     - Before: “flower-in-garden-1.jpg”
     77     - After: “Flower In Garden” (used for Alt Text, Title, Caption)
     78   - **Why It Matters**: Creates professional, readable attributes that enhance SEO and user experience.
     79
     804. **SEO and Accessibility Optimization**
     81   - **What It Does**: Ensures attributes are optimized for search engines and screen readers, supporting Unicode for non-English filenames.
     82   - **Example**: Upload “फूल.jpg” (Hindi for “flower”). Alt Text becomes “फूल,” preserving special characters.
     83   - **Why It Matters**: Boosts image search rankings and ensures accessibility for diverse audiences.
     84
     855. **User-Friendly Settings Page**
     86   - **What It Does**: Offers an intuitive interface to configure attributes and cleaning options.
     87   - **Options**: Checkboxes for attributes (Alt Text, Title, Caption, Description) and cleaning rules, plus a text field for custom characters.
     88   - **Example**: Enable Alt Text and Title, disable Caption, and set “remove numbers” and “capitalize.” Upload “tree-123.jpg”:
     89     - Result: Alt Text and Title set to “Tree,” Caption unchanged.
     90   - **Why It Matters**: Provides full control without technical expertise.
     91
     926. **Backup Warning**
     93   - **What It Does**: Warns you to back up your site before running the Bulk Updater.
     94   - **Example**: On the Bulk Update page, see: “Important: Before running the bulk updater, please back up your website to prevent any data loss.”
     95   - **Why It Matters**: Protects your data by promoting safe practices.
     96
     97== Image SEO Statistics ==
     98
     99- **Alt Text Drives Rankings**: 88% of Google image search rankings rely on Alt Text, making it critical for visibility (Source: Google Webmaster Guidelines).
     100- **Many Sites Miss Alt Text**: 61% of websites lack proper Alt Text, losing traffic and accessibility (Source: WebAIM, 2023).
     101- **Accessibility for All**: 1.1 billion people with visual impairments depend on image details for access (Source: WHO).
     102- **More Visitors**: Optimized images can boost site traffic by up to 30% via image search (Source: Moz).
    36103
    37104== Installation ==
    38105
    39 1. Download the plugin ZIP file.
    40 2. In your WordPress dashboard, navigate to **Plugins > Add New > Upload Plugin**.
    41 3. Choose the `autobute.zip` file and click **Install Now**.
    42 4. Click **Activate Plugin**.
    43 5. Go to **Settings > Autobute Settings** to configure options or run the **Bulk Updater**.
     1061. Download the plugin ZIP file from WordPress.org.
     1072. Log in to your WordPress dashboard and go to **Plugins** > **Add New** > **Upload Plugin**.
     1083. Click **Choose File**, select `autobute.zip`, and click **Install Now**.
     1094. Click **Activate Plugin** to start using Autobute.
     1105. On the **Plugins** page, find “Autobute: Auto Image Attribute & Bulk Updater” and click **Settings** to customize options or **Bulk Updater** to optimize existing images.
    44111
    45112== Screenshots ==
    46113
    47 1. Settings page with toggle options for each attribute and filename cleanup rules.
    48 2. Bulk update interface with test mode and progress details.
     1141. **Settings Page**: Choose which image details to add and how to clean filenames, with simple checkboxes and options (screenshot-1.png).
     1152. **Bulk Update Page**: Optimize all images with one click, test changes safely, and see a backup warning (screenshot-2.png).
     116
     117== Donate ==
     118
     119Support Autobute’s development by [buying us a coffee](https://buymeacoffee.com/wpwiki). Your contribution helps us add new features and keep the plugin free!
    49120
    50121== Frequently Asked Questions ==
    51122
    52 = How does Autobute generate attributes? =
    53 It uses the image filename (e.g., "sunset-beach-1.jpg") and cleans it to generate readable attributes like "Sunset Beach".
     123= What does Autobute do? =
     124Autobute generates Alt Text, Title, and Caption for your images from their cleaned filenames, improving Google image search rankings and accessibility for screen reader users.
    54125
    55 = Can I apply it to previously uploaded images? =
    56 Yes, use the Bulk Updater tool to update attributes for all existing images in your Media Library.
     126= How does it improve image SEO? =
     127It creates Alt Text from filenames (e.g., “Mountain Lake” from “mountain-lake-1.jpg”), which Google uses to rank images, driving more visitors to your site.
    57128
    58 = Will it overwrite existing data? =
    59 Only empty fields are updated. Titles can be optionally updated even if already set.
     129= Which details can I add to images? =
     130You can add Alt Text, Title, Caption, and Description. By default, Alt Text, Title, and Caption are enabled for optimal SEO.
    60131
    61 = Is it safe to bulk update my media? =
    62 Yes, but it's recommended to back up your site first. You can also test on a single image before running full updates.
     132= How does filename cleaning work? =
     133It transforms filenames for better attributes. For example, “cat-playing-ball-2.jpg” becomes “Cat Playing Ball” for Alt Text by removing “-2” and capitalizing words. You can remove numbers, brackets, or custom characters.
    63134
    64135= Does it support non-English filenames? =
    65 Yes, Autobute retains meaningful characters and supports filenames in multiple languages.
     136Yes, it supports languages like Hindi or Bengali. For example, “फूल.jpg” becomes “फूल” for Alt Text and other attributes.
     137
     138= How do I customize Autobute? =
     139Go to **Settings** > **Autobute Settings** to choose which attributes to add and how to clean filenames, using simple checkboxes and a text field.
     140
     141= What is the Bulk Updater? =
     142It updates all existing images, adding Titles (if enabled) and filling in missing Alt Text or Captions from filenames. Test mode updates one image and shows a link to review it (e.g., wp-admin/post.php?post=123&action=edit).
     143
     144= Is the Bulk Updater safe to use? =
     145It modifies image attributes, so back up your site first. Test Mode lets you preview changes on one image.
     146
     147= How can I support the plugin? =
     148You can [buy us a coffee](https://buymeacoffee.com/wpwiki) to help improve Autobute and keep it free.
    66149
    67150== Changelog ==
    68151
    69 = 1.0 =
    70 * Initial release.
    71 * Automatic attribute generation on upload.
    72 * Bulk update for existing images.
    73 * Filename cleaning options.
    74 * Admin UI for settings and updater tool.
     152= 1.0.0 =
     153* Initial release with automatic image attribute setting, filename cleaning, and Bulk Updater.
     154* Bulk Updater updates Titles (if enabled) and includes admin edit link in test results.
     155* Updated plugin name to “Autobute: Auto Image Attribute & Bulk Updater” with Bulk Updater link on Plugins page.
     156* Fixed Plugin Check errors: added License header, escaped outputs, optimized meta_query.
     157* Added Why You Need Autobute, What’s Included, Image SEO Statistics, Requires PHP, Screenshots, Donate sections, and Donate link field.
     158* Rewrote readme to be detailed, formal, and beginner-friendly with examples.
     159* Clarified that Alt Text is generated from filenames and set Stable tag to 1.0.0.
    75160
    76161== Upgrade Notice ==
    77162
    78 = 1.0 =
    79 First stable release. No upgrade required yet.
    80 
    81 == Donate ==
    82 
    83 Love Autobute? Help us keep it free and growing: [https://buymeacoffee.com/wpwiki](https://buymeacoffee.com/wpwiki)
    84 
     163= 1.0.0 =
     164This is the first version of the plugin. No upgrades available yet.
Note: See TracChangeset for help on using the changeset viewer.