Working in Edit Mode (the Contributor Plus Editor)

Note

Since a Contributor Plus user has all the permissions a regular Reviewer has, all the features described in Working in Review Mode are also relevant for the Contributor Plus user.

If you have a Contributor Plus user account, you can open a contribution assignment in Edit mode,. In Edit mode, you can access a variety of features for editing content and providing feedback. You can also open a topic and use the Contributor Plus Editor to make changes. The Contribution Plus Editor is embedded on the page.

If you are new to using the Contributor Plus Editor, this topic contains an overview of the interface and some tips on working on a contribution assignment.

Edit Mode and the Contributor Plus Editor

If you are a contributor, when you view content it will load in Edit Mode. There is an initial Edit Mode view, where you can view the table of contents, share the content with others, and add new topics. From this view, you can choose to edit the content, and this opens the Contributor Plus Editor.

  1. In the Review/Contribution interface, switch to the initial view of Edit Mode. The initial view is shown when you open content as a contributor. It shows the topics, but you have not yet entered the Contributor Plus Editor, where you can change the content.

  2. Hover the mouse over any topic.

    The topic will be highlighted in a light blue color.

  3. Click the topic to open the Contributor Plus Editor.

Let's take a look at the main features:

Editor mode overview labels
  1. Paligo authors can switch between edit mode and the full Paligo editor.

  2. Use to show and hide the navigation sidebar/Table of Contents (TOC).

  3. The editing toolbar. Use these options when creating and editing the content. The editing toolbar is not displayed when you first open the assignment. You can display it by selecting any part of the text.

    To find out more about the editing toolbar options, see Edit Content in the Contributor Plus Editor.

  4. The profile settings dialog. If the content contains filters and/or variables, you should choose the profile set for the contribution. The person who sends you the contribution assignment should tell you which set you should use, and you can select it from the Favorites tab.

  5. Use the assignment button to end the contribution, either by setting it to Done or Needs Work.

  6. Use to switch between review mode and edit mode. In review mode, you can only provide feedback. In edit mode, you can change the content.

  7. Use to show and hide the comments sidebar, which you can use to provide feedback and to reply to other comments.

    To find out more about using comments, see Comments in Edit Mode.

  8. Content that has a feedback comment is highlighted in yellow. If content is marked red, it means it is reused content and should not be edited.

  9. If the content contains variables, they are shown with dark gray highlights. Variables are pieces of content that can change in different scenarios.

Tip

You can also compare content to previous revisions, called "snapshots". To find out more, see Compare Contributions in Edit Mode.

Tips for Working in the Contributor Plus Editor

If you are new to the Contributor Plus Editor, you will find that will feel very similar to user-friendly rich text editors you may have used before.

Here are some useful tips on using the editor:

  • To add a comment when the Contributor Plus Editor is open, use the pen icon. Note that this is different to Review mode, where you select text and then add a comment.

    comment-in-contributor-plus.png
  • If you want to add content after a large block element, such as an ordered list, or an admonition (note, warning, and the like), you need to add a break first. The break tells Paligo that the list block has ended.

    After such a content block, hover the mouse at the end of it, and the break button will appear:

    break.png
  • The content may be set up to use variables and filters. For example, a paragraph could be hidden when the content is published for the USA but visible when published for the EU. We recommend that Paligo Authors set up the variables and filters before they send the contribution assignment to you. All you need to do is choose the profile that the author has added as a favorite.

  • Content that is highlighted in yellow has a comment associated with it.

  • Content that is highlighted with a red background is reused content and is protected from being edited. This can only be edited (if needed) in the full Paligo Editor. If you need to make changes to reused content, use a comment to explain what changes are needed.

  • Topics with a light blue background are topics reused inside other topics.

  • Content is written in blocks. So you cannot select two adjacent paragraphs and apply formatting to them at the same time. Instead, you apply it to each block individually.

There are many inline elements that you can use as part of your edit, such as bold, italic, and underline. You can add them to individual letters, words, or entire paragraphs.

