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

Long class names overlap with source file location and go out of bounds #2227

Open
mvriel opened this issue Jan 25, 2020 · 3 comments
Open

Comments

@mvriel
Copy link
Member

mvriel commented Jan 25, 2020

In the default template when there is a lengthy class name, this name may become too long and overlap with the file name in the top right.

Example:

image

This is undesirable and a nice solution should be found on resolving this. Wrapping to the next line may be an option (though, how would you hyphenate), make the text smaller (but wouldn't that be too small?) or moving the source file indicator a little (or the title) are possible solutions.

Unfortunately, trying these out is the only way to determine an aesthetically pleasing solution

@mvriel mvriel added this to the 3.0.0 milestone Jan 25, 2020
@jaapio jaapio added this to Needs triage in phpDoc issue triage board Jan 25, 2020
@ashnazg
Copy link
Member

ashnazg commented Jan 26, 2020

My first thought would be to split the bold classname heading on its CamelCase boundaries, e.g.
Command line
Options
Middleware

@jrfnl
Copy link
Contributor

jrfnl commented Jun 14, 2020

I've ran into this as well.

phpdoc-overlapping-text-bug

I've been playing a little with solutions, but I got the feeling the CSS classes are re-used a lot, which means that it would affect quite a few things when changing anything.

Adding a padding-top of approx 20px to the H2 would work but looks off.

phpdoc-overlapping-text-bug-option-1

An alternative solution would be to move the file reference up to be next to the breadcrumb, that would work fine for the class where I found the issue, but would be problematic for deeply nested classes.

phpdoc-overlapping-text-bug-option-2
phpdoc-overlapping-text-bug-option-2-b

Moving it to above the breadcrumbs could work, but then it starts to feel very disconnected to the class it pertains to.

phpdoc-overlapping-text-bug-option-3

All in all, I haven't found a solution yet which feels right, but wanted to share these experiments.

jrfnl added a commit to jrfnl/phpDocumentor-issue-demo that referenced this issue Jun 15, 2020
@mvriel
Copy link
Member Author

mvriel commented Jun 15, 2020

Thank you for sharing; this is still an ongoing issue and I recognize the considerations that you have. I am starting to wonder if I shouldn't just design this in a completely different location / way. More updates follow :)

@jaapio jaapio removed this from the 3.0.0 milestone Oct 6, 2020
@jaapio jaapio added this to Backlog in v3.2 via automation Nov 6, 2020
@jaapio jaapio removed this from Needs triage in phpDoc issue triage board Nov 6, 2020
@jaapio jaapio added this to To do in v3.4 Dec 28, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
No open projects
v3.2
Backlog
v3.4
Backlog
Development

No branches or pull requests

4 participants