Manual:Extension/VisualEditor

BlueSpice uses a slightly customized version of the MediaWiki extension VisualEditor as editing tool. This editor supports all common edit tasks that are useful in a wiki environment. You can refer to the official documentation for basic help. Here in the BlueSpice Helpdesk, we only give some hints and tips for using the editor.

What is the visual editor?

VisualEditor

The visual editor is optimized for editing wiki pages. Important characteristics and functions are:

1. Page structuring with headings.
2. Consistent text formatting.
3. Linking of contents.
4. Inserting special content (files/media, tables, templates, magic words)
5. Adjusting page options.

Text editing

Typical text formatting options such as bold, italics, or text color are available as a context menu. When you highlight text, a menu with common formatting elements appears. For example, you can apply a different text color.

Applying text color

Pasting content from your clipboard

Undo

If you paste content from your clipboard (e.g., copied from MS Word or MS Excel), you usually also paste many unnecessary formatting tags from the original application. To avoid, this you should paste the content as plaintext.

If you already pasted text which resulted in undesirable formatting, you can use the undo function in VisualEditor to remove the content again if you have not yet saved the page or switched between visual and source editing mode.

To paste content as plain text instead, use the shortcut Ctrl+Shift+v.

Shortcuts

If you want to apply multiple formatting options at the same time, shortcuts are often the quickest way. For example, to show text in bold and italic, highlight the text and press Ctrl+b (for "bold") and Ctrl+i (for "italics"). Even a link can be quickly inserted by pressing Ctrl+k. Pressing Ctrl+b again will cancel the bold. Multiple formats can be removed after text selection with Ctrl+m.

All available keyboard shortcuts are marked accordingly in VisualEditor next to each menu item.

Menu items with shortcuts

Note:For a list of all available shortcuts, click on "Keyboard shortcuts" in the Visual Editor help menu (the question mark menu item).

Inserting other content

Many typical page elements such as images, files and tables can be integrated into your page from the Insert menu.

• File formats with a preview option: jpg/jpeg, png, gif, pdf
• File formats without preview option are always inserted as links (e.g., Microsoft Office formats)

If you want to learn more about inserting these elements, go to the following help pages:

• Images
• Files (PDF, xls, doc, ...)
• Tables
• Templates

Wiki-specific content

Some functions in the Insert menu are little known from traditional word processing, but are quite typical for working with a wiki. Therefore, they are briefly introduced here. Find more information on the help pages here in the helpdesk or at mediawiki.org:

• Comment: Add comments to the page. These are only visible in the source code.
• Gallery: A simple picture gallery can support many process flows.
• Magic word: Wiki features such as signature, word counter, category tree or even process diagrams with draw.io can be integrated as a "magic word".
• Your signature: Only works on pages that allow signatures. Pages in the Namespace "Pages" are not included.
• Codeblock: Programming code is displayed here in clean code blocks, optionally with line numbers.
• References list: Creates footnote references.
• Chemical formula: The formula rendering uses an external service via Wikimedia's REST API.
• Math formula: An editor opens for entering a mathematical formula.

Switching between edit modes

When creating or editing a page, the page usually loads in visual editing mode. If you are familiar with the formatting language of MediaWiki ("Wikitext"), you can easily switch to source editing mode using the "Switch editor" menu item and edit your page content there:

Hints and tips

VisualEditor is optimized for editing web pages. That's why it has exactly the features that are often needed to create a wiki page. The consistent formatting of content supports the readability of your wiki content.

Text formatting

In the text formatting menu, the following additional options are available when a text passage has been selected:

Text color: different text colors can be selected via an inspector menu.

Center align: Text can be selected and centered paragraph by paragraph.

Indent: Text can be indented once (note: multiple indentation is only possible via the source text).

Text formatting options