This is similar to "formatting" in a word processing program, but with more possibilities.

  1. Highlight the text that you want to have the inline element.

  2. On the toolbar, select the bold button for bold emphasis (1), the italic button for italic emphasis (2), or the inline element button to display a list of other inline elements (3).

    toolbar-inline-bold-italic.jpg

    If you selected bold or italic, ignore step 3 and proceed to step 4.

  3. Choose the type of inline element you want to use.

    inline-contributor-toolbar.jpg

    Underline, strikethrough, superscript, and subscript affect the appearance of text and are common options on text editors.

    Use inline code if you want the selected text to be marked up as code. It will be styled differently in the output so that it is clear that the text is code and not regular text.

    Note

    For blocks of code, i.e if you are not adding it inline in the middle of text, use the Code block icon in the toolbar instead.

    Use guilabel to mark up text as a user interface label. This is often used for options in software. We have used it in this topic on the various options (underline, strikethrough, etc.)

    Use tag to mark up text as an HTML or XML element. For example, if the topic was about formatting HTML headings, you might have <h1> in the text and you could apply the tag to that. In the output, the tag content has a different styling to regular content.

  4. Select Save.

As a contributor, you can add entire lists and procedures or individual steps to a topic.

Procedure. To add a new list or procedure:
  1. Place the cursor at the position where you want the new list or procedure to be.

    Note

    If you want to add a list after another "structure" such as a subsection, add a break first. You can then add the list after the break.

    break.png
  2. Select the appropriate list option from the toolbar:

    toolbar-lists.jpg

    Where you have the following types of lists:

    1. Ordered list. Use this for numbered lists that are charts or rankings. Do not use the it for step-by-step procedures (instructions/tasks). For such lists, use the procedure list instead.

    2. Unordered list. Use this for lists of items where there is no sequence to be followed ("bullet lists").

    3. Procedure. Use the procedure list for step-by-step instructions/tasks.

  3. Enter the text for the first step/list item. Press Enter at the end of the line to create the next step/list item on the next line.

  4. Add as many steps as you need.

Note

If you want to add a paragraph or other elements after the list or procedure, you will need to add a break.

. To add images and other content inside a step:
  • To add content apart from text, for example an image after the text, in a list item, press ShiftEnter after the text.

    The cursor will be under the text, and you can insert another paragraph, image, an admonition (note, warning, etc), or any other content.

. To create a sub list (indented list)
  • To create a sub list (or "indented" list), just create a new list item after an existing one, and then use the Tab key to indent the new list item. At the end of the sub list, if the main list is to continue, create another sub list item and then use ShiftTab to outdent it again.

. To convert a list to a paragraph
  • To convert a bullet list to a paragraph, position the cursor before the first character in the bullet point's text, and then press backspace.

  • With number lists and procedures, position the cursor before the first character in the numbered item/step's text and then press backspace. The numbered item/step will convert into a paragraph on the previous numbered item/step. If you convert the first numbered item/step in a list, that item/step will turn into a paragraph.

When you are working on a Contributor Plus edit, you may want to add a paragraph or some other element after a block element such as a list or admonition (note, warning, etc.). To do this, you need to first add a break, so that Paligo knows that the previous block element has ended.

  1. Position the cursor after the last block element. For example, if you want to add a paragraph after a procedure, position the cursor after the last step in the procedure. An arrow icon and a line appear. and if you select the arrow icon, you will create a break. The break ends the list and places the cursor on a new line, ready for you to insert a new element such as a paragraph.

  2. Select the arrow icon to create a break. The break ends the previous structure, such as a list, and places the cursor on a new line, ready for you to insert a new element such as a paragraph.

    breaks-after-blocks.gif

If you are working on a Contributor Plus edit you may want to add a code block to show examples of code.

A code block is a section of one or more lines of code, and when the content is published, the code block is formatted with syntax highlighting, indentation, and so on.

