|
Size: 2917
Comment:
|
Size: 3086
Comment:
|
| Deletions are marked like this. | Additions are marked like this. |
| Line 29: | Line 29: |
| This part provides a general overview of the blocks of activity you will be using the software to accomplish. | This section provides an overview of SPC and the purpose of the software. |
| Line 33: | Line 33: |
| This part includes sets of specific procedures for the blocks of activity described in Part I. | This section organizes the common activities the software is used to achieve into blocks of specific procedures. |
| Line 35: | Line 35: |
| === Part III: === | === Part III: Reference === |
| Line 53: | Line 53: |
| * '''<XXXX>''' - This indicates that all or part of filename or directory is required. The actual characters depend on your input or are automatically filled in by the program. | |
| Line 58: | Line 59: |
| /!\ Warnings like this tell you actions you '''must''' take or information you ''should'' have before you can continue. | /!\ Warnings like this tell you actions you '''must''' take or information you ''should'' consider before you continue. |
| Line 60: | Line 61: |
| (!) Information notes like this provide you with details and explanation that will help you understand the topic presented. | (!) Information notes like this provide you with details and explanation that can help you understand the topic presented. |
Introduction
This user manual includes overviews, procedures and reference for executables, directories and files associated with the SPC (Stereophotoclinometry) software.
This manual applies to SPC software version _.
Who This Manual Is Intended to Help
The SPC User Manual is intended for users who have training and experience using one or more of the programs included.
Do we want to include a bullet list of general knowledge assumed? Or maybe list what is not assumed??
This manual does not provide detailed trouble shooting assistance.
- I think I need wording here on how that's expected to be handled.
What This Manual Includes
Each procedure or reference entry
- provides a general description of the item
- lists related files, directories, or programs
- explains input, output, or contents
- shows samples of input, output, or contents
Some entries include additional references and more detailed information.
How This Manual Is Organized
Part I: Overview
This section provides an overview of SPC and the purpose of the software.
Part II: How Tos
This section organizes the common activities the software is used to achieve into blocks of specific procedures.
Part III: Reference
This part includes reference entries for executables, directories and files. It is arranged alphabetically and subdivided into these sections:
- Programs
- Directories
- Files
- Input
- Output
- Support
How Standard Items Are Identified
Throughout this manual, we have used these systems for marking the items we discuss:
Names of programs, directories, and files - These usually appear as hypertext links because they are entries in this manual. In the interactive version of the manual, you can click on the link to find out more specific information.
Names of programs, directories, and files - These appear in bold in the entry where they are discussed. This is used instead of hyperlinking to avoid circular references.
Names of DIRECTORIES - These written in ALL CAPS followed by /.
Names of files - These may appear in ALL CAPS, mixed case, or all lower case, depending on how the filename appears in the software.
<XXXX> - This indicates that all or part of filename or directory is required. The actual characters depend on your input or are automatically filled in by the program.
User keyboard inputs - These are shown in 'single' quotes. You should type what is in the 'single' quotes and then hit the Enter key.
'Enter' means just hit the Enter key as the input. 
CRITICAL MESSAGES APPEAR LIKE THIS! You should pay particular attention to these to avoid data loss or other errors. ![/!\](/wiki/classic/img/alert.png "/!\")
Warnings like this tell you actions you must take or information you should consider before you continue. Information notes like this provide you with details and explanation that can help you understand the topic presented.