Difference between revisions of "UserManual:VisualEditor"

<bookshelf src="Book:User manual" />
            
            
        ==What is VisualEditor?==
        
        One of the most important tools for inserting and formatting content in BlueSpice is its visual editor. This visual editor is based on the MediaWiki extension VisualEditor. With this sophisticated editor pages can be quickly and clearly filled with a variety of content.
        
        
        
        When creating or editing a page, you're in visual edit mode right now. If you are familiar with the code language of MediaWiki ("WikiText"), you can easily switch over using the "Switch editor" button:
        
        
        <br />
        
        [[File:Manual:editing.png|250x250px]]
        
        
        
        ==Text editing== 
        
        Typical text formatting such as '''bold''', ''italics'', or <span class="col-turquoise">text color</span> are already possible during text input. When you highlight text, you will see a mini menu with the most important formatting elements. With one click, the desired formatting can be selected. This is especially fast if you want to change the text color, for example: [[File:BlueSpice 3.1 - Notable Changes - Text colors.png]]
        
        
        
        The mini menu appears only in the text flow, not when an entire paragraph is highlighted. When you select text within a bullet point, make sure that you select only the text itself and not the whole line. Otherwise, paragraph formatting will be selected "behind the scenes" and the mini menu will not appear.
        
        
        
        If you want to apply multiple formats 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 the visual editor:
        
        
        
        [[File:Manual:editing tools.png|350x350px]]
        
        
        
        ==Insert external content==
        
        Many typical page elements such as images, files and tables can be integrated into your page from the "Insert" menu.
        
        
        
        If you want to learn more about inserting these elements, go to the appropriate help page:
        
        
        
        *[[UserManual:VisualEditor/Images|Images]]
        
        *[[UserManual:VisualEditor/Files| Files (PDF, xls, doc, ...)]]
        
        *[[UserManual:Visual Editor / Tables| Tables]]
        
        *[[UserManual:Template|Templates]]
        
        
        
        ==Beyond your typical 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 page of MediaWiki:
        
        
        
        *'''Comment:''' Add comments to the page. These are only visible in the source code.
        
        *'''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.
        
        *'''Gallery:''' A simple picture gallery can support many process flows.
        
        *'''Codeblock:''' Programming code is displayed here in clean code blocks, optionally with lines.
        
        *'''Itemization list:'''
        
        *'''Chemical formula:'''
        
        *'''Math formula:''' An editor opens for entering a mathematical formula. [https://www.mediawiki.org/wiki/Help:VisualEditor/User_guide/en#Editing_mathematical_formulae More info on MediaWiki].
        
        
        
        ==MediaWiki Reference==
        
        Since the visual editor 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==
        
        The visual editor 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 by using VisualEditor greatly supports the readability of your wiki content.
        
        
        
        The BlueSpice Editor offers the following options:
        
        
        
        ===Text formatting=== 
        
        {| class="wikitable"
        
        |-
        
        ! colspan="2" |'''Text formatting'''
        
        |-
        
        |Undo function
        
        [[File:Manual:error.png|frameless|112x112px]]
        
        |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)
        
        |-
        
        |Paragraph formatting
        
        [[File:Manual:paragraph.png|frameless|162x162px]]
        
        |Here text can be defined as heading or specific paragraph type.
        
        
        
        ''Note:'' If you work in a [[UserManual:Visual Editor / Tables|table]], the options will change accordingly (content cell and header cell):[[File:Manual:content cell.png|alt=screenshot: content cell|left|frameless|183x183px|alternative-text=VisualEditor-paragraph2]]<br />
        
        |-
        
        |Character formatting
        
        
        
        |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.
        
        ([https://www.mediawiki.org/wiki/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]])
        
        |-
        
        |Insert hyperlink<br />
        
        |If no text was selected before the hyperlink dialog was opened, the link will be generated with a number:
        
        [https://www.mediawiki.org/wiki/Help:VisualEditor/User_guide/de#Erste_Schritte:_Die_VisualEditor-Werkzeugleiste]
        
        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.
        
        |-
        
        |quote
        
        |The citation menu is used to insert references (also called itemizations or footnotes) within the text.
        
        |-
        
        |Block formatting
        
        |
        
        |}
        
        
        
        
        <br />
        
        
        
        ===Insert special content===
        
        {| class="wikitable"
        
        |-
        
        ! colspan="2" |'''Paste Special Content'''
        
        |-
        
        |Insert menu
        
        
        
        [[File:Manual:insert.png|frameless|102x102px]]
        
        |Use the "insert" menu to insert various media (images, videos) and text formats:
        
        |-
        
        |media
        
        |Inserting pictures and videos
        
        
        
        ([https://www.mediawiki.org/wiki/Help:VisualEditor/User_guide/en#Getting_Started:_The_VisualEditor-ToolbarHelp:VisualEditor/User_guide/en#Editing_images_and_other_media_files Details on MediaWiki]])
        
        |-
        
        |templates
        
        |Include a [[UserManual:Template|template]] in the page.
        
        |-
        
        |tables
        
        |[[UserManual:Visual Editor / 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:[[File:Manual:comment.png|alt=screenshot: comment|left|frameless|186x186px|alternativetext=VisualEditor-comment]]<br />
        
        |-
        
        |Gallery
        
        |
        
        |-
        
        |Magic word
        
        |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 -->
        
        
        
        
        
        
        
        
        <br /> [[UserManual:MagicWords|Learn more about the functionMagic Word]]".
        
        
        
        Overview of all [[UserManual:Extension/BlueSpiceSmartList|Magic Words in the visual editor]].<!-- more info needed -->
        
        |-
        
        |Your signature
        
        |This option can only be used in discussions. It allows to add a signature at any point of a discussion.
        
        |-
        
        |Code block
        
        |With code block various code examples can be entered, like e.g. in HTML syntax. The code is then displayed properly formatted:
        
        
        <br /><syntaxhighlight lang="html" line="1">
        
        
        <span style="color: red">red text</span>
        
        
        </syntaxhighlight>
        
        |-
        
        |Itemization list
        
        |
        
        |-
        
        |Chemical formula
        
        |<!-- Received error message -->
        
        |-
        
        |Math formula
        
        |It opens an editor for entering a mathematical formula.
        
        
        
        [[UserManual:Https://www.mediawiki|More info on MediaWiki]]
        
        |-
        
        |Special Characters
        
        |
        
        |}<br />Page options
        
        {| class="wikitable"
        
        |-
        
        ! colspan="2" |'''Page Options'''
        
        |-
        
        |Options menu[[File:Manual:tool.png|alt=screenshot|left|frameless|69x69px|alternative text=VisualEditor-options]]
        
        
        
        |The options menu allows editing of all page settings.
        
        |-
        
        |options
        
        |This button allows the page settings and page information to be updated simultaneously within a dialog box.
        
        |-
        
        |Categories
        
        |Here you assign the page to one or more categories [[UserManual:Category| Categories]]. The page will appear accordingly on all linked category pages.
        
        |-
        
        |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.
        
        
        
        
        
        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.
        
        |-
        
        |Advanced Settings
        
        |
        
        |-
        
        |languages
        
        |
        
        |-
        
        |Used templates
        
        |
        
        |-
        
        |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.
        
        |-
        
        |Search 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 see code editing, please contact an administrator of your wiki. The following settings must be checked in this case:
        
        
        
        *Global settings via the configuration manager
        
        *Namespace management settings
        
        *Parsoid service on the server
        
        
        
        
        <br />
        
        
        <!-- 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 -->
        
        
        
        [[en:{{FULLPAGENAME}}]]
        
        [[UserManual:De:VisualEditor]]
        
        [[Category:Editing]]
        
        [[Category:Content]]