[Openfirst-cvscommit] manual index.php,1.4,1.5
Brought to you by:
xtimg
Menu
▾
▴
[Openfirst-cvscommit] manual index.php,1.4,1.5
|
From: <xt...@us...> - 2003-10-12 22:43:31
|
Update of /cvsroot/openfirst/manual
In directory sc8-pr-cvs1:/tmp/cvs-serv12646
Modified Files:
index.php
Log Message:
Make basic changes found by proof reading, including rewording, spelling, grammar, and minor technical inaccuracies.
Index: index.php
===================================================================
RCS file: /cvsroot/openfirst/manual/index.php,v
retrieving revision 1.4
retrieving revision 1.5
diff -C2 -d -r1.4 -r1.5
*** index.php 29 Sep 2003 21:19:45 -0000 1.4
--- index.php 12 Oct 2003 22:40:49 -0000 1.5
***************
*** 100,110 ****
files according. For Unix users there is a module called bashinstall written
by Tim Ginn that automatically retrieves and arranges the files. Unfortunately
! there is no equivelent for our Windows users, therefor we will have to
! do it the older fashioned way. Follow the following steps to ensure that
you are installing and preparing your computer properly:</p>
<ol>
! <li>Visit http://www.openfirst.org or http://www.openfirst.org/nightly/
and download the latest version of the full openFIRST system.</li>
! <li>Its time to configure your system with the proper software. Click
on one of the following links to learn how to setup your webserver technology:
IIS/PWS with PHP on Windows, Apache with PHP on Windows, Apache with
--- 100,110 ----
files according. For Unix users there is a module called bashinstall written
by Tim Ginn that automatically retrieves and arranges the files. Unfortunately
! there is no equivelent for our Windows users, therefore we will have to
! do it the old-fashioned way. Follow these steps to ensure that
you are installing and preparing your computer properly:</p>
<ol>
! <li>Visit <a href='http://www.openfirst.org/'>http://www.openfirst.org</a> or <a href='http://www.openfirst.org/nightly/'>http://www.openfirst.org/nightly/</a>
and download the latest version of the full openFIRST system.</li>
! <li>It's time to configure your system with the proper software. Click
on one of the following links to learn how to setup your webserver technology:
IIS/PWS with PHP on Windows, Apache with PHP on Windows, Apache with
***************
*** 114,130 ****
on Windows, ODBC on Windows, ODBC on Linux.</li>
<li>Now that you have your webserver and database software setup and running
! properly lets unpack the files that you download in Step 1 and place
! the files somewhere in your root directory. For IIS/PWS users you may
! find this at c:/inetpub/wwwroot/ for Apache users on Windows your root
! is located at c:/Apache Group/Apache/htdocs/, for Apache users on Linux
! your root would be /home/apache/htdocs/.<br>
<br>
! If you are using another server technology then you must find the root
! folder by reading their supplied help documents. openFIRST has been
tested on IIS/PWS, Apache and Sambar using MySQL, MSSQL and ODBC. If
you find any complications in compatibility contact our development
team as soon as possible.</li>
! <li>This is a good time to make sure that all read/write permission on
! files are set properly. You will want to make sure that you have write
capability set for the globals file located at /config/globals.php.</li>
<li>Now that you have your webserver, database and openFIRST base files
--- 114,133 ----
on Windows, ODBC on Windows, ODBC on Linux.</li>
<li>Now that you have your webserver and database software setup and running
! properly lets unpack the files that you downloaded in Step 1 and place
! them somewhere beneath your document root directory. Here are some common locations of this directory:
! <table>
! <tr><th>Operating System</th><th>Web Server</th><th>Location</th></tr>
! <tr><td>Windows</td><td>Microsoft IIS/PWS</td><td>c:/inetpub/wwwroot/</td></tr>
! <tr><td>Windows</td><td>Apache</td><td>c:/Apache Group/Apache/htdocs/</td></tr>
! <tr><td>Unix</td><td>Apache</td><td>/home/<b>yourusernamehere</b>/public_html/</td></tr>
! </table>
<br>
! If you are using another server technology then you must find the root
! folder by reading the server software's accompanying help documents. openFIRST has been
tested on IIS/PWS, Apache and Sambar using MySQL, MSSQL and ODBC. If
you find any complications in compatibility contact our development
team as soon as possible.</li>
! <li>This is a good time to make sure that all read/write permissions on
! files are set properly. You will want to make sure that you have write
capability set for the globals file located at /config/globals.php.</li>
<li>Now that you have your webserver, database and openFIRST base files
***************
*** 133,139 ****
for you will have to enter them into the openFIRST installer.</li>
<li> If you are running opeFIRST on a local system you can use (http://localhost
! or 127.0.0.1) to access your webserver files. Open your web browser
! and navigate yourself localhost/config/index.php which should automatically
! direct you to the install shield.</li>
<li>At this point you will be able to use our installer to guide you through
the installation process.<br>
--- 136,142 ----
for you will have to enter them into the openFIRST installer.</li>
<li> If you are running opeFIRST on a local system you can use (http://localhost
! or 127.0.0.1) to access your webserver files. In some versions of IIS this will not work, if this is the case you will have to access your webserver using an alternative address. Open your web browser
! and navigate to localhost/config/index.php which should automatically
! direct you to the base configuration wizard.</li>
<li>At this point you will be able to use our installer to guide you through
the installation process.<br>
***************
*** 147,152 ****
and password. By default openFIRST sets an admin account for you. Login
with this information: username: admin, password: openfirst.</li>
! <li>You should make sure there are no security holes by remove the write
! permissions to config/global.php or deleting config/first.php. We are
not responsible for any damaged websites or webservers if this security
hole is not closed.</li>
--- 150,155 ----
and password. By default openFIRST sets an admin account for you. Login
with this information: username: admin, password: openfirst.</li>
! <li>You should make sure there are no security holes by removing the write
! permissions from config/globals.php or deleting config/first.php. We are
not responsible for any damaged websites or webservers if this security
hole is not closed.</li>
***************
*** 155,166 ****
directory you basically placed all the modules that come with the system
in their correct spots. Now you will have to actually install the modules
! you wish to use. Click Install Components. Select the modules which
! you would like to run on the openFIRST system. Note that you dont have
to use all the modules that come with openFIRST. There are many people
! who would just like to use our modules for specific reasons. For more
information on how to do this read the Modules & Components section
of the manual.</li>
<li>Once you have the modules installed you have to activate them and
! decide if you want them shown on the menu. Click Module Administration.
A list of all the currently installed modules will be shown.</li>
<li>Click on the checkboxes that correspond to each module. The Includes
--- 158,169 ----
directory you basically placed all the modules that come with the system
in their correct spots. Now you will have to actually install the modules
! you wish to use. To do this, login to the openFIRST system from the screen following setup. Click Install Components. Select the modules which
! you would like to run on the openFIRST system. Note that you don't have
to use all the modules that come with openFIRST. There are many people
! who would just like to a few of our modules for specific reasons. For more
information on how to do this read the Modules & Components section
of the manual.</li>
<li>Once you have the modules installed you have to activate them and
! decide if you want them to be shown on the menu. Click Module Administration.
A list of all the currently installed modules will be shown.</li>
<li>Click on the checkboxes that correspond to each module. The Includes
***************
*** 170,176 ****
includes textbox will be found in the directory of the module. For example
the logger module has an include file called logger.php. This file may
! be found iat/logger/logger.php.</li>
<li>Congratulations, you have just installed openFIRST, the first open-source
! robotics driven website for teams and students of the FIRST Robotics
Competition.</li>
</ol>
--- 173,179 ----
includes textbox will be found in the directory of the module. For example
the logger module has an include file called logger.php. This file may
! be found at /logger/logger.php.</li>
<li>Congratulations, you have just installed openFIRST, the first open-source
! robotics-oriented website for teams and students of the FIRST Robotics
Competition.</li>
</ol>
***************
*** 180,185 ****
there are any new versions that you can download.</p>
<p>If you are still having problems with installing openFIRST then please
! review the steps over one more time and read carefully. If all else fails
! please report the problem to our technical support staff at http://www.openfirst.org.</p>
<p>Thank you for using openFIRST and enjoy!</p></td>
</tr>
--- 183,188 ----
there are any new versions that you can download.</p>
<p>If you are still having problems with installing openFIRST then please
! review the preceding steps over one more time and read carefully. If all else fails
! please report the problem to our technical support staff at <a href='http://www.openfirst.org/'>http://www.openfirst.org</a>.</p>
<p>Thank you for using openFIRST and enjoy!</p></td>
</tr>
***************
*** 192,206 ****
</tr>
<tr>
! <td>So you like a few openFIRST modules but you dont want to have to use the
entire system. We are perfectly fine with this; in fact we have developed
openFIRST to enocourage this. In order to use just a few modules all you
! have to do is download the base module, pop it into your website root and
! run the install shield. You can use headers and footers directly from your
! website or you can modify our headers and footers directly.
<p>You can even use your original website database. All you have to do is
use the same connection information. We made sure that openfirst tables
wouldnt interfere with your websites table so we named each of our tables
with a prefix of ofirst_.</p>
! <p>Its that easy. Just download and install the modules you want and viola!</p></td>
</tr>
<?php
--- 195,209 ----
</tr>
<tr>
! <td>So you'd like a few openFIRST modules but you don't want to have to use the
entire system. We are perfectly fine with this; in fact we have developed
openFIRST to enocourage this. In order to use just a few modules all you
! have to do is download the base module, plop it into your website root and
! run the base configuration utility. You can use headers and footers directly from your
! website or you can modify our provided headers and footers.
<p>You can even use your original website database. All you have to do is
use the same connection information. We made sure that openfirst tables
wouldnt interfere with your websites table so we named each of our tables
with a prefix of ofirst_.</p>
! <p>It's that easy. Just download and install the modules you want and viola!</p></td>
</tr>
<?php
***************
*** 223,231 ****
you already have a website then you could adapt your header and footer
files to work seemlesly with the openFIRST system. The headers and footers
! you specify are adapted everywhere on the system. Even the e-mail outputs
! include the system headers.</p>
<p>Our team has adopted CSS in the headers because we wanted to give our
users more power in the design and look of the website. You will have
! to code the CSS to our specifications but atleast you will be able to
control colors, backgrounds etc.</p></td>
</tr>
--- 226,234 ----
you already have a website then you could adapt your header and footer
files to work seemlesly with the openFIRST system. The headers and footers
! you specify are adapted everywhere on the system. Even the e-mail output
! includes the system headers.</p>
<p>Our team has adopted CSS in the headers because we wanted to give our
users more power in the design and look of the website. You will have
! to code the CSS to our specifications but at least you will be able to
control colors, backgrounds etc.</p></td>
</tr>
***************
*** 245,253 ****
functions. The functions folder (/config/functions/) contains files which
are automatically included into the globals. When globals is first called
! the system scans the folder and includes the functions. Functions in this
! folder are usually vital to the overall system. They provide the system
! with functions such like multipartmail(), the openFIRST mail function
and make_wysiwyg(), which is the basic WYSIWYG function.</p>
! <p>Although if you would like you may remove the file with the function
you wish to disable. The great thing about this is that even though you
remove the function files the system has a fall-back function. For example
--- 248,256 ----
functions. The functions folder (/config/functions/) contains files which
are automatically included into the globals. When globals is first called
! the system scans the functions/ folder and includes the functions. Functions in this
! folder are never vital to the overall system. They provide the system
! with enhanced functions such like multipartmail(), the openFIRST mail function
and make_wysiwyg(), which is the basic WYSIWYG function.</p>
! <p>If you like you may remove the file with the function
you wish to disable. The great thing about this is that even though you
remove the function files the system has a fall-back function. For example
***************
*** 256,267 ****
automatically revert to using a normal text box.</p>
<p>Each module uses relative paths to configure the modules which means
! that you have o have the module folders in the systems base root. This
is because when globals runs it depends on the include value from the
! ofirst_config which will automatically include module specific include
files from each folder. For example logger has an include that is carried
throughout the website to help log visitors. When globals is called it
! automatically gets the logger include files from the databaes and includes
/logger/logger.php. It was programmed this way so that users will have
! more power over increasing the systems features and power.</p>
<p>Another great feature that we implemented into openFIRST is the database
selection. openFIRST supports MySQL, MSSQL and ODBC. The way this works
--- 259,270 ----
automatically revert to using a normal text box.</p>
<p>Each module uses relative paths to configure the modules which means
! that you have to place the module folders in the system's base root. This
is because when globals runs it depends on the include value from the
! ofirst_config which will automatically include any module-specific include
files from each folder. For example logger has an include that is carried
throughout the website to help log visitors. When globals is called it
! automatically gets the logger include files from the database and includes
/logger/logger.php. It was programmed this way so that users will have
! more power over increasing the system's features and power.</p>
<p>Another great feature that we implemented into openFIRST is the database
selection. openFIRST supports MySQL, MSSQL and ODBC. The way this works
***************
*** 274,278 ****
<p align="left">So as you can see openFIRST is very extensible and neatly
coded to allow for PHP programmers to easily develop something or adapt
! to the website. Note: this chart does not list all the avaiable variables/functions
avaiable globally throughout the website. You must read the descriptions
of each individual module manual to get that information.</p>
--- 277,281 ----
<p align="left">So as you can see openFIRST is very extensible and neatly
coded to allow for PHP programmers to easily develop something or adapt
! the website. Note: this chart does not list all the avaiable variables/functions
avaiable globally throughout the website. You must read the descriptions
of each individual module manual to get that information.</p>
***************
*** 283,285 ****
<?php
} ?>
! <?php include("$footer"); ?>
\ No newline at end of file
--- 286,288 ----
<?php
} ?>
! <?php include("$footer"); ?>
|