Procedure. To add a code block:
  1. Position the cursor on a new line.

  2. Select the code block toolbar button to create a code block.

    codeblock-toolbar.jpg
  3. Optional: You can set the programming language for the code sample if you want.

    Click inside the code block to display the cog icon on the top corner, and then select the cog icon to display the Set the programming language dialog.

    contributor-code-block-cog-red.jpg

    Note

    In many cases Paligo will output proper syntax highlighting just by auto-detecting the language. But in some cases the results will be better if the language is specified.

  4. Add the code inside the code block.

    contributor-code-block.jpg
  5. Select Save.

    Tip

    A few tips about working with code blocks:

    1. If the code block is in the main body of the section, and you want to add more content after it, hover over the end of the code block, and use the "break" widget.

      It is also possible to hit Enter twice quickly in a row, which will exit the code block instead of adding a new line.

    2. If the code block is inside a list item or step in a procedure, use Shift Enter to add a new line, otherwise a new list item will be created instead.

Note

If the code text already exists in the topic, you can turn it in to a code block by highlighting the text and then selecting the code block option.

In Review mode you just click on text or select phrases, and the comment added directly.

For obvious reasons, this will not happen when you have the Editor open, as you need to edit there.

Instead, when the Editor is open, you can use the Comment toolbar option to add a comment to content you are editing. The comment will appear in the comments sidebar.

  1. Select the content that you want to apply the comment to. (Or just put the cursor anywhere inside the text fragment to comment on the whole paragraph).

  2. Click the Comment icon in the toolbar.

    add-comment-toolbar.jpg
  3. Enter the text for your comment in the box that appears in the comments sidebar.

    Tip

    You can use "mentions" to notify other people of your comments directly, just like on social media. To send a mention notification to another Paligo user, use the @ symbol and then start typing their name. You can select the person you want to notify from the dropdown menu.

  4. Select Save.

Paligo saves the comment. A yellow highlight is shown around the content to indicate that it has a comment.

Note

As a Contributor Plus, you can also add replies to comments in the comments sidebar.

By default, any content that has a comment associated with it is shown with a yellow highlight. If you prefer to work without the comment highlights, you can turn them off by using the show/hide comments toolbar option.

show-comments-toolbar.jpg

Select the show/hide comments option to toggle the highlights on and off.

You can add image files to your Contributor Plus edits by using the Image toolbar option.

  1. Position the cursor where you want to add the image.

  2. Select the Image option on the toolbar.

    image-toolbar.jpg
  3. Browse/search for the image files you want to use or upload new image files to the Paligo media library. Select the image file to add it to the topic.

    add-image-contributor.jpg

    Browse or search for image files that are already in your Paligo database (1). Or upload new image files (2).

    Tip

    When browsing the images, hover over an image to display a magnifying glass in the top corner. Select the magnifying glass to display a large view of the image in a popup. You can then close the popup and select that image or choose a different image.

    contributor-image-zoom.jpg
  4. Select Save.

You can add tables to your Contributor Plus edits and also edit existing tables. To add a table, follow the steps below. If you only want to edit a table, see step 4.

  1. Position the cursor on the line where you want to add the table.

  2. Select the table option in the toolbar.

    contributor-toolbar-table.jpg
  3. Choose the number of rows and columns you want the table to have. You can add more rows and columns later if needed.

    contributor-table-dimensions.jpg
  4. Use the table options to format the table. To access the table options, select the cells that you want to format. You can select a single cell or any group of adjacent cells, such as an entire column or row, or two adjacent cells in a row.

    When you select the cells, a context-menu appears with options for formatting the table.

    Contribution plus editor table editing options. Icons shown, annotated with numbers 1 to 7.

    Where:

    1. Make selected cells into table header.

    2. Delete the entire table.

    3. Insert row above or below the selected row. You can also delete the selected row with this option.

    4. Insert column to the left or right of the selected column. You can also delete the selected column with this option.

    5. Merge selected cells or split them horizontally or vertically.

    6. Set the vertical alignment for the selected cells.

    7. Set the horizontal alignment for the selected cells.

  5. Select Save.

