From 8ede1a2ecbb62577afd32996956c5feaf7ddf9b6 Mon Sep 17 00:00:00 2001 From: Derek Jones Date: Wed, 5 Oct 2011 13:34:52 -0500 Subject: replacing the old HTML user guide with a Sphinx-managed user guide --- user_guide/overview/appflow.html | 95 ------------------ user_guide/overview/at_a_glance.html | 162 ------------------------------- user_guide/overview/cheatsheets.html | 83 ---------------- user_guide/overview/features.html | 118 ---------------------- user_guide/overview/getting_started.html | 92 ------------------ user_guide/overview/goals.html | 98 ------------------- user_guide/overview/index.html | 84 ---------------- user_guide/overview/mvc.html | 100 ------------------- 8 files changed, 832 deletions(-) delete mode 100644 user_guide/overview/appflow.html delete mode 100644 user_guide/overview/at_a_glance.html delete mode 100644 user_guide/overview/cheatsheets.html delete mode 100644 user_guide/overview/features.html delete mode 100644 user_guide/overview/getting_started.html delete mode 100644 user_guide/overview/goals.html delete mode 100644 user_guide/overview/index.html delete mode 100644 user_guide/overview/mvc.html (limited to 'user_guide/overview') diff --git a/user_guide/overview/appflow.html b/user_guide/overview/appflow.html deleted file mode 100644 index fbc68fab0..000000000 --- a/user_guide/overview/appflow.html +++ /dev/null @@ -1,95 +0,0 @@ - - - - - -Application Flow Chart : CodeIgniter User Guide - - - - - - - - - - - - - - - - - - - - - -
- - - - - -

CodeIgniter User Guide Version 2.0.3

-
- - - - - - - - - -
- - -
- - - -
- - -

Application Flow Chart

- -

The following graphic illustrates how data flows throughout the system:

- -
CodeIgniter application flow
- - -
    -
  1. The index.php serves as the front controller, initializing the base resources needed to run CodeIgniter.
    2. -
  2. The Router examines the HTTP request to determine what should be done with it.
    3. -
  3. If a cache file exists, it is sent directly to the browser, bypassing the normal system execution.
    4. -
  4. Security. Before the application controller is loaded, the HTTP request and any user submitted data is filtered for security.
    5. -
  5. The Controller loads the model, core libraries, helpers, and any other resources needed to process the specific request.
    6. -
  6. The finalized View is rendered then sent to the web browser to be seen. If caching is enabled, the view is cached first so -that on subsequent requests it can be served.
    7. -
- - - - -
- - - - - - - \ No newline at end of file diff --git a/user_guide/overview/at_a_glance.html b/user_guide/overview/at_a_glance.html deleted file mode 100644 index 641c04b22..000000000 --- a/user_guide/overview/at_a_glance.html +++ /dev/null @@ -1,162 +0,0 @@ - - - - - -CodeIgniter at a Glance : CodeIgniter User Guide - - - - - - - - - - - - - - - - - - - - - -
- - - - - -

CodeIgniter User Guide Version 2.0.3

-
- - - - - - - - - -
- - -
- - - -
- -

CodeIgniter at a Glance

- - -

CodeIgniter is an Application Framework

- -

CodeIgniter is a toolkit for people who build web applications using PHP. Its goal is to enable you to develop projects much faster than you could if you were writing code -from scratch, by providing a rich set of libraries for commonly needed tasks, as well as a simple interface and -logical structure to access these libraries. CodeIgniter lets you creatively focus on your project by -minimizing the amount of code needed for a given task.

- -

CodeIgniter is Free

-

CodeIgniter is licensed under an Apache/BSD-style open source license so you can use it however you please. -For more information please read the license agreement.

- -

CodeIgniter is Light Weight

-

Truly light weight. The core system requires only a few very small libraries. This is in stark contrast to many frameworks that require significantly more resources. -Additional libraries are loaded dynamically upon request, based on your needs for a given process, so the base system -is very lean and quite fast. -

- -

CodeIgniter is Fast

-

Really fast. We challenge you to find a framework that has better performance than CodeIgniter.

- - -

