ClearFoundation

This page defines page layout standards for all wiki pages. For help with wiki syntax you can you can follow this guide.

Bold is used highlight fields in software (webconfig, installer, etc).

EXAMPLE:

The Bind Password is the master password for the LDAP server.

Italics are used to add emphasis.

EXAMPLE:

You must turn your server on in order to install the Operating System.

Used to call out minor examples and notes. These will appear similar to the smallest heading but can be used on the same line as regular text and are not addressable by link navigation. In some cases Widgets will be used instead.

EXAMPLE

EXAMPLE: This is an example.

-or-

NOTE

Code is listed in a special box. This is done so that the text can be pasted from the dialog box into a terminal session or command line. This is called out but using a double space in front of the line in the text dialog box.

EXAMPLES

cat /etc/fstab && df -h

[root@server var]# ls -la
total 27
drwxr-xr-x  23 root      root      1024 Apr  3 14:01 .
drwxr-xr-x  23 root      root      1024 Jun 25 12:58 ..
drwxrwx---   2 root      root      1024 Feb 28  2007 bacula
drwxr-xr-x   8 root      root      1024 Feb 24  2009 cache
drwxr-xr-x   2 root      root      1024 Sep 10 17:00 db
drwxr-xr-x   3 root      root      1024 Feb 21  2009 empty
drwxr-xr-x   4 flexshare flexshare 1024 Sep  8  2008 flexshare
drwxr-xr-x   2 root      root      1024 Oct 18  2007 ftp
drwxr-xr-x  33 root      root      1024 Jun 25 13:01 lib
drwxr-xr-x   2 root      root      1024 Feb 21  2005 local
drwxrwxr-x   9 root      lock      1024 Sep 11 04:02 lock
drwxr-xr-x  14 root      root      3072 Sep  6 04:03 log
lrwxrwxrwx   1 root      root        10 Feb 21  2009 mail -> spool/mail
drwxr-xr-x   4 root      root      1024 Apr  3 14:01 mnt
drwxr-xr-x   2 root      root      1024 Feb 21  2005 nis
drwxr-xr-x   2 root      root      1024 Feb 21  2005 opt

Widgets can be used in various pages for calling special attention to particular items.

To help guide users through a specific task, you will often ask a user to click through a menus system. For example:

Network Firewall Port Forwarding

<navigation>Network|Firewall|Port Forwarding</navigation>

To help guide users through a specific task, you will often ask a user to click on a specific button. For example:

Add the IP address and click on Submit

Add the IP address and click on <button>Submit</button>

Notes give information as an aside to the main topic or give emphasis to the current topic.

<note>
This is a new feature.
</note>

Important notes give notice for recommended items. This will come from best practices or other compelling factors.

<note important>
Enabling outside http access and authenticated user access on Web Flexshares without using SSL will mean that your passwords will be transmitted across the Internet in plain text!!
</note>

A tip shows the users optional information that can be particularly useful but not required. This can be a best practice or some method that is just cool.

<note tip>
Enabling this feature makes this usable by the Flexshare module.
</note>

Warnings are used to express concern if there are irreversible or dangerous procedures. These help the reader take special care before proceeding.

<note warning>
Formatting your drive during the install automatically WILL delete all information on ALL drives that are connected, not just the first one !!
</note>