Skip to content
This repository has been archived by the owner on Jun 24, 2021. It is now read-only.

CSS Reference for v.11 should be hosted together with JavaDocs #213

Closed
eugener opened this issue Sep 22, 2018 · 10 comments
Closed

CSS Reference for v.11 should be hosted together with JavaDocs #213

eugener opened this issue Sep 22, 2018 · 10 comments
Labels
documentation Updates or additions to documentation

Comments

@eugener
Copy link
Collaborator

eugener commented Sep 22, 2018

For v.10 it is hosted at
https://docs.oracle.com/javase/10/docs/api/javafx/scene/doc-files/cssref.html

@eugener eugener added the documentation Updates or additions to documentation label Sep 22, 2018
@eugener eugener changed the title CSS reference for v.11 should be hosted together with JavaDocs CSS Reference for v.11 should be hosted together with JavaDocs Sep 22, 2018
@DJViking
Copy link

See if there is anything that can be done with Google when searching for the JavaFX CSS.
Unless specifying the JavaFX version, the top most results is for JavaFX 2, then JavaFX 8.
One need to search explicit for "JavaFX 10 CSS" to get the latest.
https://www.google.com/search?q=JavaFX%20CSS
https://www.google.com/search?q=JavaFX%208%20CSS
https://www.google.com/search?q=JavaFX%209%20CSS
https://www.google.com/search?q=JavaFX%2010%20CSS

@kevinrushforth
Copy link
Collaborator

kevinrushforth commented Sep 22, 2018

The css reference is already part of the online javadocs for each release. For JavaFX 11, it is here:
https://openjfx.io/javadoc/11/javafx.graphics/javafx/scene/doc-files/cssref.html

@kevinrushforth
Copy link
Collaborator

Not sure what we can do about Google's search results, though...

@kevinrushforth
Copy link
Collaborator

Btw, the CSS Reference Guide is linked from the description of the javafx.css package docs, among other places:

@eugener
Copy link
Collaborator Author

eugener commented Sep 22, 2018

Would it make sense to refer to it directly from the javafx 11 release site?

@kevinrushforth
Copy link
Collaborator

Not sure. It's been linked from the javafx.css package docs in the javadocs since JavaFX 8. If you think most people don't know that, it could be useful to provide a link from the release site. Of course you could say the same think about the FXML reference (which is linked from the javafx.fxml package docs).

@eugener
Copy link
Collaborator Author

eugener commented Sep 22, 2018

In any case it is easy to do. Will add if we have an agreement from few people here

@DJViking
Copy link

There is no result for the JavaFX 11 CSS Reference.
https://www.google.com/search?q=JavaFX%2011%20CSS%20Reference

Unless people know exactly where to find it, they would have a hard time getting to it. This is specially so for new developers. When I need to look at the reference I just google it, but now I probably need a bookmark to get to the 11 version. I tried to see if I could browse to it from http://openjfx.io/javadoc/11, but that was not easy. First you need to know which module the CSS Reference is in, then which package. The CSS Reference is mentioned at the end of the package description.

@nlisker
Copy link

nlisker commented Sep 23, 2018

I always go to the FXML/CSS references from the tutorial page. Because it's not a JavaDoc, I think it could use its own place.

@kevinrushforth
Copy link
Collaborator

I don't think hosting it separately is the answer, since it only has meaning in connection with the JavaFX API and is tied with the particular version of JavaFX. Having a pointer to it from the release site would be fine, and based on the few comments here, seems useful.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
documentation Updates or additions to documentation
Projects
None yet
Development

No branches or pull requests

4 participants