1. Using Visual Builder Studio
  2. Maximize the Power of Your Project
  3. Co-Author Wikis
  4. Create and Manage Wiki Pages

Create and Manage Wiki Pages

From the Wiki Home page, you can create and open wiki pages, add child wiki pages, add attachments, show or hide the tree view that displays the structure for the project's wiki pages, and delete or restore deleted wiki pages. From the Wiki Draft page, you can open and edit saved drafts, publish drafts, and delete any drafts that are no longer needed.

In the left navigator, click Wiki Wiki to display the top-level Wiki page.


Description of wiki-page-initial-no-pages-defined.png follows
Description of the illustration wiki-page-initial-no-pages-defined.png

From there, you can create a Wiki Home page, as well as create and manage your project's wiki pages and drafts. Any project user can create a wiki page. For a page that you didn't create, depending on the edit and delete access set by the creator of the wiki page, you may or may not be able to edit or delete it. However, if you’re a project owner, you can always do that.

If a collection of wiki pages already exists, but has no Wiki Home page, you can click + Home Page to create one. Before creating a new Wiki Home page for the collection, notice that the Refresh, Edit, and Delete buttons are not available.


Description of no-wiki-home-page.png follows
Description of the illustration no-wiki-home-page.png

There is no button for creating a child page, since all pages under the Wiki Home page are child pages. That's why you just see the + Page button, to the right.

Here's what you need to know about creating and editing wiki pages:

Action How To

Create a wiki home page

  1. On the Wiki page, click + Home Page.

  2. The path field, where you see /, denotes the path to the Wiki Home page you want to create.

    The default path cannot be modified.

  3. In the Page Text tab, enter the content.

    Use the project’s wiki markup language to format the contents. To open the markup language’s cheat sheet, click the reference link above the text area.

    You can also use the markup toolbar for quick formatting. The toolbar provides frequently used actions so you can quickly and easily format text, or add elements like links, images, lists, tables, and more.

    The toolbar also provides editor options so you can turn off line numbers, change line wrapping, and show (or hide) the wiki editor's minimap.

  4. Click Publish to publish the new Wiki Home page.

    If you click Close, you are prompted to retain a draft of the page you were working on or to delete the draft and discard your work.

    If you click Discard Draft, the draft you were working on won't be saved.

Create a wiki page

  1. On the Wiki page, click + Create Page.

  2. In the field where you see the Enter path text, enter the full path to the page you want to create.

    The path should consist of URL-safe characters, without any spaces or periods. Don't add a trailing slash at the end. There's no need to create folders. Just enter the full path you want to create and folders will be created automatically.

  3. In the Page Text tab, enter the content.

    Use the project’s wiki markup language or the markup toolbar to format the contents. To open the markup language’s cheat sheet, click the reference link above the text area.

  4. Click Save to publish the new page.

    Click Close and you'll be allowed to retain a draft of the page you were working on or delete the draft and discard your work.

Open a wiki page
To open a wiki page, click the wiki page title on the Wiki Home page or in the tree view.

Tip:

Click the Show/Hide Wiki Tree View Show/Hide Wiki Tree View icon icon to show or hide the wiki navigation tree that's displayed on the page's left side.

If a wiki page has child wiki pages, you can expand the parent (and any child pages that have child wiki pages) in the Wiki Home page or in the tree view by clicking the Expand selection icon icon to the left of the wiki page title and select the child wiki page name to open it.

Tip:

Click the Pages link in the wiki tree to navigate back to the Wiki Home page.

You can collapse any expanded wiki page by clicking the Collapse selection icon icon to the left of its page title, in the page or tree view.

Edit a wiki page
To edit a page, click Edit. If a saved draft for the page exists, select Resume Editing to display the draft with the last saved changes or select New Edit to start editing the published page. Use the wiki’s markup language or the markup toolbar to format the contents.

Tip:

To open the markup language’s cheat sheet, click the reference link above the text area.
If the project is using the Markdown markup language:

  • Use # followed by the issue ID to add a reference to the issue. For example, #12 will create a link to the issue ID 12.

  • Use ! followed by the merge request ID to add a reference to the merge request. For example, !34 will create a link to the merge request ID 34.

  • See http://www.emoji-cheat-sheet.com/ for the complete list of supported emoticons and text patterns.

Edit a draft of a wiki page

  1. Above the wiki navigation tree that's displayed on the page's left side, click Wiki Draft.

    You can also click the separator Separator to the right of the wiki tree view Wiki tree view icon in the page's breadcrumbs.


    Description of my-drafts-shortcut.png follows
    Description of the illustration my-drafts-shortcut.png

    Select Wiki Draft and the Wiki Draft page will open.

  2. Locate the draft of the wiki page you want to edit and click Edit the Edit icon under Actions.

Create a child wiki page

  1. Open the parent wiki page.

  2. Click + Child.

You can also create a child wiki page without opening or creating its parent wiki. On the Wiki page, click + Page. In Page Title, enter the path of the child wiki page. For example, to create a HelloWorld child page of the Welcome page, enter Welcome/HelloWorld in the title. If the Welcome page doesn't exist, VB Studio will create both the Welcome and HelloWorld pages. Open the empty Welcome wiki page, click Publish to create the page, then add content to it.

Add an attachment

You can attach files of any type to a wiki page, including images, videos, docs, spreadsheets, and archived files.

  1. Open the wiki page or the draft in edit mode.

  2. Click the Attachments tab.

  3. In the Files to Attach or Update section, click Select. Browse and select files to attach.

    You can also drag and drop files to the drop area.

  4. Click Attach.

  5. Click Save.

Publish a draft of a wiki page

  1. On the Wiki Drafts page, locate the draft of the wiki page you want to publish.

  2. Click Publish the Upload icon under Actions.

    A draft of a new page can only be published if it contains a path. A draft of an existing page can only be published if the draft contains changes from the underlying page.

Delete a wiki page

  1. Open the wiki page

  2. Click Delete.

  3. In the Delete Wiki Page dialog box, select I understand that my wiki page will be permanently deleted and click Delete.

The wiki page along with its comments is deleted. An activity with a link to restore the wiki page (if necessary) is added to the recent activities feed of the Project Home page.

If you delete a parent wiki page, its child wiki pages aren’t deleted. The parent wiki page name continues to appear in the breadcrumb path.

To delete a draft of a wiki page, from the Wiki Drafts page, click Delete Delete icon under Actions Action menu. In the Delete Wiki Page dialog box, select I understand that my wiki draft will be permanently deleted, and click Delete draft.

Restore a wiki page

  1. Click the deleted wiki name in the recent activity feed or any other wiki page where it was referenced.

  2. Click Restore.

The wiki page, along with all comments and attachments, will be restored to its original path.

To restore a parent wiki page, open it and click Restore.