Using the Wiki Content Editor

The Wiki Content Editor is where administrators and wiki managers create, edit, and publish the body content of individual wiki pages. The editor provides a rich text authoring environment with formatting tools, version management, file attachments, and activity tracking to support comprehensive documentation development.

Proper use of the Content Editor ensures that documentation is well-formatted, properly versioned, discoverable through search, and visible to the intended audience once published.

Opening the Content Editor

Access the Content Editor from the wiki's Contents tab to begin creating or editing page content.

Requirements

To use the Content Editor, you must have one of the following:

• Administrator system role
• Manage permission on the wiki (granted through sharing)

To Open the Content Editor

1. Navigate to Setup and click Create > Wikis.
2. Click the wiki name to open it.
3. Click the Contents tab.
4. Right-click the page you want to edit.
5. Select Open Content Editor.

The Content Editor opens with four tabs: Content, Settings, Attachments, and Activity. Action buttons (Close, Save, Publish) appear in the upper-right corner and apply to the page as a whole.

Content Editor Layout

The Content Editor is organized into four tabs, each serving a specific purpose in the content management workflow:

• Content – Author and format the main page content using the rich text editor.
• Settings – Manage page metadata, publication status, and version assignments.
• Attachments – Add supplemental files, notes, snippets, and bookmarks.
• Activity – Review page engagement metrics and activity history.

A typical workflow involves editing content, reviewing settings, optionally adding attachments, and then saving and publishing when ready.

Content Tab

The Content tab is where you author the main body content that users read when viewing the page.

Page Identification

At the top of the Content tab, the following fields are displayed:

Title

The page title appears at the top of the editor. You can edit the title directly from this field. Changes to the title are saved when you click Save and take effect immediately without requiring republication.

Path

The URL path for the page is displayed below the title, showing the wiki's base path followed by the page-specific path. You can edit the path directly from this field. Changes to the path take effect immediately when saved.

Preview Button

Click Preview to view the page as it will appear to end users. Preview opens in a new view, allowing you to verify formatting and layout before publishing.

Rich Text Editor

The main area of the Content tab contains a WYSIWYG (What You See Is What You Get) editor for creating formatted content. The editor displays content approximately as it will appear to users, allowing you to see formatting results as you work.

Formatting Toolbar

The formatting toolbar provides comprehensive text and content formatting options:

Text Formatting

• Bold, Italic, Underline, Strikethrough
• Subscript and Superscript
• Text color and background color

Paragraph Formatting

• Headings and paragraph styles (Format dropdown)
• Font family and font size selection
• Text alignment (left, center, right, justify)
• Indentation controls

Lists

• Bulleted (unordered) lists
• Numbered (ordered) lists

Content Elements

• Tables – Insert and configure tables with rows and columns
• Horizontal rules – Insert divider lines
• Special characters – Insert symbols and special characters

Links and Media

• Hyperlinks – Insert links to external URLs or other wiki pages
• Images – Insert images from your computer, the Magentrix server, or external URLs

Editing Tools

• Find and Replace – Search for and replace text within the content
• Undo and Redo – Reverse or reapply recent changes
• Paste options – Paste as plain text or paste from Word

Working with Images

Images enhance documentation by providing visual context, screenshots, diagrams, and illustrations.

To Insert an Image

1. Place the cursor where you want the image to appear.
2. Click the image icon in the toolbar.
3. Select the image source:
   • Upload – Select an image file from your computer.
   • Server – Choose an image stored on your Magentrix server.
   • URL – Enter the URL of an externally hosted image.
4. Configure image properties as needed.
5. Click OK to insert the image.

Image Editing

• Resize – Click and drag a corner of the image directly in the editor to resize proportionally.
• Properties – Double-click the image to open the image properties dialog, where you can adjust dimensions, alignment, and other settings.
• Hyperlink – Images can be made into hyperlinks. Configure whether the link opens in the current window or a new window.

Working with Hyperlinks

Hyperlinks connect your documentation to related content, external resources, and other wiki pages.

To Insert a Hyperlink

1. Select the text you want to make into a link.
2. Click the hyperlink icon in the toolbar.
3. Enter the URL or select a target.
4. Configure whether the link opens in the current window or a new window.
5. Click OK to insert the link.

Source Mode

For advanced formatting and customization, the editor provides direct access to the underlying HTML code.

To Access Source Mode

1. Click Source in the toolbar.
2. Edit the HTML code directly.
3. Click Source again to return to the visual editor.

Source mode is useful for:

• Applying custom CSS styles
• Fixing formatting issues
• Adding HTML elements not available through the toolbar
• Pasting pre-formatted HTML content

Settings Tab

The Settings tab manages page metadata, publication status, and version assignments. These settings control how the page appears in search results and which users can view it.

Description

Description (Required)

Enter a summary of the page content. The description appears in wiki search results and helps users determine if the page contains the information they need. Write clear, concise descriptions that accurately reflect the page content.

Status and Publishing

Status

Displays the current publication status of the page:

• Draft – The page is not visible to end users. Only administrators and wiki managers can view draft pages through the management interface.
• Published – The page is visible to users based on wiki permissions and version assignments.

Publish Date

Displays the date and time when the page was last published. This field is read-only and automatically populated when you publish the page.

