From 2b8996d3d30aa7d5278a44dc602968124996a62f Mon Sep 17 00:00:00 2001 From: ashutoshkhainar33-star Date: Mon, 24 Aug 2026 18:46:34 +0530 Subject: [PATCH] updated readme seo and aeo --- README.md | 82 +++++++++++++++++++++++++++++++++++++++++++++++-------- 1 file changed, 71 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index a8948af..8237f2e 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,11 @@ # FastPix video picker for TinyMCE (tiny_fastpix) -Pick one of your FastPix videos from inside the editor and drop it into the page โ€” +[![Moodle 4.5+](https://img.shields.io/badge/Moodle-4.5%2B-F98012?logo=moodle&logoColor=white)](https://moodle.org/) +[![PHP 8.1+](https://img.shields.io/badge/PHP-8.1%2B-777BB4?logo=php&logoColor=white)](https://www.php.net/) +[![Editor: TinyMCE](https://img.shields.io/badge/editor-TinyMCE-2FBBED)](https://www.tiny.cloud/) + + +Pick one of your FastPix videos from inside the editor and drop it into the page - no playback ids, no hand-typed short codes. `tiny_fastpix` is the **authoring** half of the FastPix suite. Where @@ -9,11 +14,17 @@ no playback ids, no hand-typed short codes. It uploads nothing and plays nothing itself; it only helps you reference a video you already have. +**Works with:** Moodle 4.5 LTS or later ยท TinyMCE editor ยท PHP 8.1+ ยท the FastPix Moodle suite (`local_fastpix` + `mod_fastpix` + `filter_fastpix`) + +๐Ÿ“– **Picker guide:** https://fastpix.com/docs/moodle/tiny-plugin  ยท  ๐Ÿš€ **Free FastPix account:** https://dashboard.fastpix.com/signup + +> **No FastPix keys needed in this plugin.** The picker reads your videos through `local_fastpix`, so there is nothing to configure here. Install the [FastPix Moodle suite](#the-fastpix-moodle-suite) first, then the **Insert FastPix video** button appears automatically for anyone who can upload FastPix videos. + --- ## The 30-second tour -1. A teacher opens any TinyMCE editor โ€” a forum post, a Page, a Book chapter, a +1. A teacher opens any TinyMCE editor - a forum post, a Page, a Book chapter, a label. 2. They click **Insert FastPix video** (or **Insert โ†’ FastPix video**). 3. A dialog shows *their* videos for **this course**. @@ -40,10 +51,10 @@ actually play: | Rule | Why | | --- | --- | -| **Your videos only** | The dialog is scoped to the signed-in user โ€” you never see another teacher's library. | +| **Your videos only** | The dialog is scoped to the signed-in user - you never see another teacher's library. | | **This course only** | Only videos uploaded through a FastPix activity *in the current course* are listed, so a course's editors see just that course's media. | | **Ready only** | Videos still uploading or processing are hidden until FastPix finishes them. | -| **Playable only** | DRM-protected videos are left out โ€” `filter_fastpix` can't embed them, so offering them would only insert a dead short code. | +| **Playable only** | DRM-protected videos are left out - `filter_fastpix` can't embed them, so offering them would only insert a dead short code. | | **Named, not numbered** | Each result shows the video's activity name (falling back to *Untitled video*), not a raw UUID. | ## Setting it up @@ -55,7 +66,7 @@ standalone tool: | --- | --- | --- | | `local_fastpix` | Stores the videos and answers "what does this user own?" | 1.0.0 | | `mod_fastpix` | Defines `mod/fastpix:uploadmedia`, the permission that gates the button | 1.0.0 | -| `filter_fastpix` | Renders the short code the picker inserts โ€” **must be enabled** | 1.0.0 | +| `filter_fastpix` | Renders the short code the picker inserts - **must be enabled** | 1.0.0 | Also: Moodle 4.5 LTS or newer with the TinyMCE editor, and PHP 8.1+ (tested to 8.3). The picker itself adds no tables, holds no FastPix credentials, and pulls in @@ -64,18 +75,18 @@ no Composer packages. **FastPix account & credentials.** Using FastPix requires a FastPix account and a FastPix **API Key** (created in the FastPix Dashboard under *Settings โ†’ API Keys*; see [Activate your account](https://fastpix.com/docs/getting-started/activate-your-account)). -This picker never asks for or stores the key โ€” it is configured **once** in +This picker never asks for or stores the key - it is configured **once** in `local_fastpix` under *Site administration โ†’ Plugins โ†’ Local plugins โ†’ FastPix*, and every plugin in the suite (including this one) reads through `local_fastpix` from there. If listings aren't working, check the credentials in `local_fastpix` first. -**Install it** the usual Moodle way โ€” upload the ZIP under *Site administration โ†’ +**Install it** the usual Moodle way - upload the ZIP under *Site administration โ†’ Plugins โ†’ Install plugins*, or drop the folder at `lib/editor/tiny/plugins/fastpix/` and finish the upgrade at *Notifications*. Moodle will refuse the install until the three plugins above are present. -**After it's in**, there's nothing to switch on for the button โ€” it appears in the +**After it's in**, there's nothing to switch on for the button - it appears in the toolbar automatically for anyone holding `mod/fastpix:uploadmedia`. Do double-check that the FastPix filter is turned **on** under *Site administration โ†’ Plugins โ†’ Filters โ†’ Manage filters*, otherwise the videos authors insert will show up to @@ -83,7 +94,7 @@ readers as plain `{fastpix:โ€ฆ}` text. ## Who can use it -The button and the web service behind it share one gate โ€” there is no separate +The button and the web service behind it share one gate - there is no separate capability to manage: | Capability | Effect | Owned by | @@ -93,13 +104,62 @@ capability to manage: ## Good to know - **TinyMCE only.** The button isn't added to Atto or other editors. That's an - *authoring* limit โ€” `filter_fastpix` still renders short codes whatever produced + *authoring* limit - `filter_fastpix` still renders short codes whatever produced them, so content written elsewhere (or by hand) still plays. - **No uploading here.** New videos come in through a `mod_fastpix` activity and surface in the picker once they're ready. An upload tab is on the roadmap. - A video only appears for the teacher recorded as its owner, and only in the course it was uploaded to. +## The FastPix Moodle suite + +`tiny_fastpix` is the editor button - the **authoring** convenience. It needs the rest of the suite installed and enabled first. All are GPL-3.0; install in this order: + +| Plugin | Role | Install order | +|---|---|---| +| [local_fastpix](https://github.com/FastPix/moodle-local_fastpix) | Foundation: FastPix credentials, secure gateway, playback-token signing. **Required first.** | 1 | +| [mod_fastpix](https://github.com/FastPix/moodle-mod_fastpix) | The **FastPix Video** activity - upload videos and defines the `mod/fastpix:uploadmedia` permission that gates this button. | 2 | +| [filter_fastpix](https://github.com/FastPix/moodle-filter_fastpix) | Renders the short code this picker inserts into an actual player. **Must be enabled.** | 3 | +| **tiny_fastpix** (this repo) | The TinyMCE button that inserts the embed short code for you. | 4 | + +Browse everything in the [FastPix organization](https://github.com/orgs/FastPix/repositories). + +## FAQ + +**What is tiny_fastpix, and what do I need first?** +It is a TinyMCE editor button that inserts a FastPix video into your content without typing a playback id. It needs `local_fastpix`, `mod_fastpix`, and `filter_fastpix` installed (and the filter enabled) first. See [Setting it up](#setting-it-up) and [The FastPix Moodle suite](#the-fastpix-moodle-suite). + +**How do I insert a FastPix video in the editor?** +Open any TinyMCE editor, choose **Insert FastPix video**, and pick a video. The plugin writes the short code for you. See [The 30-second tour](#the-30-second-tour). + +**Do I need FastPix API keys for this plugin?** +No. Credentials are configured once in `local_fastpix`; this picker reads through it and stores nothing. See [Setting it up](#setting-it-up). + +**Why don't I see the Insert FastPix video button?** +You need the `mod/fastpix:uploadmedia` capability in that course, a TinyMCE editor, and the plugin installed. See [Who can use it](#who-can-use-it) and [Troubleshooting](#troubleshooting). + +**The inserted code shows as `{fastpix:...}` text instead of a video.** +The FastPix filter is not enabled. Turn on **FastPix video embeds** under **Site administration > Plugins > Filters > Manage filters**. See [Troubleshooting](#troubleshooting). + +**Which videos appear in the picker?** +Your own videos, that are ready (not still processing), playable (non-DRM), and were uploaded through a FastPix activity in the current course. See [What shows up in the picker](#what-shows-up-in-the-picker). + +**Can I upload a new video from the picker?** +No. Uploading happens in a FastPix Video activity (`mod_fastpix`); new videos then appear in the picker once ready. See [Good to know](#good-to-know). + +**Does it work in Atto or other editors?** +TinyMCE only. Content written elsewhere still plays, because `filter_fastpix` renders the short code however it got there. See [Good to know](#good-to-know). + +**Which Moodle and PHP versions are supported?** +Moodle 4.5 LTS or later, with the TinyMCE editor, and PHP 8.1 or later (tested through PHP 8.3). See [Setting it up](#setting-it-up). + +## Troubleshooting + +- **No Insert FastPix video button.** Confirm you hold `mod/fastpix:uploadmedia` in that course, that you are using the TinyMCE editor, and that the plugin is installed. +- **Inserted short code shows as plain `{fastpix:...}` text.** Enable the **FastPix video embeds** filter under **Site administration > Plugins > Filters > Manage filters**. +- **The picker list is empty.** Check the FastPix credentials in `local_fastpix`; videos must be ready, non-DRM, uploaded in the current course, and owned by you. +- **Moodle refuses to install the plugin.** `local_fastpix`, `mod_fastpix`, and `filter_fastpix` must be present first. + ## Privacy The picker keeps no personal data of its own. It ships a `null_provider` and @@ -117,4 +177,4 @@ leaves all storage to `local_fastpix`. The detail lives in ยฉ 2026 FastPix Inc. Distributed under the [GNU GPL v3.0 or later](https://www.gnu.org/licenses/gpl-3.0.html); full text in -[`LICENSE`](https://github.com/FastPix/moodle-tiny_fastpix/blob/main/LICENSE). +[`LICENSE`](https://github.com/FastPix/moodle-tiny_fastpix/blob/main/LICENSE). \ No newline at end of file