Thread: [Phpslash-commit] CVS: phpslash-ft/doc/html phpslash.sgml,1.62,1.63

SourceForge Headquarters 225 Broadway Suite 1600 San Diego, CA 92101 +1 (858) 422-6466

Update of /cvsroot/phpslash/phpslash-ft/doc/html
In directory sc8-pr-cvs1:/tmp/cvs-serv15891/phpslash-ft/doc/html

Modified Files:
	phpslash.sgml 
Log Message:
install and upgrade docs

Index: phpslash.sgml
===================================================================
RCS file: /cvsroot/phpslash/phpslash-ft/doc/html/phpslash.sgml,v
retrieving revision 1.62
retrieving revision 1.63
diff -C2 -d -r1.62 -r1.63
*** phpslash.sgml	9 Jan 2003 01:18:18 -0000	1.62
--- phpslash.sgml	9 Jan 2003 16:36:28 -0000	1.63
***************
*** 196,201 ****
    <item><url url="http://www.php.net/" name="The PHP Engine">
      <itemize>
!       <item>Suggested version 4.0.3pl1 and higher.
!       <item>Required version 3.0.10.
        <item> If possible, use a php module compiled for you server's 
               native API (as opposed to the CGI version).  PHP works fine 
--- 196,201 ----
    <item><url url="http://www.php.net/" name="The PHP Engine">
      <itemize>
!       <item>Suggested version 4.3 and higher.
!       <item>Required version 4.1.2.
        <item> If possible, use a php module compiled for you server's 
               native API (as opposed to the CGI version).  PHP works fine 
***************
*** 210,214 ****
    <item><url url="http://phplib.netuse.de/" name="PHPLIB">
      <itemize>
!       <item>Suggested version 7.2d and higher.
        <item>If you have PHP4, you *must* run at least 7.2c because of a bug in the template library.
      </itemize>
--- 210,214 ----
    <item><url url="http://phplib.netuse.de/" name="PHPLIB">
      <itemize>
!       <item>Suggested version 7.4-pre1 and higher.
        <item>If you have PHP4, you *must* run at least 7.2c because of a bug in the template library.
      </itemize>
***************
*** 302,306 ****

  I'm going to assume that you have a public_html directory where all 
! your html files reside.  
  <enum>
    <item>Unpack PHPLIB and move the php directory to ~username/phplib
--- 302,307 ----

  I'm going to assume that you have a public_html directory where all 
! your html files reside.   <bf>Note:  PHPLIB should not need any installation or
! configuration.  Any references below should be optional for developers</bf>.
  <enum>
    <item>Unpack PHPLIB and move the php directory to ~username/phplib
***************
*** 324,405 ****
  </enum>

! <sect1> Edit the config.php3 script in the phpslash directory.
  <p>
  <descrip>
  <tag/Section 1.1/

! If you didn't auto_prepend the "prepend.php3" script in a .htaccess
! file then go ahead and uncomment this line.  PHPSlash needs to see
! one copy of the file, either it's required here or it's automatically
! done via the PHP engine.  If you have both enabled then you'll get 
! a 'Cannot redeclare class db_sql' error. 

  <tag/Section 1.11/

  Here are some directory and URL paths that are needed by phpslash., Shown below is a brief explanation along with an example of what the line will look like in the config file.  You'll need to edit these in order for phpslash to work.
  NOTE: There are no trailing slashes at the end.  
  NOTE: The format changed from previous versions of phpSlash.

! A reference to the local running php script.  We use this a lot, so it makes sense to make a copy in our own array and use that instead of doing a global $PHP_SELF; on every function 
! and object. $_PSL[phpself] = $HTTP_SERVER_VARS['PHP_SELF'];
! 
! Complete filesystem path to the pages
! $_PSL[basedir] = '/home/nathan/webDevel/phpslash-ft/public_html';
! 
! Path to the templates directory
! $_PSL[templatedir] = $_PSL[basedir] . '/templates';
! 
! Path to the class directory
! $_PSL[classdir] = '/home/nathan/webDevel/phpslash-ft/class';
! 
! The base URL for the phpslash site
! $_PSL[rooturl] = 'http://fatboy.mystic/ft';
! 
! The base URL for the admin pages
! $_PSL[adminurl] = $_PSL[rooturl] . '/admin';
! 
! The base URL for images that pertain to phpslash
! $_PSL[imageurl] = $_PSL[rooturl] . '/images';
! 
! The url for all the topic images.
! $_PSL[topicimageurl] = $_PSL[imageurl] . "/topics";
! 
! The full directory path to the topic images.
! $_PSL[topicimagedir] = $_PSL[basedir] . "/images" . "/topics";

