WordPress.org
Get WordPress

Plugin Directory

Changeset 3299145


Ignore:
Timestamp:
05/23/2025 06:25:16 AM (9 months ago)
Author:
group107
Message:

Update README.txt: make links clickable, adjust tags per WP-Org requirements

File:
1 edited

Legend:

Unmodified
Added
Removed

  • accessible-docs/trunk/README.txt

    r3298695 r3299145  
    22Contributors: group107
    33Donate link: https://group107.com/
    4 Tags: accessibility, pdf, screenreader, wcag, ada
     4Tags: accessibility, pdf, screen-reader, wcag, ada
    55Requires at least: 6.6
    66Requires PHP: 7.4
    … …  
    1515
    1616**Make your PDFs accessible with a single click**
    17 AccessibleDocs WordPress Plugin helps you deliver *accessible PDFs* in compliance with *WCAG* and *ADA accessibility* standards — right from your website.
     17Accessible Docs WordPress plugin helps you deliver *accessible PDFs* in compliance with *WCAG* and *ADA accessibility* standards — right from your website.
    1818
    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 AccessibleDocs platform and automatically delivered.
     19When 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.
    2020
    2121This ensures your digital content is *screen reader friendly* and inclusive for all users — without requiring manual file conversion.
    … …  
    2323== Key Features ==
    2424- **Automatic PDF Accessibility Conversion**
    25   Turns your existing PDFs into accessible documents via the AccessibleDocs platform.
     25  Upload your existing PDFs and let the Accessible Docs API handle WCAG/ADA compliance.
    2626- **Email-Based Delivery**
    2727  Users receive the accessible version directly to their inbox.
    2828- **Request Logs for Admins**
    29   View all requests in the WordPress dashboard. Filter by file, user, or date.
     29  View and filter all requests in the WordPress dashboard by file name, user email, or date.
    3030- **Popup Customization**
    31   Modify texts, language, and behavior to fit your site’s tone and audience.
     31  Modify popup texts, styles, and behavior to match your brand’s tone.
    3232- **Multilingual Support**
    33   Full compatibility with Polylang and WPML. Enable or disable popup per language.
     33  Full compatibility with Polylang and WPML; enable or disable the popup per language.
    3434- **Accessibility Built-In**
    35   The popup is *keyboard-accessible* and works well with *screen readers*.
     35  The popup is keyboard-accessible and works seamlessly with screen readers.
    3636
    3737== Real-World Usage Examples ==
    … …  
    4141- An **e-commerce platform** provides accessible product guides and manuals to all customers.
    4242
    43 == Who Is It For? ==
    44 **WordPress Website Administrators**
    45 Save time and legal risk — no need to convert PDFs manually. Gain visibility into document requests directly from your dashboard.
    46 
    47 **End Users / Visitors**
    48 Whether visually impaired or using assistive tech, users can request and receive accessible documents quickly and privately.
    49 
    50 **Accessibility Consultants & Agencies**
    51 Embed this tool in client websites to automate accessibility offerings without complex integrations.
    52 
    53 == External Services ==
    54 
    55 This plugin connects to the **Accessible Docs API** (https://api.accessibledocs.ai) to upload and process PDF files into accessible formats.
    56 
    57 The following data is sent to the API:
    58 - User's email address
    59 - File identifier (attachment ID)
    60 - File download link (publicly accessible)
    61 
    62 Data is sent only when a user submits a file for accessibility conversion via the popup.
    63 
    64 Service provider:
    65 Accessible Docs API - https://api.accessibledocs.ai
    66 - Terms of Use: https://accessibledocs.ai/terms-and-conditions/
    67 - Privacy Policy: https://accessibledocs.ai/privacy-policy/
    68 
    6943== Installation ==
    70 
    71441. Upload the plugin files to `/wp-content/plugins/accessible-docs` or install via the WordPress Plugin Directory.
    72 2. Activate the plugin via the Plugins screen in WordPress.
    73 3. Navigate to **Accessible Docs** in the admin menu and enter your AccessibleDocs account credentials.
    74 4. Customize the popup content and visibility options in the plugin settings.
    75 5. Done! Visitors can now request accessible PDFs.
     452. Activate **Accessible Docs** through the **Plugins** screen in WordPress.
     463. Go to **Accessible Docs** in the admin menu and enter your API credentials.
     474. Customize popup content and visibility options in the plugin settings.
     485. Visitors can now request accessible PDFs—automatically.
    7649
    7750== Frequently Asked Questions ==
     51= Will my uploaded PDFs be stored permanently? =
     52No. 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.
    7853
    79 = Will my uploaded PDFs be stored anywhere? =
    80 No, the plugin does not store documents permanently. Files are sent to the AccessibleDocs platform for processing and are only available in your admin account.
     54= Is the plugin free? =
     55Yes, Accessible Docs is free to install. PDF processing requires an active subscription to Accessible Docs.
    8156
    82 = Is the plugin free to use? =
    83 The plugin is free to install. However, processing requires an active AccessibleDocs subscription.
    84 
    85 = Does it work with external PDF URLs? =
    86 No. The plugin currently supports only local PDF links hosted on your WordPress website.
     57= Can I use external PDF URLs? =
     58Currently, only local PDF links hosted on your WordPress site are supported.
    8759
    8860= Is the popup accessible via keyboard and screen readers? =
    89 Yes, the popup is built to meet accessibility guidelines including keyboard navigation and screen reader support.
     61Absolutely. We built the popup to meet WCAG and ARIA guidelines.
    9062
    91 = Can I customize the popup content or style? =
    92 Yes. The popup message, design, and language-specific settings are customizable in the plugin admin settings.
    93 
    94 = How do I track user requests for accessible documents? =
    95 Navigate to **Accessible Docs > Documents** in the WordPress admin dashboard to filter and manage requests.
    96 
    97 = Does the plugin support multilingual websites? =
    98 Yes, the plugin is fully compatible with WPML and Polylang.
    99 
    100 = Will users get the accessible file instantly? =
    101 Users will receive an email with either the accessible version or a status update shortly after submission.
    102 
    103 = Can I limit or disable the popup on specific pages or languages? =
    104 Yes. The popup can be controlled per language and disabled on selected pages.
     63= How do I track accessibility requests? =
     64Go to **Accessible Docs > Documents** in your WordPress dashboard to review and filter requests.
    10565
    10666== Changelog ==
    107 
    10867= 1.0.1 =
    109 * Added custom HTTP header to identify plugin-based requests.
    110 * Updated tags and metadata in README for plugin directory compatibility.
     68* 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.
    11171
    11272= 1.0.0 =
    113 * Initial release — public plugin with support for PDF accessibility requests, admin tracking, and popup customization.
     73* Initial release — automatic PDF accessibility requests, admin tracking, and popup customization.
    11474
    11575== Upgrade Notice ==
    116 
    11776= 1.0.1 =
    118 Added custom header to API requests and improved plugin directory metadata.
     77Added custom HTTP header to identify plugin-based API requests and improved directory metadata.
Note: See TracChangeset for help on using the changeset viewer.