[Openfirst-cvscommit] manual flowchart.gif,NONE,1.1 index.php,1.3,1.4 openfirst.html,1.2,NONE
Brought to you by:
xtimg
Menu
▾
▴
[Openfirst-cvscommit] manual flowchart.gif,NONE,1.1 index.php,1.3,1.4 openfirst.html,1.2,NONE
|
From: <dav...@us...> - 2003-09-29 21:20:13
|
Update of /cvsroot/openfirst/manual
In directory sc8-pr-cvs1:/tmp/cvs-serv17685
Modified Files:
index.php
Added Files:
flowchart.gif
Removed Files:
openfirst.html
Log Message:
Added new graphic to advanced openFIRST information. Made index.php the main script to look at. Separated information and options actually within the index page to make navigation and reading easier.
--- NEW FILE: flowchart.gif ---
(This appears to be a binary file; contents omitted.)
Index: index.php
===================================================================
RCS file: /cvsroot/openfirst/manual/index.php,v
retrieving revision 1.3
retrieving revision 1.4
diff -C2 -d -r1.3 -r1.4
*** index.php 23 Aug 2003 20:23:25 -0000 1.3
--- index.php 29 Sep 2003 21:19:45 -0000 1.4
***************
*** 5,9 ****
* Copyright (C) 2003,
* openFIRST Project
! * Original Author: Tim Ginn <tim...@po...>
*
* This program is free software; you can redistribute it and/or modify
--- 5,9 ----
* Copyright (C) 2003,
* openFIRST Project
! * Original Author: David Di Biase <dav...@ea...>
*
* This program is free software; you can redistribute it and/or modify
***************
*** 26,141 ****
*
*/
include("../config/globals.php");
! include($header);
! ?>
! <h1>Manual</h1>
<?php
- if(isset($_GET["chapter"]) == false && isset($_GET["id"]) == false && isset($_POST["ID"]) == false && isset($_GET["doc"]) == false) {
- echo("<p>The following manuals exist, and are able to be read and commented on:</p>");
- $query = ofirst_dbquery("SELECT document FROM ofirst_manual GROUP BY document;");
- if(ofirst_dbnum_rows($query) == 0) { echo("<p>There is currently no documentation available.</p>"); }
- while($q = ofirst_dbfetch_object($query)) {
- echo($q->document);
- }
- }
- if(isset($_GET["chapter"]) == false && isset($_GET["id"]) == false && isset($_POST["ID"]) == false && isset($_GET["doc"]) == true) {
- echo("<h2>Table of Contents</h2>");
- $query = "SELECT ID, title, chapter FROM ofirst_manual ORDER BY chapter, title WHERE document='" . $_GET["doc"] . "';";
- $q = ofirst_dbquery($query);
- while($t = ofirst_dbfetch_object($q)) {
- if($t->chapter != $lastchapter) {
- echo("<h3>Chapter $t->chapter</h3>");
- }
- echo("<br /><a href='./?id=$t->ID'>$t->title</a>");
- $lastchapter = $t->chapter;
}
! } elseif(isset($_GET["id"]) == true || isset($_POST["ID"]) == true) {
! if(isset($_POST["ID"]) == true) {
! $id = $_POST["ID"];
! $doc = $_POST["doc"];
! echo("<p><strong>Note Added.</strong></p>");
! $query = "SELECT notes FROM ofirst_manual WHERE ID='$id';";
! $q = ofirst_dbquery($query);
! $t = ofirst_dbfetch_object($q);
!
! $query = "UPDATE ofirst_manual SET notes='$t->notes [note-break]<strong>" .
! $_POST["title"]
! . "</strong> - " .
! $_POST["name"] . " - " .
! $_POST["email"] . "<br /> " .
! $_POST["note"] . "' WHERE ID='$id' AND document='$doc';";
! $q = ofirst_dbquery($query);
! } else {
! $id = $_GET["id"];
}
!
! $query = "SELECT * FROM ofirst_manual WHERE ID='$id' AND document='" . $doc . "';";
! $q = ofirst_dbquery($query);
! $f = ofirst_dbfetch_object($q);
! echo("<h2>$f->title</h2>
! <h3>$f->functionname</h3>
! <p>Maintainer: $f->maintainer
! <br />Original Author: $f->creator</p>
! ");
! if(isset($f->syntax) == true) {
! echo("<div style='background-color: #f0f0f0;'>
! <p>
! <strong>Syntax:</strong>
! <br /><code>
! $f->syntax
! </code>
! </p>
! </div>
! ");
! }
! echo("<h3>Description</h3>
! <p>
! $f->description
! </p>
! ");
!
! echo("<h3>User Contributed Notes</h3>");
!
! if(isset($f->notes) == true) {
! $note = explode("[note-break]", $f->notes);
!
! $notecount = count($note);
!
! for($x = 0; $x <= $notecount; $x++) {
! if(((int) ($x/2)) == ($x/2)) {
! echo("<div style='background-color: #888888;'>");
! } else {
! echo("<div style='background-color: #f3f3f3;'>");
! }
! echo("<p>$note[$x]</p>
! </div>
! ");
!
! }
! } else {
! echo("<p>There are no user contributed notes</p>");
! }
!
! echo("
! <form action='./' method='post'>
! <table>
! <tr><td><input type='hidden' name='ID' value='$f->ID'>Note Title
! <input type='hidden' name='doc' value='$f->document'>
! </td><td> <input type='text' name='title' />
! </td></tr><tr><td>Your E-mail Address</td><td><input type='text' name='email' />
! </td></tr><tr><td>Your Name</td><td><input type='text' name='name' />
! </td></tr><tr><td>Note</td><td><textarea rows='10' cols='25' name='note'>Type your note here.</textarea>
! </td></tr><tr><td> </td><td><input type='submit' value='Add note'> <input type='reset'
! value='Clear note'>
! </td></tr>
! </table>
! </form>
! ");
!
!
! }
?>
<?php
! include($footer);
?>
--- 26,285 ----
*
*/
+
include("../config/globals.php");
! include("$header");
! ?>
! <h1 align="center">openFIRST Manual Module</h1>
!
! <table width="68%">
! <?php if(! isset($_GET['manual'])){ ?>
! <tr>
! <th>Introduction</th>
! </tr>
! <tr>
! <td><p>Welcome to the openFIRST Portal System manual. We hope that this manual
! will cover any questions and information that you have concerning the
! openFIRST Portal System. If there is an issue that you do not find documented
! within this manual then please contact our support group by visiting <a href="http://www.openfirst.org">http://www.openfirst.org</a>.</p>
! <p>openFIRST was founded by David Di Biase and Tim Ginn of the <a href="http://www.archangelrobotics.com">Archangel
! Robotics Team</a> and the <a href="http://www.portperryrobotics.ca">Port
! Perry Robotics Team</a>. As of September 30th 2003 openFIRST has a total
! of 4 supporting developers. The goal of the founders was to provide teams
! with an easy and efficient way of hosting and managing a website. Instead
! of worrying about the nitty-gritty aspects of a website any team can effectively
! and efficiently start a website and concentrate on getting their message
! out.</p>
! <p>If you have any information about the openFIRST Development Team then
! please visit our website. Also note that we are always looking for new
! and interesting modules. If your team has coded and founded a new module
! then please send it to openFIRST and have it implemented into the system.</p>
! <p>On behalf of the openFIRST Development Team, good luck and enjoy!</p></td>
! </tr>
! <?php } ?>
! <tr>
! <th><p>Table of Contents</p></th>
! </tr>
! <tr>
! <td width="92%"> <ol>
! <p> <strong>Basic Manuals</strong></p>
! <li><a href="index.php?manual=setup">How to Setup openFIRST</a></li>
! <li><a href="index.php?manual=modules">Modules and Components</a></li>
! <li><a href="index.php?manual=customize">How to Customize Your Website</a></li>
! <li><a href="index.php?manual=advanced">The Nitty-Gritty of openFIRST</a><br>
! <br>
! <strong>Module Manuals and Documentation</strong><br>
! <br>
! </li>
! <li><a href="openfirst.base/base.php">openFIRST.base</a></li>
! <li><a href="openfirst.messenger/messenger.php">openFIRST.messenger</a></li>
! <li><a href="openfirst.members/members.php">openFIRST.members</a></li>
! <li><a href="openfirst.awards/awards.php">openFIRST.awards</a></li>
! <li><a href="openfirst.projects/projects.php">openFIRST.projects</a></li>
! <li><a href="openfirst.guestbook/guestbook.php">openFIRST.guestbook</a></li>
! <li><a href="openfirst.logger/logger.php">openFIRST.logger</a></li>
! <li><a href="openfirst.feedback/feedback.php">openFIRST.feedback</a></li>
! <li><a href="openfirst.news/news.php">openFIRST.news</a></li>
! <li><a href="openfirst.photogallery/photogallery.php">openFIRST.photogallery</a></li>
! <li><a href="openfirst.search/search.php">openFIRST.search</a></li>
! <li><a href="openfirst.sidebars/sidebars.php">openFIRST.sidebars</a></li>
! <li><a href="openfirst.emoticon/emoticon.php">openFIRST.emoticon </a></li>
! </ol>
! <p> </p></td>
! </tr>
! <?php if(isset($_GET['manual']) && $_GET['manual'] == "setup"){ ?>
! <tr>
! <th>How to Setup openFIRST</th>
! </tr>
! <tr>
! <td>openFIRST as of this version has 13 complete modules. At the bottom of
! this page you will see a complete list of the modules and links to their
! manual references. The openFIRST system has many complex functions and is
! completely intergrated for allowing ease of use for webmasters.
! <p>The first step to setting up openFIRST is downloading and arranging the
! 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
! PHP on Linux.</li>
! <li>Click on one of the following links to learn how to setup your webserver
! with a database technology: MySQL on Windows, MySQL on Linux, MSSQL
! 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
! in place we may begin the actual installation process.</li>
! <li>Open your database software and prepare your username and password
! 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>
! <br>
! Note: Please be very careful when entering file locations and connecting
! files to the openFIRST system. If you conect the files incorrectly you
! will receive a slew of errors. If this is your case you will have refresh
! first.php and try again.</li>
! <li>If you have completed the install correctly the system should bring
! you to the next page error free. This page will prompt you for a username
! 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>
! <li>openFIRST is designed to allow you to have control over the content
! and features on the website. When you unpackaged the file to the root
! 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
! File texbox is used to edit the includes that each module are required
! to use. We added this feature to give webmasters more control over which
! functions to be included into the system. The files you list in the
! 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>
! <p>Note: The openFIRST Configuration Area also has another nifty feature.
! It has an openFIRST Version Check and Update System which automatically
! scans the version numbers of your module scripts and lets you know if
! 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>
<?php
}
! if(isset($_GET['manual']) && $_GET['manual'] == "modules"){
! ?>
! <tr>
! <th>Modules and Components</th>
! </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
}
! if(isset($_GET['manual']) && $_GET['manual'] == "customize"){
?>
+ <tr>
+ <th>How to Customize openFIRST</th>
+ </tr>
+ <tr>
+ <td>openFIRST was designed to allow the manipulation and/or addition to the
+ system without interfering with important system functions. We enourage
+ anyone who is fluent in PHP to help develop and expand the openFIRST Portal
+ System. If a developer comes up with a quality module the openFIRST team
+ will take the module into consideration and adopt it as a certified module.
+ <p>Now you may have noticed that the portal system asks you for links to
+ a header and footer. What we suggest is that webmasters take our headers
+ and edit them to their own specifications, in this case you wont have
+ to make extra code for displaying information such as header links. If
+ 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>
<?php
! }
! if(isset($_GET['manual']) && $_GET['manual'] == "advanced"){
?>
+ <tr>
+ <th>The Nitty-Gritty of openFIRST</th>
+ </tr>
+ <tr>
+ <td><p>There is more to this system then just the fancy HTML and front-ends.
+ openFIRST has a complex internal structure. The entire system works off
+ relative path linking to make reference to scripts easy. The most important
+ foundation of the system is the config folder, obviously. /config contains
+ all the main files for installation, headers, footers, global files, and
+ 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
+ the openFIRST WYSIWYG feature is used to replace almost every text area
+ on the site. If you were to remove this function the WYSIWYG box would
+ 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
+ is that all the database related functions are run through openFIRST functions
+ first (ie. ofirst_dbquery). The function itself checks if the system is
+ setup to run MySQL, MSSQL or ODBC and selects between them. It then returns
+ the data to the original function.</p>
+ <p>Here is a basic diagram of how openFIRST works:</p>
+ <p align="center"><img src="flowchart.gif" width="398" height="308"></p>
+ <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>
+ <p align="left">Be creative and have fun with your coding!</p></td>
+ </tr>
+ </table>
+
+ <?php
+ } ?>
+ <?php include("$footer"); ?>
\ No newline at end of file
--- openfirst.html DELETED ---
|
