|
This document gives examples of what different highlighted sections look like
and what they mean. Remember, don't be alarmed if you login to the website
and noticed that much of the examples in the documentation are customized
to your account's information. This is a feature of the documentation system
that makes it easier for you to see how the information applies to you.
Whenver you see text like this, it means that you are being warned about something related to the subject.
The warning should be read so that you understand any special conditions that you might need to know about.
The red and orange triangle should be noticeable.
Careful! You may be eaten by a grue!
Tips can be useful information when you aren't sure where to start. Whether it is
some simple setting that you can use or something more complicated like theory on
how to use something, this is what a tip will look like.
The following means that you are supposed to type this command in on the command line.
chmod 755 filename.txt
And this emphasizes the name of a file.
/home/username/path/to/file
This type of text is used when trying to show HTML code.<HTML>
<BODY BGCOLOR="#555555">
<TABLE>
<TR>
<TD>Cell 1</TD>
<TD>Cell 2</TD>
</TR>
</TABLE>
</BODY>
</HTML>
print "And this text style is used when showing PHP code";
if ($username) {
ereg_replace("username", "$username", $line);
} else {
print "No username was found.\n";
}
die ("Done here.");
$ cat README
Finally, we have the shell output style, which shows commands
and output you would see on the command line through SSH
$ ls -l
-rw------- 1 mark mark 25367 Aug 6 2003 tigerdirect-order.html
-rw-rw-r-- 1 mark mark 1337 Dec 31 16:28 tolsen.gpg
-rw-rw-r-- 1 mark mark 23986 Aug 18 16:40 trythis.exe
-rw-rw-r-- 1 mark mark 407 Jun 18 2002 usernames
-rw-r--r-- 1 mark mark 3617 May 30 2002 webalizer.conf
-rw------- 1 mark mark 34663 Sep 29 17:34 webDesign.abw
-rw-r--r-- 1 mark mark 54008 Sep 10 2001 whitedress1.jpg
-rw-r--r-- 1 mark mark 59085 Sep 10 2001 whitedress2.jpg
drwxrwxr-x 11 mark mark 4096 Dec 29 02:37 www
mkrenz@flynn .mozilla $ less ./firefox/default.yp2/chrome/userChrome-example.css
$
So as you can see, this documentation system is quite versatile and helpful
to give you exactly the information that you need in a clear and consice manner.
Hope you enjoy it.
Modified: 2005-01-11 19:06:52
|