Text formatting
Undo function	Left arrow: Undo last action (greyed out: there is no last action yet) Right arrow: Restore last action (greyed out: there's nothing to restore yet)
Format Paragraph	Here text can be defined as heading or specific paragraph type. Note: If you work in a table, the options will change accordingly (content cell and header cell):
Style text	If no text has been selected before clicking on the " A" button and on a button, the text will be formatted from the current position of the cursor. (More Info at mediawiki.org/wiki/Help:VisualEditor/User_guide/en#Getting_Started:_The_VisualEditor-Toolbar])
Insert hyperlink	If no text was selected before the hyperlink dialog was opened, the link will be generated with a number: [1] To subsequently change the hyperlink description, just click on the link to open the edit menu. In a table, you may need to double-click the cell first and then click the hyperlink again.
Cite	The citation menu is used to insert footnote references within the text.
Structure	Formats ordered and unordered lists. If paragraph breaks or images need to be inserted within a bullet point, use Shift+Enter to avoid creating a new list item.

Insert special content

Paste Special Content
Insert menu	Use the "insert" menu to insert various media (images, videos) and text formats:
Media	Inserting pictures and videos (Details on MediaWiki])
Templates	Include a template in the page.
Tables	Tables are an important tool for formatting tabular page content.
Comment	Comments are not visible to readers, but only in edit mode. A comment can be inserted anywhere on a page. The comment can be edited by clicking on it. And this is what a comment looks like:
Magic word  -v4.2.x	With a "magic word" you can include certain variables or so-called behavioral switches in your page. For example, you can display the word count: More about Magic words
Gallery	Allows to display a set of images as a gallery. Formatting examples for the different settings can be found at mediawiki.org/wiki/Help:Images#Gallery_syntax
Your signature	This option allows to add your wiki signature (User name and timestamp) at any location in the page.
Code block	With code block various code examples can be entered, like e.g. in HTML syntax. The code is then displayed properly formatted: <span style="color: red">red text</span>
Refernces list	This menu item creates a <references /> tag at the location where it is inserted. The footnote references up to this point are then displayed at that location instead of the end of the page. Remaining footnotes in the page are still shown at the end of the page.
Chemical formula	The formula rendering uses an external service via Wikimedia's REST API.
Math formula	It opens an editor for entering a mathematical formula. [[on MediaWiki]]
Special Characters	Opens a panel to select special characters that are not available on your keyboard. To close the panel, click the menu item again.

Page options

Page Options
Options menu	The options menu allows editing of all page settings. It is not
Options	This button allows the page settings and page information to be updated simultaneously within a dialog box. To change any page options on the page, you need to be in visual editing mode.
Categories	Here, you assign the page to one or more categories while in edit mode.
Page Settings	Page redirection: When the page is redirected, the content of the page is no longer displayed, but the target page is loaded directly. Show Table of Contents: By default, a table of contents is shown if a page has more than three headings. You can use this setting to always force or suppress the table of contents.
Advanced Settings	Let this page be indexed by search engines: Only applies to public search engines. The wiki's internal search is not affected. Show a tab on this page to add a new section: Not supported in BlueSpice 4 Discovery skin. Display title: Sets a title that is shown as page heading. It can be found by the search and is used in page lists created by Semantic MediaWiki inline queries. Title visibility: This setting hides the entire title section of a page and is often applied on the main page or other portal pages of the wiki. If the title is not visible, the edit button is also not available. In this case, you can click on all actions... > Edit in the page tools. "all actions" Menu
Languages	Menu item to access interlanguage links Shows wiki pages on different wikis that are connected via Interlanguage links. Depending on the wiki's skin, the links are shown in a specific location. In the BlueSpice 4 Discovery skin, the interlanguage links are shown in the top menu. mediawiki.org/wiki/Help:Links#Interwiki_links
Templates used	List the templates that are embedded on the page.
View as right-to-left	Support for languages that are read from right to left. Clicking this button right-side formats the page text. Click again to set the text flush left.
Find and replace	Words or characters can be searched and replaced directly on the page. The "Undo" button can be used to cancel the change.

Troubleshooting: Visual editing is disabled

If you only have the source editing option in your editor toolbar, please contact an administrator of your wiki. The following settings must be checked in this case:

• Global settings via the configuration manager
• Namespace manager settings

Technical Reference: VisualEditor

---

To submit feedback about this documentation, visit our community forum.