isaacphysics / isaac-editor

An AngularJS and React based content editor for the Isaac platform

isaac-editor

The old Isaac Physics Content Editor, used to create the JSON site content for the Isaac Physics project. This project used React components inside an AngularJS app. It was used from 2014 until 2022, when it was superseded by isaac-content-editor, a modern React app replacement.

Developing the Content Editor

To develop the content editor:

• Check out this repo
• Run npm run sass to generate the CSS
• Run via npm start, and then visit localhost:8421 in a web browser

You may find it useful to edit github_application.js to change the OAuth settings, or to alter the remote repository the editor connects to in services.js. Both of these are configured on a per-hostname basis.

isaac-editor's Issues

Add a list of mathjax definitions to the site

Fractional (numeric) answers

Issue found in 223562a

Some answers are exact fractions - would it be possible to allow students to input these?

Also, would there be a way to input answers in standard form?

Saving fails

There seems to be an issue with saving content since my latest update (8b95e8a). I'm looking into this now.

List of concepts to add to question

Once we have a full list of concepts it would be nice to have a drop-down box or similar with all of these in so that we can select which concepts apply to the question, both for tagging the questions and for adding to the hints sections

Upload videos

Issue found in 223562a

I believe this is already on your radar but I realised there wasn't an issue logged so I thought it was worth adding one. Could you add a way to upload videos? This would help as the videos could be easily checked against a question.

Very difficult to add choices to multiple choice questions

When creating a multiple choice quesiton it is barely possible to click in the right place to add a choice, so I end up going into the json in order to make some choices appear. Could this be made easier to do?

Thanks

Can't see which answer is labelled as correct in multiple choice questions

At the moment in the editor you can't see which of the choices in the multiple choice questions is correct. This is awkward as we need to update the answer feed to take into account that the choices will be displayed randomly so they can't refer to the correct choice by label.

Setup Analytics

Setup some analytics so that we can see how the editor is used.

Maybe Google?

Missing metadata for figures created in the editor

When creating a new figure could the editor provide space for content creators to add the following meta data (currently this is not included by default):

• id - to allow cross referencing
• title - to improve searchability
• tags - to improve searchability
• author - to improve traceability
• altText - for accessibility

Back button doesn't work!

Commas appearing in units

Issue found in 959e505

In some units , is used to make sure that the spacing is correct. However when these units are copied and pasted into other bits of content the comma starts appearing in the processed maths section (how it looks after you have finished editing and clicked done). I've left some like this in http://www.cl.cam.ac.uk/~ipd21/rutherford/scooter/app/#!/edit/master/content/questions/physics/mechanics/kinematics/level2/decc_car.json so that you can see this effect.

Referencing figures and equations

Just a note that we need a way of cross referencing figures and labels within a given page. It may also be useful to cross reference beyond the same page but this could be done with a link.

Comments Box in Editor

Could a box displaying comments be added to the editor - if we stop work overnight but don't want to forget our place, or other useful notes?

I used to use the LaTeX file and used commented lines for notes - but we can't do this here since typing comments directly into the JSON isn't allowed.

Allow editors to choose from a list of predefined question types.

This should prevent errors caused by misspellings in the type JSON field.

Question type

Radio buttons do not appear to be selected if have multiple questions on a page. But clicking them does change the question type in the JSON.

Implement tags in the editor

Implement add/edit/remove for tags in content objects displayed on the editor.

Saving modifications

Being able to save content using the ctrl-s shortcut.

Adding Title and Level when creating a new question

At the moment when starting a new question the title appears in the .json as "Page Title Here", and unlike the pages that were imported from latex files there's no level or id. Are these needed and if so could they automatically populate when you create a new question? Also, should the topic also appear somewhere in the .json?

Image upload should replace existing file

Clicking on image should download it.

No way to know what definitions are available

Add some sort of popup list of MathJax definitions.

Talk page

It would be nice to have an area on the content editor for each question for comments from the content team, where we could discuss whether the hints are appropriate, if the question is in the correct level, flag up any problems with the solution etc.

Automatic blanking of default text on click

Would it be quick to automatically remove the default text when you click on the box to enter new text. RSI from mousing and content entry :)

Allow editors to enter custom commit messages

@sacummins suggests that we pre-populate the message field with the existing suggested message, and encourage users to add more detail.

If users do not wish to alter the default message, this should not add more than 1 click to the save workflow.

Multiple choice questions

Being able to create multiple choice questions without having to go into the JSON code.

Underscores in maths

If you have multiple equations which contain underscores in a content element, markdown interprets that as wanting everything between the two underscores as being in italics. This stops MathJax being able to know where the first maths bit stops and everything between the two math elements with underscores is placed in italics and with now spaces.

Multiple Choice Choices

Would like to be able to see the choices in normal view (rather than json view) to also be able to check that the subscripts etc all working.

Loss of content when creating new content

If you write something in a content box, but don't click "Done", then if you create a new piece of content using the + symbol that is next to the currently open content, then you will lose all of the changes to the content that you have just written.

This doesn't happen if you create new content elsewhere in the page, if you click "Done" before creating new content, or if you edit some different content before clicking the + arrow.

Accidentially deleting things