Classification Fields

Wiki Category

Displays the category where the page resides in the content tree. This field is read-only. To move a page to a different category, use drag-and-drop in the Contents tab.

Language

Displays the language associated with the page content, inherited from the wiki settings.

Wiki

Displays the name of the parent wiki this page belongs to.

Audit Fields

Created By

Displays the user who created the page and the creation timestamp. This field is read-only.

Modified By

Displays the user who last modified the page and the modification timestamp. This field is read-only and updates automatically when changes are saved.

Versions Section

When wiki versioning is enabled, the Settings tab includes a Versions selector for assigning the page to one or more versions.

The Versions section displays two lists:

• Available Versions (Left) – Versions the page is not currently assigned to.
• Selected Versions (Right) – Versions the page is assigned to.

To Assign Versions

1. Select a version from the left list.
2. Use the arrow controls to move it to the right list.

To Remove Version Assignments

1. Select a version from the right list.
2. Use the arrow controls to move it to the left list.

Attachments Tab

The Attachments tab allows you to associate supplemental materials with the page. Attachments provide users with additional resources beyond the main page content.

File Attachments

Upload files to share supplemental documentation, reference materials, downloads, or supporting resources with page viewers.

To Attach a File

1. Click the Attachments tab.
2. Click Attach File, or drag and drop files directly into the upload area.
3. Select the file from your device.
4. Click Open to upload.

Attached files appear in a list and are available for download by users viewing the published page.

Additional Attachment Types

Beyond file uploads, you can create additional attachment types using the New menu:

Notes

Notes are inline text documents stored with the page. Use notes for supplemental information, internal documentation, or content that doesn't fit in the main page body.

1. Click New > New Note.
2. Enter a name for the note.
3. Click Save.
4. Enter the note content.
5. Click the X button to close when finished.

Snippets

Snippets are reusable code blocks or text fragments. Use snippets for code examples, configuration samples, or template text.

1. Click New > New Snippet.
2. Enter a name for the snippet.
3. Select the file type (for syntax highlighting if applicable).
4. Click Save.
5. Enter the snippet content.
6. Click the X button to close when finished.

Bookmarks

Bookmarks are links to external URLs. Use bookmarks to reference external documentation, related websites, or online resources.

1. Click New > Bookmark.
2. Enter a name for the bookmark.
3. Enter the URL.
4. Click Save.

Activity Tab

The Activity tab provides insight into how the page is being used, helping you understand content effectiveness and identify opportunities for improvement.

Visits

The Visits section displays a chart comparing page views across time periods:

• This Week – Page views for the current week.
• Last Week – Page views for the previous week.

Use this comparison to identify trends in page engagement and determine whether content updates or promotion efforts are affecting traffic.

Activity Log

Below the visits chart, a detailed activity log lists events related to the page, including:

• Page views
• Content edits
• Publications
• Revisions

The activity log helps administrators audit changes and understand how the page has evolved over time.

Saving and Publishing

Understanding the distinction between saving and publishing is essential for managing content effectively.

Save

Clicking Save preserves all changes to the page, including:

• Content changes in the editor
• Title and path changes
• Description updates
• Version assignments
• Attachments

Saved changes are stored but not visible to end users until the page is published. Use Save to preserve work in progress without making content live.

Publish

Clicking Publish makes the saved content visible to end users (subject to wiki permissions and version assignments).

To Publish a Page

1. Review the content to ensure accuracy and completeness.
2. Verify version assignments in the Settings tab (if versioning is enabled).
3. Click Publish in the upper-right corner.

After publishing:

• The page Status changes to Published.
• The Publish Date is updated to the current date and time.
• The content becomes visible to users with appropriate permissions.

Revert to Draft

If you need to remove a published page from user view without deleting it, you can revert it to draft status.

To Revert to Draft

1. Open the Content Editor for the published page.
2. Click Revert to Draft.

The page is removed from user view but all content is preserved. You can continue editing and republish when ready.

Close

Clicking Close exits the Content Editor and returns you to the wiki management page.

If you have unsaved changes, a warning prompt appears asking you to confirm before closing. Save your work before closing to avoid losing changes.

Best Practices and Recommendations

Save Frequently: Save your work regularly while editing to avoid losing changes. Saved content is preserved even if you close the browser or lose connectivity.

Preview Before Publishing: Always use the Preview function to review how content appears to end users before publishing. Verify formatting, links, and images display correctly.

Write Clear Descriptions: Invest time in writing accurate page descriptions. Descriptions appear in search results and significantly impact content discoverability.

Use Headings for Structure: Organize content with headings (H1, H2, H3) to create a clear hierarchy. Well-structured content is easier to scan and navigate.

Optimize Images: Use appropriately sized images to balance visual quality with page load performance. Resize large images before uploading when possible.

Test Links: Verify all hyperlinks work correctly before publishing. Broken links frustrate users and reduce documentation credibility.

Use Source Mode Sparingly: While source mode provides powerful customization options, use it only when necessary. Stick to the visual editor for most formatting to avoid HTML errors.

Review Activity Regularly: Check the Activity tab periodically to understand which pages receive the most traffic and identify content that may need updates or improvement.

Jump to Wiki Module Checklist

<< Configuring Wiki Versions