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

Jump to bottom

Preserving state/linking to ScalaDoc #4473

Closed
scabug opened this issue Apr 12, 2011 · 5 comments
Closed

Preserving state/linking to ScalaDoc #4473

scabug opened this issue Apr 12, 2011 · 5 comments
Assignees
@lindydonna
Labels
enhancement scaladoc tool

Comments

@scabug
Copy link

scabug commented Apr 12, 2011

= problem =
There is no way (afaik) to link to a particular class. A workaround seems to be the direct linking of the right frame, which results in loosing the navigation on the left side. (Which makes it necessary to open the frame in a new tab first, to be able to get the address of it.)

= analysis =
I guess using frames is part of the problem, but I can't see an easy solution for that.

= enhancement recommendation =
It would be nice to push the current page to the address bar in the browser, so that it is possible to copy'and'paste that address and use it as a link.

Additionally there should be a way to link not only to a class, but also to a certain part of it, like the description or a specific method.

Also the state should be preserved, e. g. the text entered in the search fields, elements collapsed/expanded, state of the Ordering/Inherited/Visibility buttons to improve usability.
@scabug
Copy link
Author

scabug commented Apr 12, 2011

Imported From: https://issues.scala-lang.org/browse/SI-4473?orig=1
Reporter: @soc
Attachments:

@scabug
Copy link
Author

scabug commented Apr 12, 2011

Rüdiger Keller (ruedigerk) said:
I will prepare a patch for addressing the linking issues.

Although I will not address the state saving suggestion as I don't think it's worth the effort.

@scabug
Copy link
Author

scabug commented Apr 14, 2011

@lindydonna said:
I agree that the state-saving would be too much effort for not much return.

@scabug
Copy link
Author

scabug commented Apr 14, 2011

Rüdiger Keller (ruedigerk) said:
I now added a little url fragment magic via js, which goes a long way toward solving this issue.

What this patch doesn't solve though:

  • Better discoverability of method anchors (they were already in there, all along, but they are only findable by inspecting the html).
  • Adding the frame on the left, when opening a normally embedded page directly. This could be done automatically by JS, or there could be a link to click.

@scabug
Copy link
Author

scabug commented Apr 19, 2011

@lindydonna said:
(In r24784) [scaladoc] Change URL when navigating Scaladoc, so as to allow linking to individual pages with the left frame intact. Patch submitted by Ruediger Keller. Closes #4473. No review.

@scabug scabug closed this as completed May 18, 2011
@scabug scabug mentioned this issue Apr 7, 2017
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@lindydonna lindydonna

Labels
enhancement scaladoc tool
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@lindydonna @scabug