Difference between revisions of "Reference:BlueSpiceInsertMagic"

(Changed categories.)
(Tag: 2017 source edit)
 

Extension: BlueSpiceInsertMagic


Overview
Description: Helps integrating special wiki tags, behavior switches or magic words Adds a dialog allowing the insertion of magic words and tags
State: stable Dependency: MediaWiki, BlueSpice
Developer: HalloWelt License:

GPL-3.0-onlyProperty "BSExtensionInfoLicense" (as page type) with input value "</br>GPL-3.0-only" contains invalid characters or is incomplete and therefore can cause unexpected results during a query or annotation process.

Type: BlueSpice Category: Editor
Edition: BlueSpiceFree"BlueSpiceFree" is not in the list (BlueSpice pro, BlueSpice free, BlueSpice Farm, BlueSpice Cloud, BlueSpice free (deactivated), BlueSpice pro (deactivated), BlueSpice Farm (deactivated), BlueSpice Cloud (deactivated)) of allowed values for the "BSExtensionInfoEdition" property., BlueSpicePro"BlueSpicePro" is not in the list (BlueSpice pro, BlueSpice free, BlueSpice Farm, BlueSpice Cloud, BlueSpice free (deactivated), BlueSpice pro (deactivated), BlueSpice Farm (deactivated), BlueSpice Cloud (deactivated)) of allowed values for the "BSExtensionInfoEdition" property.

Features

[edit source]

The extension

InsertMagic provides a

dialogue for the edit mode (VisualEditor and classical view) to help you insert helpful tags and MagicWords (Behavior switches, variables, parser functions).

Technical background[edit | edit source]

For a better understanding of the terminology used, here a short glossary:

  • MagicWord: WikiCode enclosed by double curly brackets ({{magicword}}) will be processed by MediaWiki either as template or MagicWord.
  • Variable: A MagicWord normally returning a single value, either a number or a string.
  • Behavior switch: A MagicWord influencing the behavior of the wiki (resp. the parser). Behavior switches cannot be programmed by oneself, but are part of the MediaWiki (parser) core. Contrary to other MagicWords they are enclosed by double underscores: __...__
  • Parser function: A mechanism to implement logic within a wiki article. The respective MagicWord often begins with a hash key: {{#...}}
  • Tag: An XML tag that may be parametrized at will, producing an output desired by the programmer.
Where do I find InsertMagic?[edit | edit source]

In both editors (visual or classic) you will find the button InsertMagic.png. Click on it to open the dialogue.

Functions of InsertMagic[edit | edit source]

In the combobox you can choose between the following categories:

  • / Tags
  • / Switches
  • / Variables

To the right of the selection you can find a detailed description of the chosen MagicWord. Under the combobox you will see the respective code. Click on Ok to insert the code into the article.

Please note: InsertMagic only offers you a selection of the most important variables and MagicWords. But of course you can also use other tags in your article, provided they work with MediaWiki.

Screenshot: The InsertMagic dialogue

dialog for inserting Magic Words in VisualEditor.

You can open the dialog box in visual and source editing modes from the editing toolbar. A selection of tags and magic words is offered. After inserting a tag on the page, further paramaters can be set.

Technical Information[edit source]

This information applies to BlueSpice 3 . Technical details for BlueSpice cloud can differ in some cases.

Requirements[edit source]

  • MediaWiki: 1.31
  • BlueSpiceFoundation: 3.2

Integrates into[edit source]

  • VisualEditor

Special pages[edit source]

API Modules[edit source]

  • bs-insertmagic-data-store

Hooks[edit source]


Attachments

Discussions