Changes between Version 4 and Version 5 of ProjectSpecificPrefs

Timestamp:

Jul 30, 2016, 4:39:56 PM (8 years ago)

Author:

davea

Comment:

--

ProjectSpecificPrefs

@@ -3 +3 @@
 You can provide users with a set of project-specific preferences, controlled via a web interface.
 These preferences are stored in XML, in a field of the user table.
-You determine the structure of this XML, and what it's used for.
-On the client, the XML is passed to your application in the [BasicApi#Communicatingwiththecoreclient APP_INIT_DATA structure].
+The code related to project-specific preferences is in `html/project/project_specific_prefs.inc`.
+When you create your project, this is initialized to sample code.
 
-Examples of project-specific preferences include:
+The sample code contains a number of preferences that you can enable
+by setting the corresponding constant to true:
 
- * Graphics preferences: e.g., color scheme.
- * [AppFiltering Application selection]: you can allow users to select which of your applications they will be sent work for.
+ * APP_SELECT_PREFS:
+   [AppFiltering Application selection]: users can select which of your applications they will be sent work for.
+ * MAX_JOBS_PREFS: users can limit the number of this project's jobs in progress
+ * MAX_CPUS_PREFS: users can limit the number of CPUs used by this project.
+ * NON_GRAPHICAL_PREF: users can choose to run non-graphical versions of apps if available.
+ * COLOR_PREFS: let the user select a color scheme for your application graphics.
+  (On the client, the XML is passed to your applications in the [BasicApi#Communicatingwiththecoreclient APP_INIT_DATA structure];
+  your graphics app can parse this and changes it colors accordingly).
+ * GFX_CPU_PREFS: the user can limit the % of CPU used by the graphics app.
 
-The PHP code related to project-specific preferences is in `html/project/project_specific_prefs.inc`.
-When you create your project, this is initialized to sample code.
-To create your own project-specific preferences, edit this file
-(and keep it under SVN or CVS somewhere).
+To create your own project-specific preferences, edit this file (and keep it under SVN or CVS somewhere).
 The functions you must supply are: