[XB] XFRM Resource Docs: Multilingual Documentation 1.0.0

Adds structured, multilingual documentation to individual XenForo Resource Manager resources.

Resource owners and team members can build product manuals, installation guides, and knowledge bases in a dedicated Documentation tab. Organize pages into a nested tree, maintain independent documentation versions, and translate content with fallback to the master language.

---

Features:​

Documentation structure and editing​

• Nested Documentation Tree: Organize categories and documents in one hierarchy, with child documents or categories beneath documents, drag-and-drop sorting, and a separate section for uncategorized pages.
• Native BB Code Editor: Write documentation with XenForo's editor, embedded images, unfurl metadata, and per-language file attachments using native upload controls. Set a maximum page length independently from forum messages.
• 🗂 Unified Content Management: Create, edit, and delete documents and categories from a shared management interface, including category-specific actions, full-width multilingual editors, and native category sorting.
• Document and Category Duplication: Duplicate documents with translations and attachments into new drafts, or copy entire categories with their subcategories and documents.
• Copy Between Resources: Reuse documentation across resources owned or managed by the same team member.
• Reusable Document Templates: Manage multilingual templates in the admin control panel, with editable starters for installation, upgrades, configuration, FAQ, and troubleshooting.
• Inline Moderation: Move or delete documentation pages through XenForo's native inline moderation controls.

Versions and publishing​

• Independent Documentation Versions: Maintain private drafts, published documentation sets, a default version, and legacy notices. Version labels are independent of Resource Manager release numbers.
• Version Copying: Start a new version from an existing published documentation set, preserving categories, translations, and attachments.
• Matching-Page Navigation: Switch versions while retaining the matching page and selected language, with a notice when the destination version has no counterpart.
• Version Overview Pages: Choose an optional overview document as the landing page for each version.
• Publication Workflow: Keep documents as drafts, schedule publication, publish them, or archive them, with management previews of private content. Scheduled publishing updates public search, sitemaps, feeds, and counters automatically.
• 🗃 Legacy Documentation: Keep older versions readable while excluding them from global search and sitemaps.
• Version-Specific Tools: Scope search, management, translation progress, feedback, analytics, and ZIP archives to a version, with optional analytics across all versions.

Multilingual content​

• Translations for Installed Languages: Maintain master-language content and independent translations for each installed XenForo language, with field-level fallback for document titles and content.
• Localized Descriptions: Provide category descriptions and optional SEO descriptions for categories and documents in each language.
• Translation Progress: Track missing, partial, outdated, and current translations for documents and categories, with resource-level language and status filters.
• Translation Review Controls: Confirm translations manually when master-language changes do not require text updates, or skip marking translations as outdated for minor document and category corrections.

Reading and navigation​

• Integrated Documentation Tab: Read documentation inside the standard resource wrapper, with document bodies styled like resource updates and management controls in the message action bar.
• 🗂 Category Landing Pages: Browse indexable category pages with nested breadcrumbs and direct document lists.
• Responsive Tree Navigation: Browse categories and documents with a compact mobile toggle and a style property for placing navigation on the left or right.
• AJAX Page Navigation: Move between documentation pages with animated transitions, scrolling to the document, and browser history support.
• Previous and Next Pages: Follow the documentation sequence using adjacent-document links.
• Automatic Table of Contents: Navigate nested headings with active-section highlighting and section-link copying. The collapsible table of contents can be disabled per document and floats outside the page's right edge after scrolling out of view when space permits.
• Resource Documentation Search: Search dynamically within a resource's documentation using AJAX results.

Feedback and analytics​

• Reader Helpfulness Feedback: Collect helpfulness votes and optional comments, with flood control and spam checks.
• Feedback Statistics: Review resource-scoped feedback statistics as a resource owner or team member. Compare document vote counts, helpfulness indicators, and recent feedback dates in a compact, responsive table.
• Documentation Analytics: Measure document views, unique readers, search demand, queries with no results, and search entry performance through privacy-conscious resource analytics.

Import, export, and integrations​

• Markdown ZIP Import and Export: Transfer nested folders, translations, attachments, and embedded local images, with portable manifest-based round trips and generic folder-based imports.
• 🗂 Preserve Existing Navigation on Import: When replacing documentation from a Markdown ZIP whose manifest contains logical keys, optionally retain the current hierarchy, page order, and overview. New pages follow existing pages; missing required parents or overview pages stop the import.
• XML and Archive Import and Export: Transfer documentation structures, publication states, hierarchy, translations, and original BB code using XenForo-style XML files. Export a ZIP archive to include all per-language attachments and embedded images, then import the XML and files together.
• Native XenForo REST API: Read and manage documentation versions, documents, categories, translations, attachments, publication states, and tree sorting using standard API keys and scopes.
• Multilingual SEO: Use language-specific URLs, canonical and hreflang metadata, TechArticle and CollectionPage structured data, and documentation category entries in XenForo's XML sitemap.

---

Requirements:​

• XenForo 2.3.0+
• XenForo Resource Manager 2.3.0+

---

Useful for:​

• Product manuals and installation guides attached to downloadable resources.
• API documentation and integration references maintained alongside a product.
• Add-on configuration guides with reusable technical page templates.
• Resource knowledge bases with documentation versions independent of release numbers.
• Multilingual documentation teams that need visibility into outdated translations.

---

FAQ:​

• How do I publish a new documentation version? Use Manage versions to create an empty draft or copy a published documentation set. Review the draft privately, publish it, then use Make default separately to change the Documentation tab destination.
• How do I export a specific documentation version? Open Manage versions and use that version's menu to export XML, an XML archive with attachments, or a Markdown ZIP. The export includes only the selected version.
• What happens to existing documentation? Existing documentation is preserved in a default Current version, including its original page URLs.
• Can I retire or delete older versions? A published version can become legacy after another published version becomes the default. Legacy documentation remains readable. Only non-default draft versions can be deleted.
• What happens when a translation is missing? Visitors see content in their selected language, with field-level fallback to the master language for document titles and content.
• How do I count master content as an available language? Set Master content language when creating or editing a documentation version, or use the shortcut on Translation status. Select the installed language used by your master content. Pages and categories without a separate translation count as Current for that language, and their editing links open the Master language tab. Existing translations retain their own status. New versions inherit this setting from their copy source unless you choose another value. XML and Markdown archives preserve it using language codes; older archives leave the target setting unchanged.
• Who can manage documentation through the REST API? API scopes do not replace user permissions. Resource visibility, documentation permissions, and resource team access apply, including restrictions on private versions and unpublished pages.
• Does XML export include attachments? Choose Export as archive to download the XML together with all attachments, including files that are not embedded in the text. The XML import form accepts both XML files and ZIP archives. A standalone XML file contains attachment metadata but requires the archive to restore the files.

---

Screenshots:​

Reading and navigation​

Content management and versions​

Translations and import​

Administration and permissions​