Analyse about links and highlighting in the tutorial about openjfx-docs HOT 3 CLOSED

Generall

• The menu titles should have the number (11) or not in the menu-text, but not confused. Examples
  • Install Java 11, Run HelloWorld using JavaFX 11, JavaFX 11 and IntelliJ...
  • Install Java, Run HelloWorld using JavaFX, JavaFX and IntelliJ...
• Header size is different in for example modular.html and ide-intellij.html

introduction.html

• JavaFX, Java (links to wiki)
• Missing '.' at the end in the first element from the listing.

install-java.html

• JDK (Link to wiki)

install-javafx.html

• This page have 2 main points (installation JavaFX and run example).
• In the view of SoC (Separation of Concerns) this page should be splitted into 2 pages.
  • First page is 'Install JavaFX 11' with the first part like the page 'Install Java'.
  • Then the second page is 'Run HelloWorld via JavaFX 11'

maven.html

• Maven (link to Homepage)

gradle.html

• Maven (link to Homepage)
• Gradle (link to Homepage)
• Download link to 'gradle version 4.10+'?

modular.html

• Headers with 'div-id' to menu are 'h3'. All other headers are 'h4'
• 'Cross-platform jar' is 'h5' <--- 2 times (special reason? why not 'h4'?
• The last 'Command Line' is in 'h3' and have the anchor 'a name="command-line"'.
  • If there a link to this place? The first 'Command Line' is linked to the menu.

ide-intellij.html

• Link to IntelliJ Homepage
• Headers with 'div-id' to menu are 'h4'. All other headers are 'h5'
  • See modular.html
• XY. Add the source code
  • Old: Then add the controller and the FXML and and the css files.
  • New: Then add the controller, the FXML and the css files.

ide-netbeans.html

• Link to NetBeans Homepage
• Typo: You can add a main class Main, based on this one, with an FXML file and a controllercontroller.
  • controller is doubled.
• 'kbd' have ' ' at the end (so the next empty space want compute)

ide-eclipse.html

• Link to Eclipse Homepage
• 'kbd' have ' ' at the end (so the next empty space want compute)
• Gradle 4. Run the project
  • 'Tasks->build->build' normally there are ' ' before and after the '->'

from openjfx-docs.

Summary (what will done):

• Add missing '.'
• Add missing ' ' before/after '->'
• Replace ' </kbd>' with '</kbd>' (no leading ' ')
• Add missing '<span class="JDK_MAJOR">', <span class="JFX_MAJOR">11</span> to the XY '11'.
• Replace the sentence "Then add the controller and the FXML and and the css files." with "Then add the controller, the FXML and the css files."
  • Attention to the link adresses (they are different in every sentence))
• Normalize Header size: Main-Header(Main-Menu)=h2, Sub-Header(Sub-Menu)=h3, Sub-Sub-Header(without Menu entry)=h4

Links

• IDEs to 'Homepage' page.
• IDE version to 'Download' page.
• Tools like Maven, Gradle to 'Homepage'
• Tools version to 'Download' page.

Additional

• Note' have no 'alert alert-warning' box (install-javafx.html)
• Remove not needed 'anchor' tag. Normalize header-size to h4 (modular.html)

New issue

• Decision to splitt the page "install-javafx.html" can be done in a new issue.
• Decision should the menu-text contains the version numer or not can be done in a new issue.
• Check again before! Sample package structure to 'resources' are different.

from openjfx-docs.

No feedback - won't contribute - close request.

from openjfx-docs.