Index: openacs-4/packages/assessment/www/doc/as_items.html
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/packages/assessment/www/doc/as_items.html,v
diff -u -r1.2 -r1.3
--- openacs-4/packages/assessment/www/doc/as_items.html 21 Jul 2004 09:20:38 -0000 1.2
+++ openacs-4/packages/assessment/www/doc/as_items.html 21 Jul 2004 16:02:49 -0000 1.3
@@ -113,11 +113,8 @@
content_type -- a derived type: something in the CR
(instead of a blob type since we use the CR for such things now)
- This value was previously stored with each
-as_as_item_type. For retrieval purposes it makes more sense thought to
-store it with the as_item itself, as this prevents us to follow each
-relationship to the as_as_item_type objects if we want to retrieve the
-answer.
+
+
max_time_to_complete - optional max number of seconds to
perform as_item
adp_chunk - a denormalization to cache the generated
@@ -177,6 +174,8 @@
Open Question (as_item_type_oq):
+ - as_item_type_id
+
- cr::name - Identifier
- as_item_default: The content of this
@@ -187,8 +186,50 @@
Short Answer (as_item_type_sa):
+
+ - as_item_type_id
+
+ - cr::name - Identifier
+ - increasing_p: Increasing will give (number of correct
+matches / number of
+total matches) *100% points. All or nothing will either give 100%, if
+all correct answers are given,
+or 0% else.
+ - allow_negative_p: This will allow a
+negative percentage as well (as the total result).
+
+
+
+ - Short Answer Answers
+(as_item_sa_answers):
+
+ - answer_id
+
+ - cr::name - Identifier
+ - cr::title - Answer string that will be matched against the
+response
+ - data_type - Integer vs. real number vs. text
+ - case_sensitive_p - Shall the match be case sensitive
+ - score - Percentage a correct match gives
+
+ - compare_by - How is the comparison done (equal, contains,
+regexp)
+ - regexp_text: If the compare_by is a "regexp", this field
+contains the actual regexp.
+ - allowed_answerbox_list - list with all answerbox ids (1 2 3 ...
+n) whose response will be tried to match against this answer. An empty
+field indicates the answer will be tried to match against all answers
+ - NOTE: These answers are reusable, that's why we have a
+relationship.
+
+
+
+
+ - Multiple Choice Item
-(as_item_type_mc):
+(as_item_type_mc)
- cr::name - Identifier
@@ -212,15 +253,15 @@
- - Multiple Choices (as_as_item_choices)
+
- Multiple Choices (as_item_choices)
contain additional information for all multiple choice as_item_types.
Obvious examples are radiobutton and checkbox as_items, but
pop-up_date,
typed_date and image_map as_items also are constructed via as_item
Choices.
Each choice is a child to an as_as_item_type Object. Note the
-difference.
- A choice does not belong to an
+difference. A choice does not belong
+to an
as_item, but to the instance of the
as_item_type! This way we can reuse multiple choice answers
easier. It
@@ -234,11 +275,8 @@
of them is used. as_item Choices have these attributes:
- choice_id
- - parent_id (belonging to an as_as_item_type
+
- parent_id (belonging to an as_item_type_mc
object).
- - table_name - To which table (eg. as_item_type_mc or
-as_item_type_im) does this choice belong to.
-
- cr::name - Identifier
- cr::titel - what is displayed in the choice's "label"
@@ -248,14 +286,20 @@
here
- text_value
- - boolean_value
+ - boolean_value
+ - timestamp_value
+
- content_value - references an as_item in the CR -- for an
image, audio file, or video file
- feedback_text - where optionally some preset feedback can be
specified by the author
- selected_p - Is this choice selected by default (when the
-item is presented to the user)
+item is presented to the user)
+ - correct_answer_p - Is this choice the correct answer
+ - sort_order - In which order shall this choice appear with
+regards to the MC item. Note, this can be overriden by the display type.
+
- score - Score given to the user if this choice is selected
(in percent).
@@ -266,7 +310,65 @@
Inter-as_item
Checks.
+ - Image Map Multiple Choice Item
+(as_item_type_im):
+
+
+ - cr::name - Identifier
+ - cr::title - Title of the image map.
+
+ - increasing_p: Increasing will give (number of correct
+matches / number of
+total matches) *100% points. All or nothing will either give 100%, if
+all correct answers are given,
+or 0% else.
+ - allow_negative_p: This will allow a
+negative percentage as well (as the total result).
+ - image_item_id -
+cr_revision_id of the image, references cr_revisions
+
+
+
+
+ - Image Map Choices
+(as_item_image_choices):
+
+
+ - choice_id
+ - parent_id (belonging to an as_as_item_type_im
+object).
+ - cr::name - Identifier
+
+ - cr::titel - what is displayed in the choice's "label"
+ - data_type - which of the value columns has the information
+this Choice conveys
+ - numeric_value - we can stuff both integers and real numbers
+here
+
+ - text_value
+ - boolean_value
+ - content_value - references an as_item in the CR -- for an
+image, audio file, or video file
+ - feedback_text - where optionally some preset feedback can be
+specified by the author
+ - selected_p - Is this choice selected by default (when the
+item is presented to the user)
+ - correct_answe_p
+
+ - score
+ - area_type - Type of the
+area that uses the coordinates_string
+ - coordinates_string -
+String that defines the html area coordinates if this choice is used in
+an image_map question.
+
+
+
+
Item Display Types
Each item has an item_display_type object associated with it, that
@@ -284,24 +386,6 @@
- cr::name - name like "Select box, aligned right", stored in the
name field of CR.
- - acs_widget - the type of "widget" displayed when the
-Item is output in html. There are many types we should support beyond
-the stock html types. We are talking ACS
-Templating widgets here.
-
- - item_answer_alignment - the orientation between the
-"question part" of the Item (the item_text/item_subtext) and the
-"answer part" -- the native Item widget (eg the textbox) or the 1..n
-choices. Alternatives accommodate L->R and R->L alphabets (or is
-this handled automagically be Internationalization?) and include:
-
- - beside_left - the "answers" are left of the "question"
- - beside_right - the "answers" are right of the "question"
- - below - the "answers" are below the "question"
- - above - the "answers" are above the "question"
-
-
- html_display_options - field to specify other stuff like
textarea dimensions ("rows=10 cols=50" eg)
@@ -316,16 +400,77 @@
heigth..) as these can be parsed in via the html_display_options.
- - textbox - single-line typed entry
+
- textbox (as_item_display_tb) - single-line typed entry
- abs_size - An abstraction of the real size value in
-"small","medium","large". Up to the developer how this translates.
+"small","medium","large". Up to the developer how this translates.
+ - item_answer_alignment - the orientation between the
+"question part" of the Item (the item_text/item_subtext) and the
+"answer part" -- the native Item widget (eg the textbox) or the 1..n
+choices. Alternatives accommodate L->R and R->L alphabets (or is
+this handled automagically be Internationalization?) and include:
+
+ - beside_left - the "answers" are left of the "question"
+ - beside_right - the "answers" are right of the "question"
+
+ - below - the "answers" are below the "question"
+ - above - the "answers" are above the "question"
+
+
+
- text area - multiple-line typed entry
+ short_answer (as_item_display_sa) - Multiple textboxes in one
+item.
+
+
+ - abs_size - An
+abstraction of the real size value in
+"small","medium","large". Up to the developer how this translates.
+ - box_orientation
+- the pattern by which 2..n answer boxes
+are
+laid out when displayed. Note that this isn't a purely stylistic issue
+better left to the .adp templates or css; the patterns have semantic
+implications that the Assessment author appropriately should control
+here.
+
+ - horizontal - all answerboxes are in one continuous line.
+
+ - vertical - all answerboxes are in one column
+
+
+
+
+ text area (as_item_display_ta) - multiple-line typed entry
- abs_size - An abstraction of the real size value in
-"small","medium","large". Up to the developer how this translates.
+"small","medium","large". Up to the developer how this translates.
+
+
+ acs_widget - the
+type of "widget" displayed when the
+Item is output in html. There are many types we should support beyond
+the stock html types. We are talking ACS
+Templating widgets here.
+
+ item_answer_alignment - the orientation between the
+"question part" of the Item (the item_text/item_subtext) and the
+"answer part" -- the native Item widget (eg the textbox) or the 1..n
+choices. Alternatives accommodate L->R and R->L alphabets (or is
+this handled automagically be Internationalization?) and include:
+
+ - beside_left - the "answers" are left of the "question"
+ - beside_right - the "answers" are right of the
+"question"
+ - below - the "answers" are below the "question"
+ - above - the "answers" are above the "question"
+
+
+
radiobutton (as_item_display_rb) - single-choice multiple-option
@@ -349,17 +494,47 @@
button_type - type of button to use
sort_order: Numerical, alphabetic, randomized or
-by order of entry (sort_order field).
+by order of entry (sort_order field).
+ item_answer_alignment - the orientation between the
+"question part" of the Item (the item_text/item_subtext) and the
+"answer part" -- the native Item widget (eg the textbox) or the 1..n
+choices. Alternatives accommodate L->R and R->L alphabets (or is
+this handled automagically be Internationalization?) and include:
+
+ - beside_left - the "answers" are left of the "question"
+ - beside_right - the "answers" are right of the "question"
+
+ - below - the "answers" are below the "question"
+ - above - the "answers" are above the "question"
+
+
+
- checkbox - multiple-choice multiple-option
+ checkbox (as_item_display_cb) - multiple-choice multiple-option
- choice_orientation (see above)
- choice_label_orientation
- allow_multiple_p - Is it allow to select multiple values ?
- sort_order: Numerical, alphabetic, randomized or
-by order of entry (sort_order field).
+by order of entry (sort_order field).
+ item_answer_alignment - the orientation between the
+"question part" of the Item (the item_text/item_subtext) and the
+"answer part" -- the native Item widget (eg the textbox) or the 1..n
+choices. Alternatives accommodate L->R and R->L alphabets (or is
+this handled automagically be Internationalization?) and include:
+
+ - beside_left - the "answers" are left of the "question"
+ - beside_right - the "answers" are right of the "question"
+
+ - below - the "answers" are below the "question"
+ - above - the "answers" are above the "question"
+
+
+
select (as_item_display_sb) - multiple-option displayed in
@@ -370,27 +545,90 @@
by order of entry (sort_order field).
allow_multiple_p - Is
it allow to select multiple values ?
+ item_answer_alignment - the orientation between the
+"question part" of the Item (the item_text/item_subtext) and the
+"answer part" -- the native Item widget (eg the textbox) or the 1..n
+choices. Alternatives accommodate L->R and R->L alphabets (or is
+this handled automagically be Internationalization?) and include:
+
+ - beside_left - the "answers" are left of the "question"
+ - beside_right - the "answers" are right of the "question"
+ - below - the "answers" are below the "question"
+ - above - the "answers" are above the "question"
+
+
+
- multiple-choice-other: Consider, for instance, a combo box
+ image map (as_item_display_im) - Title with picture
+
+ - allow_multiple_p - Is
+it allow to select multiple values ?
+
+ -
+item_answer_alignment - the orientation between the
+"question part" of the Item (the item_text/item_subtext) and the
+"answer part" -- the native Item widget (eg the textbox) or the 1..n
+choices. Alternatives accommodate L->R and R->L alphabets (or is
+this handled automagically be Internationalization?) and include:
+
+ - beside_left - the "answers" are left of the "question"
+ - beside_right - the "answers" are right of the "question"
+ - below - the "answers" are below the "question"
+ - above - the "answers" are above the "question"
+
+
+
+
+ multiple-choice-other: Consider, for instance, a combo box
that consists of a radiobutton plus a textbox -- used for instance when
you need a check "other" and then fill in what that "other" datum is.
In effect this is a single Item but it has two different forms: a
-radiobutton and a textbox.
+radiobutton and a textbox. The answer will NOT be stored in the answer
+choice table. There is no item_type "multiple-choice-other"
+ - widget_choice - Type of the widget for the multiple choice
+part
+ - sort_order: Numerical, alphabetic,
+randomized or
+by order of entry (sort_order field).
+ - other_size: size of the other text field.
- other_label: label (instead of "other").
- - display_type: What display type should be used for the
-multiple-choice-part ?
+ -
+item_answer_alignment - the orientation between the
+"question part" of the Item (the item_text/item_subtext) and the
+"answer part" -- the native Item widget (eg the textbox) or the 1..n
+choices. Alternatives accommodate L->R and R->L alphabets (or is
+this handled automagically be Internationalization?) and include:
+
+ - beside_left - the "answers" are left of the "question"
+ - beside_right - the "answers" are right of the "question"
+
+ - below - the "answers" are below the "question"
+ - above - the "answers" are above the "question"
+
+
+
pop-up_date - a widget with month-day-year select elements
that resets the day element based on year and month (ie include Feb 29
-during leap years -- via Javascript) and tests for valid dates
+during leap years -- via Javascript) and tests for valid dates
+
typed_date - similar to pop-up_date but month-day-year
elements are textboxes for all-keyboard entry; needs no resetting
-scripts but does need date validity check
- image_map - requires a linked image; the image map coordinates
-are handled as Item Choices
+scripts but does need date validity check
+
file_upload - present a File box (browse button, file_name
textbox, and submit button together) so user can upload a file
@@ -418,8 +656,6 @@
- message_id
- message
- - locale (Actually I hope the i18n system Joel proposed makes this
-obsolete).