Tips for using DataStax documentation

Describes helpful features and icons used in DataStax documentation.

Pop-up example

The following table shows the most common uses for pop-ups:

Pop-ups Description
File paths Shows the file locations of configuration files with links.
Drivers Displays a list of drivers with links.
Available versions Shows which versions are available.
Compatible versions Lists the compatible versions.
Supported products Lists which products are supported.

Drop-down menu

To make navigation easier, use the drop-down menu in the upper-right corner to go to a different version or a related document.

Button used to see list of available DataStax documents.

List of available DataStax documents grouped by product and version.

If the same page exists in another version, the selected version will open to that page. Otherwise, the top-level page opens.

Popups

Popup links

Popup links are indicated by dotted underlines. Click here to try it out.

Syntax legend popup

  • To see the syntax legend for a command, select Show syntax legendIcon hover popup.
  • To move the legend, use your cursor to click and drag the pop-up on your page.
    Screenshot of popup window that can be moved by clicking and dragging the window.
  • To resize the pop-up, click and drag any side or corner of the syntax legend.
    Screenshot of popup window that can be resized by clicking and dragging the corner or side of the popup.

Navigation icons

Icons help you navigate, expand images, create bookmarks, and more.

Icon Description
left navigation arrow Go backwards through the topics.

Hover over the arrow to display the title of the previous topic.

right navigation arrow Go forward through the topics.

Hover over the arrow to display the title of the next topic.

expand collapse arrow Expand or collapse a section, table, or left navigation menu.

For headings and tables, you can also click the text to expand or collapse.

Print this doc icon Print current page.
Toggle search highlights Toggle highlighted search terms on and off.
Expand or collapse page sections Expand or collapse all sections on a page.
submenu indicator Indicates that a top navigation menu has submenus.
Click to view the syntax legend for a command.
external-link icon Indicates that the link goes to web sites external to datastax.com, docs.datastax.com, and academy.datastax.com. For example:

Configure your operating system to use the OpenJDK 8 (1.8.0_151 minimum).

bookmark icon Appears when hovering over subheadings and provides a link for bookmarking.

Click to display the link in address bar.

Appears when hovering over subheadings and provides a link for bookmarking.

Click to display the link in address bar.

Footer icons

These icons are displayed at the bottom of each page.

Icon Description
PDF file icon PDF version.
PDF file icon DataStax on Facebook.
Twitter icon DataStax on Twitter.
DataStax documentation tips icon Open the doc tips page from any topic.
Github icon Open the DataStax GitHub repository.
Zip file icon Going off the grid? Download the document Zip file to use the HTML document offline.