WordPress.org
Get WordPress

Plugin Directory

Changeset 3299159


Ignore:
Timestamp:
05/23/2025 07:14:09 AM (9 months ago)
Author:
group107
Message:

Update README.txt:

  • Make all external links clickable.
  • Complete metadata for WP.org requirements.
File:
1 edited

Legend:

Unmodified
Added
Removed

  • accessible-docs/trunk/README.txt

    r3299145 r3299159  
    1313
    1414== Description ==
    15 
    1615**Make your PDFs accessible with a single click**
    17 Accessible Docs WordPress plugin helps you deliver *accessible PDFs* in compliance with *WCAG* and *ADA accessibility* standards — right from your website.
    18 
    19 When visitors click on a PDF link, a customizable *popup* invites them to request an *accessible version by email*. Documents are processed by the <a href="https://api.accessibledocs.ai">Accessible Docs API</a> platform and automatically delivered.
    20 
    21 This ensures your digital content is *screen reader friendly* and inclusive for all users — without requiring manual file conversion.
     16Accessible Docs WordPress plugin helps you deliver *accessible PDFs* in compliance with WCAG and ADA standards — right from your website. When visitors click a PDF link, a customizable popup invites them to request an accessible version by email. Documents are processed by the [Accessible Docs API](https://api.accessibledocs.ai) and automatically delivered. This ensures your content is *screen reader friendly* for all users without manual conversion.
    2217
    2318== Key Features ==
    … …  
    3530  The popup is keyboard-accessible and works seamlessly with screen readers.
    3631
    37 == Real-World Usage Examples ==
    38 - A **university website** allows students to request accessible syllabi and brochures.
    39 - A **government portal** ensures all public PDFs are compliant and inclusive.
    40 - A **nonprofit site** offers accessible reports to visually impaired donors and researchers.
    41 - An **e-commerce platform** provides accessible product guides and manuals to all customers.
     32== External Services ==
     33This plugin connects to the [Accessible Docs API](https://api.accessibledocs.ai) to upload and process PDF files into accessible formats.
     34
     35Service provider:
     36- [Accessible Docs API](https://api.accessibledocs.ai)
     37- [Terms of Use](https://accessibledocs.ai/terms-and-conditions/)
     38- [Privacy Policy](https://accessibledocs.ai/privacy-policy/)
    4239
    4340== Installation ==
    44 1. Upload the plugin files to `/wp-content/plugins/accessible-docs` or install via the WordPress Plugin Directory.
     411. Upload the plugin folder to `/wp-content/plugins/accessible-docs` or install via the WordPress Plugin Directory.
    45422. Activate **Accessible Docs** through the **Plugins** screen in WordPress.
    46433. Go to **Accessible Docs** in the admin menu and enter your API credentials.
    47 4. Customize popup content and visibility options in the plugin settings.
    48 5. Visitors can now request accessible PDFs—automatically.
     444. Customize popup content and visibility in the plugin settings.
     455. Visitors can now request accessible PDFs automatically.
    4946
    5047== Frequently Asked Questions ==
    5148= Will my uploaded PDFs be stored permanently? =
    52 No. Uploaded PDFs are sent to the <a href="https://api.accessibledocs.ai">Accessible Docs API</a> for processing and are not stored on your server.
     49No. Uploaded PDFs are sent to the Accessible Docs API for processing and are not stored on your server.
    5350
    5451= Is the plugin free? =
    55 Yes, Accessible Docs is free to install. PDF processing requires an active subscription to Accessible Docs.
     52Yes, Accessible Docs is free to install. PDF processing requires an active Accessible Docs subscription.
    5653
    5754= Can I use external PDF URLs? =
    58 Currently, only local PDF links hosted on your WordPress site are supported.
     55Only local PDF links hosted on your WordPress site are supported.
    5956
    6057= Is the popup accessible via keyboard and screen readers? =
    61 Absolutely. We built the popup to meet WCAG and ARIA guidelines.
     58Absolutely — it’s built to meet WCAG and ARIA guidelines.
    6259
    6360= How do I track accessibility requests? =
    64 Go to **Accessible Docs > Documents** in your WordPress dashboard to review and filter requests.
     61Go to **Accessible Docs > Documents** in your dashboard to view and filter requests.
    6562
    6663== Changelog ==
    6764= 1.0.1 =
    6865* Added custom HTTP header `X-AccessibleDocs-Plugin: true` to all API requests.
    69 * Updated README tags and metadata for directory compatibility.
    70 * Fixed link markup to ensure clickable URLs in plugin page.
     66* Updated tags and metadata for directory compatibility.
     67* Fixed link syntax so URLs are clickable on the plugin page.
    7168
    7269= 1.0.0 =
    … …  
    7572== Upgrade Notice ==
    7673= 1.0.1 =
    77 Added custom HTTP header to identify plugin-based API requests and improved directory metadata.
     74Added custom header to API requests and improved plugin directory metadata.
     75
Note: See TracChangeset for help on using the changeset viewer.