Skip to content

Commit 639bfd9

Browse files
Wim3000Wim3000
committed
Update devenv v2.6.8
1 parent e4f9452 commit 639bfd9

File tree

7 files changed

+167
-83
lines changed

7 files changed

+167
-83
lines changed

‎.devcontainer/docker-compose.yml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
services:
22
app:
3-
image: ghcr.io/ximeraproject/xake2024:v2.4.2
4-
# image: ghcr.io/ximeraproject/xake2024:v2.4.2-full
3+
image: ghcr.io/ximeraproject/ximeralatex:v2.6.8
4+
# image: ghcr.io/ximeraproject/ximeralatex:v2.6.8-full
55
volumes:
66
# This is where VS Code should expect to find your project's source code and the value of "workspaceFolder" in .devcontainer/devcontainer.json
77
- ..:/code:cached

‎.gitignore‎

Lines changed: 21 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,29 @@
11
## Ignore.xmKeyFile (contains dummy key, but potential real key should probably never be committed)
2-
*.xmKeyFile*
2+
.xmKeyFile*
33
## Don't push ximeraserve (Obsolete now: till 11/2024 used instead of .xmKeyFile)
44
*.ximeraserve*
55
#
66
## Graphics - recommend to be ignored, as TikZ-generated pictures should NOT be committed
77
*.svg
88
*.png
9+
*.svg
910
*.pdf
1011
## Folder xmPictures is in the graphicspath, and should contain the pictures used in \includegraphics
11-
## So in xmPictures things presumably must be committed
12-
xmPictures/*
13-
!xmPictures/*.jpg
14-
!xmPictures/*.pdf
15-
!xmPictures/*.png
16-
## Note: capital .JPG.PDF/PNG should better NOT be used ...
17-
!xmPictures/*.JPG
18-
!xmPictures/*.PDF
19-
!xmPictures/*.PNG
12+
## So png,svg,pdf,jpg in (subfolders of) xmPictures presumably must be committed
13+
## but everything else in there should be ignored
14+
xmPictures/**
15+
!xmPictures
16+
!xmPictures/**/
17+
!xmPictures/**/*.jpg
18+
!xmPictures/**/*.svg
19+
!xmPictures/**/*.pdf
20+
!xmPictures/**/*.png
21+
!xmPictures/**/*.tex
22+
## Note: capital JPG/PDF/PNG should NOT be used ...
23+
!xmPictures/**/*.JPG
24+
!xmPictures/**/*.SVG
25+
!xmPictures/**/*.PDF
26+
!xmPictures/**/*.PNG
2027
## Core latex/pdflatex auxiliary files:
2128
*.aux
2229
*.lof
@@ -299,7 +306,10 @@ Thumbs.db
299306

300307
# For exam-stuff ... ?
301308
ans[0-9]*.tex
309+
310+
302311
*.jax
312+
*.xmjax
303313
*.ids
304314
*.oc
305315

@@ -311,6 +321,7 @@ metadata.json
311321
# multiwrite latex
312322
*.mw
313323
*.dlog
324+
*.failed
314325

315326
# ximera-download contains (downloadable!) PDF's generated by xake (bakehanout/bakestandaard)
316327
ximera-downloads

‎.vscode/settings.json‎

