Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Luaxake: use the new xake version, written in Lua #28

Draft
wants to merge 23 commits into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .devcontainer/docker-compose.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
services:
app:
image: ghcr.io/ximeraproject/xake2024:v2.4.3
image: ghcr.io/ximeraproject/ximeralatex:v2.5.0
# image: ghcr.io/ximeraproject/xake2024:v2.4.3-full
volumes:
# This is where VS Code should expect to find your project's source code and the value of "workspaceFolder" in .devcontainer/devcontainer.json
Expand Down
27 changes: 19 additions & 8 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -6,16 +6,23 @@
## Graphics - recommend to be ignored, as TikZ-generated pictures should NOT be committed
*.svg
*.png
*.svg
*.pdf
## Folder xmPictures is in the graphicspath, and should contain the pictures used in \includegraphics
## So in xmPictures things presumably must be committed
!xmPictures/*.jpg
!xmPictures/*.pdf
!xmPictures/*.png
## Note: capital .JPG.PDF/PNG should better NOT be used ...
!xmPictures/*.JPG
!xmPictures/*.PDF
!xmPictures/*.PNG
## So png,svg,pdf,jpg in (subfolders of) xmPictures presumably must be committed
## but everything else in there should be ignored
xmPictures/**
!xmPictures
!xmPictures/**/
!xmPictures/**/*.jpg
!xmPictures/**/*.svg
!xmPictures/**/*.pdf
!xmPictures/**/*.png
## Note: capital JPG/PDF/PNG should NOT be used ...
!xmPictures/**/*.JPG
!xmPictures/**/*.SVG
!xmPictures/**/*.PDF
!xmPictures/**/*.PNG
## Core latex/pdflatex auxiliary files:
*.aux
*.lof
Expand Down Expand Up @@ -298,7 +305,10 @@ Thumbs.db

# For exam-stuff ... ?
ans[0-9]*.tex


*.jax
*.xmjax
*.ids
*.oc

Expand All @@ -310,6 +320,7 @@ metadata.json
# multiwrite latex
*.mw
*.dlog
*.failed

# ximera-download contains (downloadable!) PDF's generated by xake (bakehanout/bakestandaard)
ximera-downloads
Expand Down
52 changes: 32 additions & 20 deletions .vscode/settings.json
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@
{
"label": "SERVE",
"alignment": "right",
"task": "All",
"task": "SERVE",
"description": "Build and publish this project.",
"tooltip": "Build and publish this repo."
},
Expand All @@ -79,9 +79,17 @@
{
"task": "Preview in Simple Browser",
"label": "Preview in Simple Browser",
"description": "View the local webserver in a preview window",
// "description": "Start local Ximera webserver.",
"problemMatcher": [],
},
{
"task": "Delete all",
"label": "Delete all HTML and PDFs",
"description": "Remove all generated files",
"problemMatcher": [],
},

