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

HTML version feature: Quick access to struct definition #6

Open
leikareipa opened this issue Sep 27, 2019 · 0 comments
Open

HTML version feature: Quick access to struct definition #6

leikareipa opened this issue Sep 27, 2019 · 0 comments

Comments

@leikareipa
Copy link

leikareipa commented Sep 27, 2019

Thanks for the good documentation, very useful when mucking about the games' assets.

One additional feature I think could be useful in the HTML version is some manner of quick access to a struct's (e.g. tr_room_info) definition from where the struct is mentioned inside a pseudocode block. For instance, while working through section 10 of the documentation (.PHD file layout), I kept a couple of extra browser tabs open to manually copy/paste/find struct definitions. While I may have been doing it wrong, it was in any case the workflow I adopted given the circumstances, and it was a bit tedious.

Being able to click a link in the pseudocode would've been quite handy. A further option might be to have the struct definition pop up on mouse hover, like e.g. Wikipedia does with its links. Also, since structs tend to be nested inside other structs, an expandable tree structure might another way to go - i.e. clicking on a symbol next to the struct's name expands out the struct's contents, and same for any structs inside there.

(I see that where a struct is mentioned outside of a code block, a direct link to its definition is provided; so maybe there's some technical reason involved for why code blocks include no links.)

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

No branches or pull requests

1 participant