Lines changed: 38 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -25,9 +25,11 @@
2525
// Terrible HACK to get PATH expanded, so that also when NOT in a container, 'xmlatex' is found
2626
// (This is only needed to make 'build' work, e.g. via F5 or the green 'Build LaTeX project' icon)
2727
// Note: when run from OUTSIDE a container, the (full) path INSIDE the container will be different !!!!
28+
// WARNING: in the root_folder %RELATIVE_DIR is empty, and you'll process .//myfile.tex ...
29+
// (Removing the ./ infra would give wrong path /myfile.tex )
2830
"args": [
2931
"-c",
30-
"cd %WORKSPACE_FOLDER%; export DEBUG=\"$DEBUG\" PATH=\"$PATH:%WORKSPACE_FOLDER%/xmScripts\"; xmlatex $DEBUG compilePdf ./%RELATIVE_DIR%/%DOCFILE_EXT%"
32+
"cd %WORKSPACE_FOLDER%; export DEBUG=\"$DEBUG\" PATH=\"$PATH:%WORKSPACE_FOLDER%/xmScripts\"; xmlatex $DEBUG bake --force --compile pdf ./%RELATIVE_DIR%/%DOCFILE_EXT%"
3133
],
3234
"env": {
3335
"DEBUG": "",
@@ -62,7 +64,7 @@
6264
{
6365
"label": "SERVE",
6466
"alignment": "right",
65-
"task": "All",
67+
"task": "SERVE",
6668
"description": "Build and publish this project.",
6769
"tooltip": "Build and publish this repo."
6870
},
@@ -79,9 +81,17 @@
7981
{
8082
"task": "Preview in Simple Browser",
8183
"label": "Preview in Simple Browser",
84+
"description": "View the local webserver in a preview window",
8285
// "description": "Start local Ximera webserver.",
8386
"problemMatcher": [],
87+
},
88+
{
89+
"task": "Delete all",
90+
"label": "Delete all HTML and PDFs",
91+
"description": "Remove all generated files",
92+
"problemMatcher": [],
8493
},
94+
8595
{
8696
"label": "Bake",
8797
"alignment": "right",
@@ -90,9 +100,15 @@
90100
"tooltip": "Bake this project."
91101
},
92102
{
93-
"task": "Bake standard",
94-
"label": "Bake standard PDFs (with answers)",
95-
"description": "Make full PDF's. ('standaard')",
103+
"task": "Bake pdf",
104+
"label": "Bake PDF's (with answers)",
105+
"description": "Make PDF's.",
106+
"problemMatcher": [],
107+
},
108+
{
109+
"task": "Bake pdf (force rebuild)",
110+
"label": "Force (re-)Bake PDF's (with answers)",
111+
"description": "Make PDF's.",
96112
"problemMatcher": [],
97113
},
98114
{
@@ -101,11 +117,24 @@
101117
"description": "Make handout PDF's.",
102118
"problemMatcher": [],
103119
},
120+
{
121+
"task": "Bake handout (fore rebuild)",
122+
"label": "Force (re-)Bake handout PDF's (without answers)",
123+
"description": "Make handout PDF's.",
124+
"problemMatcher": [],
125+
},
126+
{
127+
"label": "Frost",
128+
"alignment": "right",
129+
"task": "Frost",
130+
"description": "Frost this project.",
131+
"tooltip": "Frost this project."
132+
},
104133
{
105134
"label": "Serve",
106135
"alignment": "right",
107136
"task": "Serve",
108-
"description": "Serve this project (does also 'frost', but no 'bake').",
137+
"description": "Serve this project.",
109138
"tooltip": "Serve this project."
110139
},
111140
{
@@ -115,18 +144,9 @@
115144
"problemMatcher": [],
116145
},
117146
{
118-
"task": "Delete standard",
119-
"label": "Delete all standard PDFs",
120-
"problemMatcher": [],
121-
},
122-
{
123-
"task": "Delete handout",
124-
"label": "Delete all handout PDFs",
125-
"problemMatcher": [],
126-
},
127-
{
128-
"task": "Delete all",
129-
"label": "Delete all HTML and PDFs",
147+
"task": "Generate GPG key",
148+
"label": "Generate a (new) GPG key",
149+
"description": "First add your name/email to config.txt",
130150
"problemMatcher": [],
131151
},
132152
],

‎.vscode/tasks.json‎