! $Host     - the hostname of the MySQL server 

! $Database - the name of the database 

! $User     - the username used to connect to the database 

! $Password - the password needed to connect to the database

  <tag/Section 1.2/

- If you look at the prepend.php3 script inside the phplib directory you'll
- see that the default is to NOT load the template library.  So for people
- who can't edit the prepend.php3 file directly we provide a chance for them
- to 'require' the template library here.  You can either put it in the 
- prepend.php3 script, or just comment it out here.  One or the other, but
- not both.  Remember, PHPSlash needs the library, but if you have it twice
- you'll get those "Can't redeclare class ..." errors.

  <tag/Section 1.3/

- These are the .class libraries that PHPSlash uses to function.  As of 
- writing we have _all_ the libraries loaded for every page.  When 0.6-FINAL
- is out we will trim these down to what's required for the main index page,
- then 'require' the libraries in other pages as needed.

  <tag/Section 1.4/

- This is the general PHPSlash function library.  This is where some of 
- our common functions reside.

  <tag/Section 1.99/

- If you have any special custom libraries that you need to be required on
- every page, then place them in this section.

  <tag/Section 2.0:  PHPLIB configuration/
--- 325,395 ----
  </enum>

! <sect1> Edit the config files.
  <p>
  <descrip>
  <tag/Section 1.1/

! Copy config-dist.ini.php somewhere.  If this is kept in the server root keep the .php extension.  For our example we will use config.ini.php.
! Copy config-dist.php to config.php.  Edit the line below to contain the full path to the ini file:
! 
!   <tscreen><verb>
!     // Specify full path to ini file
!     $psl_inifile = "config.ini.php";
!   </verb></tscreen>

  <tag/Section 1.11/

+ Edit the ini file appropriately as detailed below.
+ 
  Here are some directory and URL paths that are needed by phpslash., Shown below is a brief explanation along with an example of what the line will look like in the config file.  You'll need to edit these in order for phpslash to work.
  NOTE: There are no trailing slashes at the end.  
  NOTE: The format changed from previous versions of phpSlash.

!   <tscreen><verb>
!     ;; The complete filesystem path to the pages
!     basedir = "/path/to/phpslash-ft/public_html"
!     ;;
!     ;; The complete filesystem path to the class directory
!     classdir = "/path/to/phpslash-ft/class"
!     ;;
!     ;; The base URL for the phpslash site
!     rooturl = "http://www.yourdomain.com/phpslash"

!     DB_Host = "localhost"
!     DB_Database = "phpslash"
!     DB_User = "phpslash"
!     DB_Password = "phpslash"

!     ;; Name of the site.  This appears for example on the titlebar of
!     ;; browser windows.
!     site_name = "PHPSlash"
!     ;;
!     ;; Email address to reach a human.  
!     site_owner = "in...@ph..."
!     ;;
!     ;; A catch phrase for your site.
!     site_slogan = "Slash for you, Slash for me"
!     ;;
!     ;; A Longer version of the title.
!     site_title = "PHPSlash: The Web Stops Here"

!     ;; Use this secret string when generating site unique variables.  For
!     ;; security's sake, change this to something, anything.  
!     magic = "ChangeThisToSomethingUnique"
!     ;;;

!   </verb></tscreen>

  <tag/Section 1.2/

  <tag/Section 1.3/

  <tag/Section 1.4/

  <tag/Section 1.99/

  <tag/Section 2.0:  PHPLIB configuration/
***************
*** 416,421 ****
  path names are correct in the config.php3 script.

! Once you correct any initial problems, go to the 'Admin' screen and log
! in with:
  <tscreen><code>
  Username:  god
--- 406,410 ----
  path names are correct in the config.php3 script.

! Once you correct any initial problems, go to the 'Admin' screen by clicking the 'login' link and log in with:
  <tscreen><code>
  Username:  god
***************
*** 425,436 ****
  Those values are case sensitive. 

