Introduction > Manual Conventions

The following typesetting conventions are used in this manual:

•Cross references to other manuals are shown in italics:
“This can be found in the RayVentory Catalog Release Notes.”

•Cross references and external links are shown in blue and are underlined:
“See RayVentory Catalog for...”

•Quotations from the computer screen (titles, prompts, and so on) are shown in bold:
“Go to Devices screen.”

•Code syntax, file samples, directory paths, entries that you may type on screen, and the like are shown in a monospaced font:
“Use docker compose -up to set your instance up”

•Large blocks of code are shown in a monospaced font with a grey background:
version: "3.7"
services:

•Italics may also be used for emphasis: “This manual is not intended...”

•Bold may also be used for inline headings: “Target: Indicates a target frame...”

Two note formats are used in RayVentory Catalog documentation

This is the basic format for giving additional information to the current topic. It can come with four different headings:
	Be aware: This note format contains important information related to your current activity. You should not skip over this text.
	Note: This format is used for items of interest that relate to the current discussion.
	Best practice: If there is a best practice approach to the current topic you can decide if you want to follow it, or stick to your own plan.
	Tip: Tips are designed to help you find the easiest and quickest way to work with RayVentory Catalog.

The second format is for very serious alerts.

WARNING

The information here may save you from data loss. Pay particular attention.

Documentation Requests

We welcome your suggestions and input on the various documentation resources available with RayVentory Catalog and its components. Your comments and requests can be forwarded through your Raynet support representative.