Changes between Version 5 and Version 6 of WebConfig

Timestamp:

May 28, 2008, 1:21:01 PM (16 years ago)

Author:

davea

Comment:

--

WebConfig

@@ -4 +4 @@
 When you create a BOINC project using [MakeProject make_project], a web site is created for you. This consists of a front page (`html/user/index.php`), which links to pages where users can log in, edit preferences, create profiles, and so on.
 
-Before your project goes public, you'll want to change this web site by adding content specific to your project, and by giving the web site a graphical identity specific to your project.  
-Make sure you do a good job; your web site has a large impact on your project's ability to [VolunteerRecruit recruit and retain participants].
+Before your project goes public, you'll want to change this web site by adding content
+and giving the web site a graphical identity specific to your project.  
+Make sure you do a good job;
+your web site has a large impact on your project's ability to
+[VolunteerRecruit recruit and retain participants].
 
-Some of this customization can be done by editing the main page (`index.php`) and the stylesheet (`white.css`) files. Other aspects are changed using a configuration file, described below.
+Some of this customization can be done by editing the main page (`index.php`) and the stylesheet (`white.css`) files.
+Other aspects are changed using a configuration file, described below.
 
 == Web configuration file ==
-The file `html/project/project.inc` serves as a configuration file for your web site. It exists in a separate directory (html/project) so that you can put all project-specific web files there (create symbolic links from `html/inc` and `html/user`).  You can also put this directory under your own CVS to manage version control.
+The file `html/project/project.inc` serves as a configuration file for your web site.
+It exists in a separate directory (html/project) so that you can put all project-specific web files there
+(create symbolic links from `html/inc` and `html/user`).
+You should put this directory under version control (SVN or CVS).
 
 The file `project.inc` is generated by [MakeProject make_project] with default values. 
-When you set up your project you need to edit this file to customize the constants and functions it contains.
+Edit this file to customize the constants and functions it contains.
 
-
-To properly configure your project you need to set values for these constants:
+Constants:
 
  '''PROJECT'''::
         The name of your project
  '''MASTER_URL'''::
-        Your project's master URL
+        Your project's master URL (warning: if you change this, volunteers will have to detach/reattach your project)
  '''URL_BASE'''::
         Base URL for web pages (usually same as master URL)
@@ -29 +35 @@
         Name of copyright holder
  '''SYS_ADMIN_EMAIL'''::
-        Users are directed here if they  have complaints about message-board moderation. Also, messages about user-of-the-day running low are sent here.
+        Users are directed here if they have complaints about message-board moderation. Also, messages about user-of-the-day running low are sent here.
  '''FORUM_MODERATION_EMAIL_USER_ID'''::
         Moderation-related emails (such as user complaints) are sent here.
@@ -39 +45 @@
         'from' name for emails
 
-You also need to customize these functions:
+Functions:
 
  '''project_banner()'''::
@@ -55 +61 @@
  '''project_user_page_private()'''::
         Prints project-specific text on private user page
+ '''donations_intro()'''::
+    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.
+ '''project_rules_policies()'''::
+    Displays customized project rules and policies. If return value is ''true'', standard rules and policies are appended in the end. If function is not defined, default rules and policies are displayed. Return true to append default rules and policies. Should use PHP `echo()` to output text. Used inhtml/user/info.php.
 
-If you want to use PHPMailer to send e-mail to project participants then you should set the following
-constants to appropriate values.
+To use PHPMailer (the preferred way to send emails to participants):
 
  '''USE_PHPMAILER'''::