MantisHub Pages – Wiki and Knowledge Base

If you are still using the Classic UI, please see the Classic UI Article for further help.

What is Pages?

Video Tutorial

Pages is a MantisHub proprietary feature where you can create an internal documentation repository that can be used as a Wiki or Knowledge Base.

Pages facilitates teamwork and knowledge sharing while increasing efficiency and simplifying infrastructure. You have one tool, combining a wiki and documentation service with your internal issue tracker and external-facing customer Helpdesk for a unified team collaboration environment. You can create documentation that cross-references other documents, internal issues, or customer support tickets.

Example use cases include:

• Reference test documentation in testing tasks
• Link to support processes from support tickets
• On-call playbooks
• Team onboarding
• Inviting comments on design documents

What can you do with Pages?

Pages supports simple Markdown formatting which you can use at any point but also has a text editor which can be used to:

• Add snippets to your Pages
• Format text
• Insert tables or lists
• Link to URLs
• Preview your page

You can also:

• Attach/Embed Images and Videos
• Link Pages to other Pages
• Link issues in your Page
• Link Pages to your issue summary, description, or note.

By default, all users with an access level of Viewer and above can view Pages. All users with an access level of Updater or above can create, update, or delete Pages.

Installing Pages

Pages is installed by default, so you can access it immediately. If you wish to uninstall it, navigate to Manage -> Plugins -> Plugin List.

When installed, you will see Wiki listed in the main menu on the left-hand side, where you can access documentation for each project.

Creating New Pages

Once Pages is installed, each project will automatically have a Home Page where you can link to Pages within your project. The default Home Page includes tips and tricks on how to use Pages functionality for easy reference. You can create a new Page in one of 2 ways.

1. Create a new page and then edit the Home Page to add the link to the new Page. OR
2. Create a link on the Home or another parent page. A link with a strikethrough will be displayed. Click on this link, which will take you to the Create Page form to create the new Page.

Option 1: From the project Home Page, click the Create button at the top of the screen.

You will be presented with the Create Page form. Enter the following:

1. Name: (Required) This will be used within the code and when linking pages. The name must not contain spaces or special characters.
2. Title: (Required) The displayed name of the Page. The title can contain spaces.
3. Content: (Required) Enter text, tables, images, etc., using the text editor.
4. Add Files

Click Create to publish your new Page. You can then link to this Page from the Home Page or a parent page using the name you have specified.

Option 2: Edit the project's Home Page or another existing parent page and create a link to a new page. To link to a page, you type in the Page's name surrounded by double brackets. For example:

[[HDPrimaryProcess]]

If the Page does not yet exist, it will create the link, but it will be displayed with a strikethrough so that you know the Page has not yet been created.

To create the Page, click the link displayed with the strikethrough. This will take you into edit mode for the new page and pre-populate the name field. You can then go ahead and fill in all the other details and click Create.

Attaching/Embedding Images and Videos

To feature images on your Page, attach your file to the Page using the + Add Files section. Then, you can insert the file within your document using the following syntax.

![Text Displayed](filename.png)

The syntax for embedding videos is the same, but as well as attaching a file that can be quite large, we support referencing a remote URL, e.g.

![Text Displayed](https://www.youtube.com/watch?v=79gzdskOGu4)

Referencing Pages within an Issue and Issues within a Page

You can reference a Page from within a MantisHub issue or MantisHub Helpdesk ticket in the same way you reference it from another Page. In your issue description or notes, type in the page name surrounded by double square brackets.

[[page-name]]

You can reference a Page within another PROJECT by typing a forward slash project name forward slash page name surrounded by double square brackets.

[[/another-project/page-name]]

Linking to MantisHub issues from a Page is done by referencing the issue ID preceded by a hash symbol #<issueID>, for example, #19724. You can link to issues or tickets in any project. Issue IDs are unique across the whole system, so it doesn't matter what project the issue belongs to.

The system will not prevent you from linking to a ticket you do not have access to, but it will prevent you from viewing that issue according to your permission. If a user does not have access to the issue, then the link will take them to a blank page.

Navigating Within Pages

A Home Page is automatically created for every project. This is where you can create a link to each new Page within the project. However, there is also a Browse menu option that will display all Pages in either the specific project or All Projects depending on your project selector. The Browse page includes a search box to allow you to search for a specific page or text within a page.

You can also view all revisions made to a page, including who made each revision, along with the time and date. There is also the option to revert to a previous version of the Page.

The ellipsis menu on the right-hand side provides the option to Print, Delete, or Move a Page to a different project.

Settings

By default, all users with an access level of Viewer and above can view Pages. All users with an access level of Updater or above can create, update, or delete Pages. To change these settings, go to Manage -> Settings -> Wiki, where you can edit the access level required to View, Create, Update, or Delete a Page.