{
"label": "Bake",
"alignment": "right",
Expand All @@ -90,9 +98,15 @@
"tooltip": "Bake this project."
},
{
"task": "Bake standard",
"label": "Bake standard PDFs (with answers)",
"description": "Make full PDF's. ('standaard')",
"task": "Bake pdf",
"label": "Bake PDF's (with answers)",
"description": "Make PDF's.",
"problemMatcher": [],
},
{
"task": "Bake pdf (force rebuild)",
"label": "Force (re-)Bake PDF's (with answers)",
"description": "Make PDF's.",
"problemMatcher": [],
},
{
Expand All @@ -101,11 +115,24 @@
"description": "Make handout PDF's.",
"problemMatcher": [],
},
{
"task": "Bake handout (fore rebuild)",
"label": "Force (re-)Bake handout PDF's (without answers)",
"description": "Make handout PDF's.",
"problemMatcher": [],
},
{
"label": "Frost",
"alignment": "right",
"task": "Frost",
"description": "Frost this project.",
"tooltip": "Frost this project."
},
{
"label": "Serve",
"alignment": "right",
"task": "Serve",
"description": "Serve this project (does also 'frost', but no 'bake').",
"description": "Serve this project.",
"tooltip": "Serve this project."
},
{
Expand All @@ -114,21 +141,6 @@
"description": "Updates the docker-container, xmScripts en .vscode config",
"problemMatcher": [],
},
{
"task": "Delete standard",
"label": "Delete all standard PDFs",
"problemMatcher": [],
},
{
"task": "Delete handout",
"label": "Delete all handout PDFs",
"problemMatcher": [],
},
{
"task": "Delete all",
"label": "Delete all HTML and PDFs",
"problemMatcher": [],
},
],
},
]
Expand Down
50 changes: 32 additions & 18 deletions .vscode/tasks.json
Original file line number Diff line number Diff line change
Expand Up @@ -12,39 +12,47 @@
{
"label": "PDF",
"args": [
"-v",
"compilePdf",
"${relativeFile}"
],
},
{
"label": "HTML",
"args": [
"--",
"--skip-mathjax",
"-v",
"compile",
"${relativeFile}"
],
},
{
"label": "Bake",
"label": "SERVE",
"args": [
"--",
"--skip-mathjax",
"bake"
"-v",
"all"
],
},
{
"label": "All",
"label": "Bake",
"args": [
"-d", "all"
"-v",
"bake"
],
},
{
"label": "Serve",
"args": [
"-v",
"serve"
],
},
},
{
"label": "Frost",
"args": [
"-v",
"frost"
],
},
{
"label": "Start Ximera Server",
"args": [
Expand All @@ -56,33 +64,39 @@
"command": "${input:openSimpleBrowser}",
},
{
"label": "Bake standard",
"label": "Bake PDF",
"args": [
"bakestandaard"
"bake",
"--compile pdf",
],
},
{
"label": "Bake handout",
"label": "Bake PDF (force rebuild)",
"args": [
"bakehandout"
"bake",
"-f",
"--compile pdf",
],
},
{
"label": "Delete standard",
"label": "Bake handout",
"args": [
"cleanstandaard"
"bake",
"--compile handout.pdf",
],
},
{
"label": "Delete handout",
"label": "Bake handout (force rebuild)",
"args": [
"cleanhandout"
"bake",
"-f",
"--compile handout.pdf",
],
},
{
"label": "Delete all",
"args": [
"clean"
"veryclean"
],
},
{
Expand Down
8 changes: 5 additions & 3 deletions aFirstFolder/aFirstActivity.tex
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,10 @@

\begin{document}
\begin{abstract}
A simple Ximera activity.
A rather simple Ximera activity.
\end{abstract}
\maketitle
\label{xim:aFirstActivity}

Perhaps the most natural setting for Ximera content is that of a
\textit{worksheet}. This is some document that may contain discussion as well
Expand All @@ -28,7 +29,7 @@ \section{A basic use case}
questions. Since Ximera provides immediate feedback, we suggest following
definitions like this one by a quick question. Here's an example:

\begin{definition}
\begin{definition}\label{def:absolute_value}
The \textbf{absolute value} of a real number $a$, denoted by $|a|$, is
\[
|a| = \begin{cases}
Expand Down Expand Up @@ -75,7 +76,8 @@ \section{A paradox}

\section{Basic exercises}

After that, you might want to have some exercises:
After that, you might want to have some exercises.
You will not find any inspiration in the above \hyperref[def:absolute_value]{definition of the absolute value}.

\begin{exercise}
Let $x$ be the number of people
Expand Down
3 changes: 3 additions & 0 deletions aFirstFolder/aGraphicsActivity.tex
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
How to include graphics and other interactive content.
\end{abstract}
\maketitle
\label{xim:aGraphicsActivity}

\section{Including images}

Expand Down Expand Up @@ -126,4 +127,6 @@ \section{Desmos, Desmos3D, and Geogebra}
\end{center}
\end{verbatim}

And remember the \hyperref[def:absolute_value]{definition of the absolute value}.

\end{document}
23 changes: 15 additions & 8 deletions xmScripts/config.txt
Original file line number Diff line number Diff line change
@@ -1,13 +1,11 @@
#
# version of Ximera xake container to use (with xmlatex)
#
# : "${XAKE_BASE:=xake2024}"
: "${XAKE_VERSION:=v2.4.3}"
#: "${XAKE_BASE:=ximeralatex}"
#: "${XAKE_VERSION:=v2.5.5-full}"
## Alternatives:
# : "${XAKE_VERSION:=v2.4.3-full}" # with texlive_full
# : "${XAKE_BASE:=xake2023}" # with older tex/xake
# : "${XAKE_VERSION:=v2.1.3_a}" # obsolete

#: "${XAKE_VERSION:=latest}"
# : "${XAKE_VERSION:=v2.4.2-full}" # with texlive_full
#
#
# For publishing locally, a default key in .xmKeyFile is sufficient.
Expand All @@ -23,7 +21,7 @@ YOUR_EMAIL=""

## : "${XIMERA_NAME:=myreponame}"
## : "${XIMERA_URL:=http://localhost:2000/}"
## : "${XIMERA_URL:=https://ximera.osu.edu}"
## : "${XIMERA_URL:=https://ximera.osu.edu/}"
## : "${XIMERA_URL:=https://set-p-dsb-zomercursus-latest.cloud-ext.icts.kuleuven.be/}"
## : "${XIMERA_URL:=https://set.kuleuven.be/voorkennis/}"

Expand All @@ -44,4 +42,13 @@ YOUR_EMAIL=""
# for LOCALLY generated/tagged images, use:
# export DOCKER_REPO=" "
# export XM_PUSH_FORCE=1
# export XM_FROST_WITH_UNCOMMITTED_CHANGES=1
# export XM_FROST_WITH_UNCOMMITTED_CHANGES=1
#
# For use in Actions, and perhaps to adapt the functionality of the PDF/HTML/SERVE buttons
#
# export XM_COMPILE_SEQUENCE=draft.html # which output to generate, eg "handout.pdf,draft.html"
# export XM_TO_PROCESS=aFirstXourse.tex # only build/frost/serve these files/courses
# export XM_CONFIGFILE=more.cfg # exotic: if you want to use a different TeX4ht config file
# export XM_SETTINGSFILE=config.lua # yet another way to set some options/Settings
# export XM_ONLY_CHECK=1 # do not actually compile/clean anything (NOT IMPLEMENTED for frost/serve!)
# export XM_FORCE=1 # force build (even if uptodate) and serve (use push -f)
Loading