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

Fix missing inclusion of libraries in graphdrawing examples #1335

Open
wants to merge 6 commits into
base: master
Choose a base branch
from

Conversation

hansonchar
Copy link

@hansonchar hansonchar commented May 31, 2024

Motivation for this change

Some of the examples at https://tikz.dev/gd-trees and https://tikz.dev/gd-usage-tikz don't currently compile with lualatex.

Checklist

Testing

Changes tested successfully on Apple M2.

$ lualatex --version
This is LuaHBTeX, Version 1.18.0 (TeX Live 2024)
Development id: 7611

Prior to this change, the example code would fail with the following log message:

...
! Package pgf Error: Unknown arrow tip kind 'Stealth'.

See the pgf package documentation for explanation.
Type  H <return>  for immediate help.
 ...

l.78 \tikz [>={Stealth[round,sep]}]

Local building of build/doc/pgfmanual.pdf

export tagname=$(git describe --abbrev=0 --tags)
export revision=$(git describe --tags)
export tagdate=$(git log -n 1 "$tagname" --pretty=format:%cs)
export revisiondate=$(git log -n 1 "$revision" --pretty=format:%cs)
l3build tag --date "$tagdate" "$tagname"
l3build doc -q

hansonchar added a commit to hansonchar/pgf that referenced this pull request Jun 6, 2024
@hansonchar hansonchar changed the title Fix missing inclusion of three libraries in one of the examples at https://tikz.dev/gd-trees Fix missing inclusion of libraries in the examples at https://tikz.dev/gd-trees and and https://tikz.dev/gd-usage-tikz Jun 6, 2024
@hansonchar hansonchar changed the title Fix missing inclusion of libraries in the examples at https://tikz.dev/gd-trees and and https://tikz.dev/gd-usage-tikz Fix missing inclusion of libraries in the examples at https://tikz.dev/gd-trees and https://tikz.dev/gd-usage-tikz Jun 6, 2024
Signed-off-by: Hanson Char <[email protected]>
hansonchar added a commit to hansonchar/pgf that referenced this pull request Jun 7, 2024
@muzimuzhi muzimuzhi changed the title Fix missing inclusion of libraries in the examples at https://tikz.dev/gd-trees and https://tikz.dev/gd-usage-tikz Fix missing inclusion of libraries in graphdrawing examples Jun 8, 2024
doc/generic/pgf/CHANGELOG.md Outdated Show resolved Hide resolved
tex/generic/pgf/graphdrawing/lua/pgf/gd/control/doc.lua Outdated Show resolved Hide resolved
@Mo-Gul
Copy link
Contributor

Mo-Gul commented Jun 9, 2024

Sorry @muzimuzhi, took a bit longer, but now I have shed some light again into this issue.

@hansonchar is right that there are missing occurrences of needed libraries. All of that started in issue #640. But at some point a question arose which (unfortunately) never was answered. So the work didn't continue.

When I remember correctly, the most important point why the work didn't continue was, that the extract.lua isn't able to also extract the "example"/"examples" in the Lua documentation (like the ones modified in the PR). This would help a lot, because it would enable (semi-)automatic testing. Unfortunately I don't have any clue about Lua programming :(

There are much more examples lacking libraries. See e.g. PR #883 which isn't merged yet (reason unknown anymore). And there is also Mo-Gul@af40f01 which could be cherry-picked. And it is very likely that there will be missing even more. If only extract.lua would handle these examples, too ... ;)

Please also note that the "extractor scripts" (Bash version and PowerShell version) need to be adapted to work after the "flattening of the file structure" ...

@hansonchar
Copy link
Author

hansonchar commented Jun 10, 2024

This PR is tangentially related to #1339

I think we can make small, incremental changes iteratively, instead of blocking these changes (that absolutely improve the pgfmanual) on the basis of the lack of a perfect solution.

What do you think?

In any case, I'll try to take a look at the extractor script problems later on. One step/issue at a time.

@hansonchar
Copy link
Author

hansonchar commented Jun 24, 2024

As an interesting trivia, I think I've found where the name Kellermann originated from. Till Tantau's implementation of the Tree Layouts follows the paper "A. Brüggemann-Klein, D. Wood, Drawing trees nicely with TEX, Electronic Publishing, 2(2), 101–115, 1989.", and "Kellermann" with double n's are given in Figure 10-12 in that paper, where "Kellermann" has a total occurrence of five times.

Copy link
Contributor

@Mo-Gul Mo-Gul left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me.

About "Kellerman" vs. "Kellermann": On that you have to agree with the others.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

4 participants