Option 1: use a custom tarball which includes those modules. In
that case, the custom tarball will have a file install.xml in
its root directory, so that installing OpenACS normally will
produce a simulation server.
Notes on custom tarball creation:
Index: openacs-4/contrib/packages/simulation/www/doc/permissions.html
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/contrib/packages/simulation/www/doc/Attic/permissions.html,v
diff -u -r1.2 -r1.3
--- openacs-4/contrib/packages/simulation/www/doc/permissions.html 26 Nov 2003 16:44:50 -0000 1.2
+++ openacs-4/contrib/packages/simulation/www/doc/permissions.html 28 Nov 2003 16:55:52 -0000 1.3
@@ -1 +1,2 @@
-Permissions View comments on this page at openacs.org Permissions View comments on this page at openacs.org @page_title;noquote@
@context;noquote@
+
+TODO: get desired layout, see below:
+
+
(this is just a mockup)
-Role Character Actor(s) In groups of Plaintiff
-
- Bob
- Jianing (Lawfirm X)
- Larry (Lawfirm Y)
-
-
+Role Actor(s) In groups of Plaintiff
Automatic Agent
Student
@@ -24,13 +24,7 @@
Defendent
-
- Bob
- Jianing (Lawfirm X)
- Larry (Lawfirm Y)
-
-
+Defendent
Automatic Agent
Student
@@ -41,13 +35,7 @@
Judge
-
- Bob
- Jianing (Lawfirm X)
- Larry (Lawfirm Y)
-
-
+Judge
Student
TA
Index: openacs-4/contrib/packages/simulation/www/siminst/cast-actors.tcl
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/contrib/packages/simulation/www/siminst/Attic/cast-actors.tcl,v
diff -u -r1.1 -r1.2
--- openacs-4/contrib/packages/simulation/www/siminst/cast-actors.tcl 27 Nov 2003 16:43:36 -0000 1.1
+++ openacs-4/contrib/packages/simulation/www/siminst/cast-actors.tcl 28 Nov 2003 16:55:52 -0000 1.2
@@ -10,3 +10,45 @@
set page_title "Choose actors"
set context [list [list "." "SimInst"] $page_title]
+
+# Loop over all workflow roles and append the actor and "in groups of" widgets to the form
+set form {
+ {pretty_name:text
+ {label "Simulation name"}
+ {html {size 50}}
+ }
+}
+
+foreach role_id [workflow::get_roles -workflow_id $workflow_id] {
+ set role_pretty_name [workflow::role::get_element -role_id $role_id -element pretty_name]
+ lappend form [list actor_${role_id}:text(select) \
+ [list label $role_pretty_name] \
+ [list options {{Student student} {Professor professor}}]
+ ]
+ lappend form [list group_${role_id}:integer [list label "In groups of"] [list value 1]]
+}
+
+ad_form \
+ -name actors \
+ -export { workflow_id } \
+ -form $form \
+ -on_submit {
+
+ # Put the actor and grouping selections on array list formats
+ set actors_list [list]
+ set groups_list [list]
+ foreach role_id [workflow::get_roles -workflow_id $workflow_id] {
+ lappend actors_list $role_id [set actor_$role_id]
+ lappend groups_list $role_id [set group_$role_id]
+ }
+
+ simulation::cast \
+ -workflow_id $workflow_id \
+ -pretty_name $pretty_name \
+ -actors $actors_list \
+ -groups $groups_list
+
+ # Proceed to the instantiation complete page
+ ad_returnredirect [export_vars -base cast-complete {workflow_id}]
+ ad_script_abort
+ }
\ No newline at end of file
Index: openacs-4/contrib/packages/simulation/www/siminst/cast-edit.tcl
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/contrib/packages/simulation/www/siminst/Attic/cast-edit.tcl,v
diff -u -r1.1 -r1.2
--- openacs-4/contrib/packages/simulation/www/siminst/cast-edit.tcl 27 Nov 2003 16:43:36 -0000 1.1
+++ openacs-4/contrib/packages/simulation/www/siminst/cast-edit.tcl 28 Nov 2003 16:55:52 -0000 1.2
@@ -5,37 +5,79 @@
}
set page_title "Create/edit simulation"
-set context [list $page_title]
+set context [list [list "." "SimInst"] $page_title]
set package_id [ad_conn package_id]
+# TODO: only one aplication group per package - need different solution
+set group_id [application_group::group_id_from_package_id -package_id $package_id]
+set group_name [group::get_element -group_id $group_id -element group_name]
+set group_options [list [list $group_name $group_id]]
+
+# TODO: Possible future casting_type options:
+# choose_role
+# choose_role_and_instance
+
+# TODO: provide more sensible default dates?
+# Notification send could be start date minus some parameter
+set in_a_month_date [clock format [expr [clock seconds] + 3600*24*31] -format "%Y %m %d"]
+set in_two_months_date [clock format [expr [clock seconds] + 2*3600*24*31] -format "%Y %m %d"]
+set in_two_and_a_half_months_date [clock format [expr [clock seconds] + 3*3600*24*31 - 3600*24*15] -format "%Y %m %d"]
+set in_three_months_date [clock format [expr [clock seconds] + 3*3600*24*31] -format "%Y %m %d"]
+set in_four_months_date [clock format [expr [clock seconds] + 4*3600*24*31] -format "%Y %m %d"]
ad_form -export { workflow_id } -name simulation \
-form {
- {enroll_start
+ {enroll_start:date,optional
{label "Enrollment start date"}
+ {value $in_a_month_date}
}
- {enroll_end
+ {enroll_end:date,optional
{label "Enrollment end date"}
+ {value $in_two_months_date}
}
- {notification_date
+ {notification_date:date
{label "Date to send start notification"}
+ {value $in_two_and_a_half_months_date}
}
- {case_start
+ {case_start:date
{label "Simulation start date"}
+ {value $in_three_months_date}
}
- {case_end
+ {case_end:date
{label "Simulation end date"}
+ {value $in_four_months_date}
}
- {enroll_type
- {label "Open Enrollment?"}
+ {enroll_type:text(radio)
+ {label "Enrollment type"}
+ {options {{Closed closed}}}
+ {value closed}
}
- {casting_type
- {label "Open casting?"}
+ {casting_type:text(radio)
+ {label "Casting type"}
+ {options {{Automatic automatic}}}
+ {value automatic}
}
- {tools
- {label "tools for enrollment and casting. (upload of user list csv, ... others?) TODO..."}
+ {user_group:integer(select)
+ {label "User Group"}
+ {options $group_options}
}
} -on_submit {
- # TODO (clone the template and create a new simulation record)
- ad_returnredirect simulation-casting
+ # Convert dates to ANSI format
+ foreach var_name {enroll_start enroll_end notification_date case_start case_end} {
+ set ${var_name}_ansi "[lindex [set $var_name] 0]-[lindex [set $var_name] 1]-[lindex [set $var_name] 2]"
+ }
+
+ simulation::template::instantiate_edit \
+ -workflow_id $workflow_id \
+ -enroll_start $enroll_start_ansi \
+ -enroll_end $enroll_end_ansi \
+ -notification_date $notification_date_ansi \
+ -case_start $case_start_ansi \
+ -case_end $case_end_ansi \
+ -enroll_type $enroll_type \
+ -casting_type $casting_type \
+ -parties $user_group
+
+ # Proceed to choosing actors
+ ad_returnredirect [export_vars -base cast-actors { workflow_id }]
ad_script_abort
}
Index: openacs-4/contrib/packages/simulation/www/siminst/index.adp
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/contrib/packages/simulation/www/siminst/Attic/index.adp,v
diff -u -r1.6 -r1.7
--- openacs-4/contrib/packages/simulation/www/siminst/index.adp 27 Nov 2003 16:43:36 -0000 1.6
+++ openacs-4/contrib/packages/simulation/www/siminst/index.adp 28 Nov 2003 16:55:52 -0000 1.7
@@ -5,12 +5,14 @@
Templates Ready for Mapping
-
Mapped Templates
-TODO...
+
+
Current Simulations
@@ -20,7 +22,7 @@
Help
- The process of creating a simulation form a simulation template is referred to as instantiation. The
+ The process of creating a simulation form a simulation template is referred to as instantiation . The
instantiation process is divided into two steps:
Index: openacs-4/contrib/packages/simulation/www/siminst/index.tcl
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/contrib/packages/simulation/www/siminst/Attic/index.tcl,v
diff -u -r1.3 -r1.4
--- openacs-4/contrib/packages/simulation/www/siminst/index.tcl 27 Nov 2003 16:43:36 -0000 1.3
+++ openacs-4/contrib/packages/simulation/www/siminst/index.tcl 28 Nov 2003 16:55:52 -0000 1.4
@@ -6,65 +6,112 @@
set context [list $page_title]
set package_id [ad_conn package_id]
-######################################################################
-#
-# avail_templates
-#
-# A list of templates that can be instantiated
-#
-######################################################################
-
#---------------------------------------------------------------------
-# avail_templates list
+# Templates ready for mapping
#---------------------------------------------------------------------
-set elements {
- pretty_name {
- label "Template"
- orderby upper(w.pretty_name)
- }
- suggested_duration {
- label "Suggested Duration"
- orderby suggested_duration
- }
- number_of_roles {
- label "Roles"
- orderby number_of_roles
- }
- min_number_of_human_roles {
- label "Min \# of players"
- orderby min_number_of_human_roles
- }
- instantiate {
- link_url_col inst_url
- display_template {
- Start mapping process
+# TODO: new columns:
+# number_of_roles
+# number_of_roles_not_cast
+# number_of_tasks
+# number_of_tasks_undescribed
+# number_of_prop_slots
+# number_of_prop_unfilled
+# TODO:
+# only show casting link if all the mapping parts are complete
+template::list::create \
+ -name ready_templates \
+ -multirow ready_templates \
+ -no_data "No templates are ready for mapping" \
+ -elements {
+ pretty_name {
+ label "Template"
+ orderby upper(w.pretty_name)
}
+ suggested_duration {
+ label "Suggested Duration"
+ orderby suggested_duration
+ }
+ number_of_roles {
+ label "Roles"
+ orderby number_of_roles
+ }
+ min_number_of_human_roles {
+ label "Min \# of players"
+ orderby min_number_of_human_roles
+ }
+ map {
+ link_url_col map_url
+ display_template {
+ Begin mapping
+ }
+ }
}
-}
-template::list::create \
- -name avail_templates \
- -multirow avail_templates \
- -no_data "No simulation templates available for instantiation." \
- -elements $elements
-
-#---------------------------------------------------------------------
-# avail_templates multirow
-#---------------------------------------------------------------------
-
-# TODO: number_of_roles, min_number_of_human_roles
-db_multirow -extend {inst_url} avail_templates select_avail_templates "
+# TODO: min_number_of_human_roles should take agents into account
+db_multirow -extend {map_url} ready_templates select_ready_templates {
select workflow_id,
suggested_duration,
pretty_name,
- (select 1) as number_of_roles,
- (select 1) as min_number_of_human_roles
+ (select count(*)
+ from workflow_roles
+ where workflow_id = w.workflow_id) as number_of_roles,
+ (select count(*)
+ from workflow_roles
+ where workflow_id = w.workflow_id) as min_number_of_human_roles
from sim_simulations ss,
workflows w
where ss.simulation_id = w.workflow_id
and w.object_id = :package_id
and ready_p = 't'
-" {
- set inst_url [export_vars -base "map-characters" { workflow_id }]
+} {
+ set map_url [export_vars -base "map-create" { workflow_id }]
+
+ if { [empty_string_p $suggested_duration] } {
+ set suggested_duration "none specified"
+ }
}
+
+#---------------------------------------------------------------------
+# Mapped templates
+#---------------------------------------------------------------------
+
+template::list::create \
+ -name mapped_templates \
+ -multirow mapped_templates \
+ -no_data "No templates have been mapped" \
+ -elements {
+ pretty_name {
+ label "Template"
+ orderby upper(w.pretty_name)
+ }
+ cast {
+ link_url_col cast_url
+ display_template {
+ Begin casting
+ }
+ }
+ }
+
+# TODO: update the mapped_p subquery for agents
+# Simpler solution:
+# type column with possible values:
+# incomplete_template
+# ready_template
+# mapped_template
+# simulation
+# and not exists (select 1
+# from sim_roles sr,
+# workflow_roles wr
+# where sr.role_id = wr.role_id
+# and sr.character_id is null
+# and wr.workflow_id = w.workflow_id
+# )
+db_multirow -extend { cast_url } mapped_templates select_mapped_templates {
+ select w.workflow_id,
+ w.pretty_name
+ from workflows w
+ where w.object_id = :package_id
+} {
+ set cast_url [export_vars -base "cast-edit" { workflow_id }]
+}
Index: openacs-4/contrib/packages/simulation/www/siminst/map-characters.adp
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/contrib/packages/simulation/www/siminst/Attic/map-characters.adp,v
diff -u -r1.1 -r1.2
--- openacs-4/contrib/packages/simulation/www/siminst/map-characters.adp 27 Nov 2003 16:43:36 -0000 1.1
+++ openacs-4/contrib/packages/simulation/www/siminst/map-characters.adp 28 Nov 2003 16:55:52 -0000 1.2
@@ -2,64 +2,45 @@
@page_title;noquote@
@context;noquote@
-
-(this is just a mockup)
-
-
+
- Map to tasks
+TODO: get desired layout, see below:
+
+
+ (this is just a mockup)
+
+
+ Role
+ Character
+
+
+ Plaintiff
+
+
+ Bob
+ Jianing (Lawfirm X)
+ Larry (Lawfirm Y)
+
+
+
+ Defendent
+
+ Bob
+ Jianing (Lawfirm X)
+ Larry (Lawfirm Y)
+
+
+ Judge
+
+ Bob
+ Jianing (Lawfirm X)
+ Larry (Lawfirm Y)
+
+
+
+
Index: openacs-4/contrib/packages/simulation/www/siminst/map-characters.tcl
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/contrib/packages/simulation/www/siminst/Attic/map-characters.tcl,v
diff -u -r1.2 -r1.3
--- openacs-4/contrib/packages/simulation/www/siminst/map-characters.tcl 28 Nov 2003 09:32:26 -0000 1.2
+++ openacs-4/contrib/packages/simulation/www/siminst/map-characters.tcl 28 Nov 2003 16:55:52 -0000 1.3
@@ -12,13 +12,35 @@
set context [list [list "." "SimInst"] $page_title]
# Loop over all workflow roles and add a character select widget for each
-# set form [list]
-# set character_options [simulation::get_object_options -content_type sim_character]
-# foreach role_id [workflow::get_roles -workflow_id $workflow_id] {
-# lappend form [list role_${role_id}:text(select) \
-# [list label [workflow::get_element -role_id $role_id -element pretty_name]] \
-# [list options $character_options]
-# ]
-# }
+set form [list]
+set character_options [simulation::get_object_options -content_type sim_character]
+foreach role_id [workflow::get_roles -workflow_id $workflow_id] {
+ set role_short_name [workflow::role::get_element -role_id $role_id -element short_name]
+ set role_pretty_name [workflow::role::get_element -role_id $role_id -element pretty_name]
+ lappend form [list role_${role_short_name}:text(select) \
+ [list label $role_pretty_name] \
+ [list options $character_options]
+ ]
+}
-# ad_form -name characters -form $form
+ad_form \
+ -name characters \
+ -export { workflow_id } \
+ -form $form \
+ -on_submit {
+
+ db_transaction {
+ # Create a new template that is clone of the existing one
+ set workflow_id [simulation::template::clone -workflow_id $workflow_id]
+
+ # Map each role to chosen character
+ foreach role_id [workflow::get_roles -workflow_id $workflow_id] {
+ set role_short_name [workflow::role::get_element -role_id $role_id -element short_name]
+ simulation::role::edit -role_id $role_id -character_id [set role_${role_short_name}]
+ }
+ }
+
+ # Proceed to the task page
+ ad_returnredirect [export_vars -base map-tasks {workflow_id}]
+ ad_script_abort
+ }
Index: openacs-4/contrib/packages/simulation/www/siminst/map-create.adp
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/contrib/packages/simulation/www/siminst/Attic/map-create.adp,v
diff -u
--- /dev/null 1 Jan 1970 00:00:00 -0000
+++ openacs-4/contrib/packages/simulation/www/siminst/map-create.adp 28 Nov 2003 16:55:52 -0000 1.1
@@ -0,0 +1,6 @@
+
+ @page_title;noquote@
+ @context;noquote@
+ template.pretty_name
+
+Admin Guide View comments on this page at openacs.org Admin Guide View comments on this page at openacs.org Design View comments on this page at openacs.org Design View comments on this page at openacs.org Simulation View comments on this page at openacs.org Simulation View comments on this page at openacs.org Installation View comments on this page at openacs.org Installation View comments on this page at openacs.org Interfaces TCL API
Each TCL API item should include inputs, outputs, and a
- comment block describing any non-obvious internal issues.
View comments on this page at openacs.org Interfaces TCL API
Each TCL API item should include inputs, outputs, and a
+ comment block describing any non-obvious internal issues.
View comments on this page at openacs.org Internal Design View comments on this page at openacs.org Internal Design View comments on this page at openacs.org Appendix�A.�Licencing View comments on this page at openacs.org Appendix A. Licencing View comments on this page at openacs.org Map XML
+
+
Map XML
The simulation package will nightly generate an XML file with information needed
for the SIMBUILD flash map. The objects in the XML file will be those that are supposed
to appear on the map, i.e. those that have the on_map_p attribute set to true. The file
Index: openacs-4/packages/simulation/www/doc/object-orientation-notes.html
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/packages/simulation/www/doc/object-orientation-notes.html,v
diff -u -r1.8 -r1.9
--- openacs-4/packages/simulation/www/doc/object-orientation-notes.html 26 Nov 2003 16:44:50 -0000 1.8
+++ openacs-4/packages/simulation/www/doc/object-orientation-notes.html 28 Nov 2003 16:55:52 -0000 1.9
@@ -1,4 +1,5 @@
-
Notes on an object-oriented simulated space
An OpenACS simulation is a collection of interactive
+
+
Notes on an object-oriented simulated space An OpenACS simulation is a collection of interactive
objects, plus a set of roles and tasks. In the first part, it
is conceptually similar to a MOO (Multiple-User Dungeon,
Object-Oriented). This is a technology dating to 1990, in which
@@ -10,7 +11,7 @@
Games), which are essentially MOOs with graphical instead of
textual interfaces. Given their lineage and success, it makes
sense to draw on MOO technology when designing our simulation
- object model.
Basic MOO objects
+ object model.Basic MOO objects
Root Class
Room
Thing
@@ -27,13 +28,13 @@
Exit
Container
Openable Container
- (From the LambdaMOO Programmer's Manual
+ (From the LambdaMOO Programmer's Manual
There are three fundamental attributes to every object:
1. A flag (either true or false) specifying whether or not the object represents a player,
2. The object that is its parent, and
3. A list of the objects that are its children; that is, those
- objects for which this object is their parent. "Every object has eight built-in properties whose values are constrained to be of particular types. "
+ objects for which this object is their parent. "Every object has eight built-in properties whose values are constrained to be of particular types. "
name a string, the usual name for this object
owner an object, the player who controls access to it
location an object, where the object is in virtual reality
@@ -43,4 +44,4 @@
r a bit, is the object publicly readable?
w a bit, is the object publicly writable?
f a bit, is the object fertile?
- View comments on this page at openacs.org View comments on this page at openacs.org
Index: openacs-4/packages/simulation/www/doc/package-install.html
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/packages/simulation/www/doc/package-install.html,v
diff -u -r1.1 -r1.2
--- openacs-4/packages/simulation/www/doc/package-install.html 14 Nov 2003 14:03:11 -0000 1.1
+++ openacs-4/packages/simulation/www/doc/package-install.html 28 Nov 2003 16:55:52 -0000 1.2
@@ -1,4 +1,5 @@
-
Package installation Requires workflow and bcms and their prerequisites.
