Home Explore Help
Sign In
wangsaitao
/
guotianyun-sp-yh
1
0
Fork 0
Files Issues 0 Pull Requests 0 Wiki
Branch: master
Branches Tags
guotianyun-s...
/
user_guide
/
documentation
/
index.html

index.html 47 KB
Permalink History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702 
  1. 

  2. 

  3. <!DOCTYPE html>
    4. 

  4. <!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
    5. 

  5. <!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
    6. 

  6. <head>
    7. 

  7.   <meta charset="utf-8">
    8. 

  8.   <meta name="viewport" content="width=device-width, initial-scale=1.0">
    9. 

  9.   
    10. 

  10.   <title>Writing CodeIgniter Documentation &mdash; CodeIgniter 3.1.11 documentation</title>
    11. 

  11.   
    12. 

  12. 

  13.   
    14. 

  14.   
    15. 

  15.     <link rel="shortcut icon" href="../_static/ci-icon.ico"/>
    16. 

  16.   
    17. 

  17. 

  18.   
    19. 

  19.   <link href='https://fonts.googleapis.com/css?family=Lato:400,700,400italic,700italic|Roboto+Slab:400,700|Inconsolata:400,700&subset=latin,cyrillic' rel='stylesheet' type='text/css'>
    20. 

  20. 

  21.   
    22. 

  22.   
    23. 

  23.     
    24. 

  24. 

  25.   
    26. 

  26. 

  27.   
    28. 

  28.   
    29. 

  29.     <link rel="stylesheet" href="../_static/css/citheme.css" type="text/css" />
    30. 

  30.   
    31. 

  31. 

  32.   
    33. 

  33.         <link rel="index" title="Index"
    34. 

  34.               href="../genindex.html"/>
    35. 

  35.         <link rel="search" title="Search" href="../search.html"/>
    36. 

  36.     <link rel="top" title="CodeIgniter 3.1.11 documentation" href="../index.html"/>
    37. 

  37.         <link rel="up" title="Contributing to CodeIgniter" href="../contributing/index.html"/>
    38. 

  38.         <link rel="next" title="Developer’s Certificate of Origin 1.1" href="../DCO.html"/>
    39. 

  39.         <link rel="prev" title="Contributing to CodeIgniter" href="../contributing/index.html"/> 
    40. 

  40. 

  41.   
    42. 

  42.   <script src="https://cdnjs.cloudflare.com/ajax/libs/modernizr/2.6.2/modernizr.min.js"></script>
    43. 

  43. 

  44. </head>
    45. 

  45. 

  46. <body class="wy-body-for-nav" role="document">
    47. 

  47. 

  48.   <div id="nav">
    49. 

  49.   <div id="nav_inner">
    50. 

  50.     
    51. 

  51.     
    52. 

  52.     
    53. 

  53.       <div id="pulldown-menu" class="ciNav">
    54. 

  54.         <ul>
    55. 

  55. <li class="toctree-l1"><a class="reference internal" href="../general/welcome.html">Welcome to CodeIgniter</a></li>
    56. 

  56. </ul>
    57. 

  57. <ul>
    58. 

  58. <li class="toctree-l1"><a class="reference internal" href="../installation/index.html">Installation Instructions</a><ul>
    59. 

  59. <li class="toctree-l2"><a class="reference internal" href="../installation/downloads.html">Downloading CodeIgniter</a></li>
    60. 

  60. <li class="toctree-l2"><a class="reference internal" href="../installation/index.html">Installation Instructions</a></li>
    61. 

  61. <li class="toctree-l2"><a class="reference internal" href="../installation/upgrading.html">Upgrading From a Previous Version</a></li>
    62. 

  62. <li class="toctree-l2"><a class="reference internal" href="../installation/troubleshooting.html">Troubleshooting</a></li>
    63. 

  63. </ul>
    64. 

  64. </li>
    65. 

  65. </ul>
    66. 

  66. <ul>
    67. 

  67. <li class="toctree-l1"><a class="reference internal" href="../overview/index.html">CodeIgniter Overview</a><ul>
    68. 

  68. <li class="toctree-l2"><a class="reference internal" href="../overview/getting_started.html">Getting Started</a></li>
    69. 

  69. <li class="toctree-l2"><a class="reference internal" href="../overview/at_a_glance.html">CodeIgniter at a Glance</a></li>
    70. 

  70. <li class="toctree-l2"><a class="reference internal" href="../overview/features.html">Supported Features</a></li>
    71. 

  71. <li class="toctree-l2"><a class="reference internal" href="../overview/appflow.html">Application Flow Chart</a></li>
    72. 

  72. <li class="toctree-l2"><a class="reference internal" href="../overview/mvc.html">Model-View-Controller</a></li>
    73. 

  73. <li class="toctree-l2"><a class="reference internal" href="../overview/goals.html">Architectural Goals</a></li>
    74. 

  74. </ul>
    75. 

  75. </li>
    76. 

  76. </ul>
    77. 

  77. <ul>
    78. 

  78. <li class="toctree-l1"><a class="reference internal" href="../tutorial/index.html">Tutorial</a><ul>
    79. 

  79. <li class="toctree-l2"><a class="reference internal" href="../tutorial/static_pages.html">Static pages</a></li>
    80. 

  80. <li class="toctree-l2"><a class="reference internal" href="../tutorial/news_section.html">News section</a></li>
    81. 

  81. <li class="toctree-l2"><a class="reference internal" href="../tutorial/create_news_items.html">Create news items</a></li>
    82. 

  82. <li class="toctree-l2"><a class="reference internal" href="../tutorial/conclusion.html">Conclusion</a></li>
    83. 

  83. </ul>
    84. 

  84. </li>
    85. 

  85. </ul>
    86. 

  86. <ul class="current">
    87. 

  87. <li class="toctree-l1 current"><a class="reference internal" href="../contributing/index.html">Contributing to CodeIgniter</a><ul class="current">
    88. 

  88. <li class="toctree-l2 current"><a class="current reference internal" href="#">Writing CodeIgniter Documentation</a></li>
    89. 

  89. <li class="toctree-l2"><a class="reference internal" href="../DCO.html">Developer’s Certificate of Origin 1.1</a></li>
    90. 

  90. </ul>
    91. 

  91. </li>
    92. 

  92. </ul>
    93. 

  93. <ul>
    94. 

  94. <li class="toctree-l1"><a class="reference internal" href="../general/index.html">General Topics</a><ul>
    95. 

  95. <li class="toctree-l2"><a class="reference internal" href="../general/urls.html">CodeIgniter URLs</a></li>
    96. 

  96. <li class="toctree-l2"><a class="reference internal" href="../general/controllers.html">Controllers</a></li>
    97. 

  97. <li class="toctree-l2"><a class="reference internal" href="../general/reserved_names.html">Reserved Names</a></li>
    98. 

  98. <li class="toctree-l2"><a class="reference internal" href="../general/views.html">Views</a></li>
    99. 

  99. <li class="toctree-l2"><a class="reference internal" href="../general/models.html">Models</a></li>
    100. 

  100. <li class="toctree-l2"><a class="reference internal" href="../general/helpers.html">Helpers</a></li>
    101. 

  101. <li class="toctree-l2"><a class="reference internal" href="../general/libraries.html">Using CodeIgniter Libraries</a></li>
    102. 

  102. <li class="toctree-l2"><a class="reference internal" href="../general/creating_libraries.html">Creating Libraries</a></li>
    103. 

  103. <li class="toctree-l2"><a class="reference internal" href="../general/drivers.html">Using CodeIgniter Drivers</a></li>
    104. 

  104. <li class="toctree-l2"><a class="reference internal" href="../general/creating_drivers.html">Creating Drivers</a></li>
    105. 

  105. <li class="toctree-l2"><a class="reference internal" href="../general/core_classes.html">Creating Core System Classes</a></li>
    106. 

  106. <li class="toctree-l2"><a class="reference internal" href="../general/ancillary_classes.html">Creating Ancillary Classes</a></li>
    107. 

  107. <li class="toctree-l2"><a class="reference internal" href="../general/hooks.html">Hooks - Extending the Framework Core</a></li>
    108. 

  108. <li class="toctree-l2"><a class="reference internal" href="../general/autoloader.html">Auto-loading Resources</a></li>
    109. 

  109. <li class="toctree-l2"><a class="reference internal" href="../general/common_functions.html">Common Functions</a></li>
    110. 

  110. <li class="toctree-l2"><a class="reference internal" href="../general/compatibility_functions.html">Compatibility Functions</a></li>
    111. 

  111. <li class="toctree-l2"><a class="reference internal" href="../general/routing.html">URI Routing</a></li>
    112. 

  112. <li class="toctree-l2"><a class="reference internal" href="../general/errors.html">Error Handling</a></li>
    113. 

  113. <li class="toctree-l2"><a class="reference internal" href="../general/caching.html">Caching</a></li>
    114. 

  114. <li class="toctree-l2"><a class="reference internal" href="../general/profiling.html">Profiling Your Application</a></li>
    115. 

  115. <li class="toctree-l2"><a class="reference internal" href="../general/cli.html">Running via the CLI</a></li>
    116. 

  116. <li class="toctree-l2"><a class="reference internal" href="../general/managing_apps.html">Managing your Applications</a></li>
    117. 

  117. <li class="toctree-l2"><a class="reference internal" href="../general/environments.html">Handling Multiple Environments</a></li>
    118. 

  118. <li class="toctree-l2"><a class="reference internal" href="../general/alternative_php.html">Alternate PHP Syntax for View Files</a></li>
    119. 

  119. <li class="toctree-l2"><a class="reference internal" href="../general/security.html">Security</a></li>
    120. 

  120. <li class="toctree-l2"><a class="reference internal" href="../general/styleguide.html">PHP Style Guide</a></li>
    121. 

  121. </ul>
    122. 

  122. </li>
    123. 

  123. </ul>
    124. 

  124. <ul>
    125. 

  125. <li class="toctree-l1"><a class="reference internal" href="../libraries/index.html">Libraries</a><ul>
    126. 

  126. <li class="toctree-l2"><a class="reference internal" href="../libraries/benchmark.html">Benchmarking Class</a></li>
    127. 

  127. <li class="toctree-l2"><a class="reference internal" href="../libraries/caching.html">Caching Driver</a></li>
    128. 

  128. <li class="toctree-l2"><a class="reference internal" href="../libraries/calendar.html">Calendaring Class</a></li>
    129. 

  129. <li class="toctree-l2"><a class="reference internal" href="../libraries/cart.html">Shopping Cart Class</a></li>
    130. 

  130. <li class="toctree-l2"><a class="reference internal" href="../libraries/config.html">Config Class</a></li>
    131. 

  131. <li class="toctree-l2"><a class="reference internal" href="../libraries/email.html">Email Class</a></li>
    132. 

  132. <li class="toctree-l2"><a class="reference internal" href="../libraries/encrypt.html">Encrypt Class</a></li>
    133. 

  133. <li class="toctree-l2"><a class="reference internal" href="../libraries/encryption.html">Encryption Library</a></li>
    134. 

  134. <li class="toctree-l2"><a class="reference internal" href="../libraries/file_uploading.html">File Uploading Class</a></li>
    135. 

  135. <li class="toctree-l2"><a class="reference internal" href="../libraries/form_validation.html">Form Validation</a></li>
    136. 

  136. <li class="toctree-l2"><a class="reference internal" href="../libraries/ftp.html">FTP Class</a></li>
    137. 

  137. <li class="toctree-l2"><a class="reference internal" href="../libraries/image_lib.html">Image Manipulation Class</a></li>
    138. 

  138. <li class="toctree-l2"><a class="reference internal" href="../libraries/input.html">Input Class</a></li>
    139. 

  139. <li class="toctree-l2"><a class="reference internal" href="../libraries/javascript.html">Javascript Class</a></li>
    140. 

  140. <li class="toctree-l2"><a class="reference internal" href="../libraries/language.html">Language Class</a></li>
    141. 

  141. <li class="toctree-l2"><a class="reference internal" href="../libraries/loader.html">Loader Class</a></li>
    142. 

  142. <li class="toctree-l2"><a class="reference internal" href="../libraries/migration.html">Migrations Class</a></li>
    143. 

  143. <li class="toctree-l2"><a class="reference internal" href="../libraries/output.html">Output Class</a></li>
    144. 

  144. <li class="toctree-l2"><a class="reference internal" href="../libraries/pagination.html">Pagination Class</a></li>
    145. 

  145. <li class="toctree-l2"><a class="reference internal" href="../libraries/parser.html">Template Parser Class</a></li>
    146. 

  146. <li class="toctree-l2"><a class="reference internal" href="../libraries/security.html">Security Class</a></li>
    147. 

  147. <li class="toctree-l2"><a class="reference internal" href="../libraries/sessions.html">Session Library</a></li>
    148. 

  148. <li class="toctree-l2"><a class="reference internal" href="../libraries/table.html">HTML Table Class</a></li>
    149. 

  149. <li class="toctree-l2"><a class="reference internal" href="../libraries/trackback.html">Trackback Class</a></li>
    150. 

  150. <li class="toctree-l2"><a class="reference internal" href="../libraries/typography.html">Typography Class</a></li>
    151. 

  151. <li class="toctree-l2"><a class="reference internal" href="../libraries/unit_testing.html">Unit Testing Class</a></li>
    152. 

  152. <li class="toctree-l2"><a class="reference internal" href="../libraries/uri.html">URI Class</a></li>
    153. 

  153. <li class="toctree-l2"><a class="reference internal" href="../libraries/user_agent.html">User Agent Class</a></li>
    154. 

  154. <li class="toctree-l2"><a class="reference internal" href="../libraries/xmlrpc.html">XML-RPC and XML-RPC Server Classes</a></li>
    155. 

  155. <li class="toctree-l2"><a class="reference internal" href="../libraries/zip.html">Zip Encoding Class</a></li>
    156. 

  156. </ul>
    157. 

  157. </li>
    158. 

  158. </ul>
    159. 

  159. <ul>
    160. 

  160. <li class="toctree-l1"><a class="reference internal" href="../database/index.html">Database Reference</a><ul>
    161. 

  161. <li class="toctree-l2"><a class="reference internal" href="../database/examples.html">Quick Start: Usage Examples</a></li>
    162. 

  162. <li class="toctree-l2"><a class="reference internal" href="../database/configuration.html">Database Configuration</a></li>
    163. 

  163. <li class="toctree-l2"><a class="reference internal" href="../database/connecting.html">Connecting to a Database</a></li>
    164. 

  164. <li class="toctree-l2"><a class="reference internal" href="../database/queries.html">Running Queries</a></li>
    165. 

  165. <li class="toctree-l2"><a class="reference internal" href="../database/results.html">Generating Query Results</a></li>
    166. 

  166. <li class="toctree-l2"><a class="reference internal" href="../database/helpers.html">Query Helper Functions</a></li>
    167. 

  167. <li class="toctree-l2"><a class="reference internal" href="../database/query_builder.html">Query Builder Class</a></li>
    168. 

  168. <li class="toctree-l2"><a class="reference internal" href="../database/transactions.html">Transactions</a></li>
    169. 

  169. <li class="toctree-l2"><a class="reference internal" href="../database/metadata.html">Getting MetaData</a></li>
    170. 

  170. <li class="toctree-l2"><a class="reference internal" href="../database/call_function.html">Custom Function Calls</a></li>
    171. 

  171. <li class="toctree-l2"><a class="reference internal" href="../database/caching.html">Query Caching</a></li>
    172. 

  172. <li class="toctree-l2"><a class="reference internal" href="../database/forge.html">Database Manipulation with Database Forge</a></li>
    173. 

  173. <li class="toctree-l2"><a class="reference internal" href="../database/utilities.html">Database Utilities Class</a></li>
    174. 

  174. <li class="toctree-l2"><a class="reference internal" href="../database/db_driver_reference.html">Database Driver Reference</a></li>
    175. 

  175. </ul>
    176. 

  176. </li>
    177. 

  177. </ul>
    178. 

  178. <ul>
    179. 

  179. <li class="toctree-l1"><a class="reference internal" href="../helpers/index.html">Helpers</a><ul>
    180. 

  180. <li class="toctree-l2"><a class="reference internal" href="../helpers/array_helper.html">Array Helper</a></li>
    181. 

  181. <li class="toctree-l2"><a class="reference internal" href="../helpers/captcha_helper.html">CAPTCHA Helper</a></li>
    182. 

  182. <li class="toctree-l2"><a class="reference internal" href="../helpers/cookie_helper.html">Cookie Helper</a></li>
    183. 

  183. <li class="toctree-l2"><a class="reference internal" href="../helpers/date_helper.html">Date Helper</a></li>
    184. 

  184. <li class="toctree-l2"><a class="reference internal" href="../helpers/directory_helper.html">Directory Helper</a></li>
    185. 

  185. <li class="toctree-l2"><a class="reference internal" href="../helpers/download_helper.html">Download Helper</a></li>
    186. 

  186. <li class="toctree-l2"><a class="reference internal" href="../helpers/email_helper.html">Email Helper</a></li>
    187. 

  187. <li class="toctree-l2"><a class="reference internal" href="../helpers/file_helper.html">File Helper</a></li>
    188. 

  188. <li class="toctree-l2"><a class="reference internal" href="../helpers/form_helper.html">Form Helper</a></li>
    189. 

  189. <li class="toctree-l2"><a class="reference internal" href="../helpers/html_helper.html">HTML Helper</a></li>
    190. 

  190. <li class="toctree-l2"><a class="reference internal" href="../helpers/inflector_helper.html">Inflector Helper</a></li>
    191. 

  191. <li class="toctree-l2"><a class="reference internal" href="../helpers/language_helper.html">Language Helper</a></li>
    192. 

  192. <li class="toctree-l2"><a class="reference internal" href="../helpers/number_helper.html">Number Helper</a></li>
    193. 

  193. <li class="toctree-l2"><a class="reference internal" href="../helpers/path_helper.html">Path Helper</a></li>
    194. 

  194. <li class="toctree-l2"><a class="reference internal" href="../helpers/security_helper.html">Security Helper</a></li>
    195. 

  195. <li class="toctree-l2"><a class="reference internal" href="../helpers/smiley_helper.html">Smiley Helper</a></li>
    196. 

  196. <li class="toctree-l2"><a class="reference internal" href="../helpers/string_helper.html">String Helper</a></li>
    197. 

  197. <li class="toctree-l2"><a class="reference internal" href="../helpers/text_helper.html">Text Helper</a></li>
    198. 

  198. <li class="toctree-l2"><a class="reference internal" href="../helpers/typography_helper.html">Typography Helper</a></li>
    199. 

  199. <li class="toctree-l2"><a class="reference internal" href="../helpers/url_helper.html">URL Helper</a></li>
    200. 

  200. <li class="toctree-l2"><a class="reference internal" href="../helpers/xml_helper.html">XML Helper</a></li>
    201. 

  201. </ul>
    202. 

  202. </li>
    203. 

  203. </ul>
    204. 

  204. 

  205.       </div>
    206. 

  206.     
    207. 

  207.       
    208. 

  208.   </div>
    209. 

  209. </div>
    210. 

  210. <div id="nav2">
    211. 

  211.   <a href="#" id="openToc">
    212. 

  212.     <img src="data:image/jpeg;base64,/9j/4AAQSkZJRgABAgAAZABkAAD/7AARRHVja3kAAQAEAAAARgAA/+4ADkFkb2JlAGTAAAAAAf/bAIQABAMDAwMDBAMDBAYEAwQGBwUEBAUHCAYGBwYGCAoICQkJCQgKCgwMDAwMCgwMDQ0MDBERERERFBQUFBQUFBQUFAEEBQUIBwgPCgoPFA4ODhQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQU/8AAEQgAKwCaAwERAAIRAQMRAf/EAHsAAQAABwEBAAAAAAAAAAAAAAABAwQFBgcIAgkBAQAAAAAAAAAAAAAAAAAAAAAQAAEDAwICBwYEAgsAAAAAAAIBAwQAEQUSBiEHkROTVNQWGDFBUVIUCHEiMtOUFWGBobHRQlMkZIRVEQEAAAAAAAAAAAAAAAAAAAAA/9oADAMBAAIRAxEAPwDSC+ygkOOaUoKigUCgUCgUCgUCgUCgUCgUCgkuGguIP9FBMFb0Hqg7We+3jlmIqqYFf4ub+/QYlnOR/LqIBKGFUbf8qWv971BytQXXE7Y3Lnm3HsFhp2TaZJAdchRXpIgSpdEJWxJEW3xoKV7F5OMy7JkQn2o7D6w33XGjEAkoiqrJEqIiOIiKuhePCgqp22dyYyS3CyWHnQ5joG61HkRnmnTbaFSMhExRVQRRVJU9iUHjE7ez+fJ0MFipmUNhBV8YUd2SoIV9KkjQla9ltegttBdPLW4/qocL+UTfrMiHW4+P9M71shuyrqaHTcxsl7jegpsji8nh5ZwMvDfgTm0RTjSmjYdFCS6KoOIipdFunCgmNYTMv457MMY6U7iI6oMieDDhRm1VbIhuoOkbqtuK0Hpzb+eZcYZexUxt6UyUqK2cd0SdjtgrhOgijcgERUlJOCIl6CpgbP3blRI8XgMjNARAyKNDfeRBdFDBVUAXgQrqH4pxoJTu2NysY97LP4ac1io5q1InHFeGO24LnVKJuKOkSQ/yKir+rh7aCLG1dzypZQI2FnvTgccYOM3FeN0XWERXAUEFVQgQkUktdLpegm+Td3/Xli/L+S/mYNJIOF9G/wBeLKrZHFb0akG6W1WtQWSg3Dyg5e7V3fipE3O4/wCrktyzYA+ufas2LbZIlmnAT2kvuoN1wft95augilglX/tzP3qCu9O3LL/wV/i5v79BvmTADq14UGu91467Z6U9y0HzH/ncj/U/sT/CgynZG7I2NezpZGUjIycJkYkZSG+uQ81pbBNKLxJfjwoMqZ3/ALYHl35AJ7/cuwHcu5k7r1Q5pHetBjquqVVJWGxj9Zrtcl/Ggy3dHMvauR3HFZj5nHNxSyW5JISYDMoIwx8tFIGHZhPNaykGapr6rUAiicEoMG21lMRj8buPAz8xhJrr7uOeiPTCyAwXUaGR1mgozbTusOsFLEiJ7fbQa/h7gcjy2H3V6xppwDNtUSxCJIqp7valBuWVzJ22xuCROXNNZiJkMtms0DbjUkAZjzoDrTMd9dDRI44ZC2YsrYdKWP2WDT2S3N9dNdlRYrGMYc06IURXSYb0igrpWS485xVNS6nF4rwslkoMwnbpgZLB7bmt5uMweAhDEl4B5uSLzzqTnnyVpW2jaJHRMSIjdDiiotvy3DOE5rYTEbkl5yFn28k7JyG4c7AU2HtLH1uKfaiMPI40CdYbpNtmLdwTSn5rewLNld+7TLdeal4WarWBkbVKBjgdElMJJwAAY5fl4kB3b1fp4XvagsGS3FjJfLzDNtS8aeXx7LzT7TyzByQE5PccRGRC0ZRUDRV6y62vbjagzLmJzS2vuPK43JY6aP1TW6Jz+RIWyFtyC06y3EkiiinAo7YCqfq1AqqnGgsOH3lhZO8d1pmcpB8j5XIm9OYlBJSQ/FSS4427DKO0RC8AlcEMhFdViRR1WDWR5t3WXVuL1d106kG9vdeye2g60+1FDyW0shIcXVpyroXt8I8dfd+NB1vioAdWnD3UF1+gD4UFc6CEKpagxXN43rwJLUHz7yX2c8zokt9uHlsPIhA4aRnnHJTLptIS6CNsY7iASpxUUMkReGpfbQW0vtN5pitvrsN28rwtBD0nc0+/Yft5XhaB6TuaXfsP28rwtA9J3NPv2H7eV4Wgek7mn37D9vK8LQPSdzT79h+3leFoHpO5pd+w/byvC0D0nc0u/Yft5XhaB6TuaXfsP28rwtA9J3NLv2H7eV4Wgek7ml37D9vK8LQPSdzS79h+3leFoHpO5p9+w/byvC0E9r7Reazy2HIYVPxkS/CUHVn26cosxyv2g7h89LYmZSXOenvLEQ1YaQ222RATcQCP8rSGqqA8S02W2pQ6FhMoAIlqCtsnwoCpdKClejI4i3Sgtb+GBxVuNBSFt1pV/RQefLjPyUDy4z8lA8uM/JQPLjPyUDy4z8lA8uM/JQPLjPyUDy4z8lA8uM/JQPLjPyUDy4z8lA8utJ/koJ7WCbBU/LQXOPAFq1koK8B0pag90CggtBBf6qB0UDooHRQOigdFA6KB0UDooHRQOigdFA6KB0UDooI0EaBQf//Z" title="Toggle Table of Contents" alt="Toggle Table of Contents" />
    213. 

  213.   </a>
    214. 

  214. </div>
    215. 

  215. 

  216.   <div class="wy-grid-for-nav">
    217. 

  217. 

  218.     
    219. 

  219.     <nav data-toggle="wy-nav-shift" class="wy-nav-side">
    220. 

  220.       <div class="wy-side-nav-search">
    221. 

  221.         
    222. 

  222.           <a href="../index.html" class="fa fa-home"> CodeIgniter</a>
    223. 

  223.         
    224. 

  224.         
    225. 

  225. <div role="search">
    226. 

  226.   <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
    227. 

  227.     <input type="text" name="q" placeholder="Search docs" />
    228. 

  228.     <input type="hidden" name="check_keywords" value="yes" />
    229. 

  229.     <input type="hidden" name="area" value="default" />
    230. 

  230.   </form>
    231. 

  231. </div>
    232. 

  232.       </div>
    233. 

  233. 

  234.       <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
    235. 

  235.         
    236. 

  236.           
    237. 

  237.           
    238. 

  238.               <ul>
    239. 

  239. <li class="toctree-l1"><a class="reference internal" href="../general/welcome.html">Welcome to CodeIgniter</a></li>
    240. 

  240. </ul>
    241. 

  241. <ul>
    242. 

  242. <li class="toctree-l1"><a class="reference internal" href="../installation/index.html">Installation Instructions</a><ul>
    243. 

  243. <li class="toctree-l2"><a class="reference internal" href="../installation/downloads.html">Downloading CodeIgniter</a></li>
    244. 

  244. <li class="toctree-l2"><a class="reference internal" href="../installation/index.html">Installation Instructions</a></li>
    245. 

  245. <li class="toctree-l2"><a class="reference internal" href="../installation/upgrading.html">Upgrading From a Previous Version</a></li>
    246. 

  246. <li class="toctree-l2"><a class="reference internal" href="../installation/troubleshooting.html">Troubleshooting</a></li>
    247. 

  247. </ul>
    248. 

  248. </li>
    249. 

  249. </ul>
    250. 

  250. <ul>
    251. 

  251. <li class="toctree-l1"><a class="reference internal" href="../overview/index.html">CodeIgniter Overview</a><ul>
    252. 

  252. <li class="toctree-l2"><a class="reference internal" href="../overview/getting_started.html">Getting Started</a></li>
    253. 

  253. <li class="toctree-l2"><a class="reference internal" href="../overview/at_a_glance.html">CodeIgniter at a Glance</a></li>
    254. 

  254. <li class="toctree-l2"><a class="reference internal" href="../overview/features.html">Supported Features</a></li>
    255. 

  255. <li class="toctree-l2"><a class="reference internal" href="../overview/appflow.html">Application Flow Chart</a></li>
    256. 

  256. <li class="toctree-l2"><a class="reference internal" href="../overview/mvc.html">Model-View-Controller</a></li>
    257. 

  257. <li class="toctree-l2"><a class="reference internal" href="../overview/goals.html">Architectural Goals</a></li>
    258. 

  258. </ul>
    259. 

  259. </li>
    260. 

  260. </ul>
    261. 

  261. <ul>
    262. 

  262. <li class="toctree-l1"><a class="reference internal" href="../tutorial/index.html">Tutorial</a><ul>
    263. 

  263. <li class="toctree-l2"><a class="reference internal" href="../tutorial/static_pages.html">Static pages</a></li>
    264. 

  264. <li class="toctree-l2"><a class="reference internal" href="../tutorial/news_section.html">News section</a></li>
    265. 

  265. <li class="toctree-l2"><a class="reference internal" href="../tutorial/create_news_items.html">Create news items</a></li>
    266. 

  266. <li class="toctree-l2"><a class="reference internal" href="../tutorial/conclusion.html">Conclusion</a></li>
    267. 

  267. </ul>
    268. 

  268. </li>
    269. 

  269. </ul>
    270. 

  270. <ul class="current">
    271. 

  271. <li class="toctree-l1 current"><a class="reference internal" href="../contributing/index.html">Contributing to CodeIgniter</a><ul class="current">
    272. 

  272. <li class="toctree-l2 current"><a class="current reference internal" href="#">Writing CodeIgniter Documentation</a></li>
    273. 

  273. <li class="toctree-l2"><a class="reference internal" href="../DCO.html">Developer’s Certificate of Origin 1.1</a></li>
    274. 

  274. </ul>
    275. 

  275. </li>
    276. 

  276. </ul>
    277. 

  277. <ul>
    278. 

  278. <li class="toctree-l1"><a class="reference internal" href="../general/index.html">General Topics</a><ul>
    279. 

  279. <li class="toctree-l2"><a class="reference internal" href="../general/urls.html">CodeIgniter URLs</a></li>
    280. 

  280. <li class="toctree-l2"><a class="reference internal" href="../general/controllers.html">Controllers</a></li>
    281. 

  281. <li class="toctree-l2"><a class="reference internal" href="../general/reserved_names.html">Reserved Names</a></li>
    282. 

  282. <li class="toctree-l2"><a class="reference internal" href="../general/views.html">Views</a></li>
    283. 

  283. <li class="toctree-l2"><a class="reference internal" href="../general/models.html">Models</a></li>
    284. 

  284. <li class="toctree-l2"><a class="reference internal" href="../general/helpers.html">Helpers</a></li>
    285. 

  285. <li class="toctree-l2"><a class="reference internal" href="../general/libraries.html">Using CodeIgniter Libraries</a></li>
    286. 

  286. <li class="toctree-l2"><a class="reference internal" href="../general/creating_libraries.html">Creating Libraries</a></li>
    287. 

  287. <li class="toctree-l2"><a class="reference internal" href="../general/drivers.html">Using CodeIgniter Drivers</a></li>
    288. 

  288. <li class="toctree-l2"><a class="reference internal" href="../general/creating_drivers.html">Creating Drivers</a></li>
    289. 

  289. <li class="toctree-l2"><a class="reference internal" href="../general/core_classes.html">Creating Core System Classes</a></li>
    290. 

  290. <li class="toctree-l2"><a class="reference internal" href="../general/ancillary_classes.html">Creating Ancillary Classes</a></li>
    291. 

  291. <li class="toctree-l2"><a class="reference internal" href="../general/hooks.html">Hooks - Extending the Framework Core</a></li>
    292. 

  292. <li class="toctree-l2"><a class="reference internal" href="../general/autoloader.html">Auto-loading Resources</a></li>
    293. 

  293. <li class="toctree-l2"><a class="reference internal" href="../general/common_functions.html">Common Functions</a></li>
    294. 

  294. <li class="toctree-l2"><a class="reference internal" href="../general/compatibility_functions.html">Compatibility Functions</a></li>
    295. 

  295. <li class="toctree-l2"><a class="reference internal" href="../general/routing.html">URI Routing</a></li>
    296. 

  296. <li class="toctree-l2"><a class="reference internal" href="../general/errors.html">Error Handling</a></li>
    297. 

  297. <li class="toctree-l2"><a class="reference internal" href="../general/caching.html">Caching</a></li>
    298. 

  298. <li class="toctree-l2"><a class="reference internal" href="../general/profiling.html">Profiling Your Application</a></li>
    299. 

  299. <li class="toctree-l2"><a class="reference internal" href="../general/cli.html">Running via the CLI</a></li>
    300. 

  300. <li class="toctree-l2"><a class="reference internal" href="../general/managing_apps.html">Managing your Applications</a></li>
    301. 

  301. <li class="toctree-l2"><a class="reference internal" href="../general/environments.html">Handling Multiple Environments</a></li>
    302. 

  302. <li class="toctree-l2"><a class="reference internal" href="../general/alternative_php.html">Alternate PHP Syntax for View Files</a></li>
    303. 

  303. <li class="toctree-l2"><a class="reference internal" href="../general/security.html">Security</a></li>
    304. 

  304. <li class="toctree-l2"><a class="reference internal" href="../general/styleguide.html">PHP Style Guide</a></li>
    305. 

  305. </ul>
    306. 

  306. </li>
    307. 

  307. </ul>
    308. 

  308. <ul>
    309. 

  309. <li class="toctree-l1"><a class="reference internal" href="../libraries/index.html">Libraries</a><ul>
    310. 

  310. <li class="toctree-l2"><a class="reference internal" href="../libraries/benchmark.html">Benchmarking Class</a></li>
    311. 

  311. <li class="toctree-l2"><a class="reference internal" href="../libraries/caching.html">Caching Driver</a></li>
    312. 

  312. <li class="toctree-l2"><a class="reference internal" href="../libraries/calendar.html">Calendaring Class</a></li>
    313. 

  313. <li class="toctree-l2"><a class="reference internal" href="../libraries/cart.html">Shopping Cart Class</a></li>
    314. 

  314. <li class="toctree-l2"><a class="reference internal" href="../libraries/config.html">Config Class</a></li>
    315. 

  315. <li class="toctree-l2"><a class="reference internal" href="../libraries/email.html">Email Class</a></li>
    316. 

  316. <li class="toctree-l2"><a class="reference internal" href="../libraries/encrypt.html">Encrypt Class</a></li>
    317. 

  317. <li class="toctree-l2"><a class="reference internal" href="../libraries/encryption.html">Encryption Library</a></li>
    318. 

  318. <li class="toctree-l2"><a class="reference internal" href="../libraries/file_uploading.html">File Uploading Class</a></li>
    319. 

  319. <li class="toctree-l2"><a class="reference internal" href="../libraries/form_validation.html">Form Validation</a></li>
    320. 

  320. <li class="toctree-l2"><a class="reference internal" href="../libraries/ftp.html">FTP Class</a></li>
    321. 

  321. <li class="toctree-l2"><a class="reference internal" href="../libraries/image_lib.html">Image Manipulation Class</a></li>
    322. 

  322. <li class="toctree-l2"><a class="reference internal" href="../libraries/input.html">Input Class</a></li>
    323. 

  323. <li class="toctree-l2"><a class="reference internal" href="../libraries/javascript.html">Javascript Class</a></li>
    324. 

  324. <li class="toctree-l2"><a class="reference internal" href="../libraries/language.html">Language Class</a></li>
    325. 

  325. <li class="toctree-l2"><a class="reference internal" href="../libraries/loader.html">Loader Class</a></li>
    326. 

  326. <li class="toctree-l2"><a class="reference internal" href="../libraries/migration.html">Migrations Class</a></li>
    327. 

  327. <li class="toctree-l2"><a class="reference internal" href="../libraries/output.html">Output Class</a></li>
    328. 

  328. <li class="toctree-l2"><a class="reference internal" href="../libraries/pagination.html">Pagination Class</a></li>
    329. 

  329. <li class="toctree-l2"><a class="reference internal" href="../libraries/parser.html">Template Parser Class</a></li>
    330. 

  330. <li class="toctree-l2"><a class="reference internal" href="../libraries/security.html">Security Class</a></li>
    331. 

  331. <li class="toctree-l2"><a class="reference internal" href="../libraries/sessions.html">Session Library</a></li>
    332. 

  332. <li class="toctree-l2"><a class="reference internal" href="../libraries/table.html">HTML Table Class</a></li>
    333. 

  333. <li class="toctree-l2"><a class="reference internal" href="../libraries/trackback.html">Trackback Class</a></li>
    334. 

  334. <li class="toctree-l2"><a class="reference internal" href="../libraries/typography.html">Typography Class</a></li>
    335. 

  335. <li class="toctree-l2"><a class="reference internal" href="../libraries/unit_testing.html">Unit Testing Class</a></li>
    336. 

  336. <li class="toctree-l2"><a class="reference internal" href="../libraries/uri.html">URI Class</a></li>
    337. 

  337. <li class="toctree-l2"><a class="reference internal" href="../libraries/user_agent.html">User Agent Class</a></li>
    338. 

  338. <li class="toctree-l2"><a class="reference internal" href="../libraries/xmlrpc.html">XML-RPC and XML-RPC Server Classes</a></li>
    339. 

  339. <li class="toctree-l2"><a class="reference internal" href="../libraries/zip.html">Zip Encoding Class</a></li>
    340. 

  340. </ul>
    341. 

  341. </li>
    342. 

  342. </ul>
    343. 

  343. <ul>
    344. 

  344. <li class="toctree-l1"><a class="reference internal" href="../database/index.html">Database Reference</a><ul>
    345. 

  345. <li class="toctree-l2"><a class="reference internal" href="../database/examples.html">Quick Start: Usage Examples</a></li>
    346. 

  346. <li class="toctree-l2"><a class="reference internal" href="../database/configuration.html">Database Configuration</a></li>
    347. 

  347. <li class="toctree-l2"><a class="reference internal" href="../database/connecting.html">Connecting to a Database</a></li>
    348. 

  348. <li class="toctree-l2"><a class="reference internal" href="../database/queries.html">Running Queries</a></li>
    349. 

  349. <li class="toctree-l2"><a class="reference internal" href="../database/results.html">Generating Query Results</a></li>
    350. 

  350. <li class="toctree-l2"><a class="reference internal" href="../database/helpers.html">Query Helper Functions</a></li>
    351. 

  351. <li class="toctree-l2"><a class="reference internal" href="../database/query_builder.html">Query Builder Class</a></li>
    352. 

  352. <li class="toctree-l2"><a class="reference internal" href="../database/transactions.html">Transactions</a></li>
    353. 

  353. <li class="toctree-l2"><a class="reference internal" href="../database/metadata.html">Getting MetaData</a></li>
    354. 

  354. <li class="toctree-l2"><a class="reference internal" href="../database/call_function.html">Custom Function Calls</a></li>
    355. 

  355. <li class="toctree-l2"><a class="reference internal" href="../database/caching.html">Query Caching</a></li>
    356. 

  356. <li class="toctree-l2"><a class="reference internal" href="../database/forge.html">Database Manipulation with Database Forge</a></li>
    357. 

  357. <li class="toctree-l2"><a class="reference internal" href="../database/utilities.html">Database Utilities Class</a></li>
    358. 

  358. <li class="toctree-l2"><a class="reference internal" href="../database/db_driver_reference.html">Database Driver Reference</a></li>
    359. 

  359. </ul>
    360. 

  360. </li>
    361. 

  361. </ul>
    362. 

  362. <ul>
    363. 

  363. <li class="toctree-l1"><a class="reference internal" href="../helpers/index.html">Helpers</a><ul>
    364. 

  364. <li class="toctree-l2"><a class="reference internal" href="../helpers/array_helper.html">Array Helper</a></li>
    365. 

  365. <li class="toctree-l2"><a class="reference internal" href="../helpers/captcha_helper.html">CAPTCHA Helper</a></li>
    366. 

  366. <li class="toctree-l2"><a class="reference internal" href="../helpers/cookie_helper.html">Cookie Helper</a></li>
    367. 

  367. <li class="toctree-l2"><a class="reference internal" href="../helpers/date_helper.html">Date Helper</a></li>
    368. 

  368. <li class="toctree-l2"><a class="reference internal" href="../helpers/directory_helper.html">Directory Helper</a></li>
    369. 

  369. <li class="toctree-l2"><a class="reference internal" href="../helpers/download_helper.html">Download Helper</a></li>
    370. 

  370. <li class="toctree-l2"><a class="reference internal" href="../helpers/email_helper.html">Email Helper</a></li>
    371. 

  371. <li class="toctree-l2"><a class="reference internal" href="../helpers/file_helper.html">File Helper</a></li>
    372. 

  372. <li class="toctree-l2"><a class="reference internal" href="../helpers/form_helper.html">Form Helper</a></li>
    373. 

  373. <li class="toctree-l2"><a class="reference internal" href="../helpers/html_helper.html">HTML Helper</a></li>
    374. 

  374. <li class="toctree-l2"><a class="reference internal" href="../helpers/inflector_helper.html">Inflector Helper</a></li>
    375. 

  375. <li class="toctree-l2"><a class="reference internal" href="../helpers/language_helper.html">Language Helper</a></li>
    376. 

  376. <li class="toctree-l2"><a class="reference internal" href="../helpers/number_helper.html">Number Helper</a></li>
    377. 

  377. <li class="toctree-l2"><a class="reference internal" href="../helpers/path_helper.html">Path Helper</a></li>
    378. 

  378. <li class="toctree-l2"><a class="reference internal" href="../helpers/security_helper.html">Security Helper</a></li>
    379. 

  379. <li class="toctree-l2"><a class="reference internal" href="../helpers/smiley_helper.html">Smiley Helper</a></li>
    380. 

  380. <li class="toctree-l2"><a class="reference internal" href="../helpers/string_helper.html">String Helper</a></li>
    381. 

  381. <li class="toctree-l2"><a class="reference internal" href="../helpers/text_helper.html">Text Helper</a></li>
    382. 

  382. <li class="toctree-l2"><a class="reference internal" href="../helpers/typography_helper.html">Typography Helper</a></li>
    383. 

  383. <li class="toctree-l2"><a class="reference internal" href="../helpers/url_helper.html">URL Helper</a></li>
    384. 

  384. <li class="toctree-l2"><a class="reference internal" href="../helpers/xml_helper.html">XML Helper</a></li>
    385. 

  385. </ul>
    386. 

  386. </li>
    387. 

  387. </ul>
    388. 

  388. 

  389.           
    390. 

  390.         
    391. 

  391.       </div>
    392. 

  392.       &nbsp;
    393. 

  393.     </nav>
    394. 

  394. 

  395.     <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
    396. 

  396. 

  397.       
    398. 

  398.       <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
    399. 

  399.         <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
    400. 

  400.         <a href="../index.html">CodeIgniter</a>
    401. 

  401.       </nav>
    402. 

  402. 

  403. 

  404.       
    405. 

  405.       <div class="wy-nav-content">
    406. 

  406.         <div class="rst-content">
    407. 

  407.           <div role="navigation" aria-label="breadcrumbs navigation">
    408. 

  408.   <ul class="wy-breadcrumbs">
    409. 

  409.     <li><a href="../index.html">Docs</a> &raquo;</li>
    410. 

  410.       
    411. 

  411.         <li><a href="../contributing/index.html">Contributing to CodeIgniter</a> &raquo;</li>
    412. 

  412.       
    413. 

  413.     <li>Writing CodeIgniter Documentation</li>
    414. 

  414.     <li class="wy-breadcrumbs-aside">
    415. 

  415.       
    416. 

  416.     </li>
    417. 

  417.     <div style="float:right;margin-left:5px;" id="closeMe">
    418. 

  418.       <img title="Classic Layout" alt="classic layout" src="data:image/gif;base64,R0lGODlhFAAUAJEAAAAAADMzM////wAAACH5BAUUAAIALAAAAAAUABQAAAImlI+py+0PU5gRBRDM3DxbWoXis42X13USOLauUIqnlsaH/eY6UwAAOw==" />
    419. 

  419.     </div>
    420. 

  420.   </ul>
    421. 

  421.   <hr/>
    422. 

  422. </div>
    423. 

  423.           <div role="main" class="document">
    424. 

  424.             
    425. 

  425.   <div class="section" id="writing-codeigniter-documentation">
    426. 

  426. <h1>Writing CodeIgniter Documentation<a class="headerlink" href="#writing-codeigniter-documentation" title="Permalink to this headline">¶</a></h1>
    427. 

  427. <p>CodeIgniter uses Sphinx to generate its documentation in a variety of formats,
    428. 

  428. using reStructuredText to handle the formatting.  If you are familiar with
    429. 

  429. Markdown or Textile, you will quickly grasp reStructuredText.  The focus is
    430. 

  430. on readability and user friendliness.
    431. 

  431. While they can be quite technical, we always write for humans!</p>
    432. 

  432. <p>A local table of contents should always be included, like the one below.
    433. 

  433. It is created automatically by inserting the following:</p>
    434. 

  434. <div class="highlight-ci"><div class="highlight"><pre><span></span><span class="o">..</span> <span class="nx">contents</span><span class="o">::</span>
    435. 

  435.         <span class="o">:</span><span class="nx">local</span><span class="o">:</span>
    436. 

  436. 

  437. <span class="o">..</span> <span class="nx">raw</span><span class="o">::</span> <span class="na">html</span>
    438. 

  438. 

  439. <span class="o">&lt;</span><span class="nx">div</span> <span class="nx">class</span><span class="o">=</span><span class="s2">&quot;custom-index container&quot;</span><span class="o">&gt;&lt;/</span><span class="nx">div</span><span class="o">&gt;</span>
    440. 

  440. </pre></div>
    441. 

  441. </div>
    442. 

  442. <div class="contents local topic" id="contents">
    443. 

  443. <ul class="simple">
    444. 

  444. <li><a class="reference internal" href="#tools-required" id="id1">Tools Required</a></li>
    445. 

  445. <li><a class="reference internal" href="#page-and-section-headings-and-subheadings" id="id2">Page and Section Headings and Subheadings</a></li>
    446. 

  446. <li><a class="reference internal" href="#method-documentation" id="id3">Method Documentation</a></li>
    447. 

  447. </ul>
    448. 

  448. </div>
    449. 

  449. <div class="custom-index container"></div><p>The &lt;div&gt; that is inserted as raw HTML is a hook for the documentation’s
    450. 

  450. JavaScript to dynamically add links to any function and method definitions
    451. 

  451. contained in the current page.</p>
    452. 

  452. <div class="section" id="tools-required">
    453. 

  453. <h2><a class="toc-backref" href="#id1">Tools Required</a><a class="headerlink" href="#tools-required" title="Permalink to this headline">¶</a></h2>
    454. 

  454. <p>To see the rendered HTML, ePub, PDF, etc., you will need to install Sphinx
    455. 

  455. along with the PHP domain extension for Sphinx.  The underlying requirement
    456. 

  456. is to have Python installed.  Lastly, you will install the CI Lexer for
    457. 

  457. Pygments, so that code blocks can be properly highlighted.</p>
    458. 

  458. <div class="highlight-bash"><div class="highlight"><pre><span></span>easy_install <span class="s2">&quot;sphinx==1.2.3&quot;</span>
    459. 

  459. easy_install <span class="s2">&quot;sphinxcontrib-phpdomain==0.1.3.post1&quot;</span>
    460. 

  460. </pre></div>
    461. 

  461. </div>
    462. 

  462. <p>Then follow the directions in the README file in the <code class="samp docutils literal"><span class="pre">cilexer</span></code> folder
    463. 

  463. inside the documentation repository to install the CI Lexer.</p>
    464. 

  464. </div>
    465. 

  465. <div class="section" id="page-and-section-headings-and-subheadings">
    466. 

  466. <h2><a class="toc-backref" href="#id2">Page and Section Headings and Subheadings</a><a class="headerlink" href="#page-and-section-headings-and-subheadings" title="Permalink to this headline">¶</a></h2>
    467. 

  467. <p>Headings not only provide order and sections within a page, but they also
    468. 

  468. are used to automatically build both the page and document table of contents.
    469. 

  469. Headings are formed by using certain characters as underlines for a bit of
    470. 

  470. text.  Major headings, like page titles and section headings also use
    471. 

  471. overlines.  Other headings just use underlines, with the following hierarchy:</p>
    472. 

  472. <div class="highlight-ci"><div class="highlight"><pre><span></span><span class="c1"># with overline for page titles</span>
    473. 

  473. <span class="o">*</span> <span class="nx">with</span> <span class="nx">overline</span> <span class="k">for</span> <span class="nx">major</span> <span class="nx">sections</span>
    474. 

  474. <span class="o">=</span> <span class="k">for</span> <span class="nx">subsections</span>
    475. 

  475. <span class="o">-</span> <span class="k">for</span> <span class="nx">subsubsections</span>
    476. 

  476. <span class="o">^</span> <span class="k">for</span> <span class="nx">subsubsubsections</span>
    477. 

  477. <span class="s2">&quot; for subsubsubsubsections (!)</span>
    478. 

  478. </pre></div>
    479. 

  479. </div>
    480. 

  480. <p>The <a class="reference download internal" href="../_downloads/ELDocs.tmbundle.zip" download=""><code class="xref download docutils literal"><span class="pre">TextMate</span> <span class="pre">ELDocs</span> <span class="pre">Bundle</span></code></a> can help you
    481. 

  481. create these with the following tab triggers:</p>
    482. 

  482. <div class="highlight-ci"><div class="highlight"><pre><span></span><span class="nx">title</span><span class="o">-&gt;</span>
    483. 

  483. 

  484.         <span class="c1">##########</span>
    485. 

  485.         <span class="nx">Page</span> <span class="nx">Title</span>
    486. 

  486.         <span class="c1">##########</span>
    487. 

  487. 

  488. <span class="nx">sec</span><span class="o">-&gt;</span>
    489. 

  489. 

  490.         <span class="o">*************</span>
    491. 

  491.         <span class="nx">Major</span> <span class="nx">Section</span>
    492. 

  492.         <span class="o">*************</span>
    493. 

  493. 

  494. <span class="nx">sub</span><span class="o">-&gt;</span>
    495. 

  495. 

  496.         <span class="na">Subsection</span>
    497. 

  497.         <span class="o">==========</span>
    498. 

  498. 

  499. <span class="nx">sss</span><span class="o">-&gt;</span>
    500. 

  500. 

  501.         <span class="na">SubSubSection</span>
    502. 

  502.         <span class="o">-------------</span>
    503. 

  503. 

  504. <span class="nx">ssss</span><span class="o">-&gt;</span>
    505. 

  505. 

  506.         <span class="na">SubSubSubSection</span>
    507. 

  507.         <span class="o">^^^^^^^^^^^^^^^^</span>
    508. 

  508. 

  509. <span class="nx">sssss</span><span class="o">-&gt;</span>
    510. 

  510. 

  511.         <span class="na">SubSubSubSubSection</span> <span class="p">(</span><span class="o">!</span><span class="p">)</span>
    512. 

  512.         <span class="s2">&quot;&quot;&quot;&quot;&quot;&quot;&quot;&quot;&quot;&quot;&quot;&quot;&quot;&quot;&quot;&quot;&quot;&quot;&quot;&quot;&quot;&quot;&quot;</span>
    513. 

  513. </pre></div>
    514. 

  514. </div>
    515. 

  515. </div>
    516. 

  516. <div class="section" id="method-documentation">
    517. 

  517. <h2><a class="toc-backref" href="#id3">Method Documentation</a><a class="headerlink" href="#method-documentation" title="Permalink to this headline">¶</a></h2>
    518. 

  518. <p>When documenting class methods for third party developers, Sphinx provides
    519. 

  519. directives to assist and keep things simple.
    520. 

  520. For example, consider the following ReST:</p>
    521. 

  521. <div class="highlight-rst"><div class="highlight"><pre><span></span><span class="p">..</span> <span class="ow">php:class</span><span class="p">::</span> Some_class
    522. 

  522. 

  523. <span class="p">        ..</span> <span class="ow">php:method</span><span class="p">::</span> some_method ( $foo [, $bar [, $bat]])
    524. 

  524. 

  525.                 This function will perform some action. The <span class="s">``$bar``</span> array must contain
    526. 

  526.                 a something and something else, and along with <span class="s">``$bat``</span> is an optional
    527. 

  527.                 parameter.
    528. 

  528. 

  529.                 <span class="nc">:param int $foo:</span> <span class="nf">the foo id to do something in</span>
    530. 

  530.                 <span class="nc">:param mixed $bar:</span> <span class="nf">A data array that must contain a something and something else</span>
    531. 

  531.                 <span class="nc">:param bool $bat:</span> <span class="nf">whether or not to do something</span>
    532. 

  532.                 <span class="nc">:returns:</span> <span class="nf">FALSE on failure, TRUE if successful</span>
    533. 

  533.                 <span class="nc">:rtype:</span> <span class="nf">bool</span>
    534. 

  534. 

  535.                 <span class="se">::</span>
    536. 

  536. 

  537. <span class="s">                        $this-&gt;load-&gt;library(&#39;some_class&#39;);</span>
    538. 

  538. 

  539. <span class="s">                        $bar = array(</span>
    540. 

  540. <span class="s">                                &#39;something&#39;             =&gt; &#39;Here is this parameter!&#39;,</span>
    541. 

  541. <span class="s">                                &#39;something_else&#39;        =&gt; 42</span>
    542. 

  542. <span class="s">                        );</span>
    543. 

  543. 

  544. <span class="s">                        $bat = $this-&gt;some_class-&gt;should_do_something();</span>
    545. 

  545. 

  546. <span class="s">                        if ($this-&gt;some_class-&gt;some_method(4, $bar, $bat) === FALSE)</span>
    547. 

  547. <span class="s">                        {</span>
    548. 

  548. <span class="s">                                show_error(&#39;An Error Occurred Doing Some Method&#39;);</span>
    549. 

  549. <span class="s">                        }</span>
    550. 

  550. 

  551. <span class="p">                ..</span> <span class="ow">note</span><span class="p">::</span> Here is something that you should be aware of when using some_method().
    552. 

  552.                                 For real.
    553. 

  553. 

  554.                 See also <span class="na">:meth:</span><span class="nv">`Some_class::should_do_something`</span>
    555. 

  555. 

  556. 

  557. <span class="p">        ..</span> <span class="ow">php:method</span><span class="p">::</span> should_do_something()
    558. 

  558. 

  559.                 <span class="nc">:returns:</span> <span class="nf">Whether or not something should be done</span>
    560. 

  560.                 <span class="nc">:rtype:</span> <span class="nf">bool</span>
    561. 

  561. </pre></div>
    562. 

  562. </div>
    563. 

  563. <p>It creates the following display:</p>
    564. 

  564. <dl class="class">
    565. 

  565. <dt id="Some_class">
    566. 

  566. <em class="property">class </em><code class="descname">Some_class</code><a class="headerlink" href="#Some_class" title="Permalink to this definition">¶</a></dt>
    567. 

  567. <dd><dl class="method">
    568. 

  568. <dt id="Some_class::some_method">
    569. 

  569. <code class="descname">some_method</code><span class="sig-paren">(</span><em>$foo</em><span class="optional">[</span>, <em>$bar</em><span class="optional">[</span>, <em>$bat</em><span class="optional">]</span><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#Some_class::some_method" title="Permalink to this definition">¶</a></dt>
    570. 

  570. <dd><p>This function will perform some action. The <code class="docutils literal"><span class="pre">$bar</span></code> array must contain
    571. 

  571. a something and something else, and along with <code class="docutils literal"><span class="pre">$bat</span></code> is an optional
    572. 

  572. parameter.</p>
    573. 

  573. <table class="docutils field-list" frame="void" rules="none">
    574. 

  574. <col class="field-name" />
    575. 

  575. <col class="field-body" />
    576. 

  576. <tbody valign="top">
    577. 

  577. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
    578. 

  578. <li><strong>$foo</strong> (<em>int</em>) – the foo id to do something in</li>
    579. 

  579. <li><strong>$bar</strong> (<em>mixed</em>) – A data array that must contain a something and something else</li>
    580. 

  580. <li><strong>$bat</strong> (<em>bool</em>) – whether or not to do something</li>
    581. 

  581. </ul>
    582. 

  582. </td>
    583. 

  583. </tr>
    584. 

  584. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">FALSE on failure, TRUE if successful</p>
    585. 

  585. </td>
    586. 

  586. </tr>
    587. 

  587. <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">bool</p>
    588. 

  588. </td>
    589. 

  589. </tr>
    590. 

  590. </tbody>
    591. 

  591. </table>
    592. 

  592. <div class="highlight-ci"><div class="highlight"><pre><span></span><span class="nv">$this</span><span class="o">-&gt;</span><span class="na">load</span><span class="o">-&gt;</span><span class="na">library</span><span class="p">(</span><span class="s1">&#39;some_class&#39;</span><span class="p">);</span>
    593. 

  593. 

  594. <span class="nv">$bar</span> <span class="o">=</span> <span class="k">array</span><span class="p">(</span>
    595. 

  595.         <span class="s1">&#39;something&#39;</span>             <span class="o">=&gt;</span> <span class="s1">&#39;Here is this parameter!&#39;</span><span class="p">,</span>
    596. 

  596.         <span class="s1">&#39;something_else&#39;</span>        <span class="o">=&gt;</span> <span class="mi">42</span>
    597. 

  597. <span class="p">);</span>
    598. 

  598. 

  599. <span class="nv">$bat</span> <span class="o">=</span> <span class="nv">$this</span><span class="o">-&gt;</span><span class="na">some_class</span><span class="o">-&gt;</span><span class="na">should_do_something</span><span class="p">();</span>
    600. 

  600. 

  601. <span class="k">if</span> <span class="p">(</span><span class="nv">$this</span><span class="o">-&gt;</span><span class="na">some_class</span><span class="o">-&gt;</span><span class="na">some_method</span><span class="p">(</span><span class="mi">4</span><span class="p">,</span> <span class="nv">$bar</span><span class="p">,</span> <span class="nv">$bat</span><span class="p">)</span> <span class="o">===</span> <span class="k">FALSE</span><span class="p">)</span>
    602. 

  602. <span class="p">{</span>
    603. 

  603.         <span class="nx">show_error</span><span class="p">(</span><span class="s1">&#39;An Error Occurred Doing Some Method&#39;</span><span class="p">);</span>
    604. 

  604. <span class="p">}</span>
    605. 

  605. </pre></div>
    606. 

  606. </div>
    607. 

  607. <div class="admonition note">
    608. 

  608. <p class="first admonition-title">Note</p>
    609. 

  609. <p class="last">Here is something that you should be aware of when using some_method().
    610. 

  610. For real.</p>
    611. 

  611. </div>
    612. 

  612. <p>See also <code class="xref py py-meth docutils literal"><span class="pre">Some_class::should_do_something()</span></code></p>
    613. 

  613. </dd></dl>
    614. 

  614. 

  615. <dl class="method">
    616. 

  616. <dt id="Some_class::should_do_something">
    617. 

  617. <code class="descname">should_do_something</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#Some_class::should_do_something" title="Permalink to this definition">¶</a></dt>
    618. 

  618. <dd><table class="docutils field-list" frame="void" rules="none">
    619. 

  619. <col class="field-name" />
    620. 

  620. <col class="field-body" />
    621. 

  621. <tbody valign="top">
    622. 

  622. <tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">Whether or not something should be done</td>
    623. 

  623. </tr>
    624. 

  624. <tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">bool</td>
    625. 

  625. </tr>
    626. 

  626. </tbody>
    627. 

  627. </table>
    628. 

  628. </dd></dl>
    629. 

  629. 

  630. </dd></dl>
    631. 

  631. 

  632. </div>
    633. 

  633. </div>
    634. 

  634. 

  635. 

  636.           </div>
    637. 

  637.           <footer>
    638. 

  638.   
    639. 

  639.     <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
    640. 

  640.       
    641. 

  641.         <a href="../DCO.html" class="btn btn-neutral float-right" title="Developer’s Certificate of Origin 1.1">Next <span class="fa fa-arrow-circle-right"></span></a>
    642. 

  642.       
    643. 

  643.       
    644. 

  644.         <a href="../contributing/index.html" class="btn btn-neutral" title="Contributing to CodeIgniter"><span class="fa fa-arrow-circle-left"></span> Previous</a>
    645. 

  645.       
    646. 

  646.     </div>
    647. 

  647.   
    648. 

  648. 

  649.   <hr/>
    650. 

  650. 

  651.   <div role="contentinfo">
    652. 

  652.     <p>
    653. 

  653.         &copy; Copyright 2014 - 2019, British Columbia Institute of Technology.
    654. 

  654.       Last updated on Sep 19, 2019.
    655. 

  655.     </p>
    656. 

  656.   </div>
    657. 

  657. 

  658.   Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
    659. 

  659.   
    660. 

  660. </footer>
    661. 

  661.         </div>
    662. 

  662.       </div>
    663. 

  663. 

  664.     </section>
    665. 

  665. 

  666.   </div>
    667. 

  667.   
    668. 

  668. 

  669. 

  670.   
    671. 

  671. 

  672.     <script type="text/javascript">
    673. 

  673.         var DOCUMENTATION_OPTIONS = {
    674. 

  674.             URL_ROOT:'../',
    675. 

  675.             VERSION:'3.1.11',
    676. 

  676.             COLLAPSE_INDEX:false,
    677. 

  677.             FILE_SUFFIX:'.html',
    678. 

  678.             HAS_SOURCE:  false
    679. 

  679.         };
    680. 

  680.     </script>
    681. 

  681.       <script type="text/javascript" src="../_static/jquery.js"></script>
    682. 

  682.       <script type="text/javascript" src="../_static/underscore.js"></script>
    683. 

  683.       <script type="text/javascript" src="../_static/doctools.js"></script>
    684. 

  684. 

  685.   
    686. 

  686. 

  687.   
    688. 

  688.   
    689. 

  689.     <script type="text/javascript" src="../_static/js/theme.js"></script>
    690. 

  690.   
    691. 

  691. 

  692.   
    693. 

  693.   
    694. 

  694.   <script type="text/javascript">
    695. 

  695.       jQuery(function () {
    696. 

  696.           SphinxRtdTheme.StickyNav.enable();
    697. 

  697.       });
    698. 

  698.   </script>
    699. 

  699.    
    700. 

  700. 

  701. </body>
    702. 

  702. </html>
    703.