Changes between Version 30 and Version 31 of WebConfig
- Timestamp:
- Mar 16, 2015, 9:39:52 PM (10 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
WebConfig
v30 v31 1 [[PageOutline]] 1 2 = Web site customization = 2 3 … … 29 30 Edit this file to customize the constants and functions it contains. 30 31 31 Constants: 32 === Constants === 32 33 33 34 '''PROJECT''':: 34 35 The name of your project 35 36 '''URL_BASE''':: 36 37 Base URL for web pages (usually same as master_url defined in config.xml). 37 38 '''SECURE_URL_BASE''':: 38 39 (optional) URL prefix for forms with passwords. If your web server supports HTTPS, set this accordingly. 39 40 '''STYLESHEET''':: 40 41 Name of stylesheet file (such as `white.css`) 41 42 '''STYLESHEET2''':: 42 43 Name of an optional project supplied stylesheet. … … 52 53 url path to user profiles, is appended to URL_BASE (default: user_profile/) 53 54 '''LANGUAGE_FILE''':: 54 name of a text file that contains language names that are shown in a selection box to the user at his profile. File is expected in html/user. (default: languages.txt) 55 name of a text file that contains language names that are shown in a selection box to the user at his profile. 56 File is expected in html/user. (default: languages.txt) 55 57 '''COPYRIGHT_HOLDER''':: 56 58 Name of copyright holder 57 59 '''SYS_ADMIN_EMAIL''':: 58 60 Users are directed here if they have complaints about message-board moderation. 59 61 '''UOTD_ADMIN_EMAIL''':: 60 62 Messages about user-of-the-day running low are sent here. … … 62 64 Send email if # of UOTD candidates falls below this (default 7) 63 65 '''POST_REPORT_EMAILS''':: 64 66 Moderation-related emails (such as user complaints) are sent here. 65 67 '''INVITE_CODES''':: 66 68 Regular expression used for [AccountControl controlling account creation]. 67 69 '''EMAIL_FROM''':: 68 70 'from' address for emails 69 71 '''EMAIL_FROM_NAME''':: 70 72 'from' name for emails 71 73 '''COUNTRY_FLAGS''':: 72 74 If defined, show country flags in forums. Steps: … … 111 113 An array of strings. An account's email address may not end with any of these strings. 112 114 113 Functions: 115 === Functions === 114 116 117 '''donations_intro()''':: 118 Displays customized donation information. 119 Useful to describe what the project uses donations for, and project specific guides for donations. 120 If function is not defined, standard donation information is displayed.html/user/donations.php. 115 121 '''project_banner()''':: 116 122 Prints page header 117 123 '''project_footer()''':: 118 Prints page footer 124 Prints page footer 125 '''project_forum_post_rules()''':: return a string describing message board policies. 126 '''project_rules_policies()''':: 127 Displays customized project rules and policies. 128 If return value is ''true'', standard rules and policies are appended. 129 If function is not defined, default rules and policies are displayed. 130 '''project_user_links($user)''':: 131 Return project-specific text to be shown after user name. 132 '''project_user_page_private()''':: 133 Prints project-specific text on private user page 134 '''project_user_summary()''':: 135 Prints project-specific text on user page 136 '''project_workunit($wu)''':: 137 Prints project-specific text on workunit page 138 '''server_status_project()''':: 139 Prints project-specific info on server status page (server_status.php). 119 140 '''show_profile_heading1(), show_profile_heading2()''':: 120 141 Text on user profile page 121 142 '''show_profile_question1(), show_profile_question2()''':: 122 Text on user profile page 123 '''project_workunit($wu)''':: 124 Prints project-specific text on workunit page 125 '''project_user_links($user)''':: 126 Return project-specific text to be shown after user name. 127 '''project_user_summary()''':: 128 Prints project-specific text on user page 129 '''project_user_page_private()''':: 130 Prints project-specific text on private user page 131 '''donations_intro()''':: 132 Displays customized donation information. Useful to describe what the project uses donations for, and project specific guides for donations. If function is not defined, standard donation information is displayed.html/user/donations.php. 133 '''project_rules_policies()''':: 134 Displays customized project rules and policies. If return value is ''true'', standard rules and policies are appended. If function is not defined, default rules and policies are displayed. 135 '''project_forum_post_rules()''':: return a string describing message board policies. 143 Text on user profile page 136 144 137 To use [https://github.com/PHPMailer/PHPMailer PHPMailer] (the preferred way to send emails to participants), you must download PHPMailer and put it in PROJECT/html/inc/phpmailer (i.e. the files class.smtp.php and class.phpmailer.php should be in that directory). Than modify the following function: 145 To use [https://github.com/PHPMailer/PHPMailer PHPMailer] (the preferred way to send emails to participants), 146 you must download PHPMailer and put it in PROJECT/html/inc/phpmailer 147 (i.e. the files class.smtp.php and class.phpmailer.php should be in that directory). 148 Then modify the following function: 138 149 139 '''make_php_mailer()''':: return a PHPMailer object with authentication information (see ServerIntro#PHPMailer), used when the above is set to true. 150 '''make_php_mailer()''':: return a PHPMailer object with authentication information (see ServerIntro#PHPMailer), 151 used when the above is set to true. 140 152 141 If you do not define '''make_php_mailer()''' then e-mail to participants can still be sent, but it will use PHP's simpler '''mail()''' function. 153 If you do not define '''make_php_mailer()''' then e-mail to participants can still be sent, 154 but it will use PHP's simpler '''mail()''' function.
