| Cpoll Parameter Notes |
|
|
|
|
| • |
Blank lines and lines beginning with ' # ' are ignored. |
| • |
Parameter names and values are case-insensitive.
Spaces are allowed before and after the parameter name,
and after the equals sign.
|
| • |
Misspelled parameter names or values are ignored and defaults are used,
but the errors are noted in the setup log. |
| • |
Parameter lines can appear in any sequence,
but the order of question and answer lines
determines how the questions
are numbered and how they're displayed on the poll page.
|
| • |
When multiple lines exist with the same parameter name,
the last one in the file is used,
except where noted below with 'CUMULATIVE' or 'Any number allowed'.
Multiple 'CUMULATIVE' parameter lines are joined together,
in the order given, to create a single parameter value. |
|
|
|
|
| Section 1 - Overall Layout |
|
|
| Parameter |
|
Default |
|
Description |
| Type= |
|
Poll |
|
Brief text identifying the type of poll, used in login page, button names,
report title, etc. Examples: Seminar Scheduler,
Course Evaluation, Faculty Survey, ClueQuiz.
Note- this parameter was perviously called Name
(which is still allowed for backward compatibility). |
| Title= |
|
User $Type |
|
Text only shown as heading at top of all pages (except popup windows) and
as html title on all pages. Example: History 201 Course Evaluation. |
| Subtitle= |
|
---- |
|
Text or html shown as bold, below Title, on login and poll pages.
CUMULATIVE |
|
|
| Header= |
|
---- |
|
Text or html shown at very top of all pages (except popup windows),
for images, etc. CUMULATIVE |
| LoginInstruct= |
|
---- |
|
Text or html shown as size=-1 on login page, directing user
login action. CUMULATIVE |
| Instructions= |
|
---- |
|
Text or html shown as bold at top of poll page, directing user
action. CUMULATIVE |
|
|
| TextColor= |
|
#4040B0 |
|
Color of text on all pages. Default is dark blue. |
| BgColor= |
|
#FFFFFF |
|
Color of background on all pages. Default is white. |
| WarnColor= |
|
#C05050 |
|
Color of warning messages on all pages. Default is medium red. |
| |
|
|
|
COLOR FORMAT: #rrggbb (hex) or browser color-name. |
| BgImage= |
|
---- |
|
Background image reference, used in all pages except popup windows.
Absolute or relative web references allowed.
Relative references are in relation to the Cpoll program location
(the http directory). Example: cpoll/linnenbak.gif |
|
|
|
| Section 2 - Users and Manager |
|
|
| Parameter |
|
Default |
|
Description |
| User= |
|
---- |
|
Users who can login to the poll. Any number allowed.
FORMAT: ID ; Password ; Name ; Email-addr |
|
|
| UserFile= |
|
---- |
|
File name of user file. Any number allowed.
Relative references are in relation to the Cpoll program location
(the http directory). Example: ../cpoll/users-art
File record FORMAT: ID ; Password ; Name ; Email-addr
|
| UserSelect= |
|
---- |
|
List of ID's in preceeding UserFile that are allowed in poll,
others in file are ignored. ID's are case-insensitive.
If not given, all ID's are allowed. Any number allowed.
CUMULATIVE (for each file)
FORMAT: ID ; ID ; ID ; ID ... |
|
|
| Mgr= |
|
---- |
|
Manager who can access manager functions. Only one allowed.
If not given, the default manager from the cpoll directory (if present) is used.
Format 1 uses the Name, Email-addr and Web-addr from the default manager.
Format 2 overrides all items of the default manager.
FORMAT1: ID ; Password
FORMAT2: ID ; Password ; Name ; Email-addr ; Web-addr |
|
|
| User/Mgr Notes: |
|
---- |
|
ID and Password are required. Name, Email-addr and Web-addr are optional.
ID and Password should be composed using only alphabetic and numeric characters,
especially do not use: space ; " ' < >
ID and Password are case insensitive during login,
but case is retained in the file records,
ie. don't change the case of the ID after poll data is collected.
For multiple records with the same ID, only the last one found is used.
Enter Name as: FirstName [MiddleName or Initial] LastName
FirstName should be one word if email will be sent with the 'first word' option.
Email-address can be a comma separated list,
but mgr should have only one e-address.
|
|
|
|
| Section 3 - Poll Behavior |
|
|
| Parameter |
|
Default |
|
Description |
| OpenDate= |
|
---- |
|
Date on which poll submits are accepted. |
| CloseDate= |
|
---- |
|
Date after which poll submits are not accepted. |
| |
|
|
|
DATE FORMAT: mm/dd/yyyy. Dates are checked only for mm = 1-12,
dd = 1-31, yyyy = 2000-3000,
and OpenDate <= CloseDate (if both are given). |
|
|
| ViewWithoutLogin= |
|
yes |
|
Allow poll view from login page without logging in.
OPTIONS: no, yes |
| ViewAllUsers= |
|
yes |
|
Include the 'View All Users' link in poll display (if
ReportGen=yes). OPTIONS: no, yes |
|
|
| ReportGen= |
|
yes |
|
Generate report on poll page. OPTIONS: no, yes |
| ReportFormat= |
|
IDList |
|
How report is shown. OPTIONS:
| IDList: |
List IDs for each answer. |
| IDListCount: |
List IDs and their count for each answer. |
| QuizIDList: |
For collaborative quizzes, turns on 'trigger' and 'result'
processing, and lists IDs for each answer. |
| QuizCount: |
For collaborative quizzes, as in QuizIDList,
but shows count of IDs instead of list of IDs for each answer. |
| Count: |
Display the count of IDs for each answer. |
| CountPercent: |
Same as Count, with the percent for each answer also shown, in parenthesis. |
| CountAve: |
Same as CountPercent, with an average calculated from the Value for
each answer, if any Value is given for any answer for the question.
The Values are also shown. |
| CountAveNoZero: |
Same as CountAve, with the average calculated by
excluding any Values = blank or zero. |
|
|
|
| ReturnURLName= |
|
---- |
|
Name of the return button at bottom of poll and on the response
page, if response page is generated. |
| ReturnURL= |
|
---- |
|
Target of return button. Can be relative or absolute Web address.
Relative references are in relation to the Cpoll program location
(the http directory). |
| |
|
|
|
NOTE - Both ReturnURL and ReturnURLName must be given for
the return button to appear. |
|
|
| Response= |
|
MsgPage |
|
Action to take after a submit. OPTIONS:
| MsgPage: |
Generate a response page with the ResponseMsg displayed, and
the Return button shown if specified. |
| Refresh: |
Redisplay the poll page with updated info. |
|
| ResponseMsg= |
|
===> |
|
Text or html displayed as bold on the response page, if page is
generated. CUMULATIVE
DEFAULT = Your $Type data has been recorded. Thank you. |
|
|
|
| Section 4 - Manager Options |
|
|
| Parameter |
|
Default |
|
Description |
| EmailSendMsg= |
|
===> |
|
Text appearing in the 'Message' box when the manager
selects 'Email Users', etc. Use '\n' for line breaks anywhere in the text.
CUMULATIVE
DEFAULT = Sincerely, mgr-name $Type Manager |
| LogEmailSent= |
|
yes |
|
Log all email sent by manager to the cpoll file.
Each email is posted in two sections - message details before any email is sent,
then email counts after all the emails are sent.
OPTIONS: no, yes |
| SetEmailFromAddr= |
|
no |
|
Set the 'from' address of each sent email to the manager's email address.
This automatically inserts an X-Authentication-Warning header in the email;
if this causes problems with some addresses, set this parameter to no.
OPTIONS: no, yes |
|
|
| ReportExecTimes= |
|
no |
|
Display user & system cpu execution times for the script processing, at the
bottom of important pages. Also display technical functions near the end
of the manager page. OPTIONS: no, yes |
|
|
|
| Section 5 - Question & Answer Setup |
|
|
| Parameter |
|
Default |
|
Description |
| PreTextStart= |
|
---- |
|
Starting text/html for all pretext values, displayed in bold. CUMULATIVE
Image example: <img src="cpoll/questionblue.gif" align="top"> |
| QuestionStart= |
|
---- |
|
Starting text/html for all questions, displayed in bold.
Shown before question numbers, if this option is on. CUMULATIVE
Text example: <font size="+2" color="blue">Q </font> |
| DisplayQuestNum= |
|
yes |
|
Display the sequential question number at the start of
each question. OPTIONS: no, yes |
|
|
| QuestionFormat= |
|
CheckboxMulti |
|
Default format for all questions. This default can be
overridden for each question. OPTIONS:
| CheckboxMulti: |
Any no. of checkboxes can be choosen by the user. |
| CheckboxSingle: |
Only one checkbox can be choosen by the user. |
| CheckboxExclusive: |
Only one checkbox can be choosen,
and any previously chosen boxes are not displayed for user selection. |
|
| AnswerLayout= |
|
Vert |
|
Default layout of answers for all questions. This default can
be overridden for each question. OPTIONS:
| Vert: |
Each checkbox + answer text are listed one per line,
below the question. |
| Horiz: |
Answers are shown below the question, but horizontally across page,
equally spaced, with checkboxes underneath. |
| PackedHoriz: |
Same as Horiz, but answers are placed on same line as question text. |
|
| QuestionSpacing= |
|
1 |
|
Number of blank lines between questions. OPTIONS: 0, 1, 2 |
|
|
| CommentAll= |
|
no |
|
Put a comment box after all questions. If no, a comment can be
specified for individual questions. OPTIONS: no, yes |
| RequireAll= |
|
no |
|
Require all questions (except comments) be answered before poll
submit is accepted. If no, individual questions can be required.
OPTIONS: no, yes |
|
|
|
| Section 6 - Questions & Answers |
|
|
| Parameter |
|
Default |
|
Description |
| PreText= |
|
---- |
|
Text or html which appears before the next question.
Can be used to separate questions into logical groups.
Any number allowed. CUMULATIVE (for each question) |
| Q....= |
|
---- |
|
Question definition with options, followed by question text, as text or html.
Any number allowed. OPTIONS:
| M, S, X: |
Question Format: CheckboxMulti, CheckboxSingle, CheckboxExclusive |
| V, H, P: |
Answer Layout: Vert, Horiz, PackedHoriz |
| C, N, L: |
Add Comment box: Comment default size, Nominal size (one line,
unlabelled), Large size (multi-line). Default size: If a question
has no A's and comment is enabled, a large comment box is generated,
otherwise a one line box is generated with the label 'Comment'. |
| R: |
Question requires an answer. If comment box requested and no A's given,
a comment must be given. In all other cases comments are optional. |
|
| A= |
|
---- |
|
Answers for each question. Any number allowed (for each question).
| FORMAT1: answer-text |
| FORMAT2: answer-text ; code-text |
| FORMAT3: answer-text ; code-text ; value |
| FORMAT4: answer-text ; code-text ;
trigger ; result |
| answer-text: |
Shown adjacent to checkbox, text or html
(html, only if code-text is given). |
| code-text: |
Shown on report and stored in file. Text ONLY.
Optional; if not given program uses answer-text. |
| value: |
Blank or numeric (0 or above). Shown on report of type CountAve and
CountAveNoZero, and used to calculate the average for the question. |
| trigger: |
Blank or numeric (0 or above). Blank, zero and 1 are treated the same.
For report of type QuizIDList or QuizCount,
specifies number of users who must select this
answer for 'result' to be shown. |
| result: |
Text or html. For report of type QuizIDList or QuizCount,
this value is shown on report as bold and with WarnColor,
if 'trigger' has been reached for this answer. |
|
|