Writing long answers in Moodle for CITS5501 assessments

A. Introduction

In tests or projects, you may be asked to write long-form English answers to questions. When such a question is displayed, Moodle provides a web-based editor for you to create your answer in. The default editor provided by Moodle is called Atto.

It’s possible to choose other editor options, however. The other options are:

TinyMCE editor

This is another web-based editor, but compared to Atto, it gives you more control over the formatting applied to your answer. We discuss it further below.

Authoring using a markup language

If you select “Plain text area”, then whenever a long-form answer box is presented, you can write your answer in a markup language such as HTML or Markdown, and can decide for each individual answer which markup language you wish to use.

The Atto editor allows you to apply a range of format styles to your code (for instance, bolding, underlining, or indentation), and to insert content such as equations, tables, and images. Details of the formatting options Atto provides can be found here.

B. Writing code in the Atto editor

When writing a long English answer, you may want to include fragments of code. In the Atto editor, the best way to do so is to select “preformatted” as the paragraph style. Text with the “preformatted” style is displayed using a monospaced font and highlighted in red.

Look at the screenshot below for how to do this.

Selecting paragraph styles in Atto

C. Changing your preferred editor

You can change your preferred editor by going to Your profile icon > Preferences > Editor preferences, and selecting a particular editor. Take a look at the screenshots below for how t do this.

Moodle preference settings


Moodle editor preferences

D. Writing code in the TinyMCE editor

The TinyMCE editor provides more control over your text formatting than the Atto editor, and uses a different method for inserting code fragments.

A list of all the TinyMCE features you can use is available on the Moodle documentation website.

To insert code fragments in TinyMCE, select the Insert > code sample menu item.

Code fragment insertion using TinyMCE

You will then be presented with a popup entry box in which you can write code, and can select a language to use for syntax highlighting. Syntax highlighting is not displayed while you write your code fragment, but is visible in your final answer.

E. Writing code using a markup language

If you select “Plain text area” as your preferred editor, then whenever a long-form entry box is displayed, you are given a choice of what markup language you wish to write your answer in.

Explanations of the different markup languages you can use are available here. For students who are familiar with it, Markdown is often the most convenient choice.

Markdown offers a number of advantages over other formats for writing documents:

Simplicity

Markdown’s syntax is straightforward and easy to pick up – it’s modelled on the way people informally indicated formatting such as bold or italics in their text documents even before markup languages became common.

Readability

Even in its raw form, Markdown is highly readable, which is helpful when sharing code snippets or writing documentation that you or others might need to quickly scan without rendering it in a browser or editor.

Widespread support in industry

Markdown is used in many tools you’ll likely encounter in both academic and professional settings, like GitHub, Jupyter notebooks, Discord forums and Slack. Mastering it now means you’ll be better prepared for collaboration and documentation tasks in the workplace.

Ease of conversion

Tools like Pandoc allow Markdown files to be easily converted to a multitude of other formats, including text formats such as HTML, and binary formats such as PDF, Word, PowerPoint. This is especially handy when you need to submit reports or documents in multiple formats without rewriting them, and unlike binary formats, changes to Markdown files can easily be recorded in version control systems.

You can read more about how to use Markdown in Moodle here and here.