Skip to content

Suggestion for 2 slight changes to docs CSS (for better clarity/readability) #10925

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

Merged
merged 1 commit into from
Mar 6, 2017
Merged

Suggestion for 2 slight changes to docs CSS (for better clarity/readability) #10925

merged 1 commit into from
Mar 6, 2017

Conversation

jostschmithals
Copy link
Contributor

I reverted this from my work on the animation docs and made this extra PR instead (as @looeee suggested (1020fda#r104101289).

I think, clarity/readability becomes relevant when a page contains many and relative long paragraphs (as for example the AnimationAction.html in #10911 ).

@mrdoob
Copy link
Owner

mrdoob commented Mar 5, 2017

Do you mind attaching here before and after screenshots? 😅

@jostschmithals
Copy link
Contributor Author

Here the desired before/after screenshots. However, from my point of view the changes become especially relevant when dynamically scrolling through a long page, for example through the 35 properties and methods of AnimationAction.html.

This is the current layout:

current_css

Here the same with the suggested changes:

changed_css

Note: The descriptions (div class="desc") are not affected by the suggested indentations:

descriptions_not_changed

@mrdoob
Copy link
Owner

mrdoob commented Mar 6, 2017

Nice!

@mrdoob mrdoob merged commit 86d0442 into mrdoob:dev Mar 6, 2017
@mrdoob
Copy link
Owner

mrdoob commented Mar 6, 2017

Thanks!

}

div {
/* padding-left: 30px; */
padding-left: 30px;
Copy link
Owner

Choose a reason for hiding this comment

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

I reverted this change though. It messed up the manual pages...

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Oh - sorry!

The manual pages seem to have a partly inconsistent CSS, and when testing the effects of my CSS changes on the manual pages I must have accidentially chosen those that looked good, since they use <div class=”desc“> (such as “Detecting WebGL”) or <p> (such as “Matrix transformations”).

My suggestion:

I would like to unify the “Manual” and “Constant” pages’ CSS by assigning div <class=”desc”> to all paragraphs that shall not be indented. That would be not much work because only a few pages are affected. In this way my CSS changes would have no negative side effects.

Would that be okay?

@jostschmithals jostschmithals deleted the docsCss branch April 27, 2017 14:23
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

Successfully merging this pull request may close these issues.

2 participants