WP Manifestindependent plugin directory
manifest / integrations / ross-documentation

Ross Documentation

WordPress plugin to display product documentation from Ross Video documentation server

by Colin Jacques · github.com/colinjacques/ross-documentation · website

★ 0stars
0forks

Install

No release zip yet. The repository archive installs, but the folder name will carry the branch suffix and updates will not flow:

wp plugin install https://github.com/colinjacques/ross-documentation/archive/refs/heads/main.zip
Readme github.com/colinjacques/ross-documentation ↗

Ross Documentation Plugin

A WordPress plugin to display product documentation from Ross Video's documentation server with modern architecture and multiple layout options.

Features

  • Multiple Shortcodes - New modern shortcodes plus backward-compatible shortcodes for existing pages
  • Multiple Layouts - Accordion, table, and list layouts
  • AJAX Search - Real-time search with debouncing
  • Automatic Sync - Cron-based sync from documentation server (twice daily)
  • URL Verification - Validates document URLs exist before displaying
  • Caching - Transient caching for optimal performance
  • Analytics - Built-in Google Analytics (GA4 & UA) download tracking
  • Responsive - Mobile-friendly styles

Installation

  1. Upload the ross-documentation folder to /wp-content/plugins/
  2. Activate the plugin through the 'Plugins' menu in WordPress
  3. Go to Settings > Ross Docs to sync documents and view available products

Shortcodes

New Shortcodes

Shortcode Description Example
[ross_docs] Display documents for a product [ross_docs product="PIVOTCam" layout="accordion"]
[ross_docs_list] Simple list of documents [ross_docs_list product="Quorum" limit="5"]
[ross_docs_search] Search form for documents [ross_docs_search placeholder="Search..."]
[ross_docs_categories] List all product categories [ross_docs_categories]
[ross_docs_products] List products by category [ross_docs_products category="CG and Graphics"]

Backward Compatible Shortcodes

Shortcode Description Example
[ross_files] Bootstrap accordion (legacy) [ross_files product="PIVOTCam" folder="all"]
[ross_file] Single file download link [ross_file name="Manual" url="https://..."]
[ross_button] Download button [ross_button href="https://..." button="Download"]

Shortcode Attributes

[ross_docs]

  • product (required) - Product name
  • type - Filter by document type
  • layout - accordion (default), table, or list
  • show_size - Show file sizes (true/false, default: true)
  • show_date - Show modification dates (true/false, default: false)
  • first_open - Open first accordion by default (true/false, default: true)

Requirements

  • WordPress 5.8+
  • PHP 7.4+

Changelog

1.0.0

  • Initial release
  • Modern architecture with OOP design
  • Multiple layout options
  • Backward compatibility with legacy shortcodes
  • AJAX search functionality
  • Automatic document sync
  • URL verification to exclude missing documents

Author

Colin Jacques - Ross Video