Changes between Version 37 and Version 38 of WebConfig

Timestamp:

Jan 24, 2018, 3:31:04 PM (6 years ago)

Author:

davea

Comment:

--

WebConfig

@@ -131 +131 @@
 === Functions ===
 
+Required functions:
+
  '''project_banner()'''::
     Prints page header
  '''project_footer()'''::
     Prints page footer
+
+Optional functions:
+
  '''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.
+    Show donation information.
+    Describe what the project uses donations for, and show guidelines for donations.
+    If function is not defined, standard donation information is displayed.
+    Called from html/user/donations.php.
  '''project_form_post_info($forum)''':: return a string describing instructions for a particular forum
     (e.g.  how to post in Questions and problems).
  '''project_forum_post_rules()''':: return a string describing message board policies.
  '''project_rules_policies()'''::
-    Displays customized project rules and policies.
+    Show general rules and policies
+    (e.g. don't run BOINC on someone else's computer without permission).
     If return value is ''true'', standard rules and policies are appended.
     If function is not defined, default rules and policies are displayed.
+ '''project_user_credit($user)'''::
+    Print table row for project-defined credit info.
  '''project_user_links($user)'''::
-    Return project-specific text to be shown after user name.
- '''project_user_page_private()'''::
-    Prints project-specific text on private user page
- '''project_user_summary()'''::
-    Prints project-specific text on user page
+    Return HTML to be shown after user name (e.g. donation icons).
+ '''project_user_page_private($user)'''::
+    Print project-specific content on private user page
+ '''project_user_summary_public($user)'''::
+    Print project-specific table row on user page
  '''project_workunit($wu)'''::
     Prints project-specific text on workunit page
@@ -160 +169 @@
  '''show_profile_question1(), show_profile_question2()'''::
     Text on user profile page
+ '''show_user_donations_private($user)'''::
+    Print table row describing donations, shown only to user.
+ '''show_user_page_private($user)'''::
+    Print project-specific info at bottom of private user page.
 
 To use [https://github.com/PHPMailer/PHPMailer PHPMailer]
@@ -173 +186 @@
 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.
-