1.3. Conventions used in this Document

1.3.1. Typographical Conventions

This is a list with examples of the typographical conventions used in this manual.

Typographical conventions

Convention

Example

Executable program with options
Enter ls --reverse to get a directory listing in reverse order.

A character or string indicating the start of an input field.

Enter your name after the User Name prompt.

User input.
John entered john as his login name.

A button.
Press the Cancel button.

A text prompt.
Enter your full name after the Name prompt

Content that may or must be replaced by the user.
Please enter filename to save the content to.

Filename.
Please open the file server.properties in your favorite editor.

Directory.
/opt/savapage

A question-and-answer set.
Q: To be, or not to be?
A: That is the question.

Key on a keyboard.
Press F1 for help.

A combination of keys.
Press Ctrl+C to abort the program.
A selection or series of
selections from a menu.
Select Print → Settings to open the dialog.

An inline code fragment.
Text in this format is used to show code examples, the
contents of files, and console output, as well as the names
of variables, commands, and other code excerpts in the text.

Code (listing).
Example code
 Line A:
 Line B: ①
 Line C: ②
1:

Comment for Line B.

2:

Comment for Line C.

Link (external).
A link to an URI is formatted like this:
https://savapage.org and support@savapage.org
… or as an alternative: visit our website or write an email.

Link (internal).
See Server Installation of this manual.

Name of a variable.
In Perl, @ARGV contains the command line parameters used
when the script was run.
Inline text that holds
some literal value.
When debug is activated more detailed logging is produced.

1.3.2. Feature Preview

../../_images/savapage-feature-preview-75x100.png

The icon above marks a section where a “feature preview” is discussed. This feature is operational yet impermanent, and available for preview to provoke feedback based on real world use. This may lead to it becoming permanent in a future release.

1.3.3. Notes

You should pay special attention to notes set apart from the text with the following icons:

Important

Important notes are marked like this.

Note

Notes provide extra background information.

Tip

Tips provide useful advice to make your life easier.

Caution

Indicate situations where you have to be careful what you are doing.

Warning

Where extreme care has to be taken.

Deprecated

Notes about a deprecated feature.

Preview

Additional notes to a Feature Preview.