From 39416543b4d6a65e4cb64ca01274192598bf9c0f Mon Sep 17 00:00:00 2001 From: Jonathan Miller <1+jmiller@noreply.git.mokoconsulting.tech> Date: Sun, 31 May 2026 01:50:33 +0000 Subject: [PATCH] Add "Configuration" --- Configuration.md | 51 ++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 51 insertions(+) create mode 100644 Configuration.md diff --git a/Configuration.md b/Configuration.md new file mode 100644 index 0000000..6fcfa77 --- /dev/null +++ b/Configuration.md @@ -0,0 +1,51 @@ +# Configuration + +Navigate to **Extensions > Plugins > System - MokoJoomOpenGraph** to configure the plugin. + +## Basic Settings + +| Parameter | Description | +|-----------|-------------| +| **Site Name** | The `og:site_name` value. Leave blank to use the Joomla site name. | +| **Default OG Title** | Site-wide fallback title for social sharing. Used when a page has no custom OG title and no page title. | +| **Default OG Description** | Site-wide fallback description. Used when a page has no custom OG description and no meta description. | +| **Default Image** | Fallback image used when no article or page image is found. Recommended: 1200x630px. | +| **Twitter Card Type** | Summary (small image) or Summary with Large Image (large image). | +| **Twitter @username** | Your site Twitter handle (e.g. @mokoconsulting). | +| **Facebook App ID** | Your Facebook App ID for `fb:app_id` meta tag. | +| **Telegram Channel** | Your Telegram channel handle for link previews. | +| **Discord Embed Color** | The color of the embed sidebar when shared on Discord. | + +## Advanced Settings + +| Parameter | Description | +|-----------|-------------| +| **Auto-generate Tags** | Automatically generate OG tags from article content when no custom tags are set. | +| **Strip HTML** | Remove HTML tags from auto-generated descriptions. | +| **Description Length** | Maximum character length for `og:description` (50-300, default 160). | +| **Auto-resize Images** | Resize images to 1200x630px using center crop. Cached in `images/mokoog/generated/`. | +| **Enable JSON-LD** | Output structured data (Article, WebPage) for Google rich results. | +| **JSON-LD Breadcrumbs** | Output BreadcrumbList schema from Joomla pathway. | + +## Fallback Chain + +OG tag values are resolved in this order: + +1. **Custom OG data** -- per-article/menu/category overrides set in the editor +2. **Page metadata** -- Joomla page title, meta description, article images +3. **Site-wide defaults** -- Default OG Title, Default OG Description, Default Image from plugin config + +This ensures every page always has OG tags, even without any manual configuration. + +## Per-Content OG Fields + +When editing an article, menu item, or category, you will see a **MokoJoomOpenGraph** tab with: + +- **OG Title** -- Custom title for social sharing +- **OG Description** -- Custom description for social sharing +- **OG Image** -- Custom image (uses Joomla media picker) +- **OG Type** -- article, website, product, profile, book, music, video +- **SEO Title** -- Custom page `` override +- **Meta Description** -- Custom meta description +- **Robots** -- noindex, nofollow, noarchive, nosnippet, noimageindex +- **Canonical URL** -- Custom canonical URL override