(Created page with "<bookshelf src="Book:User manual" /> {{DISPLAYTITLE:Edit pages}} BlueSpice uses the MediaWiki extension VisualEditor as editing tool. This sophisticated editor supports all co...")
BlueSpice uses the MediaWiki extension VisualEditor as editing tool. This sophisticated editor supports all common edit tasks that you can expect in a wiki environment.
==What is VisualEditor?==
You can insert already uploaded files or upload new files directly when editing an article.
The visual editor is optimized for editing wiki pages. Important characteristics and functions are:
=== Drag-and-drop method ===
You can upload a new file when you edit a page:
#'''Page structuring''' with headings.
# '''Drag''' the file onto the page. A horizontal line will appear where the file will be dropped.
#Consistent '''text formatting'''.
# '''Change''' the file name in the ''Upload file'' dialog (optional). [[File:Insert files 1.png|alt=Insert file via drag-and-drop|center|thumb|400x400px|Insert file via drag-and-drop]]
#'''Linking''' of contents.
# '''Click''' ''Insert''.
#'''Inserting special content''' (files/media, tables, templates, magic words)
# '''Double-click''' the thumbnail to adjust the size and positioning (optional).
#Adjusting '''page options'''.
</div><section end="training" />
==Text editing==
=== Editor toolbar ===
Typical text formatting options such as '''bold''', ''italics'', or <span class="col-turquoise">text color</span> 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.
To upload and insert a file from the editor toolbar:
<br />
[[File:BlueSpice_3.1_-_Notable_Changes_-_Text_colors.png|center|thumb|Applying text color|link=Special:FilePath/BlueSpice_3.1_-_Notable_Changes_-_Text_colors.png]]<br />
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.
<br />
[[File:Manual:editing_tools.png|alt=Menu items with shortcuts|center|thumb|350x350px|Menu items with shortcuts]]
<br />
{{Messagebox|boxtype=note|Note text=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)
*Files can be connected with namespaces and categories
<section end="training-medien" />
If you want to learn more about inserting these elements, go to the following help pages:
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.
*'''[[mediawikiwiki:Help:VisualEditor/User_guide#Editing_media_galleries|Gallery]]:''' A simple picture gallery can support many process flows.
*'''[[Manual:MagicWords|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:'''
*'''Chemical formula:''' The formula rendering uses an external service via Wikimedia's REST API.
*'''[[mediawikiwiki:Help:VisualEditor/User_guide/en#Editing_mathematical_formulae|Math formula]]:''' An editor opens for entering a mathematical formula.
==Switching between edit modes==
When creating or editing a page, the page loads in visual editing mode. If you are familiar with the code language of MediaWiki ("Wikitext"), you can easily switch to source editing mode using the "Switch editor" button:
Since VisualEditor is a standard MediaWiki extension, you can also read a [https://www.mediawiki.org/wiki/Help:VisualEditor/User_guide/en|complete documentation of functionality on MediaWiki]. Here in the BlueSpice Helpdesk, we only give some hints and tips for using the editor.
== 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.
|Here text can be defined as heading or specific paragraph type.
''Note:'' If you work in a [[Visual Editor / Tables|table]], the options will change accordingly (content cell and header cell):[[File:Manual:content cell.png|left|frameless|183x183px|alternative-text=VisualEditor-paragraph2|link=Special:FilePath/Manual:content_cell.png]]<br />
|-
|Style text
[[File:Manual:VE character formatting.png|link=Special:FilePath/Manual:VE_character_formatting.png]]
|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.
([[mediawikiwiki:Help:VisualEditor/User_guide/en#Getting_Started:_The_VisualEditor-Toolbar|More Info at mediawiki.org/wiki/Help:VisualEditor/User_guide/en#Getting_Started:_The_VisualEditor-Toolbar]]])
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.
# '''Select''' ''Insert > Images and Media'' from the editor toolbar.[[File:instert_2.0.0.png|alt=|center|thumb|250x250px|''Insert Media'' dialog]]
|Use the "insert" menu to insert various media (images, videos) and text formats:
# '''Switch''' to the ''Upload'' tab (2) in the ''Media settings'' dialog to upload a new file. <br />To select an existing file, switch to the ''Advanced search'' tab (3). The ''Search'' tab (1) shows the latest uploaded files for selection.[[File:Insert files 2.png|alt=Media settings|center|thumb|650x650px|Media settings]]
|-
# '''Click''' ''Select a file.'' Provide a ''Target namespace'' (optional). If you are unsure, leave the namespace setting as suggested.
|media
# '''Click''' ''Upload''. The dialog window ''Media Settings'' opens.
([[mediawikiwiki:Help:VisualEditor/User_guide/en#Getting_Started:_The_VisualEditor-ToolbarHelp:VisualEditor/User_guide/en#Editing_images_and_other_media_files|Details on MediaWiki]]])
|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.
Now click "Upload":
And this is what a comment looks like:[[File:Manual:comment.png|left|frameless|186x186px|alternativetext=VisualEditor-comment|link=Special:FilePath/Manual:comment.png]]<br />
The general and advanced settings are largely identical to [[VisualEditor/Images|image]] files. However, there are differences in the linking options, as, for example, a PDF file is not displayed as an image directly on the page.
|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: <!-- insert word count here -->
[[File:Manual:VE chemical formula.png|link=Special:FilePath/Manual:VE_chemical_formula.png]]
|The formula rendering uses an external service via Wikimedia's REST API.<br />
|-
|Math formula
[[File:Manual:VE math formula.png|150x150px|link=Special:FilePath/Manual:VE_math_formula.png]]
|It opens an editor for entering a mathematical formula.
[<nowiki/>[[https://www.mediawiki.org/wiki/Help:VisualEditor/User_guide/en#Editing_mathematical_formulae|More|info on MediaWiki]]]
*'''Link this file (1):''' The inserted link opens the file.
|-
*'''Link file description page (2):''' The link leads to the file page on the wiki. There, you can view the file details or upload a new version of the file.
|Special Characters
*'''Embed this file (3):''' The link inserts a preview image. The preview image opens the file description page when clicked. This only works with PDF and .tiff files.
[[File:Manual:VE special characters.png|link=Special:FilePath/Manual:VE_special_characters.png]]
|The options menu allows editing of all page settings.
'''General Settings:''' An alternative text is required if you embed the file on the page. This is done via the corresponding "Embed this file" button. Since a preview image is created here, the alternative text should be used just like with images.
|Here you assign the page to one or more categories [[Manual:Creating and using categories|Categories]]. The page will appear accordingly on all linked category pages.
|Page redirection: When the page is redirected, the content of the page is no longer displayed, but the target page is loaded directly.
If you link to the file or the file description page, VisualEditor will in both cases inserts the same link text, even though the link will lead to different pages. However, the displayed link text can be changed directly on the page. Just click into the text and change it accordingly.
This setting can also be used to display or remove the table of contents at the top of the page. The table of contents is automatically generated by the headings on the page. When a page has more than three headings, the table of contents appears automatically by default.
{{Messagebox|boxtype=note|Note text=If you place a file link directly on already selected text, VisualEditor will replace the selected text with the file information. It is therefore advisable to insert a file link via VisualEditor when the cursor is located at a blank space.}}
[[File:Manual:VE view as right-to-left.png|link=Special:FilePath/Manual:VE_view_as_right-to-left.png]]
|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
[[File:Manual:VE find and replace.png|link=Special:FilePath/Manual:VE_find_and_replace.png]]
|Words or characters can be searched and replaced directly on the page. The "Undo" button can be used to cancel the change.
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:
The maximum allowed file size cannot be configured in the wiki itself. The maximum allowed limit is defined on the server in the php.ini file in the PHP installation. The actual (possibly smaller) limit, however, is set in the BlueSpice installation in LocalSettings.php or another configuration file in the settings.d folder. The default setting is 32 MB.
*Global settings via the [[Manual:Extension/BlueSpiceConfigManager|configuration manager]]
Contact your wiki administrator if you receive an error message when trying to upload a larger file.
<!-- Document Info --><!-- User story: As a maintainer, I'd like to understand all the features of VisualEditor so I can assist wiki authors in using them. --><!-- Information type: Concept -->
{{Filename}}
[[en:{{FULLPAGENAME}}]]
[[de:VisualEditor]]
[[Category:Editing]]
[[Category:Editing]]
Revision as of 16:45, 19 September 2022
You can insert already uploaded files or upload new files directly when editing an article.
Drag the file onto the page. A horizontal line will appear where the file will be dropped.
Change the file name in the Upload file dialog (optional).
Insert file via drag-and-drop
ClickInsert.
Double-click the thumbnail to adjust the size and positioning (optional).
Editor toolbar
To upload and insert a file from the editor toolbar:
SelectInsert > Images and Media from the editor toolbar.
Insert Media dialog
Switch to the Upload tab (2) in the Media settings dialog to upload a new file. To select an existing file, switch to the Advanced search tab (3). The Search tab (1) shows the latest uploaded files for selection.
Media settings
ClickSelect a file. Provide a Target namespace (optional). If you are unsure, leave the namespace setting as suggested.
ClickUpload. The dialog window Media Settings opens.
Now click "Upload":
The general and advanced settings are largely identical to image files. However, there are differences in the linking options, as, for example, a PDF file is not displayed as an image directly on the page.
Special features when including files
There are three ways to link a file on a page:
Link this file (1): The inserted link opens the file.
Link file description page (2): The link leads to the file page on the wiki. There, you can view the file details or upload a new version of the file.
Embed this file (3): The link inserts a preview image. The preview image opens the file description page when clicked. This only works with PDF and .tiff files.
General Settings: An alternative text is required if you embed the file on the page. This is done via the corresponding "Embed this file" button. Since a preview image is created here, the alternative text should be used just like with images.
If you link to the file or the file description page, VisualEditor will in both cases inserts the same link text, even though the link will lead to different pages. However, the displayed link text can be changed directly on the page. Just click into the text and change it accordingly.
Note:If you place a file link directly on already selected text, VisualEditor will replace the selected text with the file information. It is therefore advisable to insert a file link via VisualEditor when the cursor is located at a blank space.
Maximum file size
The maximum allowed file size cannot be configured in the wiki itself. The maximum allowed limit is defined on the server in the php.ini file in the PHP installation. The actual (possibly smaller) limit, however, is set in the BlueSpice installation in LocalSettings.php or another configuration file in the settings.d folder. The default setting is 32 MB.
Contact your wiki administrator if you receive an error message when trying to upload a larger file.
Avoiding unusual file names
Note:When uploading a new file, you should check the file/page name for unusual special characters (e.g., ", %, /,< ,>, [ ,], {, }). Change the name to include only standard characters, since the server file system could have problems with them or since some characters have special meanings in MediaWiki.
The special characters (, ), &, + can be used and are translated into their equivalent %-hex notation.
: will be converted to spaces, unless it is part of an existing namespace prefix.
Discussions