diff options
Diffstat (limited to 'user_guide_src')
-rw-r--r-- | user_guide_src/cilexer/cilexer/cilexer.py | 22 | ||||
-rw-r--r-- | user_guide_src/source/_themes/eldocs/layout.html | 2 | ||||
-rw-r--r-- | user_guide_src/source/_themes/eldocs/static/asset/css/common.css | 22 | ||||
-rw-r--r-- | user_guide_src/source/changelog.rst | 40 | ||||
-rw-r--r-- | user_guide_src/source/conf.py | 4 | ||||
-rw-r--r-- | user_guide_src/source/helpers/number_helper.rst | 2 | ||||
-rw-r--r-- | user_guide_src/source/license.rst | 307 |
7 files changed, 318 insertions, 81 deletions
diff --git a/user_guide_src/cilexer/cilexer/cilexer.py b/user_guide_src/cilexer/cilexer/cilexer.py index 265b4077f..e571ce627 100644 --- a/user_guide_src/cilexer/cilexer/cilexer.py +++ b/user_guide_src/cilexer/cilexer/cilexer.py @@ -1,3 +1,25 @@ +# CodeIgniter +# http://codeigniter.com +# +# An open source application development framework for PHP 5.1.6 or newer +# +# NOTICE OF LICENSE +# +# Licensed under the Open Software License version 3.0 +# +# This source file is subject to the Open Software License (OSL 3.0) that is +# bundled with this package in the files license.txt / license.rst. It is +# also available through the world wide web at this URL: +# http://opensource.org/licenses/OSL-3.0 +# If you did not receive a copy of the license and are unable to obtain it +# through the world wide web, please send an email to +# licensing@ellislab.com so we can send you a copy immediately. +# +# Copyright (c) 2008 - 2011, EllisLab, Inc. (http://ellislab.com/) +# http://opensource.org/licenses/OSL-3.0 Open Software License (OSL 3.0) + + + import re import copy diff --git a/user_guide_src/source/_themes/eldocs/layout.html b/user_guide_src/source/_themes/eldocs/layout.html index a79720ef1..4b1a0221c 100644 --- a/user_guide_src/source/_themes/eldocs/layout.html +++ b/user_guide_src/source/_themes/eldocs/layout.html @@ -84,7 +84,7 @@ <div id="brand" class="{{ project_abbreviation }}"> <a href="http://{{ project_domain }}/"><img src="{{ pathto('_static/asset/img/' + project_abbreviation + '-logo.gif', 1) }}" alt="{{ project }}"></a> - <p>{{ version }} User Guide</p> + <p>{{ release }} User Guide</p> {%- if show_source and has_source and sourcename %} <p><a href="{{ pathto('_sources/' + sourcename, true)|e }}" rel="nofollow">{{ _('Show Source') }}</a></p> diff --git a/user_guide_src/source/_themes/eldocs/static/asset/css/common.css b/user_guide_src/source/_themes/eldocs/static/asset/css/common.css index 28182a162..45b1fe724 100644 --- a/user_guide_src/source/_themes/eldocs/static/asset/css/common.css +++ b/user_guide_src/source/_themes/eldocs/static/asset/css/common.css @@ -1,3 +1,25 @@ +/* +CodeIgniter +http://codeigniter.com + +An open source application development framework for PHP 5.1.6 or newer + +NOTICE OF LICENSE + +Licensed under the Open Software License version 3.0 + +This source file is subject to the Open Software License (OSL 3.0) that is +bundled with this package in the files license.txt / license.rst. It is +also available through the world wide web at this URL: +http://opensource.org/licenses/OSL-3.0 +If you did not receive a copy of the license and are unable to obtain it +through the world wide web, please send an email to +licensing@ellislab.com so we can send you a copy immediately. + +Copyright (c) 2008 - 2011, EllisLab, Inc. (http://ellislab.com/) +http://opensource.org/licenses/OSL-3.0 Open Software License (OSL 3.0) +*/ + html, body, h1, h2, h3, h4, h5, h6, p, ul, ol, li, dl, dd, dt, pre, form, fieldset{ margin: 0; padding: 0; } diff --git a/user_guide_src/source/changelog.rst b/user_guide_src/source/changelog.rst index 8249b63ad..3a2990b2c 100644 --- a/user_guide_src/source/changelog.rst +++ b/user_guide_src/source/changelog.rst @@ -2,11 +2,21 @@ Change Log ########## -Version 2.1.0 (planned) +Version 3.0 (planned) ======================= Release Date: Not Released +- License + + - CodeIgniter has been relicensed with the Open Software License (3.0), + eliminating its old proprietary licensing. + + - All system files are licensed with OSL 3.0. + - Config, error, and sample files shipped in the application folder are + licensed with the Academic Free License (3.0) to allow you to retain + all licensing authority over your own application code. + - General Changes - Added an optional backtrace to php-error template. @@ -66,7 +76,7 @@ Release Date: Not Released - CI_Loader::_ci_autoloader() is now a protected method. - Added is_unique to the :doc:`Form Validation library <libraries/form_validation>`. - - Modified valid_ip() to use PHP's filter_var() when possible (>= PHP 5.2) in the <a href="libraries/form_validation.html">Form Validation</a> library. + - Modified valid_ip() to use PHP's filter_var() when possible (>= PHP 5.2) in the :doc:`Form Validation library <libraries/form_validation>`. - Added $config['use_page_numbers'] to the :doc:`Pagination library <libraries/pagination>`, which enables real page numbers in the URI. - Added TLS and SSL Encryption for SMTP. @@ -105,14 +115,14 @@ Bug fixes for 2.1.0 __construct(). - Fixed a bug (#85) - OCI8 (Oracle) database escape_str() function did not escape correct. -- Fixed a bug (#344) - Using schema found in <a href="libraries/sessions.html">Saving Session Data to a Database</a>, system would throw error "user_data does not have a default value" when deleting then creating a session. +- Fixed a bug (#344) - Using schema found in :doc:`Saving Session Data to a Database <libraries/sessions>`, system would throw error "user_data does not have a default value" when deleting then creating a session. - Fixed a bug (#112) - OCI8 (Oracle) driver didn't pass the configured database character set when connecting. - Fixed a bug (#182) - OCI8 (Oracle) driver used to re-execute the statement whenever num_rows() is called. -- Fixed a bug (#82) - WHERE clause field names in the DB <samp>update_string()</samp> method were not escaped, resulting in failed queries in some cases. -- Fixed a bug (#89) - Fix a variable type mismatch in DB <samp>display_error()</samp> where an array is expected, but a string could be set instead. +- Fixed a bug (#82) - WHERE clause field names in the DB update_string() method were not escaped, resulting in failed queries in some cases. +- Fixed a bug (#89) - Fix a variable type mismatch in DB display_error() where an array is expected, but a string could be set instead. - Fixed a bug (#467) - Suppress warnings generated from get_magic_quotes_gpc() (deprecated in PHP 5.4) - Fixed a bug (#484) - First time _csrf_set_hash() is called, hash is never set to the cookie (in Security.php). -- Fixed a bug (#60) - Added _file_mime_type() method to the `File Uploading Library <libraries/file_uploading>` in order to fix a possible MIME-type injection. +- Fixed a bug (#60) - Added _file_mime_type() method to the :doc:`File Uploading Library <libraries/file_uploading>` in order to fix a possible MIME-type injection. - Fixed a bug (#537) - Support for all wav type in browser. - Fixed a bug (#576) - Using ini_get() function to detect if apc is enabled or not. @@ -280,7 +290,7 @@ Hg Tag: v2.0.1 TRUE and Reactor: FALSE. - Added an ENVIRONMENT constant in index.php, which affects PHP error reporting settings, and optionally, which configuration - files are loaded (see below). Read more on the `Handling + files are loaded (see below). Read more on the :doc:`Handling Environments <general/environments>` page. - Added support for :ref:`environment-specific <config-environments>` @@ -288,7 +298,7 @@ Hg Tag: v2.0.1 - Libraries - - Added decimal, less_than and greater_than rules to the `Form + - Added decimal, less_than and greater_than rules to the :doc:`Form validation Class <libraries/form_validation>`. - :doc:`Input Class <libraries/input>` methods post() and get() will now return a full array if the first argument is not @@ -362,7 +372,7 @@ Hg Tag: v2.0.0 - Removed the deprecated Validation Class. - Added CI\_ Prefix to all core classes. - Package paths can now be set in application/config/autoload.php. - - `Upload library <libraries/file_uploading>` file_name can + - :doc:`Upload library <libraries/file_uploading>` file_name can now be set without an extension, the extension will be taken from the uploaded file instead of the given name. - In :doc:`Database Forge <database/forge>` the name can be omitted @@ -534,7 +544,7 @@ Hg Tag: v2.0.0 - Added "default" to the list :doc:`Reserved Names <general/reserved_names>`. - Added 'application/x-msdownload' for .exe files and - ''application/x-gzip-compressed' for .tgz files to + 'application/x-gzip-compressed' for .tgz files to config/mimes.php. - Updated the output library to no longer compress output or send content-length headers if the server runs with @@ -665,7 +675,7 @@ Hg Tag: v1.7.2 - General - - Compatible with PHP 5.3.0 + - Compatible with PHP 5.3.0. - Modified :doc:`show_error() <general/errors>` to allow sending of HTTP server response codes. - Modified :doc:`show_404() <general/errors>` to send 404 status @@ -1273,7 +1283,7 @@ Hg Tag: 1.6.1 URL encoded strings. - Added $_SERVER, $_FILES, $_ENV, and $_SESSION to sanitization of globals. - - Added a `Path Helper <./helpers/path_helper>`. + - Added a :doc:`Path Helper <./helpers/path_helper>`. - Simplified _reindex_segments() in the URI class. - Escaped the '-' in the default 'permitted_uri_chars' config item, to prevent errors if developers just try to add additional @@ -1680,7 +1690,7 @@ Version 1.5.2 Release Date: February 13, 2007 - Added subversion information - to the `downloads <installation/downloads>` page. + to the :doc:`downloads <installation/downloads>` page. - Added support for captions in the :doc:`Table Library <./libraries/table>` - Fixed a bug in the @@ -1736,7 +1746,7 @@ Version 1.5.0 Release Date: October 30, 2006 -- Added `DB utility class <./database/utilities>`, permitting DB +- Added :doc:`DB utility class <./database/utilities>`, permitting DB backups, CVS or XML files from DB results, and various other functions. - Added :doc:`Database Caching Class <./database/caching>`. @@ -1895,7 +1905,7 @@ Release Date: September 17, 2006 sub-folders <general/controllers>`. Kudos to Marco for `suggesting <http://codeigniter.com/forums/viewthread/627/>`_ this (and the next two) feature. -- Added regular expressions support for `routing +- Added regular expressions support for :doc:`routing rules <./general/routing>`. - Added the ability to :doc:`remap function calls <./general/controllers>` within your controllers. diff --git a/user_guide_src/source/conf.py b/user_guide_src/source/conf.py index bd5e65297..bb10d06e4 100644 --- a/user_guide_src/source/conf.py +++ b/user_guide_src/source/conf.py @@ -48,9 +48,9 @@ copyright = u'2011, EllisLab, Inc.' # built documents. # # The short X.Y version. -version = '2.1' +version = '3.0' # The full version, including alpha/beta/rc tags. -release = '2.1.0' +release = '3.0-dev' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. diff --git a/user_guide_src/source/helpers/number_helper.rst b/user_guide_src/source/helpers/number_helper.rst index 28bc2f200..af6cdad57 100644 --- a/user_guide_src/source/helpers/number_helper.rst +++ b/user_guide_src/source/helpers/number_helper.rst @@ -42,4 +42,4 @@ result. echo byte_format(45678, 2); // Returns 44.61 KB .. note:: The text generated by this function is found in the following - language file: language//number_lang.php + language file: language/<your_lang>/number_lang.php diff --git a/user_guide_src/source/license.rst b/user_guide_src/source/license.rst index bf689a03a..17179a95c 100644 --- a/user_guide_src/source/license.rst +++ b/user_guide_src/source/license.rst @@ -1,62 +1,245 @@ -############################# -CodeIgniter License Agreement -############################# - -Copyright (c) 2008 - 2011, EllisLab, Inc. -All rights reserved. - -This license is a legal agreement between you and EllisLab Inc. for the -use of CodeIgniter Software (the "Software"). By obtaining the Software -you agree to comply with the terms and conditions of this license. - -Permitted Use -============= - -You are permitted to use, copy, modify, and distribute the Software and -its documentation, with or without modification, for any purpose, -provided that the following conditions are met: - -#. A copy of this license agreement must be included with the - distribution. -#. Redistributions of source code must retain the above copyright notice - in all source code files. -#. Redistributions in binary form must reproduce the above copyright - notice in the documentation and/or other materials provided with the - distribution. -#. Any files that have been modified must carry notices stating the - nature of the change and the names of those who changed them. -#. Products derived from the Software must include an acknowledgment - that they are derived from CodeIgniter in their documentation and/or - other materials provided with the distribution. -#. Products derived from the Software may not be called "CodeIgniter", - nor may "CodeIgniter" appear in their name, without prior written - permission from EllisLab, Inc. - -Indemnity -========= - -You agree to indemnify and hold harmless the authors of the Software and -any contributors for any direct, indirect, incidental, or consequential -third-party claims, actions or suits, as well as any related expenses, -liabilities, damages, settlements or fees arising from your use or -misuse of the Software, or a violation of any terms of this license. - -Disclaimer of Warranty -====================== - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, -EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, WARRANTIES OF -QUALITY, PERFORMANCE, NON-INFRINGEMENT, MERCHANTABILITY, OR FITNESS FOR -A PARTICULAR PURPOSE. - -Limitations of Liability -======================== - -YOU ASSUME ALL RISK ASSOCIATED WITH THE INSTALLATION AND USE OF THE -SOFTWARE. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS OF THE -SOFTWARE BE LIABLE FOR CLAIMS, DAMAGES OR OTHER LIABILITY ARISING FROM, -OUT OF, OR IN CONNECTION WITH THE SOFTWARE. LICENSE HOLDERS ARE SOLELY -RESPONSIBLE FOR DETERMINING THE APPROPRIATENESS OF USE AND ASSUME ALL -RISKS ASSOCIATED WITH ITS USE, INCLUDING BUT NOT LIMITED TO THE RISKS OF -PROGRAM ERRORS, DAMAGE TO EQUIPMENT, LOSS OF DATA OR SOFTWARE PROGRAMS, -OR UNAVAILABILITY OR INTERRUPTION OF OPERATIONS. +################################### +Open Software License ("OSL") v 3.0 +################################### + +This Open Software License (the "License") applies to any original work of +authorship (the "Original Work") whose owner (the "Licensor") has placed the +following licensing notice adjacent to the copyright notice for the Original +Work: + +*Licensed under the Open Software License version 3.0* + + +***************************** +1) Grant of Copyright License +***************************** + +Licensor grants You a worldwide, royalty-free, non-exclusive, sublicensable +license, for the duration of the copyright, to do the following: + + *a)* to reproduce the Original Work in copies, either alone or as part of + a collective work; + + *b)* to translate, adapt, alter, transform, modify, or arrange the + Original Work, thereby creating derivative works ("Derivative Works") + based upon the Original Work; + + *c)* to distribute or communicate copies of the Original Work and + Derivative Works to the public, *with the proviso that copies of Original + Work or Derivative Works that You distribute or communicate shall be + licensed under this Open Software License*; + + *d)* to perform the Original Work publicly; and + + *e)* to display the Original Work publicly. + + +************************** +2) Grant of Patent License +************************** + +Licensor grants You a worldwide, royalty-free, non-exclusive, sublicensable +license, under patent claims owned or controlled by the Licensor that are +embodied in the Original Work as furnished by the Licensor, for the duration +of the patents, to make, use, sell, offer for sale, have made, and import the +Original Work and Derivative Works. + + +******************************* +3) Grant of Source Code License +******************************* + +The term "Source Code" means the preferred form of the Original Work for +making modifications to it and all available documentation describing how to +modify the Original Work. Licensor agrees to provide a machine-readable copy +of the Source Code of the Original Work along with each copy of the Original +Work that Licensor distributes. Licensor reserves the right to satisfy this +obligation by placing a machine-readable copy of the Source Code in an +information repository reasonably calculated to permit inexpensive and +convenient access by You for as long as Licensor continues to distribute the +Original Work. + + +******************************** +4) Exclusions From License Grant +******************************** + +Neither the names of Licensor, nor the names of any contributors to the +Original Work, nor any of their trademarks or service marks, may be used to +endorse or promote products derived from this Original Work without express +prior permission of the Licensor. Except as expressly stated herein, nothing +in this License grants any license to Licensor's trademarks, copyrights, +patents, trade secrets or any other intellectual property. No patent license +is granted to make, use, sell, offer for sale, have made, or import +embodiments of any patent claims other than the licensed claims defined in +Section 2) No license is granted to the trademarks of Licensor even if such +marks are included in the Original Work. Nothing in this License shall be +interpreted to prohibit Licensor from licensing under terms different from +this License any Original Work that Licensor otherwise would have a right to +license. + + +********************** +5) External Deployment +********************** + +The term "External Deployment" means the use, distribution, or communication +of the Original Work or Derivative Works in any way such that the Original +Work or Derivative Works may be used by anyone other than You, whether those +works are distributed or communicated to those persons or made available as an +application intended for use over a network. As an express condition for the +grants of license hereunder, You must treat any External Deployment by You of +the Original Work or a Derivative Work as a distribution under section 1(c). + + +********************* +6) Attribution Rights +********************* + +You must retain, in the Source Code of any Derivative Works that You create, +all copyright, patent, or trademark notices from the Source Code of the +Original Work, as well as any notices of licensing and any descriptive text +identified therein as an "Attribution Notice." You must cause the Source Code +for any Derivative Works that You create to carry a prominent Attribution +Notice reasonably calculated to inform recipients that You have modified the +Original Work. + + +**************************************************** +7) Warranty of Provenance and Disclaimer of Warranty +**************************************************** + +Licensor warrants that the copyright in and to the Original Work and the +patent rights granted herein by Licensor are owned by the Licensor or are +sublicensed to You under the terms of this License with the permission of the +contributor(s) of those copyrights and patent rights. Except as expressly +stated in the immediately preceding sentence, the Original Work is provided +under this License on an "AS IS" BASIS and WITHOUT WARRANTY, either express or +implied, including, without limitation, the warranties of non-infringement, +merchantability or fitness for a particular purpose. THE ENTIRE RISK AS TO THE +QUALITY OF THE ORIGINAL WORK IS WITH YOU. This DISCLAIMER OF WARRANTY +constitutes an essential part of this License. No license to the Original Work +is granted by this License except under this disclaimer. + + +************************** +8) Limitation of Liability +************************** + +Under no circumstances and under no legal theory, whether in tort (including +negligence), contract, or otherwise, shall the Licensor be liable to anyone +for any indirect, special, incidental, or consequential damages of any +character arising as a result of this License or the use of the Original Work +including, without limitation, damages for loss of goodwill, work stoppage, +computer failure or malfunction, or any and all other commercial damages or +losses. This limitation of liability shall not apply to the extent applicable +law prohibits such limitation. + + +***************************** +9) Acceptance and Termination +***************************** + +If, at any time, You expressly assented to this License, that assent indicates +your clear and irrevocable acceptance of this License and all of its terms and +conditions. If You distribute or communicate copies of the Original Work or a +Derivative Work, You must make a reasonable effort under the circumstances to +obtain the express assent of recipients to the terms of this License. This +License conditions your rights to undertake the activities listed in Section +1, including your right to create Derivative Works based upon the Original +Work, and doing so without honoring these terms and conditions is prohibited +by copyright law and international treaty. Nothing in this License is intended +to affect copyright exceptions and limitations (including "fair use" or "fair +dealing"). This License shall terminate immediately and You may no longer +exercise any of the rights granted to You by this License upon your failure to +honor the conditions in Section 1(c). + + +********************************* +10) Termination for Patent Action +********************************* + +This License shall terminate automatically and You may no longer exercise any +of the rights granted to You by this License as of the date You commence an +action, including a cross-claim or counterclaim, against Licensor or any +licensee alleging that the Original Work infringes a patent. This termination +provision shall not apply for an action alleging patent infringement by +combinations of the Original Work with other software or hardware. + + +***************************************** +11) Jurisdiction, Venue and Governing Law +***************************************** + +Any action or suit relating to this License may be brought only in the courts +of a jurisdiction wherein the Licensor resides or in which Licensor conducts +its primary business, and under the laws of that jurisdiction excluding its +conflict-of-law provisions. The application of the United Nations Convention +on Contracts for the International Sale of Goods is expressly excluded. Any +use of the Original Work outside the scope of this License or after its +termination shall be subject to the requirements and penalties of copyright or +patent law in the appropriate jurisdiction. This section shall survive the +termination of this License. + + +******************* +12) Attorneys' Fees +******************* + +In any action to enforce the terms of this License or seeking damages relating +thereto, the prevailing party shall be entitled to recover its costs and +expenses, including, without limitation, reasonable attorneys' fees and costs +incurred in connection with such action, including any appeal of such action. +This section shall survive the termination of this License. + + +***************** +13) Miscellaneous +***************** + +If any provision of this License is held to be unenforceable, such provision +shall be reformed only to the extent necessary to make it enforceable. + + +*************************************** +14) Definition of "You" in This License +*************************************** + +"You" throughout this License, whether in upper or lower case, means an +individual or a legal entity exercising rights under, and complying with all +of the terms of, this License. For legal entities, "You" includes any entity +that controls, is controlled by, or is under common control with you. For +purposes of this definition, "control" means (i) the power, direct or +indirect, to cause the direction or management of such entity, whether by +contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the +outstanding shares, or (iii) beneficial ownership of such entity. + + +**************** +15) Right to Use +**************** + +You may use the Original Work in all ways not otherwise restricted or +conditioned by this License or by law, and Licensor promises not to interfere +with or be responsible for such uses by You. + + +******************************** +16) Modification of This License +******************************** + +This License is Copyright © 2005 Lawrence Rosen. Permission is granted to +copy, distribute, or communicate this License without modification. Nothing in +this License permits You to modify this License as applied to the Original +Work or to Derivative Works. However, You may modify the text of this License +and copy, distribute or communicate your modified version (the "Modified +License") and apply it to other original works of authorship subject to the +following conditions: (i) You may not indicate in any way that your Modified +License is the "Open Software License" or "OSL" and you may not use those +names in the name of your Modified License; (ii) You must replace the notice +specified in the first paragraph above with the notice "Licensed under <insert +your license name here>" or with a notice of your own that is not confusingly +similar to the notice in this License; and (iii) You may not claim that your +original works are open source software unless your Modified License has been +approved by Open Source Initiative (OSI) and You comply with its license +review and certification process.
\ No newline at end of file |