CodeIgniter Uses M-V-C

-

CodeIgniter uses the Model-View-Controller approach, which allows great separation between logic and presentation. -This is particularly good for projects in which designers are working with your template files, as the code these file contain will be minimized. We describe MVC in more detail on its own page.

- -

CodeIgniter Generates Clean URLs

-

The URLs generated by CodeIgniter are clean and search-engine friendly. Rather than using the standard "query string" -approach to URLs that is synonymous with dynamic systems, CodeIgniter uses a segment-based approach:

- -example.com/news/article/345 - -

Note: By default the index.php file is included in the URL but it can be removed using a simple .htaccess file.

- -

CodeIgniter Packs a Punch

-

CodeIgniter comes with full-range of libraries that enable the most commonly needed web development tasks, -like accessing a database, sending email, validating form data, maintaining sessions, manipulating images, working with XML-RPC data and -much more.

- -

CodeIgniter is Extensible

-

The system can be easily extended through the use of your own libraries, helpers, or through class extensions or system hooks.

- - -

CodeIgniter Does Not Require a Template Engine

-

Although CodeIgniter does come with a simple template parser that can be optionally used, it does not force you to use one. - -Template engines simply can not match the performance of native PHP, and the syntax that must be learned to use a template -engine is usually only marginally easier than learning the basics of PHP. Consider this block of PHP code:

- -<ul>
-
-<?php foreach ($addressbook as $name):?>
-
-<li><?=$name?></li>
-
-<?php endforeach; ?>
-
-</ul> - -

Contrast this with the pseudo-code used by a template engine:

- -<ul>
-
-{foreach from=$addressbook item="name"}
-
-<li>{$name}</li>
-
-{/foreach}
-
-</ul> - -

Yes, the template engine example is a bit cleaner, but it comes at the price of performance, as the pseudo-code must be converted -back into PHP to run. Since one of our goals is maximum performance, we opted to not require the use of a template engine.

- - -

CodeIgniter is Thoroughly Documented

-

Programmers love to code and hate to write documentation. We're no different, of course, but -since documentation is as important as the code itself, -we are committed to doing it. Our source code is extremely clean and well commented as well.

- - -

CodeIgniter has a Friendly Community of Users

- -

Our growing community of users can be seen actively participating in our Community Forums.

- - -
- - - - - - - \ No newline at end of file diff --git a/user_guide/overview/cheatsheets.html b/user_guide/overview/cheatsheets.html deleted file mode 100644 index b7b10b90c..000000000 --- a/user_guide/overview/cheatsheets.html +++ /dev/null @@ -1,83 +0,0 @@ - - - - - -CodeIgniter Cheatsheets : CodeIgniter User Guide - - - - - - - - - - - - - - - - - - - - - -
- - - - - -

CodeIgniter User Guide Version 2.0.3

-
- - - - - - - - - -
- - -
- - - -
- -

CodeIgniter Cheatsheets

- -

Library Reference

- -
CodeIgniter Library Reference
- -

Helpers Reference

-
CodeIgniter Library Reference
- -
- - - - - - - \ No newline at end of file diff --git a/user_guide/overview/features.html b/user_guide/overview/features.html deleted file mode 100644 index 5f71c5083..000000000 --- a/user_guide/overview/features.html +++ /dev/null @@ -1,118 +0,0 @@ - - - - - -CodeIgniter Features : CodeIgniter User Guide - - - - - - - - - - - - - - - - - - - - - -
- - - - - -

CodeIgniter User Guide Version 2.0.3

-
- - - - - - - - - -
- - -
- - - -
- - -

CodeIgniter Features

- -

Features in and of themselves are a very poor way to judge an application since they tell you nothing -about the user experience, or how intuitively or intelligently it is designed. Features -don't reveal anything about the quality of the code, or the performance, or the attention to detail, or security practices. -The only way to really judge an app is to try it and get to know the code. Installing -CodeIgniter is child's play so we encourage you to do just that. In the mean time here's a list of CodeIgniter's main features.

