Skip to content

Commit 42b153b

Browse files
Wim3000Wim3000
committed
update README
1 parent bdc2697 commit 42b153b

File tree

4 files changed

+93
-61
lines changed

4 files changed

+93
-61
lines changed

‎README.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,10 @@ This repo contains basic examples of Ximera constructs that can be used as
22
* demo
33
* tests
44

5+
The main branch is published [here](https://set-p-dsb-zomercursus-latest.cloud-ext.icts.kuleuven.be/ximeraexamples/coreXimeraFeatures/environments/theoremEnvironments).
56

7+
Note you can always get the TeX-code by appending .tex to the URL of an activity.
68

79

10+
A more detailed description of how to use this repo for testing is in the [README_testing](README_testing.md)
11+

‎README_testing.md‎

Lines changed: 87 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,87 @@
1+
Testing session:
2+
3+
* Fork, clone and checkout your copy of ximeraExamples
4+
```
5+
~/git/ximera/ximeraExamples$ git pull
6+
Already up to date.
7+
```
8+
* Create a new branch for your new development/test (optional)
9+
* The new branch is only needed if you foresee to make new test, or adapt existing ones
10+
```
11+
~/git/ximera/ximeraExamples$ git checkout -b test-link
12+
Switched to a new branch 'test-link'
13+
```
14+
15+
* Setup the test/development version:
16+
* if testing a dockerimage, update config.txt(local PC) or docker_compose.yml (in Codespace)
17+
* if you need to change the contents of the dockerimage, use xmlatex copySettingLocal to create a .ximera_local
18+
* if testing an existing ximeraLatex branch (perhaps on a clone somewhere) : check it out in .ximera_local
19+
* if making new changes to ximeraLatex: fork, clone, and checkout a new branch
20+
21+
```
22+
~/git/ximera/ximeraExamples$ git clone https://github.com/bartsnapp/ximeraLatexFrameDev.git .ximera_local
23+
Cloning into '.ximera_local'...
24+
remote: Enumerating objects: 4273, done.
25+
remote: Counting objects: 100% (284/284), done.
26+
remote: Compressing objects: 100% (92/92), done.
27+
remote: Total 4273 (delta 208), reused 193 (delta 192), pack-reused 3989 (from 3)
28+
Receiving objects: 100% (4273/4273), 6.12 MiB | 4.84 MiB/s, done.
29+
Resolving deltas: 100% (2753/2753), done.
30+
```
31+
* Use, update or create a relevant test
32+
* you can use the VSCode 'PDF' or 'HTML' buttons, or the xmlatex script (see infra)
33+
* not the 'USING .ximera_local from local repo' line in the output when you made a .ximera_local
34+
* the .log file wiyll contain detailed info about which files where actually used/included
35+
```
36+
~/git/ximera/ximeraExamples$ xmlatex ghaction testXourses.TODO/linkTest.tex
37+
Restarting myself in docker (from image ghcr.io/ximeraproject/ximeralatex:v2.7.0)
38+
Starting /usr/local/bin/xmlatex ghaction testXourses.TODO/linkTest.tex (on host docker-desktop, i.e. inside a docker container)
39+
USING .ximera_local from local repo
40+
Starting Github-action build (name; bake/frost/serve)
41+
[INFO ] main : Set compile_sequence=pdf,html (and output_formats=pdf,html)
42+
[INFO ] main : Processing argument 1: testXourses.TODO/linkTest.tex
43+
[INFO ] files: Marked source tex NO_COMPILATION for examples.TODO/links/links.tex
44+
[INFO ] files: Marked source tex NEEDS_COMPILATIONS for testXourses.TODO/linkTest.tex
45+
[STATUS ] main : 1 file needs compiling: testXourses.TODO/linkTest.tex
46+
[STATUS ] main : Start bake
47+
[INFO ] bake : Added 2 compile commands for file 1/1: testXourses.TODO/linkTest.tex
48+
[STATUS ] bake : There are 2 commands to run for 1 files
49+
[STATUS ] bake : Command 1/2 (1) starting for pdf of testXourses.TODO/linkTest.tex (pdf|testXourses.TODO/linkTest.tex)
50+
[STATUS ] bake : Command 2/2 (2) starting for html of testXourses.TODO/linkTest.tex (html|testXourses.TODO/linkTest.tex)
51+
[STATUS ] bake : Command 2/2 (2) returns OK after 7.5 seconds (0 failed) for html of testXourses.TODO/linkTest.tex
52+
[INFO ] bake : Command html|testXourses.TODO/linkTest.tex scheduled for RETRY (was job 2 (2))
53+
[STATUS ] bake : Command 2r/2 (2) starting for html of testXourses.TODO/linkTest.tex (html|testXourses.TODO/linkTest.tex)
54+
[INFO ] bake : Moving /code/testXourses.TODO/linkTest.pdf to ximera-downloads/with-answers/testXourses.TODO/linkTest.pdf
55+
[STATUS ] bake : Command 1/2 (1) returns OK after 10.0 seconds (0 failed) for pdf of testXourses.TODO/linkTest.tex
56+
[INFO ] html : No parts found, adding one, as this is needed in (some versions of) the ximeraServer
57+
[INFO ] html : Adapted html being saved as testXourses.TODO/linkTest.html (/code/testXourses.TODO/linkTest.html)
58+
[STATUS ] bake : Command 2r/2 (2) returns OK after 5.0 seconds (0 failed) for html of testXourses.TODO/linkTest.tex
59+
[STATUS ] bake : Finished compiling 1 files in 13.6 seconds
60+
[STATUS ] main : Bake succeeded: Baked 1 files, no errors found
61+
[INFO ] main : Mmm, file testXourses.TODO/linkTest.tex still needs compilation.
62+
[INFO ] main : Still 1 files to be compiled after bake.
63+
[STATUS ] main : Start frost
64+
[WARNING] frost: There are 2 uncommitted files; should serve only to localhost
65+
[WARNING] frost: There are 1 file to be compiled; should serve only to localhost
66+
[INFO ] frost: Adding XOURSE testXourses.TODO/linkTest.tex (Master link Test Xourse)
67+
[INFO ] frost: Found publications/0333286ab0e4c1ceb1046418afcc88032080ff59 (tree:e58298d99203d801017d707c551651ab53fdce1f tag:0333286ab0e4c1ceb1046418afcc88032080ff59)
68+
[STATUS ] frost: Creating tag publications/a40cd692e6e6af56fd0ce8fc37f7db318d567d35 for a40cd692e6e6af56fd0ce8fc37f7db318d567d35
69+
[STATUS ] main : Frost succeeded: Created publications/a40cd692e6e6af56fd0ce8fc37f7db318d567d35
70+
[STATUS ] main : Start serve
71+
[INFO ] frost: Publishing to localhost: http://localhost:2000/ximeraexamples.git
72+
[STATUS ] frost: Forced serving (git push -f ximera publications/a40cd692e6e6af56fd0ce8fc37f7db318d567d35)
73+
[STATUS ] frost: Forced serving (git push -f ximera a40cd692e6e6af56fd0ce8fc37f7db318d567d35:refs/heads/master)
74+
[STATUS ] main : Serve succeeded: Published publications/a40cd692e6e6af56fd0ce8fc37f7db318d567d35to http://localhost:2000/ximeraexamples
75+
```
76+
* Verify the output
77+
78+
* If yoy make useful changes in .ximera_local: commit and push, make a pull request for ximeraLatex
79+
* If you make useful changes in ximeraExamples: commit an push, make a pull request for ximeraExamples
80+
* when in doubt, or when this procedure does not work as advertized: contact ximera-project!
81+
82+
83+
![screenshot expected output](../xmPictures/screenshot_links.png)
84+
85+
86+
87+

‎link/README.md‎

Lines changed: 1 addition & 60 deletions
Original file line numberDiff line numberDiff line change
@@ -1,63 +1,4 @@
1-
Testing session:
2-
3-
```
4-
5-
wiobb@GHUM-L-EJ305KR2:~/git/ximera/ximeraExamples$ git pull
6-
Already up to date.
7-
8-
wiobb@GHUM-L-EJ305KR2:~/git/ximera/ximeraExamples$ git checkout -b test-link
9-
Switched to a new branch 'test-link'
10-
11-
wiobb@GHUM-L-EJ305KR2:~/git/ximera/ximeraExamples$ git clone https://github.com/bartsnapp/ximeraLatexFrameDev.git .ximera_local
12-
Cloning into '.ximera_local'...
13-
remote: Enumerating objects: 4273, done.
14-
remote: Counting objects: 100% (284/284), done.
15-
remote: Compressing objects: 100% (92/92), done.
16-
remote: Total 4273 (delta 208), reused 193 (delta 192), pack-reused 3989 (from 3)
17-
Receiving objects: 100% (4273/4273), 6.12 MiB | 4.84 MiB/s, done.
18-
Resolving deltas: 100% (2753/2753), done.
19-
20-
wiobb@GHUM-L-EJ305KR2:~/git/ximera/ximeraExamples$ xmlatex ghaction testXourses.TODO/linkTest.tex
21-
Restarting myself in docker (from image ghcr.io/ximeraproject/ximeralatex:v2.7.0)
22-
Starting /usr/local/bin/xmlatex ghaction testXourses.TODO/linkTest.tex (on host docker-desktop, i.e. inside a docker container)
23-
USING .ximera_local from local repo
24-
Starting Github-action build (name; bake/frost/serve)
25-
[INFO ] main : Set compile_sequence=pdf,html (and output_formats=pdf,html)
26-
[INFO ] main : Processing argument 1: testXourses.TODO/linkTest.tex
27-
[INFO ] files: Marked source tex NO_COMPILATION for examples.TODO/links/links.tex
28-
[INFO ] files: Marked source tex NEEDS_COMPILATIONS for testXourses.TODO/linkTest.tex
29-
[STATUS ] main : 1 file needs compiling: testXourses.TODO/linkTest.tex
30-
[STATUS ] main : Start bake
31-
[INFO ] bake : Added 2 compile commands for file 1/1: testXourses.TODO/linkTest.tex
32-
[STATUS ] bake : There are 2 commands to run for 1 files
33-
[STATUS ] bake : Command 1/2 (1) starting for pdf of testXourses.TODO/linkTest.tex (pdf|testXourses.TODO/linkTest.tex)
34-
[STATUS ] bake : Command 2/2 (2) starting for html of testXourses.TODO/linkTest.tex (html|testXourses.TODO/linkTest.tex)
35-
[STATUS ] bake : Command 2/2 (2) returns OK after 7.5 seconds (0 failed) for html of testXourses.TODO/linkTest.tex
36-
[INFO ] bake : Command html|testXourses.TODO/linkTest.tex scheduled for RETRY (was job 2 (2))
37-
[STATUS ] bake : Command 2r/2 (2) starting for html of testXourses.TODO/linkTest.tex (html|testXourses.TODO/linkTest.tex)
38-
[INFO ] bake : Moving /code/testXourses.TODO/linkTest.pdf to ximera-downloads/with-answers/testXourses.TODO/linkTest.pdf
39-
[STATUS ] bake : Command 1/2 (1) returns OK after 10.0 seconds (0 failed) for pdf of testXourses.TODO/linkTest.tex
40-
[INFO ] html : No parts found, adding one, as this is needed in (some versions of) the ximeraServer
41-
[INFO ] html : Adapted html being saved as testXourses.TODO/linkTest.html (/code/testXourses.TODO/linkTest.html)
42-
[STATUS ] bake : Command 2r/2 (2) returns OK after 5.0 seconds (0 failed) for html of testXourses.TODO/linkTest.tex
43-
[STATUS ] bake : Finished compiling 1 files in 13.6 seconds
44-
[STATUS ] main : Bake succeeded: Baked 1 files, no errors found
45-
[INFO ] main : Mmm, file testXourses.TODO/linkTest.tex still needs compilation.
46-
[INFO ] main : Still 1 files to be compiled after bake.
47-
[STATUS ] main : Start frost
48-
[WARNING] frost: There are 2 uncommitted files; should serve only to localhost
49-
[WARNING] frost: There are 1 file to be compiled; should serve only to localhost
50-
[INFO ] frost: Adding XOURSE testXourses.TODO/linkTest.tex (Master link Test Xourse)
51-
[INFO ] frost: Found publications/0333286ab0e4c1ceb1046418afcc88032080ff59 (tree:e58298d99203d801017d707c551651ab53fdce1f tag:0333286ab0e4c1ceb1046418afcc88032080ff59)
52-
[STATUS ] frost: Creating tag publications/a40cd692e6e6af56fd0ce8fc37f7db318d567d35 for a40cd692e6e6af56fd0ce8fc37f7db318d567d35
53-
[STATUS ] main : Frost succeeded: Created publications/a40cd692e6e6af56fd0ce8fc37f7db318d567d35
54-
[STATUS ] main : Start serve
55-
[INFO ] frost: Publishing to localhost: http://localhost:2000/ximeraexamples.git
56-
[STATUS ] frost: Forced serving (git push -f ximera publications/a40cd692e6e6af56fd0ce8fc37f7db318d567d35)
57-
[STATUS ] frost: Forced serving (git push -f ximera a40cd692e6e6af56fd0ce8fc37f7db318d567d35:refs/heads/master)
58-
[STATUS ] main : Serve succeeded: Published publications/a40cd692e6e6af56fd0ce8fc37f7db318d567d35to http://localhost:2000/ximeraexamples
59-
60-
```
1+
Screenshot of output:
612

623
![screenshot expected output](../xmPictures/screenshot_links.png)
634

‎link/link.tex‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
\title{Links}
44

5-
\author{Bart Snapp}
5+
\author{Bart Snapp and Wim Obbels}
66

77
\begin{document}
88
\begin{abstract}

0 commit comments

Comments
 (0)