| 1 |
% \iffalse meta-comment |
| 2 |
% vim: textwidth=75 |
| 3 |
%<*internal> |
| 4 |
\iffalse |
| 5 |
%</internal> |
| 6 |
%<*readme> |
| 7 |
| |
| 8 |
------------:| ------------------------------------------------------------ |
| 9 |
ximera:| Simultaneously write print and online interactive materials |
| 10 |
Author:| Jim Fowler and Oscar Levin and Jason Nowell and Wim Obbels and Hans Parshall and Bart Snapp |
| 11 |
E-mail:| [email protected] |
| 12 |
License:| Released under the LaTeX Project Public License v1.3c or later |
| 13 |
See:| http://www.latex-project.org/lppl.txt |
| 14 |
|
| 15 |
Short description: |
| 16 |
Some text about the class: probably the same as the abstract. |
| 17 |
%</readme> |
| 18 |
%<*internal> |
| 19 |
\fi |
| 20 |
\def\nameofplainTeX{plain} |
| 21 |
\ifx\fmtname\nameofplainTeX\else |
| 22 |
\expandafter\begingroup |
| 23 |
\fi |
| 24 |
%</internal> |
| 25 |
%<*install> |
| 26 |
\input docstrip.tex |
| 27 |
\keepsilent |
| 28 |
\askforoverwritefalse |
| 29 |
\preamble |
| 30 |
------------:| ------------------------------------------------------------ |
| 31 |
ximera:| Simultaneously writing print and online interactive materials |
| 32 |
Author:| Jim Fowler and Oscar Levin and Jason Nowell and Wim Obbels and Hans Parshall and Bart Snapp |
| 33 |
E-mail:| [email protected] |
| 34 |
License:| Released under the LaTeX Project Public License v1.3c or later |
| 35 |
See:| http://www.latex-project.org/lppl.txt |
| 36 |
|
| 37 |
\endpreamble |
| 38 |
\postamble |
| 39 |
|
| 40 |
Copyright (C) 2024 by Bart Snapp <[email protected]> and Jim Fowler <[email protected]> |
| 41 |
|
| 42 |
This work may be distributed and/or modified under the |
| 43 |
conditions of the LaTeX Project Public License (LPPL), either |
| 44 |
version 1.3c of this license or (at your option) any later |
| 45 |
version. The latest version of this license is in the file: |
| 46 |
|
| 47 |
http://www.latex-project.org/lppl.txt |
| 48 |
|
| 49 |
This work is "maintained" (as per LPPL maintenance status) by |
| 50 |
Bart Snapp. The source code can be found at: |
| 51 |
|
| 52 |
https://github.com/XimeraProject/ximeraLatex |
| 53 |
|
| 54 |
This work consists of the file ximera.dtx, the associated files |
| 55 |
under src/, and a Makefile. |
| 56 |
|
| 57 |
Running "make" generates the derived files README, ximera.pdf, ximera.cls, xourse.cls. |
| 58 |
|
| 59 |
Running "make inst" installs the files in the user's TeX tree. |
| 60 |
|
| 61 |
Running "make install" installs the files in the local TeX tree. |
| 62 |
|
| 63 |
\endpostamble |
| 64 |
|
| 65 |
\usedir{tex/latex/ximera} |
| 66 |
\input docstrip |
| 67 |
\askforoverwritefalse |
| 68 |
\generate{ |
| 69 |
\file{ximera.cls}{ |
| 70 |
\from{ximera.dtx}{classXimera} |
| 71 |
\from{src/banner.dtx}{classXimera} |
| 72 |
\from{src/options.dtx}{classXimera} |
| 73 |
\from{src/packages.dtx}{classXimera} |
| 74 |
\from{src/tikzexport.dtx}{classXimera} |
| 75 |
\from{src/hyperref.dtx}{classXimera} |
| 76 |
\from{src/suppress.dtx}{classXimera} |
| 77 |
\from{src/makeCounter.dtx}{classXimera} |
| 78 |
\from{src/pagesetup.dtx}{classXimera} |
| 79 |
\from{src/metadata.dtx}{classXimera} |
| 80 |
\from{src/outcomes.dtx}{classXimera} |
| 81 |
\from{src/macros.dtx}{classXimera} |
| 82 |
\from{src/theorems.dtx}{classXimera} |
| 83 |
\from{src/enumerate.dtx}{classXimera} |
| 84 |
\from{src/proof.dtx}{classXimera} |
| 85 |
\from{src/only.dtx}{classXimera} |
| 86 |
\from{src/problem.dtx}{classXimera} |
| 87 |
\from{src/hints.dtx}{classXimera} |
| 88 |
\from{src/abstract.dtx}{classXimera} |
| 89 |
\from{src/title.dtx}{classXimera} |
| 90 |
\from{src/image.dtx}{classXimera} |
| 91 |
\from{src/interactives/javascript.dtx}{classXimera} |
| 92 |
\from{src/interactives/include.dtx}{classXimera} |
| 93 |
\from{src/interactives/geogebra.dtx}{classXimera} |
| 94 |
\from{src/interactives/desmos.dtx}{classXimera} |
| 95 |
\from{src/interactives/google.dtx}{classXimera} |
| 96 |
\from{src/interactives/graph.dtx}{classXimera} |
| 97 |
\from{src/link.dtx}{classXimera} |
| 98 |
\from{src/interactives/video.dtx}{classXimera} |
| 99 |
\from{src/answer.dtx}{classXimera} |
| 100 |
\from{src/choice.dtx}{classXimera} |
| 101 |
\from{src/solution.dtx}{classXimera} |
| 102 |
\from{src/feedback.dtx}{classXimera} |
| 103 |
\from{src/freeresponse.dtx}{classXimera} |
| 104 |
\from{src/verbatim.dtx}{classXimera} |
| 105 |
\from{src/dialogue.dtx}{classXimera} |
| 106 |
\from{src/instructornotes.dtx}{classXimera} |
| 107 |
\from{src/xkcd.dtx}{classXimera} |
| 108 |
\from{src/foldable.dtx}{classXimera} |
| 109 |
\from{src/leash.dtx}{classXimera} |
| 110 |
\from{src/interactives/sagemath.dtx}{classXimera} |
| 111 |
\from{src/jax.dtx}{classXimera} |
| 112 |
\from{src/ungraded.dtx}{classXimera} |
| 113 |
\from{src/clearEnv.dtx}{classXimera} |
| 114 |
\from{src/hideEnv.dtx}{classXimera} |
| 115 |
} |
| 116 |
} |
| 117 |
\generate{ |
| 118 |
\file{xourse.cls}{ |
| 119 |
\from{ximera.dtx}{classXourse} |
| 120 |
\from{src/optionsxourse.dtx}{classXourse} |
| 121 |
\from{src/activity.dtx}{classXourse} |
| 122 |
\from{src/sectioning.dtx}{classXourse} |
| 123 |
\from{src/logo.dtx}{classXourse} |
| 124 |
\from{src/graded.dtx}{classXourse} |
| 125 |
} |
| 126 |
} |
| 127 |
\generate{ |
| 128 |
\file{ximera.cfg}{ |
| 129 |
\from{ximera.dtx}{cfgXimera} |
| 130 |
\from{src/pagesetup.dtx}{cfgXimera} |
| 131 |
\from{src/packages.dtx}{cfgXimera} |
| 132 |
\from{src/jax.dtx}{cfgXimera} |
| 133 |
\from{src/sectioning.dtx}{cfgXimera} |
| 134 |
\from{src/title.dtx}{cfgXimera} |
| 135 |
\from{src/abstract.dtx}{cfgXimera} |
| 136 |
\from{src/image.dtx}{cfgXimera} |
| 137 |
\from{src/outcomes.dtx}{cfgXimera} |
| 138 |
\from{src/textcolor.dtx}{cfgXimera} |
| 139 |
\from{src/verbatim.dtx}{cfgXimera} |
| 140 |
\from{src/html.dtx}{cfgXimera} |
| 141 |
\from{src/ending.dtx}{cfgXimera} |
| 142 |
} |
| 143 |
} |
| 144 |
\generate{ |
| 145 |
\file{ximera.4ht}{ |
| 146 |
\from{ximera.dtx}{htXimera} |
| 147 |
\from{src/pagesetup.dtx}{htXimera} |
| 148 |
\from{src/title.dtx}{htXimera} |
| 149 |
\from{src/problem.dtx}{htXimera} |
| 150 |
\from{src/macros.dtx}{htXimera} |
| 151 |
\from{src/theorems.dtx}{htXimera} |
| 152 |
\from{src/image.dtx}{htXimera} |
| 153 |
\from{src/dialogue.dtx}{htXimera} |
| 154 |
\from{src/foldable.dtx}{htXimera} |
| 155 |
\from{src/interactives/video.dtx}{htXimera} |
| 156 |
\from{src/xkcd.dtx}{htXimera} |
| 157 |
\from{src/link.dtx}{htXimera} |
| 158 |
\from{src/interactives/graph.dtx}{htXimera} |
| 159 |
\from{src/answer.dtx}{htXimera} |
| 160 |
\from{src/choice.dtx}{htXimera} |
| 161 |
\from{src/freeresponse.dtx}{htXimera} |
| 162 |
\from{src/interactives/javascript.dtx}{htXimera} |
| 163 |
\from{src/interactives/include.dtx}{htXimera} |
| 164 |
\from{src/interactives/geogebra.dtx}{htXimera} |
| 165 |
\from{src/interactives/desmos.dtx}{htXimera} |
| 166 |
\from{src/interactives/google.dtx}{htXimera} |
| 167 |
\from{src/feedback.dtx}{htXimera} |
| 168 |
\from{src/leash.dtx}{htXimera} |
| 169 |
\from{src/labels.dtx}{htXimera} |
| 170 |
\from{src/interactives/sagemath.dtx}{htXimera} |
| 171 |
\from{src/ungraded.dtx}{htXimera} |
| 172 |
\from{src/footnotes.dtx}{htXimera} |
| 173 |
\from{src/ending.dtx}{htXimera} |
| 174 |
} |
| 175 |
} |
| 176 |
\generate{ |
| 177 |
\file{xourse.4ht}{ |
| 178 |
\from{ximera.dtx}{htXourse} |
| 179 |
\from{src/logo.dtx}{htXourse} |
| 180 |
\from{src/metadata.dtx}{htXourse} |
| 181 |
\from{src/activity.dtx}{htXourse} |
| 182 |
\from{src/sectioning.dtx}{htXourse} |
| 183 |
\from{src/graded.dtx}{htXourse} |
| 184 |
\from{src/interactives/video.dtx}{htXourse} |
| 185 |
\from{src/ending.dtx}{htXourse} |
| 186 |
} |
| 187 |
} |
| 188 |
%</install> |
| 189 |
%<install>\endbatchfile |
| 190 |
%<*internal> |
| 191 |
\usedir{source/latex/ximera} |
| 192 |
\generate{ |
| 193 |
\file{ximera.ins}{\from{\jobname.dtx}{install}} |
| 194 |
} |
| 195 |
\nopreamble\nopostamble |
| 196 |
\usedir{doc/latex/ximera} |
| 197 |
\generate{ |
| 198 |
\file{README.txt}{\from{\jobname.dtx}{readme}} |
| 199 |
} |
| 200 |
\ifx\fmtname\nameofplainTeX |
| 201 |
\expandafter\endbatchfile |
| 202 |
\else |
| 203 |
\expandafter\endgroup |
| 204 |
\fi |
| 205 |
%</internal> |
| 206 |
% \fi |
| 207 |
% |
| 208 |
% \iffalse |
| 209 |
%<*driver> |
| 210 |
\ProvidesFile{ximera.dtx} |
| 211 |
%</driver> |
| 212 |
%<classXimera|classXourse>\NeedsTeXFormat{LaTeX2e}[1999/12/01] |
| 213 |
%<classXimera>\ProvidesClass{ximera} |
| 214 |
%<classXourse>\ProvidesClass{xourse} |
| 215 |
%<classXimera|classXourse> [2024/05/12 v1.5.1 |
| 216 |
%<classXimera> Simultaneously write print and online interactive materials] |
| 217 |
%<classXourse> Combining Ximera activities into Xourses] |
| 218 |
%<*driver> |
| 219 |
\documentclass{ltxdoc} |
| 220 |
\usepackage[a4paper,margin=25mm,left=50mm,nohead]{geometry} |
| 221 |
\usepackage[numbered]{hypdoc} |
| 222 |
\usepackage{hyperref} |
| 223 |
|
| 224 |
\EnableCrossrefs |
| 225 |
\CodelineIndex |
| 226 |
\RecordChanges |
| 227 |
\begin{document} |
| 228 |
\DocInput{\jobname.dtx} |
| 229 |
\section{ximera.cls} |
| 230 |
\DocInput{src/options.dtx} |
| 231 |
\DocInput{src/packages.dtx} |
| 232 |
\DocInput{src/pagesetup.dtx} |
| 233 |
\subsection{Structure} |
| 234 |
\DocInput{src/macros.dtx} |
| 235 |
\DocInput{src/theorems.dtx} |
| 236 |
\DocInput{src/enumerate.dtx} |
| 237 |
\DocInput{src/proof.dtx} |
| 238 |
\DocInput{src/problem.dtx} |
| 239 |
\DocInput{src/hints.dtx} |
| 240 |
\DocInput{src/solution.dtx} |
| 241 |
\DocInput{src/verbatim.dtx} |
| 242 |
\DocInput{src/dialogue.dtx} |
| 243 |
\DocInput{src/instructornotes.dtx} |
| 244 |
\DocInput{src/only.dtx} |
| 245 |
\DocInput{src/foldable.dtx} |
| 246 |
\DocInput{src/leash.dtx} |
| 247 |
\subsection{Document metadata} |
| 248 |
\DocInput{src/metadata.dtx} |
| 249 |
\DocInput{src/abstract.dtx} |
| 250 |
\DocInput{src/title.dtx} |
| 251 |
\DocInput{src/outcomes.dtx} |
| 252 |
\DocInput{src/labels.dtx} |
| 253 |
\subsection{Images} |
| 254 |
\DocInput{src/image.dtx} |
| 255 |
\DocInput{src/tikzexport.dtx} |
| 256 |
\DocInput{src/xkcd.dtx} |
| 257 |
\subsection{Links} |
| 258 |
\DocInput{src/hyperref.dtx} |
| 259 |
\subsection{Interactives} |
| 260 |
\DocInput{src/interactives/include.dtx} |
| 261 |
\DocInput{src/interactives/google.dtx} |
| 262 |
\DocInput{src/interactives/geogebra.dtx} |
| 263 |
\DocInput{src/interactives/desmos.dtx} |
| 264 |
\DocInput{src/interactives/graph.dtx} |
| 265 |
\DocInput{src/interactives/video.dtx} |
| 266 |
\DocInput{src/interactives/javascript.dtx} |
| 267 |
\DocInput{src/interactives/sagemath.dtx} |
| 268 |
\subsection{Answerables} |
| 269 |
\DocInput{src/answer.dtx} |
| 270 |
\DocInput{src/choice.dtx} |
| 271 |
\DocInput{src/freeresponse.dtx} |
| 272 |
\DocInput{src/feedback.dtx} |
| 273 |
\DocInput{src/ungraded.dtx} |
| 274 |
\subsection{Support for the web} |
| 275 |
\DocInput{src/jax.dtx} |
| 276 |
\DocInput{src/html.dtx} |
| 277 |
\subsection{Tools} |
| 278 |
\DocInput{src/suppress.dtx} |
| 279 |
\DocInput{src/ending.dtx} |
| 280 |
\section{xourse.cls} |
| 281 |
\DocInput{src/optionsxourse.dtx} |
| 282 |
\DocInput{src/activity.dtx} |
| 283 |
\DocInput{src/sectioning.dtx} |
| 284 |
\DocInput{src/graded.dtx} |
| 285 |
\DocInput{src/logo.dtx} |
| 286 |
\end{document} |
| 287 |
%</driver> |
| 288 |
% \fi |
| 289 |
% |
| 290 |
%\def\fileversion{v1.5.1} |
| 291 |
%\def\filedate{2024/05/12} |
| 292 |
% \DoNotIndex{\newcommand,\newenvironment} |
| 293 |
% |
| 294 |
%\title{\textsf{ximera} --- Simultaneously write print and online interactive materials.\thanks{This file |
| 295 |
% describes version \fileversion, last revised \filedate.} |
| 296 |
%} |
| 297 |
%\author{Jim Fowler \and Jeramiah Hocutt \and Oscar Levin \and Jason Nowell \and Wim Obbels \and Hans Parshall \and Bart Snapp} |
| 298 |
%\date{Released \filedate} |
| 299 |
% |
| 300 |
%\maketitle |
| 301 |
% |
| 302 |
%\changes{v1.0.0}{2018/05/25}{First public release} |
| 303 |
%\changes{v1.5.0}{2024/05/08}{Submitting to CTAN} |
| 304 |
%\changes{v1.5.1}{2024/05/12}{Fixed date bug} |
| 305 |
|
| 306 |
% \begin{abstract} |
| 307 |
% ``\textsf{Ximera} begins where \TeX\ ends.'' The \textsf{ximera} |
| 308 |
% class aids in the creation of handouts, worksheets, exercises, and |
| 309 |
% sections of textbooks to be used either individually or ``glued'' |
| 310 |
% together via a \textsf{xourse} file. All \textsf{ximera} documents |
| 311 |
% can be deployed in an online interactive form via \texttt{xake} |
| 312 |
% See: \href{https://ximera.osu.edu}{Ximera Project} and the source |
| 313 |
% code on \href{https://github.com/XimeraProject}{GitHub}. |
| 314 |
% \end{abstract} |
| 315 |
% |
| 316 |
% \section{Introduction} |
| 317 |
% |
| 318 |
% Ximera, pronounced ``chimera,'' (\textbf{X}imera: |
| 319 |
% \textbf{I}nteractive, \textbf{M}athematics, |
| 320 |
% \textbf{E}\textbf{R}esources, for \textbf{A}ll) is an open-source |
| 321 |
% platform that provides tools for authoring and publishing (PDF and |
| 322 |
% Online), open-source, interactive educational content, such as textbooks, assessments, and online courses. |
| 323 |
% The Ximera document class provides the following features: |
| 324 |
% \begin{description} |
| 325 |
% \item[Formatting for different domains] The Ximera document class |
| 326 |
% provides built-in support for formatting documents in both PDF and |
| 327 |
% online formats, which can be a big time-saver for |
| 328 |
% authors. Additionally, it allows for the simultaneous creation of |
| 329 |
% solution manuals and teaching editions, which can be especially |
| 330 |
% useful for educators. |
| 331 |
%\item[Compiling individually or as a whole] With the Ximera document |
| 332 |
% class, authors can easily compile individual documents or an entire |
| 333 |
% collection of documents. This flexibility can be helpful when making |
| 334 |
% changes to specific documents without having to re-compile the |
| 335 |
% entire collection. Moreover, this allows an author to share large |
| 336 |
% portions of a text with another, with minimal changes. |
| 337 |
%\item[Interactive content] The Ximera document class allows for the |
| 338 |
% inclusion of interactive content, such as answer boxes that are |
| 339 |
% validated by a client-side computer algebra system. Additionally, it |
| 340 |
% allows for the embedding of YouTube videos, Desmos graphs, and |
| 341 |
% GeoGebra interactives. |
| 342 |
%\item[All content displayed] By default, the Ximera document class |
| 343 |
% displays all content to the author. This means the author see what |
| 344 |
% the students see, along with answers and solutions, and links (that |
| 345 |
% can be checked) to various interactive elements (when deployed, the |
| 346 |
% interactive elements are truly embedded). This can be especially |
| 347 |
% helpful for catching errors or inconsistencies in the content. |
| 348 |
%\end{description} |
| 349 |
% |
| 350 |
%Online examples can be found at |
| 351 |
%\begin{center} |
| 352 |
%\url{https://go.osu.edu/ximera-examples} |
| 353 |
%\end{center} |
| 354 |
|
| 355 |
|
| 356 |
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% |
| 357 |
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% |
| 358 |
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% |
| 359 |
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% |
| 360 |
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% |
| 361 |
|
| 362 |
|
| 363 |
%\Finale |