Menu
▾
▴
[phpBT-dev] CVS: phpbt/docs/sgml configuration.sgml,1.1,1.2 dependencies.sgml,1.1,1.2 docs.dsl,1.2,1.3 phpbt.sgml,1.3,1.4
|
From: Benjamin C. <bc...@us...> - 2001-10-01 01:12:40
|
Update of /cvsroot/phpbt/phpbt/docs/sgml
In directory usw-pr-cvs1:/tmp/cvs-serv30583/sgml
Modified Files:
configuration.sgml dependencies.sgml docs.dsl phpbt.sgml
Log Message:
Filled in the configuration options, added more to the dependencies section, changed the TOC generation
Index: configuration.sgml
===================================================================
RCS file: /cvsroot/phpbt/phpbt/docs/sgml/configuration.sgml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- configuration.sgml 2001/09/29 18:35:54 1.1
+++ configuration.sgml 2001/10/01 01:12:38 1.2
@@ -25,6 +25,109 @@
<para>Location of your cvs web interface (see <function>format_comments()</function> in <filename>bug.php</filename>). This is for links to files in CVS generated from the comments attached to bugs.</para>
</listitem>
</varlistentry>
+ <varlistentry>
+ <term>DB_TYPE</term>
+ <listitem>
+ <para>The type of database server you are using, according to PHPlib's naming convention. Possible choices are msql, mssql, mysql, oci8, odbc, oracle, pgsql, and sybase. Note that only MySQL and PostgreSQL have been tested with &phpbt;</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>DB_HOST</term>
+ <listitem>
+ <para>The hostname of the database server.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>DB_DATABASE</term>
+ <listitem>
+ <para>The name of the database to be used.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>DB_USER</term>
+ <listitem>
+ <para>Username to use for connecting to the database.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>DB_PASSWORD</term>
+ <listitem>
+ <para>The password to use for connecting to the database.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>ADMINEMAIL</term>
+ <listitem>
+ <para>The email address that will be used for all correspondence to and from the bug tracker.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>ENCRYPTPASS</term>
+ <listitem>
+ <para>When true, passwords will be stored as an <function>md5()</function> hash in the database. When false, they will be stored as plaintext.</para>
+ <para>If this is set to true, a new password will be generated for users if they request their password to be emailed to them, as the encryption is not reversible.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>THEME</term>
+ <listitem>
+ <para>The directory below the <filename>templates</filename> directory (both in the top directory and the <filename>admin</filename> directory) where the <acronym>HTML</acronym> template files are located. This makes it easy to wrap the bug tracker in a completely different look.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>USE_JPGRAPH</term>
+ <listitem>
+ <para>Whether to use the <ulink url="http://www.aditus.nu/jpgraph/">JpGraph</ulink> graphing class for some reports.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>MASK_EMAIL</term>
+ <listitem>
+ <para>If true, then email addresses will be shown as <computeroutput>example at example dot com</computeroutput>. Otherwise, email addresses will be shown as <computeroutput>ex...@ex...</computeroutput>.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>HIDE_EMAIL</term>
+ <listitem>
+ <para>If true, email addresses will be shown as <computeroutput>******</computeroutput> to users who are not logged in (to help avoid spam bots on public bug trackers). If false, email addresses will be shown according the setting of <varname>MASK_EMAIL</varname>, above.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>USE_SEVERITY_COLOR</term>
+ <listitem>
+ <para>Whether to color the rows of the bug list according to the severity of the bugs. The severity colors can be set via the admin interface. If this is false, the bugs will be listed with alternating background colors of white and gray.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>EMAIL_IS_LOGIN</term>
+ <listitem>
+ <para>If true, then users login with their email address, and the email address is shown for fields such as Assigned To and Reported By. If false, the login is not tied to the user's email address.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>ATTACHMENT_PATH</term>
+ <listitem>
+ <para>The subdirectory in which to store bug attachments. This directory needs to writeable by the web server.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>ATTACHMENT_MAX_SIZE</term>
+ <listitem>
+ <para>Maximum size (in bytes) of an attachment. This will not override the settings in <filename>php.ini</filename> if <filename>php.ini</filename> has a lower limit.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>DATEFORMAT</term>
+ <listitem>
+ <para>The format for displaying the date, according to PHP's <ulink url="http://www.php.net/manual/function.date.php"><function>date()</function></ulink> function.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>TIMEFORMAT</term>
+ <listitem>
+ <para>The format for displaying the date, according to PHP's <ulink url="http://www.php.net/manual/function.date.php"><function>date()</function></ulink> function.</para>
+ </listitem>
+ </varlistentry>
</variablelist>
</sect1>
Index: dependencies.sgml
===================================================================
RCS file: /cvsroot/phpbt/phpbt/docs/sgml/dependencies.sgml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- dependencies.sgml 2001/09/27 13:40:20 1.1
+++ dependencies.sgml 2001/10/01 01:12:38 1.2
@@ -3,13 +3,51 @@
<title>Dependencies</title>
<abstract>
- <para>&phpbt; requires one external package, PHPlib, and can optionally use JpGraph.</para>
+ <para>&phpbt; requires one external package, PHPlib, and can optionally use JpGraph. Of course a web server and a database are also necessary.</para>
</abstract>
<sect2 id="dep-phplib">
<title>PHPlib</title>
<para>PHPlib can be found at <ulink url="http://phplib.sourceforge.net/">http://phplib.sourceforge.net</ulink>. It provides the database abstraction layer, html templates, and session and authentication management.</para>
+ <sect3>
+ <title>Database Abstraction</title>
+ <para>Instead of using PHP's database functions directly, interactions are done via database objects, which extend PHPlib's <classname>DB_Sql</classname> class.</para>
+ <para>The global variable <varname>$q</varname> is available as an instance of the class <classname>dbclass</classname>. This class adds two functions to the <classname>DB_Sql</classname> class, <function>grab()</function> and <function>grab_field()</function>. If they are called with an argument, the argument is passed as a query to the database and the results are returned from that query. If no argument is passed, they return results from the previous call to <function>query()</function>. Here are some examples:</para>
+ <programlisting>
+ // Grab one field from one record in the database
+ $user_email = $q->grab_field("select email from ".TBL_AUTH_USER." where user_id = 1");
+ echo $user_email;
+
+ // Stuff all the fields from a user record into an array
+ $user_info = $q->grab("select * from ".TBL_AUTH_USER." where user_id = 1");
+ echo $user_info['email'];
+
+ // Work with a set of records
+ $q->query("select * from ".TBL_AUTH_USER);
+ while ($row = $q->grab()) {
+ echo $row['email'].'<br>';
+ }
+ </programlisting>
+ </sect3>
+ <sect3>
+ <title>Templates</title>
+ <para>Instead of outputting HTML from the scripts, templates are used to separate the code from the HTML. The templates contain tokens that are replaced by the scripts with values. The general process for using templates is as follows:</para>
+ <programlisting>
+ // Set up the file to be used
+ $t->set_file('content', 'bugdisplay.html');
+
+ // Substitute the tokens with data
+ $t->set_var(array(
+ 'title' => $buginfo['title'],
+ 'description' => $buginfo['description'],
+ ....
+ ));
+
+ // Parse the template and print it out (inside a wrap template)
+ $t->pparse('main', array('content', 'wrap', 'main');
+ </programlisting>
+ </sect3>
</sect2>
</sect1>
Index: docs.dsl
===================================================================
RCS file: /cvsroot/phpbt/phpbt/docs/sgml/docs.dsl,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- docs.dsl 2001/09/29 18:35:34 1.2
+++ docs.dsl 2001/10/01 01:12:38 1.3
@@ -22,7 +22,7 @@
(define (toc-depth nd)
(if (string=? (gi nd) (normalize "book"))
- 3
+ 2
2))
Index: phpbt.sgml
===================================================================
RCS file: /cvsroot/phpbt/phpbt/docs/sgml/phpbt.sgml,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- phpbt.sgml 2001/09/29 18:35:54 1.3
+++ phpbt.sgml 2001/10/01 01:12:38 1.4
@@ -19,7 +19,7 @@
<bookinfo>
<title>&phpbt;</title>
<abstract>
- <para>&phpbt; is a web-based bug reporting and tracking system. It allows development teams to manage the testing and debugging segments of the development cycle.</para>
+ <para>&phpbt; is a web-based bug reporting and tracking system. It helps development teams to manage the testing and debugging segments of the development cycle.</para>
</abstract>
</bookinfo>
@@ -47,8 +47,8 @@
<para>Adding on to or extending &phpbt; should be easy for those with a knowledge of PHP and SQL. New developers are always welcome to join the project at <ulink url="http://www.sourceforge.net/projects/phpbt/">http://www.sourceforge.net/projects/phpbt</ulink>, or to simply submit patches, bug reports, or feature requests.</para>
</abstract>
- &devstandards;
&dependencies;
+ &devstandards;
</chapter>
</book>
|