To add admonitions, such as warnings, notes, and tips in the Contributor Plus Editor:

  1. Position the cursor on a new line.

    Note

    If you want to add the admonition after a list, you will first need to add a break to end the list.

    To add it after the text in a step, hit Shift Enter to position the cursor after the text but still inside the step.

  2. Select the Admonitions toolbar button and choose the type of admonition you want to add.

    contributor-toolbar-admonitions.jpg
    contributor-admonition-types.jpg
  3. Add content to the admonition. By default, each admonition has a paragraph.

    note-with-title.jpg
  4. Select Save.

You can use the clear formatting toolbar button to remove inline formatting, such as bold, italic, guilabel, tag, etc., from your contribution content.

Note

Technically, in XML this isn't formatting, but inline elements. But it will seem the same. In actuality, what happens is that the inline element is removed, but the text content remains.

Warning

Do not use the Clear formatting toolbar button on text fragments that have a red background.

In Paligo's full XML Editor, authors can reuse pieces of content in different places. For example, they could reuse the same paragraph in several different topics instead of writing it separately in each topic.

If you receive a contribution assignment that contains reused content, that content is highlighted with a red background and is unavailable for editing.

It is important not to apply the Clear formatting, as that would break the reuse.

If you need to provide feedback on such a text fragment, do so in a comment instead.

To clear the formatting of a phrase:

  1. Select the content that you want to change, for example a phrase with bold text, or marked as a guilabel.

  2. Select the clear formatting toolbar button.

    clear-toolbar.jpg
  3. The formatting (inline element) is removed, but the text content remains.

Note

Should you happen to clear the formatting on a reused text fragment, you can use the undo command to fix it (CtrlZ or CmdZ on Mac)

You can add new subsections to the content in a contribution assignment. For example, the original writer may have missed out some important related information and you want to add it as a paragraph in a subsection with its own heading.

Note

When the contribution assignment is complete and your content is added to the full Paligo editor, each subsection will be a topic on its own. The Paligo author can then set them up to work as subsections.

You can only add one level of sub sections, and it needs to be at the very end of the topic. If you have any other content after the sub section it will cause a validation error. However, you will still be able to save, should you do this, and a full Author user can correct the errors.

To add a subsection, use the title toolbar option:

  1. Position the cursor where you want to add the sub section. Note that it must be at the end of the main section (topic).

    Note

    If you want to add a subsection after another "structure" such as a list or another subsection, add a break first. You can then add the subsection after the break.

    break.png
  2. Select the title toolbar option.

    title-toolbar.jpg
  3. Enter a title for the new sub section. You can then add any additional content into the sub section, such as text, images, etc. When you save your changes, you will see that the sub section appears in a shaded box:

    subsection-contributor.jpg
  4. Select Save.

Caution

This is only for users with a very advanced understanding of HTML code.

By editing the source code in the Contributor Plus Editor, it is very easy to make mistakes and create a corrupt topic if you are not absolutely sure what you are doing.

If you are not sure of this, ask a colleague with an Author license to make the change you want to do instead, as they can do it in the full Paligo Editor.

We recommend that you make your contributions using the regular edit mode features. However, there may be times where you want to look at the source code of the page, for example, if a formatting element appears to be in the wrong place.

In the Contributor Plus Editor, the source content is in HTML (it is only transformed to XML when saved to the database), and you can view it by selecting the Source code toolbar icon.

contributions-toolbar-sourcecode.jpg
contributions-source-code-content.jpg

You can change the content in the source editor, but you can only save your changes if the HTML structure is valid. Do not use the source editor unless you have a good understanding of HTML.

To close the source code editor, just click the Source code icon again.

Use the Undo option to cancel your last action. If needed, you can select the Undo option multiple times to cancel your previous actions in order.

To reverse an undo, so that a cancelled action is restored, use the Redo option.

customise-toolbar-undoredo.jpg

Undo (1) cancels the previous action and Redo (2) restores the previous action.

You can also use the standard keyboard shortcuts (Ctrl Z or Cmd Z on Mac) for Undo, and (Ctrl Y or CmdShift Z on Mac) for Redo.