Document conventions - AWS General Reference

Document conventions

The following are the common typographical conventions for AWS technical publications.

Inline code (for example, commands, operations, parameters, constants, XML elements, and regular expressions)

Formatting: Text in a monospace font

Example: java -version

Example blocks (for example, sample code and scripts)

Formatting: Text in a monospace font inside a shaded block

Example:

# ls -l /var/www/html/index.html
-rw-rw-r--  1 root root 1872 Jun 21 09:33 /var/www/html/index.html
# date
Wed Jun 21 09:33:42 EDT 2006
Mutually exclusive options

Formatting: Text separated by vertical bars

Example: (start | stride | edge)

Optional parameters

Formatting: Text enclosed in square brackets

Example: [-n, -quiet]

Definitions

Formatting: Text in italics

Example: Amazon Machine Image (AMI)

Technical publications

Formatting: Text in italics

Example: Amazon Simple Storage Service User Guide

Elements in the user interface

Formatting: Text in bold

Example: Choose File, Properties.

User input (text that a user types)

Formatting: Text in a monospace font

Example: For the name, type my-new-resource.

Placeholder text for a required value

Formatting: Text in italics

Example:

aws ec2 register-image --image-location my-s3-bucket/image.manifest.xml