About the Wiki Module
The Wiki module is a content management system designed for creating, organizing, and maintaining structured documentation within your Magentrix portal. Wikis provide a centralized location for knowledge bases, product documentation, training materials, API references, and other collections of related content that users need to access and navigate efficiently.
Unlike standalone documents or articles, wikis organize content into hierarchical structures with categories and pages, enabling users to browse logically organized information through an intuitive navigation sidebar. The module supports versioning for maintaining multiple documentation sets, keyword search for quick content discovery, and granular permissions for controlling access.
Key Capabilities
The Wiki module provides the following core capabilities:
Hierarchical Content Organization: Content is structured into categories (folders) and pages arranged in a navigable tree. Categories can contain sub-categories and pages, allowing for logical grouping of related information. The sidebar navigation reflects this hierarchy and remains visible as users browse, enabling quick movement between topics.
Rich Content Authoring: A WYSIWYG (What You See Is What You Get) editor allows wiki managers to create professionally formatted content with text styling, tables, images, hyperlinks, and embedded media. Source code editing is available for advanced formatting and customization.
Version Management: Wikis can maintain multiple versions of documentation simultaneously—such as different product releases or API versions. Users can switch between versions while browsing, and administrators control which pages belong to each version. This enables long-term documentation maintenance without duplicating entire wikis.
Search Functionality: When enabled, users can search page titles, descriptions, and content directly from the wiki sidebar. Search results help users quickly locate specific information within large documentation sets.
Flexible Permissions: Wikis can be shared with specific users, user groups, security roles, or made publicly accessible. Permission levels control whether users can only view content or also manage and publish it.
Activity Tracking: Page-level analytics show visit trends and activity logs, helping administrators understand content effectiveness and identify high-traffic documentation.
Attachments: Supporting materials such as files, notes, code snippets, and external links can be attached to individual pages, providing users with supplemental resources alongside the main content.
Common Use Cases
Organizations typically use the Wiki module for:
Knowledge Bases: Centralized repositories of organizational knowledge, FAQs, troubleshooting guides, and reference materials that help users find answers independently.
Product Documentation: User guides, feature documentation, and how-to content organized by product area or functionality. Version management allows maintaining documentation for multiple product releases.
API and Technical Documentation: Developer guides, API references, integration instructions, and code examples organized in a structured, searchable format. Technical documentation often benefits from versioning to support multiple platform or API versions.
Training Materials: Structured learning content, onboarding guides, and procedural documentation that users can navigate sequentially or access by topic.
Partner and Customer Portals: Self-service documentation portals where partners or customers can access relevant information based on their permissions and relationship with your organization.
Key Concepts
Understanding the following concepts is essential for working with the Wiki module:
Wiki: A wiki is the top-level container that defines a collection of related documentation. Each wiki has its own URL path, language setting, permissions, and optional versioning configuration. A portal can contain multiple wikis for different purposes or audiences.
Category: Categories are folders used to organize wiki pages into logical groups. Categories can be nested (sub-categories within categories) to create hierarchical structures. A category only appears to end users when it contains at least one published page.
Page: Pages are individual documentation articles containing the actual content users read. Each page has a title, URL path, description, and body content. Pages must be placed within a category and must be published before users can view them.
Version: When versioning is enabled, versions represent different documentation sets within the same wiki—such as different product releases. Pages are assigned to one or more versions, and users can select which version to view when browsing. Versions allow maintaining historical documentation alongside current content without duplication.
Draft vs. Published: Both wikis and individual pages have publication states. Draft content is only visible to administrators and wiki managers. Published content is visible to users based on configured permissions. Content changes can be saved without publishing, allowing work-in-progress editing.
User Roles
The Wiki module involves three primary user types:
Administrators: Users with the Administrator system role have full access to create wikis, configure settings, manage permissions, and publish content. Administrators can access all wiki management functions through Setup.
Wiki Managers: Users granted Manage permission on a specific wiki through the Share dialog can create and organize categories, add and edit pages, manage versions, and publish content within that wiki. Wiki managers access wiki management through Setup in the same manner as administrators but can only manage wikis they have been granted access to.
End Users: Users with View permission can browse published wiki content, use search (if enabled), switch between versions (if versioning is enabled), and download attachments. End users access wikis through the portal navigation and cannot see draft content or access management functions.
Related Documentation
The following documentation provides detailed guidance for working with the Wiki module:
Video for Wiki module
Wiki Module Checklist >>