Digabi is a codebase used in the Abitti exam system, the digital exam environment for the Finnish Matriculation Examination.
All bug reports, feature requests, and pull requests are appreciated. However, the following should be kept in mind:
- Pull requests based on submitted issues cannot be implemented due to limited resources. Similarly, upstream issues related to third-party projects in use are not forwarded.
- No guarantee can be given that submitted pull requests will be reviewed.
- Our focus is strictly on the Finnish Matriculation Examination, as defined by law. Issues or pull requests unrelated to this mission will not be addressed.
- Official channels should be used for inquiries. The issue tracker and pull requests are not to be used for general questions or support requests.
Before any contribution is accepted to the codebase, to clarify the intellectual property rights associated with contributions to open-source projects owned by the Finnish Matriculation Examination Board, all contributors must sign and submit a Contribution License Agreement (CLA):
- Individuals should sign and send the Personal CLA to [email protected].
- Organizations or corporations should sign and send the Corporate CLA to the same address.
Engine for the MEX exam format.
Provides:
- Exam preview tools for exam developers
- MEX format documentation
- Tools for mastering an exam to run it in Matriculation examination board's environment
Make sure you test any MEX format exam manually before publishing it or using it with Abitti in production. This manual testing should include holding the exam, answering all questions, grading it, and checking that all examinees' answers are available.
The MEX format and this engine is still under development: All functionalities of the MEX format do not yet work in Abitti. Breaking changes are also still possible without prior warning.
Make sure the following are installed in your system:
After Node.js has been installed, open a new terminal window and type the following command.
$ npm install -g @digabi/exam-engine-cli
This installs the ee command-line program to your system.
To create a new exam, use
$ ee new Esimerkkikoe
This creates a Esimerkkikoe directory, containing a basic exam.xml file and an
empty attachments directory where to place attachments.
To start a live preview of any exam on your computer, navigate to the exam directory and run
$ ee preview
To use an exam in Abitti, it must be first packaged as a transfer zip. It is then possible to import it to Abitti by clicking "Tuo koe/För in prov".
To create a transfer zip, navigate to the exam directory and run
$ ee create-transfer-zip
This creates a transfer zip file in the exam directory for each language version of the exam.
Offline version refers to a static version of an exam that can be viewed in a web browser without any additional tools.
To create an offline version of the exam, navigate to the exam directory and use
$ ee create-offline
Most of the artifacts in this repository are licensed under LICENSE. Exceptions are:
- XHTML-based XML Schema Definition files packages/mastering/schema. See packages/mastering/schema/xhtml11.xsd for the license.
- Abitti and the Abitti logo are EU trademarks registered by the Finnish Matriculation Examination Board (FMEB) under the codes 015833742 and 015838915. For detailed use rights, see https://abitti.net/abitti-trademark.html
- Several attachments in the SC sample exam packages/exams/SC/ are third party material. See
the
<e:reference>tags in packages/exams/SC/SC.xml for details.
The information in this section is only relevant for developers.
Exam-engine is structured as a monorepo containing several NPM packages.
| Component | Purpose |
|---|---|
| @digabi/exam-engine-core | The main UI code responsible for rendering a mastered exam into HTML. It produces an AMD bundle containing several React components and a CSS file. This AMD bundle is packaged to every exam .mex file and loaded dynamically when taking the exam. |
| @digabi/exam-engine-mastering | Mastering is a step in which we take a source XML file, validate its contents, do some processing (e.g. calculate the maximum score and assign IDs for each question). A single source XML file will produce a separate mastered XML file for each language defined in the source XML. |
| @digabi/exam-engine-rendering | Contains webpack-related code for previewing an exam or converting one into a static HTML file (also known as an "offline exam"). |
| @digabi/exam-engine-exams | Contains sample exams in the mex format. |
| @digabi/exam-engine-cli | Contains the ee CLI tool. |
The ee client can be run with npm run ee. So to preview an exam, run
$ npm run ee preview path/to/exam.xml
Before doing any changes to the code, you'll want to command TypeScript to compile any changes within the whole project automatically.
$ npm run watch
$ npm run lint
To run all tests
$ npm run test
To run a specific test or a specific set of tests, use
$ npm run test packages/foo/__tests__/testFoo.ts
$ npm run test packages/foo
If you've made changes to the code that affect exam mastering or rendering, you need to update the test snapshots by running. Review changes the snapshots manually.
$ npm run test-jest -- -u
Increase version number of the packages:
$ npx lerna version premajor | preminor | prepatch | prerelease [--force-publish] [--yes]Use --force-publish to set new version even when there are no changes and --yes to auto-confirm
version to be set. This will create a tag for new version and push it to the remote repository.
GitHub Action will be triggered to publish new version to npm repository after successfully building the repositories and running tests.
Similar to prerelease, just
$ npx lerna version major | minor | patch [--force-publish] [--yes]