Skip to content

HTML version feature: Quick access to struct definition #6

@leikareipa

Description

@leikareipa

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.)

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions