Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Overview

Some fields within Paradigm use a text editor known as TinyMCE. This will help you format text to improve the appearance of your content. This is commonly used in the communication events, editing for emails, and student reviews. This knowledge article will provide a detailed description of this feature that may be helpful in your content formatting experience within Paradigm.

Complexity:

Status
colourBlue
titleMedium


Navigation

Table of Contents
maxLevel1
stylesquare
excludeOverview|Workflow

Workflow

Table of Contents
minLevel2
maxLevel3
stylenone

Expand
titleAssumptions

Assumptions

  • You have the minimum Permission Level to edit notes/fields, create communication events which require you to format contents as required within Paradigm.

  • You have basic understanding of formatting content using text editors.

Expand
titleKey Terms and Concepts

Key Terms and Concepts


Rich Text Editor

This feature can be found in most areas of the system where text can be entered and you have the option to improve the appearance of your content. The toolbar contains icons for editing and formatting your text.

TinyMCE Interface



Implications

NOTE: Content is saved in HTML format. When inserting images, the system will not embed a copy of the image. It is highly recommended to always keep the images in your institution’s images hosting site, as it will impact the image view in the future if the file for some reasons has been deleted or removed.

Workflow

Paradigm Editor Workflow

Status
colourGreen
titlestep 1
Select the content you want to format.

Navigate to a page within Paradigm and locate the contents you want to format.

Expand
titleThis section will give you an example of what field/content you can format in Paradigm.
Info

INFO: Only fields with TinyMCE can be formatted.

Note Field in Paradigm with TinyMCE

In the example above, the user is trying to edit and format the content of the Notes: field of a student from Student > Student Details > Edit Details.

Status
colourGreen
titlestep 2
Input content and start formatting.

Expand
titleCharacter Count characteristics when editing content.

NOTE: The character count showing below the field name has a few characteristics to be aware of when editing content.

  • It counts the characters of the HTML source code, not the letters on the screen. So the text “hi” is not equal to “hi” (bold formatting). This is because the editor needs to include hidden instructions to present the text as bold. These instructions are included in the character count.

  • Due to performance issues TinyMCE and many other plugins we looked through disable looking for changes to text as the user types. Instead the count is updated whenever the content has finished changing. This is often detected by a mouse click or navigating to another field. Clicking outside the editing area will trigger this update to the character count.

Character Count Location

Expand
titleThis section will provide you details of the formatting features available in the Text Editor.

TinyMCE in Paradigm has the following editing features on its toolbar:

TinyMCE Toolbar

Status
colourGreen
title1
Undo and Redo – let you reverse and restore your formatting.

Status
colourGreen
title2
Insert, Edit or Remove Links – let you insert a link and unlink the inserted links. In inserting links, you will be prompted with the screen below:

Insert Link Fields

Status
colourGreen
title3
Insert/Edit Images – see Inserting images

Status
colourGreen
title4
Horizontal line – lets you add a divider to organise your content.

Status
colourGreen
title5
Special Character --lets you add these special characters.

Special Characters in TinyMCE

Status
colourGreen
title6
Text Formatting – let you format your texts into Bold, Italic, and Strikethrough.

Status
colourGreen
title7
Lists formatting, Increase Indent – let you set your lists into a Numbered list or Bullet list. The third button is for indention.

Status
colourGreen
title8
Blockquote – lets you insert a quotation of text from another source.

Status
colourGreen
title9
Formats – let you format your content with the following options:


Formats menuHeadings optionsInline optionsBlocks optionsAlignment options

Status
colourGreen
title10
Paragraph – lets you format the paragraphs of your content.

Anchor
InsertImages
InsertImages

Status
colourYellow
titlehow to
Insert images

Expand
titleThis section will provide you instructions on how to insert images using the Text Editor.

NOTE: Images can be added by referring to a URL where the image is stored externally. Check your institution’s images hosting site.

Status
colourGreen
title1
Click the Image button in the toolbar.

Status
colourGreen
title2
Enter the URL of the image that you want to add. In the example below, https://silverband.com.au/images/silverband-logo-web.png.

Status
colourGreen
title3
It also asks for an image description when inserting an image. This is useful for vision impaired users or when the image fails to load. It’s highly recommended to use this whenever an image is used.

Status
colourGreen
title4
Click Ok.

How to insert an image using TinyMCE

Note

BE ADVISED: This will not embed a copy of the image in the Notes field. If the file is deleted, removed or inaccessible for some reason in the future, the person viewing it later will not be able to see the image.

Related Pages

Filter by label (Content by label)
showLabelsfalse
max5
showSpacefalse
cqllabel in ( "student" , "student-file" , "communication" , "email" , "student-summary" )

Overview | Assumptions | Key Terms and Concepts | Implications | Workflow | Video | Related Pages | Further Reading


Paradigm Knowledge Base Home