Difference between revisions of "Manual:VisualEditor"

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?==
        
        
        
        
        <section begin="training-intro" />
        
        
        
            
            
        The visual editor is optimized for editing wiki pages. Important characteristics and functions are:<section end="training-intro" />
        
        
        <section begin="training" />
        
        
        
            
            
        *consistent '''structuring''' and '''text formatting''' of wiki pages
        
        *'''Special formats''' (tables, formulas, footnotes, ...)
        
        *insert '''special contents'''(files/media, links, diagrams, magic words)
        
        *set '''page options'''
        
        
        
            
            
        *integrate '''tools''': link inspector, media dialog, code editor
        
        *depends on the external library ''Parsoid''
        
        
        <section end="training" />
        
        
        
        ==Text editing== 
        
        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.
        
        
        <br />
        
        [[File:BlueSpice_3.1_-_Notable_Changes_-_Text_colors.png|alt=Applying text color|center|thumb|Applying text color]]
            
            
            
            == Shortcuts ==
            
            If you <br />
            
            
            
            == Pasting content from your clipboard (ctrl+shift+v) ==
            
            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.
            
            [[File:Manual:error.png|link=https://en.wiki.bluespice.com/wiki/File:Manual:error.png|alt=Undo|thumb|112x112px|Undo]]
            
            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 />
        
        
        
        {{Box Note|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.
        
        
        
        If you want to learn more about inserting these elements, go to the following help pages:
        
        
        
        *[[VisualEditor/Images|Images]]
        
        *[[VisualEditor/Files | Files (PDF, xls, doc, ...)]]
        
        *[[Visual Editor / Tables | Tables]]
        
        *[[Template|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.
        
        *'''[[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:'''
        
        *'''[[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: 
        
        
        
        [[File:Manual:editing.png|250x250px|link=https://en.wiki.bluespice.com/wiki/File:Manual:editing.png]]
        
        
        <br />
        
        ==MediaWiki reference==
        
        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.
        
        
        
        ===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)
        
        |-
        
        |Format Paragraph
        
        [[File:Manual:paragraph.png|frameless|162x162px]]
        
        |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|alt=screenshot: content cell|left|frameless|183x183px|alternative-text=VisualEditor-paragraph2]]<br />
        
        |-
        
        |Style text
        
        [[File: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.
        
        ([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
        
        [[File:Manual:VE Insert hyperlink.png]]<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.
        
        |-
        
        |cite
        
        [[File:Manual:VE cite.png]]
        
        |The citation menu is used to insert references (also called itemizations or footnotes) within the text.
        
        |-
        
        |Structure
        
        [[File:Manual:VE structure new.png]]
        
        
        
        |
        
        |}
        
        
        
        
        <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
        
        [[File:Manual:VE media.png]]
        
        |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
        
        [[File:Manual:VE template.png]]
        
        |Include a [[Template|template]] in the page.
        
        |-
        
        |tables
        
        [[File:Manual:VE table.png]]
        
        |[[Visual Editor / Tables|Tables]] are an important tool for formatting tabular page content.
        
        |-
        
        |comment
        
        [[File:Manual:VE comment.png]]
        
        |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
        
        [[File:Manual:VE gallery.png]]
        
        |
        
        |-
        
        |Magic word
        
        [[File:Manual:VE magic word.png]]
        
        |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 /> [[MagicWords|Learn more about the functionMagic Word]]".
        
        
        
        Overview of all [[Manual:Extension/BlueSpiceSmartList|Magic Words in the visual editor]].<!-- more info needed -->
        
        |-
        
        |Your signature
        
        [[File:Manual:VE your signature.png]]
        
        |This option can only be used in discussions. It allows to add a signature at any point of a discussion.
        
        |-
        
        |Code block
        
        [[File:Manual:VE code block.png|150x150px]]
        
        |With code block various code examples can be entered, like e.g. in HTML syntax. The code is then displayed properly formatted:
        
        
        <br /><pre>
        
        
        <span style="color: red">red text</span>
        
        
        </pre>
        
        |-
        
        |Refernces list
        
        [[File:Manual:VE refernces list.png|150x150px]]
        
        
        <br />
        
        |
        
        |-
        
        |Chemical formula
        
        [[File:Manual:VE chemical formula.png]]
        
        |<!-- Received error message -->
        
        |-
        
        |Math formula
        
        [[File:Manual:VE math formula.png|150x150px]]
        
        |It opens an editor for entering a mathematical formula.
        
        
        
        [[https://www.mediawiki.org/wiki/Help:VisualEditor/User_guide/en#Editing_mathematical_formulae|More info on MediaWiki]]
        
        |-
        
        |Special Characters
        
        [[File:Manual:VE special characters.png]]
        
        
        <br />
        
        |
        
        |}<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
        
        [[File:Manual:VE options.png]]
        
        |This button allows the page settings and page information to be updated simultaneously within a dialog box.
        
        |-
        
        |Categories
        
        [[File:Manual:VE categories.png]]
        
        |Here you assign the page to one or more categories [[Category| Categories]]. The page will appear accordingly on all linked category pages.
        
        |-
        
        |Page Settings
        
        [[File:Manual:VE page settings.png]]
        
        |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
        
        [[File:Manual:VE advanced settings.png]]
        
        |
        
        |-
        
        |Languages
        
        [[File:Manual:languages.png]]
        
        |
        
        |-
        
        |Templates used
        
        [[File:Manual:VE templates used.png]]
        
        |
        
        |-
        
        |View as right-to-left
        
        [[File: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]]
        
        |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}}]]
        
        [[de:VisualEditor]]
        
        [[Category:Editing]]