Documentation for downloading and configuring the ProFormA Format Editor
This editor is maintained by members of the ProFormA group within the
eCULT project. The
purpose of the editor is to provide a stand-alone interface for the XML
exchange format for programming exercises (ProFormA) which is
available on GitHub.
A research
paper which provides further explanations about this project
has been written by Strickroth et al.
Installation
The editor can be downloaded
from Github. It
is written in Javascript and does not require compilation.
Documentation
A user manual (in German) and an FAQ (in English) are available from
within the editor.
Configuration
Although the purpose of the ProFormA format is to exchange programming
exercises, not all features are supported by all tools. The editor can therefore be
configured for specific tools.
- Several variables (such as useCodemirror) can be set within the config.js
in order to turn such features on or off.
- Tests can be added or removed in config.js as well.
Even the list of supported programming languages can be modified.
Look at config.js for details.
- Larger tool-specific code should be placed in separate files (such
as loncapa.js).
Known Bugs and Missing Features
- Grading hints are currently only used in a very simple way.
- XML validation is currently only conducted for the main schema,
not for the other namespaces.
- Look at the readme.md file for more information.
Further information is available in the user manual and in the
comments in the code.
Gitlab issue tracking is available
here.
Testing
A set of python/selenium tests that cover basic features is provided for regression testing.