← Back to branch summary

~ubuntu-branches/ubuntu/lucid/boinc/lucid

« back to all changes in this revision

Viewing changes to doc/web_config.php

  • Committer: Bazaar Package Importer
  • Author(s): Frank S. Thomas, Frank S. Thomas
  • Date: 2008-05-31 08:02:47 UTC
  • mfrom: (1.1.8 upstream)
  • Revision ID: james.westby@ubuntu.com-20080531080247-4ce890lp2rc768cr
Tags: 6.2.7-1
http://bugs.debian.org/463823
[ Frank S. Thomas ]
* New upstream release.
  - BOINC Manager: Redraw disk usage charts immediately after connecting to
    a (different) client. (closes: 463823)
* debian/copyright:
  - Added the instructions from debian/README.Debian-source about how
    repackaged BOINC tarballs can be reproduced because DevRef now
    recommends to put this here instead of in the afore-mentioned file.
  - Updated for the new release.
* Removed the obsolete debian/README.Debian-source.
* For consistency upstream renamed the core client and the command tool
  ("boinc_client" to "boinc" and "boinc_cmd" to "boinccmd"). Done the same
  in all packages and created symlinks with the old names for the binaries
  and man pages. Also added an entry in debian/boinc-client.NEWS explaining
  this change.
* debian/rules: Do not list Makefile.ins in the clean target individually,
  just remove all that can be found.

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/web_config.php
1
 
<?php
2
 
require_once("docutil.php");
3
 
page_head("Web site overview");
4
 
echo "
5
 
<h2>Customizing the default web site</h2>
6
 
<p>
7
 
When you create a BOINC project using
8
 
<a href=make_project.php>make_project</a>,
9
 
a web site is created for you.
10
 
This consists of a front page (html/user/index.php),
11
 
which links to pages where users can
12
 
log in, edit preferences, create profiles, and so on.
13
 
<p>
14
 
Before your project goes public,
15
 
you'll want to change this web site by
16
 
adding content specific to your project,
17
 
and by giving the web site a graphical identity specific to your project.
18
 
Make sure you do a good job;
19
 
your web site has a large impact on your project's ability to
20
 
<a href=recruit.php>recruit and retain participants</a>.
21
 
</ul>
22
 
 
23
 
<p>
24
 
Some of this customization can be done by editing
25
 
the main page (index.php) and the stylesheet (white.css).
26
 
Other aspects are changed using a configuration file, described below.
27
 
 
28
 
<h2>Web configuration file</h2>
29
 
<p>
30
 
The file 'html/project/project.inc' serves as a
31
 
configuration file for your web site.
32
 
It exists in a separate directory (html/project) so that
33
 
you can put this directory under CVS
34
 
and put all project-specific web files there
35
 
(create symbolic links from html/inc and html/user).
36
 
<p>
37
 
project.inc is generated by <a href=make_project.php>make_project</a>
38
 
with default values.
39
 
It includes constants:
40
 
";
41
 
list_start();
42
 
list_item("PROJECT", "The name of your project");
43
 
list_item("MASTER_URL", "Your project's master URL");
44
 
list_item("URL_BASE", "Base URL for web pages (usually same as master URL)");
45
 
list_item("STYLESHEET", "Name of stylesheet file");
46
 
list_item("COPYRIGHT_HOLDER", "Name of copyright holder");
47
 
list_item("SYS_ADMIN_EMAIL", "Users are directed here if they
48
 
    have complaints about message-board moderation.
49
 
    Also, messages about user-of-the-day running low are sent here.
50
 
");
51
 
list_item("FORUM_MODERATION_EMAIL_USER_ID",
52
 
    "Moderation-related emails (such as user complaints) are sent here.
53
 
");
54
 
list_item("INVITE_CODES", "regular expression used for
55
 
    <a href=account_control.php>controlling account creation</a>.
56
 
");
57
 
list_item("EMAIL_FROM", "'from' address for emails");
58
 
list_item("EMAIL_FROM_NAME", "'from' name for emails");
59
 
list_end();
60
 
 
61
 
echo "
62
 
and functions:
63
 
";
64
 
list_start();
65
 
list_item("project_banner($title)", "prints page header");
66
 
list_item("project_banner()", "prints page footer");
67
 
list_item("show_profile_heading1(), show_profile_heading2()",
68
 
    "text on user profile page");
69
 
list_item("show_profile_question1(), show_profile_question2()",
70
 
    "text on user profile page");
71
 
list_item("project_workunit()",
72
 
    "prints project-specific text on workunit page"
73
 
);
74
 
list_item("project_user_summary()",
75
 
    "prints project-specific text on user page"
76
 
);
77
 
list_item("project_user_page_private()",
78
 
    "prints project-specific text on private user page"
79
 
);
80
 
list_end();
81
 
echo "
82
 
and variables:
83
 
";
84
 
list_start();
85
 
list_item("USE_PHPMAILER", "Set to true if you use
86
 
    <a href=http://phpmailer.sourceforge.net/>PHPMailer</a>.
87
 
    In this case you must download PHPMailer and put it
88
 
    (i.e. the directory 'phpmailer') in your html/inc directory.
89
 
");
90
 
list_item("PHPMAILER_HOST",
91
 
    "The Host argument to PHPMailer; typically a semicolon-separated list
92
 
    of SMTP servers.
93
 
");
94
 
list_item("PHPMAIL_MAILER",
95
 
    "The Mailer argument to PHPMailer; typically 'sendmail', 'mail', or 'smtp'.
96
 
");
97
 
list_end();
98
 
page_tail();
99
 
?>