Changes between Version 3 and Version 4 of WebConfig


Ignore:
Timestamp:
May 26, 2007, 8:00:46 AM (17 years ago)
Author:
Eric Myers
Comment:

Explicit instructions on what to change; monospace font for file and directory names; PHPMailer not required

Legend:

Unmodified
Added
Removed
Modified

  • WebConfig

    v3 v4  
    22
    33== Customizing the default web site ==
    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.
     4When 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.
    55
    6 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].
     6Before 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. 
     7Make sure you do a good job; your web site has a large impact on your project's ability to [VolunteerRecruit recruit and retain participants].
    78
    8 Some of this customization can be done by editing the main page (index.php) and the stylesheet (white.css). Other aspects are changed using a configuration file, described below.
     9Some 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.
    910
    1011== Web configuration file ==
    11 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 this directory under CVS and put all project-specific web files there (create symbolic links from html/inc and html/user).
     12The 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.
    1213
    13 project.inc is generated by [MakeProject make_project] with default values. It includes constants:
     14The file `project.inc` is generated by [MakeProject make_project] with default values.
     15When you set up your project you need to edit this file to customize the constants and functions it contains.
     16
     17
     18To properly configure your project you need to set values for these constants:
    1419
    1520 '''PROJECT'''::
    … …  
    2025        Base URL for web pages (usually same as master URL)
    2126 '''STYLESHEET'''::
    22         Name of stylesheet file
     27        Name of stylesheet file (such as `white.css`)
    2328 '''COPYRIGHT_HOLDER'''::
    2429        Name of copyright holder
    … …  
    2833        Moderation-related emails (such as user complaints) are sent here.
    2934 '''INVITE_CODES'''::
    30         regular expression used for [AccountControl controlling account creation].
     35        Regular expression used for [AccountControl controlling account creation].
    3136 '''EMAIL_FROM'''::
    3237        'from' address for emails
    … …  
    3439        'from' name for emails
    3540
    36 and functions:
     41You also need to customize these functions:
    3742
    3843 '''project_banner()'''::
    39         prints page header
     44        Prints page header
    4045 '''project_banner()'''::
    41         prints page footer
     46        Prints page footer
    4247 '''show_profile_heading1(), show_profile_heading2()'''::
    43         text on user profile page
     48        Text on user profile page
    4449 '''show_profile_question1(), show_profile_question2()'''::
    45         text on user profile page
     50        Text on user profile page
    4651 '''project_workunit()'''::
    47         prints project-specific text on workunit page
     52        Prints project-specific text on workunit page
    4853 '''project_user_summary()'''::
    49         prints project-specific text on user page
     54        Prints project-specific text on user page
    5055 '''project_user_page_private()'''::
    51         prints project-specific text on private user page
     56        Prints project-specific text on private user page
    5257
    53 and variables:
     58If you want to use PHPMailer to send e-mail to project participants then you should set the following
     59constants to appropriate values.
    5460
    5561 '''USE_PHPMAILER'''::
    … …  
    5965 '''PHPMAIL_MAILER'''::
    6066        The Mailer argument to PHPMailer; typically 'sendmail', 'mail', or 'smtp'.
     67
     68If you do not set '''USE_PHPMAILER''' then e-mail to participants can still be sent, but it will use PHP's simpler '''mail()''' function.