! In the NavBar (the blue bar under the topic icons with all the text links
! on it), click on 'Authors'.  Change the password for God and click on 
  update.

! NOTE:  Do not delete the God account yet.  First create an account for
! yourself with all Security permissions.  Then, post a story to the
! site.  Next, delete that "Welcome to PHPSlash" story that was posted by
! god and NOW you can delete the god account.

  You should be able to figure out what everything does and how it works.  This
--- 414,422 ----
  Those values are case sensitive. 

! In the task links, click on 'Authors'.  Change the password for god and click on 
  update.

! NOTE:  Do not delete the god account yet.  First create an account for
! yourself with root(all) Security permissions.  Then, post a story to the site.  Next, delete that "Welcome to PHPSlash" story that was posted by god and NOW you can delete the god account.  Alternately, just change all the info in the god account to personalize it.  Then after logging out, the correct info will be updated.

  You should be able to figure out what everything does and how it works.  This
***************
*** 440,448 ****
  <sect1> phpSlash and the register_globals setting
  <p>
! phpSlash currently does not work with the register_globals setting turned 
! Off.  Yes we are aware of the problems this causes.  yes we are aware that 
! php4.2.0 defaults to turning off register_gloabals.  This will be 
! addressed in the next release (M7) with an all new user input and config 
! parsing system.

  <sect1> A few notes on the installation of phplib
--- 426,430 ----
  <sect1> phpSlash and the register_globals setting
  <p>
! phpSlash should not depend on register_globals being set on.

  <sect1> A few notes on the installation of phplib
***************
*** 713,717 ****
  </itemize>

! <sect1>From versions 0.65 to 0.65++
  <p> Versions of phpSlash greater than 0.6.2 <bf>will not</bf> support
  upgrading a 0.5.x install.  You will manually need to upgrade to 0.6.2 and
--- 695,699 ----
  </itemize>

! <sect1>From versions 0.65 to 0.7
  <p> Versions of phpSlash greater than 0.6.2 <bf>will not</bf> support
  upgrading a 0.5.x install.  You will manually need to upgrade to 0.6.2 and
***************
*** 725,729 ****
  <P>
  <itemize>
!   <item> Install phpslash 0.65++ in a new directory and set all the path  
    related variables as documented in the INSTALL file.  Oh yeah, copy over
    any special logos or topic images that you will need from the old slash
--- 707,711 ----
  <P>
  <itemize>
!   <item> Install phpslash 0.7 in a new directory and set all the path  
    related variables as documented in the INSTALL file.  Oh yeah, copy over
    any special logos or topic images that you will need from the old slash
***************
*** 735,739 ****
  <p>
  <enum>
!   <item> It would be a good idea to backup the database at this point: 

    <tscreen><code>
--- 717,721 ----
  <p>
  <enum>
!   <item> It would be a good idea to backup the database at this point or upgrade a copy of the database: 

    <tscreen><code>
***************
*** 748,751 ****
--- 730,745 ----
    </code></tscreen>

+   <item>Copy db_xfer.php3.disabled to db_xfer.php3
+ 
+   <tscreen><code>
+        cp db_xfer.php3.disabled db_xfer.php3
+   </code></tscreen>
+ 
+   <item> Load up the db_xfer.php3 script in a browser.  All boxes should
+   be checked, just hit submit. 
+ 
+   <item> Delete, move or rename the db_xfer.php3 script so it can't be run
+   again.
+ 
    <p>
    <bf>STOP IF YOU GOT ANY ERRORS, YOU NEED TO FIX THEM BEFORE YOU
***************
*** 760,764 ****

    <tscreen><code>
!        $_PSL[defaultskin] = "default";
    </code></tscreen>

--- 754,758 ----

    <tscreen><code>
!        $_PSL[defaultskin] = "bluecurves";
    </code></tscreen>

***************
*** 833,836 ****
--- 827,838 ----
  <sect2> Troubleshooting

+ <p>
+  Here are some things that you may need to manually adjust:
+ <itemize>
+    <item>The "Administration" Block may need to be moved from the "Admin"
+    section to the "User" section.  It can be deleted entirely with no
+    ill effects.
+ 
+ </itemize>

  <!-- SECTION START: User Documentation -->    

Thread: [Phpslash-commit] CVS: phpslash-ft/doc/html phpslash.sgml,1.62,1.63

phpslash-commit