WIKI Guidelines

OpenJFX uses Confluence for its wiki. You can read the confluence documentation for detailed information on macros (which we make use of) as well as other generic information. The intent of this page is to detail how and when to use different macros when writing documents for the OpenJFX wiki.

Structure of the Page

By default, when you create a new page, you are given the entire width of the browser page for your content. The style used by wikis.oracle.com is such that there is no "page tree" that consistently shows up on each page. If you want to have a navigation tree on the left (as we have on this page), then you need to use macros in order to provide structure for your page, and use the pagetree macro for displaying the navigation tree.

The basic boilerplate is as follows (without the backslashes. I wasn't able to figure out how to escape the macro...):

\{section}
\{column}
\{pagetree:root=OpenJFX|searchBox=true}
\{column}
\{column:width=25px}\{column}
\{column}

content goes here

\{column}
\{section}

This will create a single vertical "section" consisting of 3 columns: the navigation column, a "gutter" column to provide spacing (optional) and the content column. Notice that each column begins and ends with the column macro tag (same as for the section and most other macros in Confluence). If you need to structure your page differently, then you can use a combination of sections and columns to break it up as appropriate (For example, perhaps you want another column on the far right as a side-bar containing different notes or relevant information).

Styling

The UI for wikis.oracle.com is not configurable, so in order to make things look good across our site we need to standardize on some choices with regards to styling.

• The h1 and h2 headings are huge. For the most part, you should think about sticking with h3 and h4 for sections and sub sections.
• Use the "info", "note", "tip", and "warning" macros for associated content. Examples of each of the following can be seen below

• Use of a table of contents (via the "toc" macro) at the top of the page is optional and should only be used for very large documents. In such a case, you might consider not showing the navigation side-bar (pagetree) so as to reduce visual clutter.

Where Things Go