Changes in 267cc00d2d
Jonathan Miller — docs(wiki): full rebuild — fix slugs/nav, refresh all pages for v01.05.x, add Admin Guide / JSON-LD Schemas / Troubleshooting / sidebar
| 1 | - | |
| 1 | + # Admin Guide | |
| 2 | + | |
| 3 | + Open **Components → MokoSuiteOpenGraph** in the Joomla administrator. | |
| 4 | + | |
| 5 | + ## Dashboard (default view) | |
| 6 | + | |
| 7 | + The dashboard is the landing screen. It shows: | |
| 8 | + | |
| 9 | + - **Coverage donut** — percentage of published articles that have an OG tag (green ≥ 80%, amber ≥ 50%, red below) | |
| 10 | + - **Field coverage gaps** — how many tags are missing a custom title, description, or image | |
| 11 | + - **Coverage by content type** — a per-`content_type` breakdown (com_content, menu, category, com_mokoshop) | |
| 12 | + - **Articles missing OG tags** — the most recent published articles with no tag, each linking to the article editor, plus a **Batch Generate** shortcut | |
| 13 | + | |
| 14 | + Switch between the dashboard and the tag list using the component submenu (**Dashboard** / **Tags**). | |
| 15 | + | |
| 16 | + ## Tag Manager (Tags) | |
| 17 | + | |
| 18 | + Lists every OG tag record. From here you can: | |
| 19 | + | |
| 20 | + - **Search and filter** by OG title and content type | |
| 21 | + - **Open the editor** by clicking a tag's title | |
| 22 | + - **New** — create a tag manually (you choose the content type, content ID, and language) | |
| 23 | + - **Edit** — select a row and edit it | |
| 24 | + - **Publish / Unpublish / Delete** — standard toolbar actions | |
| 25 | + - **SEO health badges** — flags for missing description, overly long title, or noindex | |
| 26 | + - **Debug links** — quick links to the Facebook Debugger, LinkedIn Inspector, and Google Rich Results test | |
| 27 | + | |
| 28 | + ### Editing a tag | |
| 29 | + | |
| 30 | + The edit screen has two tabs: | |
| 31 | + | |
| 32 | + - **Details** — content type, content ID, language, OG title/description/image/type, og:video, published state | |
| 33 | + - **SEO Meta Tags** — SEO title, meta description, robots, canonical URL | |
| 34 | + | |
| 35 | + `maxlength` hints match the database limits (SEO title 70, meta description 200). Required fields are validated on save. | |
| 36 | + | |
| 37 | + ## Batch Generation | |
| 38 | + | |
| 39 | + Click **Batch Generate** (toolbar or dashboard). The component: | |
| 40 | + | |
| 41 | + 1. Counts published articles that have no OG tag | |
| 42 | + 2. Processes them in chunks, generating OG title/description/image from the article content | |
| 43 | + 3. Shows a live progress bar | |
| 44 | + | |
| 45 | + Requires the `mokoog.batch` permission (or core `create`). | |
| 46 | + | |
| 47 | + ## CSV Import / Export | |
| 48 | + | |
| 49 | + - **Export CSV** — downloads all OG tags (including `og_video`, `event_data`, `recipe_data`, `custom_schema`) | |
| 50 | + - **Import CSV** — click **Import**, choose a `.csv` file, and upload. New columns are appended, so older exports still import. JSON columns are validated (objects/arrays only) and `og_video` is restricted to http/https. | |
| 51 | + | |
| 52 | + The CSV header row defines the columns; `content_type`, `content_id`, and `language` form the unique key used to update-or-insert each row. | |
| 53 | + | |
| 54 | + Requires the `mokoog.import` permission (or core `create` + `edit`). | |
| 55 | + | |
| 56 | + ## Permissions | |
| 57 | + | |
| 58 | + Open **Options → Permissions** to grant per-group access to the custom actions: | |
| 59 | + | |
| 60 | + - `mokoog.batch` — batch generation | |
| 61 | + - `mokoog.import` — CSV import/export | |
| 62 | + | |
| 63 | + These complement the standard core actions (`core.create`, `core.edit`, `core.delete`, `core.manage`). | |
| 64 | + | |
| 65 | + ## Plugin Settings | |
| 66 | + | |
| 67 | + Site-wide behaviour (defaults, JSON-LD, sitemap, AI, LocalBusiness) is configured in the **System - MokoSuiteOpenGraph** plugin — see [Configuration](Configuration). | |
| 68 | + |