This page describes the common conventions used throughout the OGSA-DAI documentation.
Commands to be executed at the command-line, arguments and values
are all shown in this teletype font.
Longer excerpts are shown as follows:
$ run-this-command
The character $ is used to denote a
command or shell prompt.
The back-slash (reverse solidus) character (\) is used to denote a
line continuation character. When typing in commands this should not
be entered, i.e.:
$ this-is-a-command that is very long so requires use of a line continuation character to make it look better on the page
would be presented as follows
$ this-is-a-command that is very long so requires use of a \
line continuation character to make it \
look better on the page
We use the Unix convention for setting and dereferencing environment variables as well as using the same for directory delimiters, e.g.
$ export MY_PATH=/home/mydir/mypath $ export MY_PATH=myOtherDir/mypath:$MY_PATH $ echo $MY_PATH
Windows users should use the corresponding DOS equivalents, e.g. the Windows equivalent of the above might be:
$ set MY_PATH=C:\home\mydir\mypath $ set MY_PATH=myOtherDir\mypath;%MY_PATH% $ echo %MY_PATH%
Java classes, interfaces, methods, variables and packages are all shown
in this teletype font
Longer excerpts are shown as follows:
public class SomeClass
{
...
}
XML elements and attributes are all shown in this
teletype font.
Longer excerpts are shown as follows:
<someElement someAttribute="someValue">
<someSubElement>
someContent
</someSubElement>
</someElement>
![]() | Tip |
|---|---|
| Useful tips are shown like this! |
![]() | Note |
|---|---|
| General notes and information about limitations are shown like this! |
![]() | Caution |
|---|---|
| Things we recommend you exercise caution over are shown like this! |
![]() | Warning |
|---|---|
| Things that can go wrong if you do not pay attention are shown like this! |