2009-08-03
QPL Reference Manual

Warning! This page is in the process of being rewritten for QPL Version 6. It may still have references to QPL Version 5.

After you have built the web version of your questionnaire, using HomeSite or the Console tools, your next step is to get the files from your computer to your web site administrator.

You should only select the files that are actually needed to run on the web site. Over 100 files are required to run one project on a web server. So its easier to think in terms of what files do not need to be there. All the files in your local project directory should be copied to your web server except for the files listed in the table below (plus any files you may have created yourself, such as notes or other documentation).

Project Files Not Needed on the Web Site

File Comment
job.pg6
job.qpl
job.err
Source program and intermediate project files.
private.key
public.key
These files are no longer used by QPL projects that were built using Version 5.04.001 or later. These files were used with previous versions of QPL to encrypt and decrypt exported data files.
job.htm
main.htm
menu.htm
hello.htm
Local HTML versions of the questionnaire project are not used on the web site.
qpl_sample_letter.htm Template for HTML-formated email message.
qpl_mail_queue.sql
qpl_mail_queue.txt
SQL script that creates the qpl_mail_queue data base and documentation.

Note: Replace "job" above with the name of your project.

For completeness, the list of files required to run your questionnaire on a web server are listed in the table below. Again, replace "job" below with the name of your project.

Project Files Required on the Web Site

File Comment
index.htm*
main.php*
menu.htm
job.inc
job.js
job.php
job.sql**
Files automatically generated by the QPL converter.

*The index.htm and main.php files are only generated the first time the PHP files are created, that is, the files are only created when they do not exist. This way, any changes you may make to these files are preserved. Delete these files if you want to rebuild them with the converter.

**The project .sql file, and any SQL files you created, should be deleted from the server after they are run.
qpl_config.inc Standard configuration file. It is used to tell your QPL project how to access various resources on your server. Although this file is included when you create a new project, it should be only installed on your server when your web administrator completes the one-time server setup tasks. All of the QPL projects on your server should share the same qpl_config.inc file.
qpl_loading.gif "Loading..." graphic that is displayed after the respondent clicks on the "Start log on" button on the home page (index.htm) and before the log in page is displayed.
qpl_bar1_1x1.gif
qpl_bar1_1x2.gif
qpl_bar1_1x3.gif
qpl_bar1_1x4.gif
qpl_bar1_1x5.gif
qpl_bar1_1x6.gif
qpl_bar1_1x7.gif
qpl_bar1_1x8.gif
qpl_bar1_1x9.gif
qpl_bar2_1x1.gif
qpl_bar2_1x2.gif
qpl_bar2_1x3.gif
qpl_bar2_1x4.gif
qpl_bar2_1x5.gif
qpl_bar2_1x6.gif
qpl_bar2_1x7.gif
qpl_bar2_1x8.gif
qpl_bar2_1x9.gif
qpl_bar3_1x1.gif
qpl_bar3_1x2.gif
qpl_bar3_1x3.gif
qpl_bar3_1x4.gif
qpl_bar3_1x5.gif
qpl_bar3_1x6.gif
qpl_bar3_1x7.gif
qpl_bar3_1x8.gif
qpl_bar3_1x9.gif
qpl_button_off.gif
qpl_button_on.gif
Standard graphic files used for the menu and navigation bar.
qpl_admin.php
qpl_admin_form.inc
qpl_button_off.gif
qpl_button_on.gif
qpl_ca_add_edit_tag_form.inc
qpl_ca_add_edit_tag_list_form.inc
qpl_ca_assign_list_question_form.inc
qpl_ca_assign_list_responses_form.inc
qpl_ca_assign_select_responses_form.inc
qpl_ca_assign_tags_form.inc
qpl_ca_delegate_admin_permissions.inc
qpl_ca_display_tag_list_form.inc
qpl_ca_reconcile_report_list_responses_form.inc
qpl_ca_report_list_form.inc
qpl_ca_report_tabulation_form.inc
qpl_ca_report_tabulation_summary_form.inc
qpl_ca_show_tag_def.php
qpl_ca_stat_cohens_kappa.inc
qpl_ca_summary_report_list_responses_form.inc
qpl_ca_wordcount_list_question_form.inc
qpl_ca_wordcount_tabulation_summary_form.inc
qpl_catch.php
qpl_constants.inc
qpl_convert.exe
qpl_custom_report_form.inc
qpl_custom_report_form_public.php
qpl_db_admin_funcs.inc
qpl_db_admin_main_form.inc
qpl_db_funcs.inc
qpl_done_form.inc
qpl_error_form.inc
qpl_expire_form.inc
qpl_export_fixed_data_form.inc
qpl_export_tab_data_form.inc
qpl_help.htm
qpl_help.php
qpl_hs_php.js
qpl_loading_form.htm
qpl_log_form.inc
qpl_login.php
qpl_login_form.inc
qpl_login_post.php
qpl_login_post_form.inc
qpl_mail_edit_form.inc
qpl_mail_select_form.inc
qpl_mail_send_form.inc
qpl_mail_test_form.inc
qpl_mail_view_log_detail_form.inc
qpl_mail_view_log_form.inc
qpl_messages.inc
qpl_nav.htm
qpl_padlock.gif
qpl_popup_calendar.js
qpl_popup_calendar_button.gif
qpl_popup_calendar_close.gif
qpl_popup_calendar_divider.gif
qpl_popup_calendar_drop1.gif
qpl_popup_calendar_drop2.gif
qpl_popup_calendar_left1.gif
qpl_popup_calendar_left2.gif
qpl_popup_calendar_right1.gif
qpl_popup_calendar_right2.gif
qpl_popup_clock_button.gif
qpl_pswd_form.inc
qpl_reset_page.inc
qpl_response_form.inc
qpl_sample_letter.htm
qpl_sample_popup_text.htm
qpl_script.js
qpl_script_disable_menu.js
qpl_script_hello.js
qpl_select_code.inc
qpl_select_form.inc
qpl_session_form.inc
qpl_show_personal_responses.php
qpl_style.css
qpl_user_edit_form.inc
qpl_user_find_form.inc
qpl_user_select_form.inc
Standard program files.

Now the web server administrator can install your questionnaire project on a web server!