diff --git a/guides/Configuration.md b/Configuration.md similarity index 63% rename from guides/Configuration.md rename to Configuration.md index a7026c1..33d1adb 100644 --- a/guides/Configuration.md +++ b/Configuration.md @@ -7,24 +7,25 @@ Navigate to **Extensions > Plugins > System - MokoSuiteOpenGraph** to configure | 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). | +| **Default OG Title** | Site-wide fallback title for social sharing. | +| **Default OG Description** | Site-wide fallback description. | +| **Default Image** | Fallback image. Recommended: 1200x630px. | +| **Twitter Card Type** | Summary or Summary with 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. | +| **Fediverse Creator** | Your Fediverse/Mastodon handle (e.g. `@user@mastodon.social`). Outputs `fediverse:creator` meta tag. | ## Advanced Settings | Parameter | Description | |-----------|-------------| -| **Auto-generate Tags** | Automatically generate OG tags from article content when no custom tags are set. | +| **Auto-generate Tags** | Automatically generate OG tags from article content. | | **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. | +| **Auto-resize Images** | Resize images to 1200x630px using center crop. | +| **Enable JSON-LD** | Output structured data for Google rich results. | | **JSON-LD Breadcrumbs** | Output BreadcrumbList schema from Joomla pathway. | ## Fallback Chain @@ -33,19 +34,19 @@ 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. +3. **Site-wide defaults** -- Default OG Title, Default OG Description, Default Image ## Per-Content OG Fields When editing an article, menu item, or category, you will see a **MokoSuiteOpenGraph** 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 Title** -- Custom title (60 optimal / 90 max chars) +- **OG Description** -- Custom description (155 optimal / 200 max chars) +- **OG Image** -- Custom image (Joomla media picker) - **OG Type** -- article, website, product, profile, book, music, video -- **SEO Title** -- Custom page `