- - - - - - -
- - - - - - - \ No newline at end of file diff --git a/user_guide/overview/getting_started.html b/user_guide/overview/getting_started.html deleted file mode 100644 index 2b6b3f288..000000000 --- a/user_guide/overview/getting_started.html +++ /dev/null @@ -1,92 +0,0 @@ - - - - - -Getting Started With CodeIgniter : CodeIgniter User Guide - - - - - - - - - - - - - - - - - - - - - -
- - - - - -

CodeIgniter User Guide Version 2.0.3

-
- - - - - - - - - -
- - -
- - - -
- -

Getting Started With CodeIgniter

- -

Any software application requires some effort to learn. We've done our best to minimize the learning -curve while making the process as enjoyable as possible. -

- -

The first step is to install CodeIgniter, then read -all the topics in the Introduction section of the Table of Contents.

- -

Next, read each of the General Topics pages in order. -Each topic builds on the previous one, and includes code examples that you are encouraged to try.

- -

Once you understand the basics you'll be ready to explore the Class Reference and -Helper Reference pages to learn to utilize the native libraries and helper files.

- -

Feel free to take advantage of our Community Forums -if you have questions or problems, and -our Wiki to see code examples posted by other users.

- - -
- - - - - - - \ No newline at end of file diff --git a/user_guide/overview/goals.html b/user_guide/overview/goals.html deleted file mode 100644 index 6acaa65a2..000000000 --- a/user_guide/overview/goals.html +++ /dev/null @@ -1,98 +0,0 @@ - - - - - -Design and Architectural Goals : CodeIgniter User Guide - - - - - - - - - - - - - - - - - - - - - -
- - - - - -

CodeIgniter User Guide Version 2.0.3

-
- - - - - - - - - -
- - -
- - - -
- - - -

Design and Architectural Goals

- -

Our goal for CodeIgniter is maximum performance, capability, and flexibility in the smallest, lightest possible package.

- -

To meet this goal we are committed to benchmarking, re-factoring, and simplifying at every step of the development process, -rejecting anything that doesn't further the stated objective.

- -

From a technical and architectural standpoint, CodeIgniter was created with the following objectives:

- - - -

CodeIgniter is a dynamically instantiated, loosely coupled system with high component singularity. It strives for simplicity, flexibility, and high performance in a small footprint package.

- - - - - - -
- - - - - - - \ No newline at end of file diff --git a/user_guide/overview/index.html b/user_guide/overview/index.html deleted file mode 100644 index 08e61e283..000000000 --- a/user_guide/overview/index.html +++ /dev/null @@ -1,84 +0,0 @@ - - - - - -CodeIgniter Overview : CodeIgniter User Guide - - - - - - - - - - - - - - - - - - - - - -
- - - - - -

CodeIgniter User Guide Version 2.0.3

-
- - - - - - - - - -
- - -
- - - -
- -

CodeIgniter Overview

- -

The following pages describe the broad concepts behind CodeIgniter:

- - - - - - -
- - - - - - - \ No newline at end of file diff --git a/user_guide/overview/mvc.html b/user_guide/overview/mvc.html deleted file mode 100644 index 4721cbf67..000000000 --- a/user_guide/overview/mvc.html +++ /dev/null @@ -1,100 +0,0 @@ - - - - - -Model-View-Controller : CodeIgniter User Guide - - - - - - - - - - - - - - - - - - - - - -
- - - - - -

CodeIgniter User Guide Version 2.0.3

-
- - - - - - - - - -
- - -
- - - -
- - -

Model-View-Controller

- -

CodeIgniter is based on the Model-View-Controller development pattern. - -MVC is a software approach that separates application logic from presentation. In practice, it permits your web pages to contain minimal scripting since the presentation is separate from the PHP scripting.

- - - -

CodeIgniter has a fairly loose approach to MVC since Models are not required. -If you don't need the added separation, or find that maintaining models requires more complexity than you -want, you can ignore them and build your application minimally using Controllers and Views. CodeIgniter also -enables you to incorporate your own existing scripts, or even develop core libraries for the system, - enabling you to work in a way that makes the most sense to you.

- - - - -
- - - - - - - \ No newline at end of file -- cgit v1.2.3-24-g4f1b