| | {anchor:AEN1} |
| | h1. {anchor:AEN2}RIFE Users Guide |
| | |
| | {anchor:AEN31} |
| | |
| | This material may be distributed only subject to the terms and conditions set forth in the Open Publication License, v1.0 or later (the latest version is presently available at http://www.opencontent.org/openpub/). |
| | |
| | h3. *Table of Contents* |
| | |
| | # [Introduction|GuideIntroduction] |
| | ## [Purpose|GuideIntroduction#sect1_intro_purpose] |
| | ## [History of RIFE|GuideIntroduction#sect1_intro_history] |
| | ## [Java web applications|GuideIntroduction#sect1_intro_javawebapps] |
| | # [Getting started|GuideGettingStarted] |
| | ## [Installing RIFE|GuideGettingStarted#sect1_starting_installing] |
| | ## [A simple RIFE application|GuideGettingStarted#sect1_starting_simple_app] |
| | # [Creating a more advanced RIFE application|GuideNumberguess] |
| | ## [Laying out the structure|GuideNumberguess#sect1_numberguess_structure] |
| | ## [Linking elements|GuideNumberguess#sect1_numberguess_linking] |
| | ## [Passing data between elements|GuideNumberguess#sect1_numberguess_data] |
| | ## [Templates|GuideNumberguess#sect1_numberguess_templates] |
| | ## [Reading data from a form|GuideNumberguess#sect1_numbergess_forms] |
| | ## [Specifying the starting point|GuideNumberguess#sect1_numberguess_arrival] |
| | ## [Wrapping it up|GuideNumberguess#sect1_numberguess_wrap_up] |
| | # [Templates|GuideTemplates] |
| | ## [The block tag|GuideTemplates#sect1_templates_block_tag] |
| | ## [The value tag|GuideTemplates#sect1_templates_value_tag] |
| | ## [Overriding the default value|GuideTemplates#sect1_templates_bv_tag] |
| | ## [The include tag|GuideTemplates#sect1_templates_i_tag] |
| | # [A friends database|GuideFriends] |
| | ## [Introduction|GuideFriends#sect1_friends_intro] |
| | ## [Defining and connecting the elements|GuideFriends#sect1_friends_elements] |
| | # [Adding configuration to the friends application|GuideConfiguration] |
| | ## [Some explanation on RIFE participants|GuideConfiguration#sect1_friends_participants] |
| | ## [Configuration in the friends application|GuideConfiguration#sect1_friends_real_configuration] |
| | ## [More on configuration |GuideConfiguration#sect1_friends_more_configuration] |
| | # [Adding database support |GuideDatabase] |
| | ## [The datasource participant |GuideDatabase#sect1_database_participant] |
| | ## [Selecting a data source |GuideDatabase#sect1_database_config] |
| | ## [The Friend bean |GuideDatabase#sect1_database_bean] |
| | ## [Managing the data |GuideDatabase#sect1_database_dbmanager] |
| | ## [Displaying the friends |GuideDatabase#sect1_database_displaying_friends] |
| | ## [Adding friends |GuideDatabase#sect1_database_adding_friends] |
| | ## [Finishing up the example |GuideDatabase#sect1_database_finishing_up] |
| | ## [We're done! |GuideDatabase#sect1_database_summary] |
| | # [Adding authentication |GuideAuthentication] |
| | ## [Authentication |GuideAuthentication#sect1_authentication] |
| | ## [Memory users |GuideAuthentication#sect1_authentication_memory_users] |
| | ## [Changing the site structure |GuideAuthentication#sect1_authentication_site_structure] |
| | ## [Putting it all together |GuideAuthentication#sect1_authentication_putting_together] |
| | ## [Finishing touches |GuideAuthentication#sect1_authentication_finishing_touches] |
| | # [Using a database for user data |GuideDatabaseUsers] |
| | ## [Authentication and database users |GuideDatabaseUsers#sect1_authentication_db_users] |
| | ## [Creating users |GuideDatabaseUsers#sect1_creating_users] |
| | ## [Managing additional user data |GuideDatabaseUsers#sect1_additional_data] |
| | # [Further reading|GuideFurtherReading] |
| | |
| | h3. *List of Figures* |
| | |
| | * [The numberguess site|GuideNumberguess#figure_numberguess_site] |
| | |
| | h3. *List of Examples* |
| | |
| | * [The participants file for Hello World |GuideGettingStarted#example_starting_participants] |
| | * [Site file for Hello World |GuideGettingStarted#example_starting_site] |
| | * [The Java element of Hello World |GuideGettingStarted#example_starting_java_element] |
| | \\ |
| | \\ |
| | * [Directory structure for the numberguess example |GuideNumberguess#example_numberguess_tructure] |
| | * [Defining exits for an element |GuideNumberguess#example_numberguess_exits] |
| | * [Defining flowlinks |GuideNumberguess#example_numberguess_flowlinks] |
| | * [Defining inputs and outputs |GuideNumberguess#example_numberguess_inputs_outputs] |
| | * [Adding data links to the guess element |GuideNumberguess#example_numberguess_guess_datalinks] |
| | * [The template for the guess page |GuideNumberguess#example_numberguess_template] |
| | * [Adding a submission to the guess element |GuideNumberguess#example_numberguess_form] |
| | * [The guess template with a form |GuideNumberguess#example_numberguess_form_template] |
| | * [Java code for the Guess element |GuideNumberguess#example_numberguess_form_java] |
| | * [The final number guess site file |GuideNumberguess#example_number_guess_site] |
| | \\ |
| | \\ |
| | * [guess.html |GuideTemplates#example_templates_guess] |
| | * [Snippet from Guess.java that uses setBlock() |GuideTemplates#example_templates_setblock_guess] |
| | * [Template that can be used as a standard page, page.html |GuideTemplates#example_templates_page] |
| | * [Including another page with the I-tag, home.html |GuideTemplates#example_templates_i_tag] |
| | \\ |
| | \\ |
| | * [Directory structure of the friends application |GuideFriends#example_friends_structure] |
| | * [Participant file for Friends database |GuideFriends#example_friends_participants] |
| | * [The DISPLAY element |GuideFriends#example_friends_elements_display] |
| | * [The MENU element |GuideFriends#example_friends_elements_menu] |
| | * [PrintTemplate.java: Using properties from Java |GuideFriends#example_friends_printtemplate] |
| | * [PrintTemplateInjection.java: Injecting properties from Java |GuideFriends#example_friends_printtemplate] |
| | * [First cut on the site definition |GuideFriends#example_friends_site_1] |
| | * [Template for listing friends |GuideFriends#example_friends_display_template] |
| | * [The Java code used to add friends |GuideFriends#example_friends_display_implementation] |
| | \\ |
| | \\ |
| | * [Participant file for Friends database |GuideConfiguration#example_friends_participants2] |
| | * [A configuration file |GuideConfiguration#example_configuration_conffile] |
| | * [Display template modified to use configuration data for title |GuideConfiguration#example_friends_display_template_configure] |
| | * [Using the values from within the configuration file |GuideConfiguration#example_configuration_conffile2] |
| | * [Filename convention when using selectors |GuideConfiguration#example_configuration_file_names] |
| | \\ |
| | \\ |
| | * [Adding a data source participant |GuideDatabase#example_participants_datasources] |
| | * [Data source definition |GuideDatabase#example_datasource] |
| | * [Selecting a data source through the configuration system |GuideDatabase#example_datasource_config] |
| | * [Friend bean class |GuideDatabase#example_friend_bean] |
| | * [Using the selected data source |GuideDatabase#example_manager_datasource_config] |
| | * [Retrieving the friends list |GuideDatabase#example_retrieving_friends] |
| | * [Our row processor |GuideDatabase#example_row_processor] |
| | * [Updating the site file |GuideDatabase#example_site_add_element] |
| | * [Element for adding a friend |GuideDatabase#example_add_element] |
| | * [Template for adding a friend |GuideDatabase#example_add_template] |
| | * [Adding a friend to the database |GuideDatabase#example_add_query] |
| | * [Method to install the Friends table |GuideDatabase#example_install_table] |
| | * [Method to remove the Friends table |GuideDatabase#example_remove_table] |
| | \\ |
| | \\ |
| | * [A memory users configuration file |GuideAuthentication#example_authentication_repository] |
| | * [Memory users configuration file |GuideAuthentication#example_authentication_memory_users] |
| | * [The main site definition file |GuideAuthentication#example_authentication_main_site_file] |
| | * [The admin site definition file |GuideAuthentication#example_authentication_admin_site_file] |
| | * [The authentication element |GuideAuthentication#example_authentication_element] |
| | * [The authentication template |GuideAuthentication#example_authentication_template] |
| | * [Adding authid to sites/friends.xml |GuideAuthentication#example_authentication_add_authid] |
| | \\ |
| | \\ |
| | * [Element using dynamic submission parameters |GuideCookbook#example_cookbook_dyn_parameters_element] |
| | * [Template used for demonstrating dynamic submission parameters |GuideCookbook#example_cookbook_dyn_parameters_template] |
| | * [Java implementation of element using dynamic submission parameters |GuideCookbook#example_cookbook_dyn_parameters_java] |
| | * [Defining an element with a cookie |GuideCookbook#example_cookbook_cookies_def] |
| | * [NewsList.java: Using cookies from Java |GuideCookbook#example_cookbook_cookies_impl] |
| | * [Site using a departure |GuideCookbook#example_more_engine_departure] |
| | * [Showing the group tag being used |GuideCookbook#example_cookbook_group] |
| | \\ |
| | \\ |
| | * [Datasource dependent implementation |GuideCookbookDatabase#example_db_adv_datasource_dependent_implementation] |
| | * [Datasource independent implementation |GuideCookbookDatabase#example_db_adv_datasource_independent_implementation] |
| | * [An abstract row processor |GuideCookbookDatabase#example_db_adv_abstract_processor] |
| | \\ |
| | \\ |
| | * [Authentication element for database users |GuideDatabaseUsers#example_authentication_db_users1] |
| | * [Installing the tables for database users |GuideDatabaseUsers#example_authentication_db_users2] |
| | | * [Encrypted memory users |GuideDatabaseUsers#example_authentication_encrypted_users] |
| | \\ |
| | \\ |
| | * [Participant file defining TestParticipant |GuideFurtherReading#example_nonweb_participants] |
| | * [Implementation of a Participant |GuideFurtherReading#example_nonweb_TestParticipant] |
| | * [Starting a participant from the main method |GuideFurtherReading#example_nonweb_main] |
| | \\ |
| | \\ |
| | * [Uploading a file without using beans |GuideCookbook#sect_cookbook_fileupload] |
