Instructions for Using the PHP Cross Reference Page
This page displays instructions for using the cross reference between a selection of PHP programs and their variables. Among the things that a user can do with the display are:
- Specifiy the top level folder of the directory where the PHP programs reside.
- Select the sort order of the data displayed.
- Hide and display the paths to the selected PHP programs which appear in column 5.
- Toggle the path on a single row of the display between visibility and invisibility.
- Choose how much data appears in column 2 of the display, which holds the major sort field of the cross reference.
There are three areas of interest in the cross reference page.
Area 1: PHP Cross Reference Display ("the Display")
- Appears under the title "Cross References: PHP".
- Two explanatory notes sit directly above the heading of the Display. The note above the left side tells how the data in the Display is sorted. The note above the right side shows the server portion of the path to programs in the Display. A user can find a programs's source code by following the folders in the server portion of the path and then the folders in the client portion that appears in column 5 of the body of the Display.
Columns of the Display
- Sequence number (column 1): sequence numbers of rows in the Display.
- Primary sort field (column 2): holds either program names or sort names, depending on the sort order of the cross reference.
- Secondary sort field (column 3): holds data from the fields that are sorted within the primary sort. If the primary sort is variable name, the secondary is program name. If the primary sort is program name, the secondary is variable name.
- Line (column 4): holds the number of the line in the program where the variable is located.
- Client part of path to program (column 5): holds the names of the folders in the program path that the client has created. This part of the path follows the server portion of the path.
Area 2: Activate
A salmon colored square to the left of the Display that is the same distance from the top of the page as the Display. It holds:
- an input box containing the text "top level folder."
- button labeled "Show Xref."
- The user clicks the button to display a cross refernce, but before doing so, he must enter the name of a folder in input box. This folder must be the top level folder in a directory that holds the PHP programs that will be the source of the data in a cross reference.
- A salmon colored square to the left of the Display that is the same distance from the top of the page as the Display. It holds:
Area 3: Options
- A salmon colored box entitled "Options" that is directly below Area 2.
- Click "Show Paths" to display the program paths in column 5 with the heading "Client Part of Path to Program".
- Click "Hide Paths" to hide the paths in column 5.
- Click "Col 2 Breaks" to show only the breaks, or changes, in the contents of cells in column 2. The contents of a cell in column 2 are hidden when they match the contents of the previous cell.
- Click "All Col2 Cells" to show the contents of all of the cells in column 2.
- Click "PgmInVar" for a cross reference sorted by variable name in alphabetical order in column 2. In column 3 appear the names of programs which hold the variables in column 2.
- Click "VarInPgm" for a cross reference sorted by program name in alphabetical order in column 2, with the names of variables the programs contain in column 3.
- Click "NoSortXref" for a cross reference in which the data are not sorted. Program names in column 2 appear in the order they are found in the directory. Each program's variables are displayed next to it in column 3 in the order found within the program.
Additional Features of the PHP Cross Reference Page
- NOTE: To toggle a path name in column 5 between visiblity and invisibility, click the row where the name resides.
There are two buttons in the upper right corner of the Cross Reference Page:
- "Return to Menu" is the rightmost of the two buttons and is a link to the domain menu page.
- "Instructions" is the leftmost button.