Lines changed: 46 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -12,39 +12,51 @@
1212
{
1313
"label": "PDF",
1414
"args": [
15-
"compilePdf",
15+
"bake",
16+
"-s",
17+
"--force",
18+
"--compile pdf",
1619
"${relativeFile}"
1720
],
1821
},
1922
{
2023
"label": "HTML",
2124
"args": [
22-
"--",
23-
"--skip-mathjax",
24-
"compile",
25+
"bake",
26+
"-s",
27+
"--force",
28+
"--compile html",
2529
"${relativeFile}"
2630
],
2731
},
2832
{
29-
"label": "Bake",
33+
"label": "SERVE",
3034
"args": [
31-
"--",
32-
"--skip-mathjax",
33-
"bake"
35+
"all",
36+
"-s",
3437
],
3538
},
3639
{
37-
"label": "All",
40+
"label": "Bake",
3841
"args": [
39-
"-d", "all"
42+
"-v",
43+
"bake"
4044
],
4145
},
4246
{
4347
"label": "Serve",
4448
"args": [
49+
"-v",
4550
"serve"
4651
],
47-
},
52+
},
53+
{
54+
"label": "Frost",
55+
"args": [
56+
"-v",
57+
"frost"
58+
],
59+
},
4860
{
4961
"label": "Start Ximera Server",
5062
"args": [
@@ -56,33 +68,41 @@
5668
"command": "${input:openSimpleBrowser}",
5769
},
5870
{
59-
"label": "Bake standard",
71+
"label": "Bake PDF",
6072
"args": [
61-
"bakestandaard"
73+
"bake",
74+
"-d",
75+
"--compile pdf",
6276
],
6377
},
6478
{
65-
"label": "Bake handout",
79+
"label": "Bake PDF (force rebuild)",
6680
"args": [
67-
"bakehandout"
81+
"bake",
82+
"-d",
83+
"-f",
84+
"--compile pdf",
6885
],
6986
},
7087
{
71-
"label": "Delete standard",
88+
"label": "Bake handout",
7289
"args": [
73-
"cleanstandaard"
90+
"bake",
91+
"--compile handout.pdf",
7492
],
7593
},
7694
{
77-
"label": "Delete handout",
95+
"label": "Bake handout (force rebuild)",
7896
"args": [
79-
"cleanhandout"
97+
"bake",
98+
"-f",
99+
"--compile handout.pdf",
80100
],
81101
},
82102
{
83103
"label": "Delete all",
84104
"args": [
85-
"clean"
105+
"veryclean"
86106
],
87107
},
88108
{
@@ -91,6 +111,12 @@
91111
"updateDevEnv"
92112
],
93113
},
114+
{
115+
"label": "Generate GPG key",
116+
"args": [
117+
"genKey"
118+
],
119+
},
94120
],
95121
"inputs": [
96122
{

‎xmScripts/config.txt‎

Lines changed: 28 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,29 @@
11
#
22
# version of Ximera xake container to use (with xmlatex)
33
#
4-
# : "${XAKE_BASE:=xake2024}"
5-
# : "${XAKE_VERSION:=v2.4.2}"
6-
## Alternatives:
7-
# : "${XAKE_VERSION:=v2.4.2-full}" # with texlive_full
8-
# : "${XAKE_BASE:=xake2023}" # with older tex/xake
9-
# : "${XAKE_VERSION:=v2.1.3_a}" # obsolete
10-
4+
# : "${XAKE_BASE:=ximeralatex}"
5+
# : "${XAKE_VERSION:=v2.6.8}"
6+
# : "${XAKE_VERSION:=v2.6.8-full}" # with texlive_full
7+
#
8+
# For publishing you'll need a GPG Key
9+
# To generate a key-pair, fill in your name and email, and run 'xmlatex genKey'
10+
YOUR_NAME="DUMMY_NAME_TEST"
11+
YOUR_EMAIL="DUMMY_EMAIL_TEST"
1112
#
13+
# Current 'xmlatex genKey' logic:
14+
# if there is no .xmKeyFile, and it is properly .gitignored,
15+
# then the new key will be stored in .xmKeyFile. This is sufficient for initial testing.
1216
#
13-
# For publishing locally, a default key in .xmKeyFile is sufficient.
14-
# For publishing to a publicly available website, you'll need proper keys.
15-
# via Codespaces: connect keys via GitHub Codespaces Secrets
16-
# on your PC: set environment variables, or edit .xmKeyFile
17-
# !! Do NEVER commit real keys to the repo !!
17+
# For use in Codespaces: paste the GPG_KEY and GPG_KEY_ID in GitHub Codespace Secrets
18+
# For use in Github Actions: paste the GPG_KEY and GPG_KEY_ID in GitHub Action Secrets
19+
# For use on your PC: use the .xmKeyFile, or set the environment variables
20+
# !! Do NOT commit a real key to the repo !!
21+
# !! DO NOT SAVE THE KEY IN THIS config.txt FILE !!
1822
#
1923

2024
## : "${XIMERA_NAME:=myreponame}"
2125
## : "${XIMERA_URL:=http://localhost:2000/}"
22-
## : "${XIMERA_URL:=https://ximera.osu.edu}"
26+
## : "${XIMERA_URL:=https://ximera.osu.edu/}"
2327
## : "${XIMERA_URL:=https://set-p-dsb-zomercursus-latest.cloud-ext.icts.kuleuven.be/}"
2428
## : "${XIMERA_URL:=https://set.kuleuven.be/voorkennis/}"
2529

@@ -40,4 +44,14 @@
4044
# for LOCALLY generated/tagged images, use:
4145
# export DOCKER_REPO=" "
4246
# export XM_PUSH_FORCE=1
43-
# export XM_FROST_WITH_UNCOMMITTED_CHANGES=1
47+
# export XM_FROST_WITH_UNCOMMITTED_CHANGES=1
48+
49+
#
50+
# For use in Actions, and perhaps to adapt the functionality of the PDF/HTML/SERVE buttons
51+
#
52+
# export XM_COMPILE_SEQUENCE=html # which output to generate, eg "pdf,handout.pdf,html"
53+
# export XM_TO_PROCESS=aFirstXourse.tex # only build/frost/serve these files/courses
54+
# export XM_CONFIGFILE=more.cfg # exotic: if you want to use a different TeX4ht config file
55+
# export XM_SETTINGSFILE=config.lua # yet another way to set some options/Settings
56+
# export XM_ONLY_CHECK=1 # do not actually compile/clean anything (NOT IMPLEMENTED for frost/serve!)
57+
# export XM_FORCE=1 # force build (even if uptodate) and serve (use push -f)

0 commit comments

Comments
 (0)