Ximera provides several environments with appropriate layout or functionality in both PDF and online:
- (a)
- theorem-like environments definition, proposition, theorem, example,
remark, warning,
and also notation, axiom, proof, explanation, observation, algorithm, claim, conclusion, condition, conjecture, corollary, criterion, fact, lemma, formula, idea, model, paradox, prodecure, summary, template:These environments determine, as is standard in LaTeX, the header, layout, and numbering of various parts of the text. Ximera also provides an HTML styling for these environments.
By default, ’theorie’ such as definition, proposition, etc. is greenish, and remark, warning, etc. are yellowish. The examples and exercises (see below) are bluish.
Example, where an optional title can be given as usual in LaTeX:
∖begin{definition}[title] CONTENT ∖end{definition}
[title] CONTENT - (b)
- problem-like environments problem, exercise, exploration, question:
These problem environments function as the above, but they can also contain commands and other environments that generate online interactive components on which answers can be entered. These answers are sent to the Ximera server, allowing for the creation of reports and analyses.
In the PDF, either the correct answers are shown directly, or drop-down menus or input points are shown (depending on options that are enabled or disabled during compilation).
Use example for examples, and exercise for exercises. The environments problem and exploration are currently not used or rarely used.
The question environment is modified to have a minimal header with only a number. In practice, it is used within an exercise or example as an alternative to itemize or enumerate.
Answers can be requested within these environments using commands like \answer or \wordChoice. Hints, feedback, and solutions are also possible.
- (c)
- hint, feedback, solution:
If there is a hint within an exercise or example, an ’Hint’ button appears online that reveals the content. Multiple hints are possible, and they can also contain, for example, \wordChoice.
The content of feedback appears automatically once an answer is entered, and you can, for example, use \begin{feedback}[correct] to display the feedback only for a correct answer.
The solution environment contains a worked-out solution that can be shown using a ’Solution’ button. Beware: there is also an environment oplossing that does not have this functionality!
By using \begin{solution}[show], the solution is always shown (also in handout mode). This is useful for examples, where the solution should be expandable online, but should be fully displayed in the handouts.
Through settings, it can be determined whether hints/feedback/solutions should be displayed in the PDF or not.
Technical detail: feedback was internally misused to implement oplossing (as \begin{feedback}{solution}). However, as of 5/2023, there is an alternative and simpler implementation using pure CSS, via preamble.tex/global.css and .ximera/ximera.4ht, only in the summer course math/idl (and nowhere else at that time).
- (d)
- onlineOnly: only appears online (and in the full PDF in red)
There is a counterpart, \pdfOnly, which, however, for unclear reasons, is not implemented as an environment but as a command; see further.
- (e)
- prompt: appears online and in non-handout mode. Not used.
- (f)
- foldable and expandable: In HTML, this is collapsible or expandable; Ximera
itself uses this functionality for hints and it is probably best NOT used
directly.
CONTENT FOLDABLE
Second line FOLDABLE.
O
NTENT EXPANDABLESecond line EXPANDABLE.
- (g)
- basicSkip and basicOnly: used to exclude certain elements from the PDF
version. Extensively used for the A program of the Summer Science
Course.
basicSkip/basicOnly has no impact online (but it may be considered to turn basicSkip into a foldable/accordion in the online version)