If you are editing text in the plain text view and you don't click done. i.e. leave it open and then add a new content section. The editor copies a section (typically the one below) i.e. when adding in between already created content blocks. If I then click done on the original open content block the duplicate section becomes one displaying the changes in the new added block and deleting the original block that was not touched.

Step 1: edit one block and do not click done
Step 2: add a block between already created content (this should produce a copy of the block below.
Step 3: change the content in the new added block so that it has different content to that below.
Step 4: click done on the original step 1 block. The content in the added block will remain but the duplicated block that was not touched will disappear.

Alternative step 3: instead of adding content delete the block by clicking the cross. Both blocks (duplicates) will disappear - losing the original untouched content of the lower duplicate block.

Jumping when opening content near bottom of page

When a piece of content near the bottom of the page is opened, the cursor will jump to the beginning of this piece of content, sometimes making the page jump up. This is frustrating while trying to add new content to the bottom.

Default image source (adding figures)

When adding a figure there is no source provided and therefore don't know how to add the location of the figure.

Units should be in upright maths font

This requires alterations to \valuedef and \quantity.

Field for "published" toggle should be added to top level content objects

A new metadata field (boolean) should be added to top level Content objects.

The default value should be false and content editors should be able to easily toggle this value within the editor to make things publicly visible on the live site.

Show title in body text as well as metadata

Could the title metadata field please also be displayed in the content body as it is causing duplicate rendering on the end website.

No way of adding figures through editor

Automatically populate author metadata in top-level content objects when they are created

The author field in the json should automatically be pre-populated with the git username of the user who created the file in the editor.

The author should not be changed with every subsequent commit as it represents the original owner / person responsible for creating the content rather than the last person to modify it.

Unstable behaviour in concertina

Issue found in potential_energy

I noticed that when I edited content in one concertina block, clicked done and then went to a previous concertina block some of the content from the neighbouring concertina sections appeared there as well. The unwanted extra content will disappear if you refresh and then go down the concertina sections in order (top to bottom.) The issue appears when you go up the concertina sections (bottom to top) or any other way. This has happened in Safari and in Chrome.

To recreate bug in potential _energy (physics concept):

1. step through the different levels: level 2 -> level 5
2. go from level 5 to level 2, or level 4, or level 3.

It is not necessarily the same content each time which is taken from one of the neighbouring concertina into another.

Display attribution in question page metadata

Accordions

Would it be possible for each accordion to have its own colour rather than the colour indicating live or not. I think this would mean that I would realise more readily which one I was editing. I.e. second accordion always blue with blue frame....

Render titles from page metadata.

Rename button does nothing

After clicking on the .json name in the black bar at the top, a box drops down with several options. Clicking "rename" just closes this box, and there's no way to edit the file name before clicking "rename"

Choice datastructure should have an explanation field

Please add an additional field called explanation for choice objects.

This should be a ContentObject as per the dto in the segue project.

This field will be used to provide information as to why a given option is correct / incorrect.

levels in accordions

For each accordion in a concept (e.g. potential_energy.json) a way of inputting the level of the accordion section is needed as there is a level indicator on each section. Currently, we can put a title in the purple box, but ideally a space for specifying the level and a longer title would be good so that it matches this page.

Branch switching doesn't appear to work

Link to Question in Editor?

Is it possible to include a link to the question on the dev site inside the editor, to save having to find the question on the website using the long Question List?

shorthand notation for d/dt

There are a few questions where we want in the text to be able to denote velocity as an x with a dot over the top or an acceleration as with two dots over the top.

LaTeX command is \dot{x} or \ddot{x} at the moment this doesn't seem to translate.

Link to what I mean (under accents section)
https://www.artofproblemsolving.com/Wiki/index.php/LaTeX:Symbols

Pages appearing as json, unable to switch back to normal editor mode

There are a few pages which appear as the .json text with no "Content Object" label at the top or "Done" button at the bottom. For an example see http://www.cl.cam.ac.uk/~ipd21/rutherford/scooter/src/main/webapp/#master:content/questions/physics/mechanics/dynamics/level5/chain_on_peg.json

I can't see an obvious problem with the .json definition, although I wouldn't be surprised if there is one there.

Add "Report Content Issue" link to editor

This should be very similar to "Report Editor Issue".

Improve scrolling behaviour

The current site has a fixed-height content panel with internal scrolling. On reflection, this is rather unpleasant.

Make the page extend to the length of the content in the traditional way. Perhaps keep the file browser fixed, but probably not.

Units in Numeric Questions

How should we enter units in Numeric Questions? Straightforward units like "N" or "m" are fine; but units like meters per second (is it "m/s" or "m / s" or "ms^-1" or "m s^{-1}" ) or worse units like meters per second squared will be difficult to enter for the end user.

Is the symbolic equation editor going to be able to deal with this, and if so - what do we write as the choices for the answers to such Numeric Questions? Does it output Mathjax like content?
If not - then I think Lisa et al need to make a decision regarding the project wide way to type them?

Pre-entered text

When you insert a new content block for example, it says "enter content here". When you click on it it disappears, but you have to click on it again to get the cursor. Could you make it so that you only have to click once to get the cursor to appear?