Menu
▾
▴
[phpBT-dev] CVS: phpbt/docs/sgml manifest.sgml,NONE,1.1 requirements.sgml,NONE,1.1 configuration.sgml,1.6,1.7 installation.sgml,1.5,1.6 phpbt.sgml,1.9,1.10 schema.sgml,1.2,1.3 dependencies.sgml,1.8,NONE
|
From: Benjamin C. <bc...@us...> - 2002-04-05 19:06:12
|
Update of /cvsroot/phpbt/phpbt/docs/sgml In directory usw-pr-cvs1:/tmp/cvs-serv28734/sgml Modified Files: configuration.sgml installation.sgml phpbt.sgml schema.sgml Added Files: manifest.sgml requirements.sgml Removed Files: dependencies.sgml Log Message: Updating for 0.8.0 --- NEW FILE: manifest.sgml --- <!-- -*- sgml -*- --> <sect1 id="manifest"> <title>What's where?</title> <para>Following is a list of the PHP files that make up &phpbt; and the functionality contained within them:</para> <itemizedlist> <listitem> <para><filename>attachment.php</filename></para> <para>Adding, deleting, and viewing attachment information.</para> </listitem> <listitem> <para><filename>bug.php</filename></para> <para>Adding, displaying, and editing bugs. This includes the detailed view of a bug, printable view, bug history, a view of the votes for a bug, and the code that emails users about bug changes.</para> </listitem> <listitem> <para><filename>config-dist.php</filename></para> <para>This file is used as a template for generating the configuration file during installation.</para> </listitem> <listitem> <para><filename>config.php</filename></para> <para>This file is empty in the distribution package. When &phpbt; has been installed this is the main configuration file that contains the table name definitions and includes the required packages.</para> </listitem> <listitem> <para><filename>include.php</filename></para> <para>This file is included by every other script at page load, and contains page set-up such as creating the database connection, initializing the template object, and doing authentication checks.</para> </listitem> <listitem> <para><filename>install.php</filename></para> <para>This file is used during the installation process to gather configuration information from the user and to set up the database.</para> </listitem> <listitem> <para><filename>logout.php</filename></para> <para>This is used to end the user's session.</para> </listitem> <listitem> <para><filename>newaccount.php</filename></para> <para>The code for creating new accounts and emailing accout information to new sers is located here.</para> </listitem> <listitem> <para><filename>query.php</filename></para> <para>The bug search form is rendered and handled by this script, along with the resulting list of bugs from a query.</para> </listitem> <listitem> <para><filename>report.php</filename></para> <para>Various summary reports.</para> </listitem> <listitem> <para><filename>upgrade.php</filename></para> <para>Used when upgrading to a new verison of &phpbt;. This file is changed with every release to include (mainly) the database queries required to upgrade the installation to the latest version.</para> </listitem> <listitem> <para><filename>user.php</filename></para> <para>User preferences and password changes are handled via this script.</para> </listitem> <listitem> <para><filename>admin/*.php</filename></para> <para>Each of these files handles a segment of the adminsitration. That is, <filename>group.php</filename> handles all the group adminstration, <filename>project.php</filename> is used for the project administration, etc.</para> </listitem> <listitem> <para><filename>inc/auth.php</filename></para> <para>Authentication class.</para> </listitem> <listitem> <para><filename>inc/functions.php</filename></para> <para>Supporting functions such as <function>build_select()</function>, etc.</para> </listitem> <listitem> <para><filename>inc/db/*.php</filename></para> <para>These files, named by database type, contain queries (such as left joins) that have different syntaxes among various database types.</para> </listitem> <listitem> <para><filename>languages/*.php</filename></para> <para>Named by language code, these files contain the localization of the text used throughout &phpbt;.</para> </listitem> </itemizedlist> </sect1> <!-- Local Variables: --> <!-- sgml-parent-document: "phpbt.sgml" --> <!-- End: --> --- NEW FILE: requirements.sgml --- <!-- -*- sgml -*- --> <sect1 id="requirements"> <title>Requirements</title> <para>Here is a list of things you need to have installed before you can install &phpbt;:</para> <itemizedlist> <listitem> <para>A web server (Apache, IIS, etc.) configured to run PHP scripts. The PHP version must be later than 4.0.6.</para> </listitem> <listitem> <para>PEAR::DB. This is the database abstraction layer that comes with PEAR, which is included with recent distributions of PHP.</para> </listitem> <listitem> <para>A database server. &phpbt; has been tested with MySQL, PostgreSQL (>= 7.1 required) and Oracle 8. If you wish to run this package on another type of database, I am more than willing to support more types of databases if you are willing to help with testing.</para> </listitem> <listitem> <para>A database created on your database server for use with &phpbt;. You will need to supply this database name during the installation process.</para> </listitem> <listitem> <para>Smarty templates (<ulink url="http://smarty.php.net/">http://smarty.php.net/</ulink>). If you do not have smarty templates already installed, a package of &phpbt; is distributed that has smarty included and ready to go.</para> </listitem> </itemizedlist> </sect1> <!-- Local Variables: --> <!-- sgml-parent-document: "phpbt.sgml" --> <!-- End: --> Index: configuration.sgml =================================================================== RCS file: /cvsroot/phpbt/phpbt/docs/sgml/configuration.sgml,v retrieving revision 1.6 retrieving revision 1.7 diff -u -r1.6 -r1.7 --- configuration.sgml 15 Dec 2001 18:58:15 -0000 1.6 +++ configuration.sgml 5 Apr 2002 19:06:08 -0000 1.7 @@ -3,7 +3,7 @@ <title>Configuration Options</title> <abstract> -<para>Most of the options listed here can be configured via the Configuration page of the admin tools. The <varname>DB_</varname> options can be found in <filename>config.php</filename>.</para> +<para>Most of the options listed here can be configured via the Configuration page of the admin tools. The <varname>DB_</varname> options can be found in <filename>config.php</filename> and are specified during the installation process via the installation web page.</para> </abstract> <variablelist> @@ -28,7 +28,7 @@ <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> +<para>The type of database server you are using, according to PEAR's naming convention. Possible choices are fbsql, ibase, ifx, msql, mssql, mysql, oci8, odbc, pgsql, and sybase. Note that only MySQL, PostgreSQL and Oracle 8 have been tested with &phpbt;</para> </listitem> </varlistentry> <varlistentry> @@ -75,6 +75,12 @@ </listitem> </varlistentry> <varlistentry> +<term>STYLE</term> +<listitem> +<para>The CSS file to be used from the <filename class="directory">styles</filename> directory. This makes it easy to change the color scheme and other CSS properties.</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> @@ -144,6 +150,42 @@ <term>LANGUAGE</term> <listitem> <para>The language file (found in the <filename class="directory">languages</filename> sub-directory to use for error and warning messages.</para> +</listitem> +</varlistentry> +<varlistentry> +<term>STRICT_UPDATING</term> +<listitem> +<para>If false, any logged-in user can make changes to a bug. If true, only the reporter, the person to whom the bug is currently assigned, and members of the Manager or Admin group can make changes to a bug.</para> +</listitem> +</varlistentry> +<varlistentry> +<term>PROMOTE_VOTES</term> +<listitem> +<para>The number of votes required to automatically promote a bug from the Unconfirmed to the New status. A value of 0 disables auto-promotion.</para> +</listitem> +</varlistentry> +<varlistentry> +<term>MAX_USER_VOTES</term> +<listitem> +<para>The total number of votes a user may file on bugs. A value of 0 disables the limit.</para> +</listitem> +</varlistentry> +<varlistentry> +<term>RECALL_LOGIN</term> +<listitem> +<para>Whether to show the "Remember Me" checkbox in the login form. When checked, that box will cause a cookie to be set that stores the user's login name or email address and will prefill the login area with that value the next time the user attempts to log in.</para> +</listitem> +</varlistentry> +<varlistentry> +<term>SHOW_PROJECT_SUMMARIES</term> +<listitem> +<para>Whether to show the detailed project stats on the home page.</para> +</listitem> +</varlistentry> +<varlistentry> +<term>FORCE_LOGIN</term> +<listitem> +<para>Whether users must log in before being able to browse the bugs or reports.</para> </listitem> </varlistentry> </variablelist> Index: installation.sgml =================================================================== RCS file: /cvsroot/phpbt/phpbt/docs/sgml/installation.sgml,v retrieving revision 1.5 retrieving revision 1.6 diff -u -r1.5 -r1.6 --- installation.sgml 28 Feb 2002 18:55:44 -0000 1.5 +++ installation.sgml 5 Apr 2002 19:06:08 -0000 1.6 @@ -13,9 +13,7 @@ <step> <para>After completing the installation, login and start reporting bugs.</para> -<important> -<para>You must have <varname>magic_quotes_gpc</varname> set to On either in <filename>php.ini</filename> or in <filename>.htaccess</filename> (see <ulink url="http://www.php.net/manual/en/configuration.php">http://www.php.net/manual/en/configuration.php</ulink> for more info).</para> -</important> + <note> <para>Optional: Install JpGraph (<ulink url="http://www.aditus.nu/jpgraph/">http://www.aditus.nu/jpgraph</ulink>) if you wish to use it for the summary bug display on the home page.</para> </note> Index: phpbt.sgml =================================================================== RCS file: /cvsroot/phpbt/phpbt/docs/sgml/phpbt.sgml,v retrieving revision 1.9 retrieving revision 1.10 diff -u -r1.9 -r1.10 --- phpbt.sgml 25 Oct 2001 13:00:21 -0000 1.9 +++ phpbt.sgml 5 Apr 2002 19:06:08 -0000 1.10 @@ -11,12 +11,13 @@ <!ENTITY bugdetail SYSTEM "bugdetail.sgml"> <!-- Administrator's Guide --> +<!ENTITY requirements SYSTEM "requirements.sgml"> <!ENTITY installation SYSTEM "installation.sgml"> <!ENTITY configuration SYSTEM "configuration.sgml"> <!-- Developer's Guide --> <!ENTITY devstandards SYSTEM "devstandards.sgml"> -<!ENTITY dependencies SYSTEM "dependencies.sgml"> +<!ENTITY manifest SYSTEM "manifest.sgml"> <!ENTITY schema SYSTEM "schema.sgml"> ]> @@ -47,6 +48,7 @@ <para>One of the main design goals of &phpbt; is to make installation and administration easy. In fact, the difficulty of installing bugzilla was a key motivator for &phpbt;'s existence.</para> </abstract> +&requirements; &installation; &configuration; @@ -58,7 +60,7 @@ <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> -&dependencies; +&manifest; &devstandards; &schema; Index: schema.sgml =================================================================== RCS file: /cvsroot/phpbt/phpbt/docs/sgml/schema.sgml,v retrieving revision 1.2 retrieving revision 1.3 diff -u -r1.2 -r1.3 --- schema.sgml 15 Dec 2001 18:58:15 -0000 1.2 +++ schema.sgml 5 Apr 2002 19:06:08 -0000 1.3 @@ -3,48 +3,6 @@ <title>Database Schema</title> <table> -<title>Schema for table active_sessions</title> -<tgroup cols="4"> -<thead> -<row> -<entry>Field</entry> -<entry>Type</entry> -<entry>Key</entry> -<entry>Description</entry> -</row> -</thead> -<tbody> -<row> -<entry>sid</entry> -<entry>varchar(32)</entry> -<entry>Primary</entry> -<entry></entry> -</row> -<row> -<entry>name</entry> -<entry>varchar(32)</entry> -<entry>Primary</entry> -<entry></entry> -</row> -<row> -<entry>val</entry> -<entry>text</entry> -<entry></entry> -<entry></entry> -</row> -<row> -<entry>changed</entry> -<entry>varchar(14)</entry> -<entry></entry> -<entry></entry> -</row> -</tbody> -</tgroup> -</table> - -<para>This table is used by PHPlib to store session information. It is updated with every call to <function>page_close()</function>.</para> - -<table> <title>Schema for table attachment</title> <tgroup cols="4"> <thead> @@ -479,6 +437,34 @@ </table> <table> +<title>Schema for table bug_dependency</title> +<tgroup cols="4"> +<thead> +<row> +<entry>Field</entry> +<entry>Type</entry> +<entry>Key</entry> +<entry>Description</entry> +</row> +</thead> +<tbody> +<row> +<entry>bug_id</entry> +<entry>int(10) unsigned</entry> +<entry>Primary</entry> +<entry></entry> +</row> +<row> +<entry>depends_on</entry> +<entry>int(10) unsigned</entry> +<entry>Primary</entry> +<entry></entry> +</row> +</tbody> +</tgroup> +</table> + +<table> <title>Schema for table bug_group</title> <tgroup cols="4"> <thead> @@ -494,13 +480,13 @@ <entry>bug_id</entry> <entry>int(10) unsigned</entry> <entry>Primary</entry> -<entry>Foreign</entry> +<entry></entry> </row> <row> <entry>group_id</entry> <entry>int(10) unsigned</entry> <entry>Primary</entry> -<entry>Foreign</entry> +<entry></entry> </row> </tbody> </tgroup> @@ -508,6 +494,40 @@ <para>This table isn't currently used.</para> <table> +<title>Schema for table bug_vote</title> +<tgroup cols="4"> +<thead> +<row> +<entry>Field</entry> +<entry>Type</entry> +<entry>Key</entry> +<entry>Description</entry> +</row> +</thead> +<tbody> +<row> +<entry>user_id</entry> +<entry>int(10) unsigned</entry> +<entry>Primary</entry> +<entry></entry> +</row> +<row> +<entry>bug_id</entry> +<entry>int(10) unsigned</entry> +<entry>Primary</entry> +<entry></entry> +</row> +<row> +<entry>created_date</entry> +<entry>bigint(20) unsigned</entry> +<entry></entry> +<entry></entry> +</row> +</tbody> +</tgroup> +</table> + +<table> <title>Schema for table bug_history</title> <tgroup cols="4"> <thead> @@ -723,35 +743,6 @@ <para>This table stores the configuration for &phpbt;</para> <table> -<title>Schema for table db_sequence</title> -<tgroup cols="4"> -<thead> -<row> -<entry>Field</entry> -<entry>Type</entry> -<entry>Key</entry> -<entry>Description</entry> -</row> -</thead> -<tbody> -<row> -<entry>seq_name</entry> -<entry>varchar(127)</entry> -<entry>Primary</entry> -<entry></entry> -</row> -<row> -<entry>nextid</entry> -<entry>int(10) unsigned</entry> -<entry></entry> -<entry></entry> -</row> -</tbody> -</tgroup> -</table> -<para>PHPlib uses this table in generating the incrementing primary key sequences for the other tables.</para> - -<table> <title>Schema for table group_perm</title> <tgroup cols="4"> <thead> @@ -1153,6 +1144,34 @@ <entry>int(10) unsigned</entry> <entry>Primary</entry> <entry></entry> +</row> +</tbody> +</tgroup> +</table> + +<table> +<title>Schema for table user_pref</title> +<tgroup cols="4"> +<thead> +<row> +<entry>Field</entry> +<entry>Type</entry> +<entry>Key</entry> +<entry>Description</entry> +</row> +</thead> +<tbody> +<row> +<entry>user_id</entry> +<entry>int(10) unsigned</entry> +<entry>Primary</entry> +<entry></entry> +</row> +<row> +<entry>email_notices</entry> +<entry>tinyint(1)</entry> +<entry></entry> +<entry>Whether the user wants to receive email notices from &phpbt;. Values are 1 for yes (default) or 0 for no.</entry> </row> </tbody> </tgroup> --- dependencies.sgml DELETED --- |
