Não pode escolher mais do que 25 tópicos Os tópicos devem começar com uma letra ou um número, podem incluir traços ('-') e podem ter até 35 caracteres.
 
 
 
 
 
 

294 linhas
22 KiB

  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
  2. "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  3. <html xmlns="http://www.w3.org/1999/xhtml">
  4. <head>
  5. <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
  6. <title>Welcome to WNFramework documentation! &mdash; WNFramework v1.8 documentation</title>
  7. <link rel="stylesheet" href="_static/default.css" type="text/css" />
  8. <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
  9. <script type="text/javascript">
  10. var DOCUMENTATION_OPTIONS = {
  11. URL_ROOT: '',
  12. VERSION: '1.8',
  13. COLLAPSE_INDEX: false,
  14. FILE_SUFFIX: '.html',
  15. HAS_SOURCE: true
  16. };
  17. </script>
  18. <script type="text/javascript" src="_static/jquery.js"></script>
  19. <script type="text/javascript" src="_static/underscore.js"></script>
  20. <script type="text/javascript" src="_static/doctools.js"></script>
  21. <link rel="top" title="WNFramework v1.8 documentation" href="#" />
  22. <link rel="next" title="core Package" href="core.html" />
  23. </head>
  24. <body>
  25. <div class="related">
  26. <h3>Navigation</h3>
  27. <ul>
  28. <li class="right" style="margin-right: 10px">
  29. <a href="genindex.html" title="General Index"
  30. accesskey="I">index</a></li>
  31. <li class="right" >
  32. <a href="py-modindex.html" title="Python Module Index"
  33. >modules</a> |</li>
  34. <li class="right" >
  35. <a href="core.html" title="core Package"
  36. accesskey="N">next</a> |</li>
  37. <li><a href="#">WNFramework v1.8 documentation</a> &raquo;</li>
  38. </ul>
  39. </div>
  40. <div class="document">
  41. <div class="documentwrapper">
  42. <div class="bodywrapper">
  43. <div class="body">
  44. <div class="section" id="welcome-to-wnframework-documentation">
  45. <h1>Welcome to WNFramework documentation!<a class="headerlink" href="#welcome-to-wnframework-documentation" title="Permalink to this headline">¶</a></h1>
  46. <p>Contents:</p>
  47. <div class="toctree-wrapper compound">
  48. <ul>
  49. <li class="toctree-l1"><a class="reference internal" href="core.html">core Package</a><ul>
  50. <li class="toctree-l2"><a class="reference internal" href="core.html#subpackages">Subpackages</a><ul>
  51. <li class="toctree-l3"><a class="reference internal" href="core.doctype.html">doctype Package</a><ul>
  52. <li class="toctree-l4"><a class="reference internal" href="core.doctype.html#subpackages">Subpackages</a><ul>
  53. <li class="toctree-l5"><a class="reference internal" href="core.doctype.control_panel.html">control_panel Package</a><ul>
  54. <li class="toctree-l6"><a class="reference internal" href="core.doctype.control_panel.html#control-panel-module"><tt class="docutils literal"><span class="pre">control_panel</span></tt> Module</a></li>
  55. </ul>
  56. </li>
  57. <li class="toctree-l5"><a class="reference internal" href="core.doctype.custom_field.html">custom_field Package</a><ul>
  58. <li class="toctree-l6"><a class="reference internal" href="core.doctype.custom_field.html#custom-field-module"><tt class="docutils literal"><span class="pre">custom_field</span></tt> Module</a></li>
  59. </ul>
  60. </li>
  61. <li class="toctree-l5"><a class="reference internal" href="core.doctype.doctype.html">doctype Package</a><ul>
  62. <li class="toctree-l6"><a class="reference internal" href="core.doctype.doctype.html#doctype-module"><tt class="docutils literal"><span class="pre">doctype</span></tt> Module</a></li>
  63. </ul>
  64. </li>
  65. <li class="toctree-l5"><a class="reference internal" href="core.doctype.doctype_mapper.html">doctype_mapper Package</a><ul>
  66. <li class="toctree-l6"><a class="reference internal" href="core.doctype.doctype_mapper.html#doctype-mapper-module"><tt class="docutils literal"><span class="pre">doctype_mapper</span></tt> Module</a></li>
  67. </ul>
  68. </li>
  69. <li class="toctree-l5"><a class="reference internal" href="core.doctype.letter_head.html">letter_head Package</a><ul>
  70. <li class="toctree-l6"><a class="reference internal" href="core.doctype.letter_head.html#letter-head-module"><tt class="docutils literal"><span class="pre">letter_head</span></tt> Module</a></li>
  71. </ul>
  72. </li>
  73. <li class="toctree-l5"><a class="reference internal" href="core.doctype.module_def.html">module_def Package</a><ul>
  74. <li class="toctree-l6"><a class="reference internal" href="core.doctype.module_def.html#module-def-module"><tt class="docutils literal"><span class="pre">module_def</span></tt> Module</a></li>
  75. </ul>
  76. </li>
  77. <li class="toctree-l5"><a class="reference internal" href="core.doctype.page.html">page Package</a><ul>
  78. <li class="toctree-l6"><a class="reference internal" href="core.doctype.page.html#module-core.doctype.page.page"><tt class="docutils literal"><span class="pre">page</span></tt> Module</a></li>
  79. </ul>
  80. </li>
  81. <li class="toctree-l5"><a class="reference internal" href="core.doctype.page_template.html">page_template Package</a><ul>
  82. <li class="toctree-l6"><a class="reference internal" href="core.doctype.page_template.html#module-core.doctype.page_template.page_template"><tt class="docutils literal"><span class="pre">page_template</span></tt> Module</a></li>
  83. </ul>
  84. </li>
  85. <li class="toctree-l5"><a class="reference internal" href="core.doctype.profile.html">profile Package</a><ul>
  86. <li class="toctree-l6"><a class="reference internal" href="core.doctype.profile.html#profile-module"><tt class="docutils literal"><span class="pre">profile</span></tt> Module</a></li>
  87. </ul>
  88. </li>
  89. <li class="toctree-l5"><a class="reference internal" href="core.doctype.property_setter.html">property_setter Package</a><ul>
  90. <li class="toctree-l6"><a class="reference internal" href="core.doctype.property_setter.html#module-core.doctype.property_setter.property_setter"><tt class="docutils literal"><span class="pre">property_setter</span></tt> Module</a></li>
  91. </ul>
  92. </li>
  93. <li class="toctree-l5"><a class="reference internal" href="core.doctype.search_criteria.html">search_criteria Package</a><ul>
  94. <li class="toctree-l6"><a class="reference internal" href="core.doctype.search_criteria.html#search-criteria-module"><tt class="docutils literal"><span class="pre">search_criteria</span></tt> Module</a></li>
  95. </ul>
  96. </li>
  97. <li class="toctree-l5"><a class="reference internal" href="core.doctype.stylesheet.html">stylesheet Package</a><ul>
  98. <li class="toctree-l6"><a class="reference internal" href="core.doctype.stylesheet.html#module-core.doctype.stylesheet.stylesheet"><tt class="docutils literal"><span class="pre">stylesheet</span></tt> Module</a></li>
  99. </ul>
  100. </li>
  101. <li class="toctree-l5"><a class="reference internal" href="core.doctype.system_console.html">system_console Package</a><ul>
  102. <li class="toctree-l6"><a class="reference internal" href="core.doctype.system_console.html#system-console-module"><tt class="docutils literal"><span class="pre">system_console</span></tt> Module</a></li>
  103. </ul>
  104. </li>
  105. </ul>
  106. </li>
  107. </ul>
  108. </li>
  109. <li class="toctree-l3"><a class="reference internal" href="core.page.html">page Package</a><ul>
  110. <li class="toctree-l4"><a class="reference internal" href="core.page.html#subpackages">Subpackages</a><ul class="simple">
  111. </ul>
  112. </li>
  113. </ul>
  114. </li>
  115. </ul>
  116. </li>
  117. </ul>
  118. </li>
  119. <li class="toctree-l1"><a class="reference internal" href="webnotes.html">webnotes Package</a><ul>
  120. <li class="toctree-l2"><a class="reference internal" href="webnotes.html#id1"><tt class="docutils literal"><span class="pre">webnotes</span></tt> Package</a></li>
  121. <li class="toctree-l2"><a class="reference internal" href="webnotes.html#module-webnotes.auth"><tt class="docutils literal"><span class="pre">auth</span></tt> Module</a></li>
  122. <li class="toctree-l2"><a class="reference internal" href="webnotes.html#module-webnotes.db"><tt class="docutils literal"><span class="pre">db</span></tt> Module</a></li>
  123. <li class="toctree-l2"><a class="reference internal" href="webnotes.html#module-webnotes.defs"><tt class="docutils literal"><span class="pre">defs</span></tt> Module</a></li>
  124. <li class="toctree-l2"><a class="reference internal" href="webnotes.html#module-webnotes.defs_template"><tt class="docutils literal"><span class="pre">defs_template</span></tt> Module</a></li>
  125. <li class="toctree-l2"><a class="reference internal" href="webnotes.html#module-webnotes.handler"><tt class="docutils literal"><span class="pre">handler</span></tt> Module</a></li>
  126. <li class="toctree-l2"><a class="reference internal" href="webnotes.html#module-webnotes.profile"><tt class="docutils literal"><span class="pre">profile</span></tt> Module</a></li>
  127. <li class="toctree-l2"><a class="reference internal" href="webnotes.html#module-webnotes.session_cache"><tt class="docutils literal"><span class="pre">session_cache</span></tt> Module</a></li>
  128. <li class="toctree-l2"><a class="reference internal" href="webnotes.html#module-webnotes.tests"><tt class="docutils literal"><span class="pre">tests</span></tt> Module</a></li>
  129. <li class="toctree-l2"><a class="reference internal" href="webnotes.html#subpackages">Subpackages</a><ul>
  130. <li class="toctree-l3"><a class="reference internal" href="webnotes.install_lib.html">install_lib Package</a><ul>
  131. <li class="toctree-l4"><a class="reference internal" href="webnotes.install_lib.html#module-webnotes.install_lib.db_init"><tt class="docutils literal"><span class="pre">db_init</span></tt> Module</a></li>
  132. <li class="toctree-l4"><a class="reference internal" href="webnotes.install_lib.html#module-webnotes.install_lib.install"><tt class="docutils literal"><span class="pre">install</span></tt> Module</a></li>
  133. </ul>
  134. </li>
  135. <li class="toctree-l3"><a class="reference internal" href="webnotes.model.html">model Package</a><ul>
  136. <li class="toctree-l4"><a class="reference internal" href="webnotes.model.html#id1"><tt class="docutils literal"><span class="pre">model</span></tt> Package</a></li>
  137. <li class="toctree-l4"><a class="reference internal" href="webnotes.model.html#module-webnotes.model.code"><tt class="docutils literal"><span class="pre">code</span></tt> Module</a></li>
  138. <li class="toctree-l4"><a class="reference internal" href="webnotes.model.html#module-webnotes.model.db_schema"><tt class="docutils literal"><span class="pre">db_schema</span></tt> Module</a></li>
  139. <li class="toctree-l4"><a class="reference internal" href="webnotes.model.html#module-webnotes.model.doc"><tt class="docutils literal"><span class="pre">doc</span></tt> Module</a></li>
  140. <li class="toctree-l4"><a class="reference internal" href="webnotes.model.html#module-webnotes.model.doclist"><tt class="docutils literal"><span class="pre">doclist</span></tt> Module</a></li>
  141. <li class="toctree-l4"><a class="reference internal" href="webnotes.model.html#module-webnotes.model.doctype"><tt class="docutils literal"><span class="pre">doctype</span></tt> Module</a><ul>
  142. <li class="toctree-l5"><a class="reference internal" href="webnotes.model.html#id2">DocType module</a></li>
  143. </ul>
  144. </li>
  145. <li class="toctree-l4"><a class="reference internal" href="webnotes.model.html#module-webnotes.model.import_docs"><tt class="docutils literal"><span class="pre">import_docs</span></tt> Module</a></li>
  146. <li class="toctree-l4"><a class="reference internal" href="webnotes.model.html#module-webnotes.model.meta"><tt class="docutils literal"><span class="pre">meta</span></tt> Module</a></li>
  147. <li class="toctree-l4"><a class="reference internal" href="webnotes.model.html#module-webnotes.model.modules"><tt class="docutils literal"><span class="pre">modules</span></tt> Module</a></li>
  148. <li class="toctree-l4"><a class="reference internal" href="webnotes.model.html#module-webnotes.model.triggers"><tt class="docutils literal"><span class="pre">triggers</span></tt> Module</a></li>
  149. </ul>
  150. </li>
  151. <li class="toctree-l3"><a class="reference internal" href="webnotes.modules.html">modules Package</a><ul>
  152. <li class="toctree-l4"><a class="reference internal" href="webnotes.modules.html#id1"><tt class="docutils literal"><span class="pre">modules</span></tt> Package</a></li>
  153. <li class="toctree-l4"><a class="reference internal" href="webnotes.modules.html#module-webnotes.modules.compress"><tt class="docutils literal"><span class="pre">compress</span></tt> Module</a></li>
  154. <li class="toctree-l4"><a class="reference internal" href="webnotes.modules.html#module-webnotes.modules.export_module"><tt class="docutils literal"><span class="pre">export_module</span></tt> Module</a></li>
  155. <li class="toctree-l4"><a class="reference internal" href="webnotes.modules.html#module-webnotes.modules.import_module"><tt class="docutils literal"><span class="pre">import_module</span></tt> Module</a></li>
  156. <li class="toctree-l4"><a class="reference internal" href="webnotes.modules.html#module-webnotes.modules.module_manager"><tt class="docutils literal"><span class="pre">module_manager</span></tt> Module</a></li>
  157. <li class="toctree-l4"><a class="reference internal" href="webnotes.modules.html#module-webnotes.modules.patch"><tt class="docutils literal"><span class="pre">patch</span></tt> Module</a></li>
  158. </ul>
  159. </li>
  160. <li class="toctree-l3"><a class="reference internal" href="webnotes.multi_tenant.html">multi_tenant Package</a><ul>
  161. <li class="toctree-l4"><a class="reference internal" href="webnotes.multi_tenant.html#id1"><tt class="docutils literal"><span class="pre">multi_tenant</span></tt> Package</a></li>
  162. <li class="toctree-l4"><a class="reference internal" href="webnotes.multi_tenant.html#query-parser-module"><tt class="docutils literal"><span class="pre">query_parser</span></tt> Module</a></li>
  163. <li class="toctree-l4"><a class="reference internal" href="webnotes.multi_tenant.html#module-webnotes.multi_tenant.setup"><tt class="docutils literal"><span class="pre">setup</span></tt> Module</a></li>
  164. </ul>
  165. </li>
  166. <li class="toctree-l3"><a class="reference internal" href="webnotes.utils.html">utils Package</a><ul>
  167. <li class="toctree-l4"><a class="reference internal" href="webnotes.utils.html#id1"><tt class="docutils literal"><span class="pre">utils</span></tt> Package</a></li>
  168. <li class="toctree-l4"><a class="reference internal" href="webnotes.utils.html#archive-module"><tt class="docutils literal"><span class="pre">archive</span></tt> Module</a></li>
  169. <li class="toctree-l4"><a class="reference internal" href="webnotes.utils.html#backups-module"><tt class="docutils literal"><span class="pre">backups</span></tt> Module</a></li>
  170. <li class="toctree-l4"><a class="reference internal" href="webnotes.utils.html#module-webnotes.utils.cache"><tt class="docutils literal"><span class="pre">cache</span></tt> Module</a></li>
  171. <li class="toctree-l4"><a class="reference internal" href="webnotes.utils.html#module-webnotes.utils.encrypt"><tt class="docutils literal"><span class="pre">encrypt</span></tt> Module</a></li>
  172. <li class="toctree-l4"><a class="reference internal" href="webnotes.utils.html#module-webnotes.utils.file_manager"><tt class="docutils literal"><span class="pre">file_manager</span></tt> Module</a></li>
  173. <li class="toctree-l4"><a class="reference internal" href="webnotes.utils.html#module-webnotes.utils.jsmin"><tt class="docutils literal"><span class="pre">jsmin</span></tt> Module</a></li>
  174. <li class="toctree-l4"><a class="reference internal" href="webnotes.utils.html#module-webnotes.utils.nestedset"><tt class="docutils literal"><span class="pre">nestedset</span></tt> Module</a></li>
  175. <li class="toctree-l4"><a class="reference internal" href="webnotes.utils.html#module-webnotes.utils.scheduler"><tt class="docutils literal"><span class="pre">scheduler</span></tt> Module</a><ul>
  176. <li class="toctree-l5"><a class="reference internal" href="webnotes.utils.html#to-install">To install:</a></li>
  177. <li class="toctree-l5"><a class="reference internal" href="webnotes.utils.html#in-cron">In cron:</a></li>
  178. </ul>
  179. </li>
  180. <li class="toctree-l4"><a class="reference internal" href="webnotes.utils.html#module-webnotes.utils.sitemap"><tt class="docutils literal"><span class="pre">sitemap</span></tt> Module</a></li>
  181. <li class="toctree-l4"><a class="reference internal" href="webnotes.utils.html#module-webnotes.utils.transfer"><tt class="docutils literal"><span class="pre">transfer</span></tt> Module</a></li>
  182. <li class="toctree-l4"><a class="reference internal" href="webnotes.utils.html#module-webnotes.utils.webservice"><tt class="docutils literal"><span class="pre">webservice</span></tt> Module</a></li>
  183. <li class="toctree-l4"><a class="reference internal" href="webnotes.utils.html#subpackages">Subpackages</a><ul>
  184. <li class="toctree-l5"><a class="reference internal" href="webnotes.utils.email_lib.html">email_lib Package</a><ul>
  185. <li class="toctree-l6"><a class="reference internal" href="webnotes.utils.email_lib.html#id1"><tt class="docutils literal"><span class="pre">email_lib</span></tt> Package</a></li>
  186. <li class="toctree-l6"><a class="reference internal" href="webnotes.utils.email_lib.html#module-webnotes.utils.email_lib.form_email"><tt class="docutils literal"><span class="pre">form_email</span></tt> Module</a></li>
  187. <li class="toctree-l6"><a class="reference internal" href="webnotes.utils.email_lib.html#module-webnotes.utils.email_lib.html2text"><tt class="docutils literal"><span class="pre">html2text</span></tt> Module</a></li>
  188. <li class="toctree-l6"><a class="reference internal" href="webnotes.utils.email_lib.html#module-webnotes.utils.email_lib.receive"><tt class="docutils literal"><span class="pre">receive</span></tt> Module</a></li>
  189. <li class="toctree-l6"><a class="reference internal" href="webnotes.utils.email_lib.html#module-webnotes.utils.email_lib.send"><tt class="docutils literal"><span class="pre">send</span></tt> Module</a></li>
  190. </ul>
  191. </li>
  192. </ul>
  193. </li>
  194. </ul>
  195. </li>
  196. <li class="toctree-l3"><a class="reference internal" href="webnotes.widgets.html">widgets Package</a><ul>
  197. <li class="toctree-l4"><a class="reference internal" href="webnotes.widgets.html#module-webnotes.widgets.auto_master"><tt class="docutils literal"><span class="pre">auto_master</span></tt> Module</a></li>
  198. <li class="toctree-l4"><a class="reference internal" href="webnotes.widgets.html#module-webnotes.widgets.event"><tt class="docutils literal"><span class="pre">event</span></tt> Module</a></li>
  199. <li class="toctree-l4"><a class="reference internal" href="webnotes.widgets.html#module-webnotes.widgets.follow"><tt class="docutils literal"><span class="pre">follow</span></tt> Module</a></li>
  200. <li class="toctree-l4"><a class="reference internal" href="webnotes.widgets.html#module-webnotes.widgets.form"><tt class="docutils literal"><span class="pre">form</span></tt> Module</a></li>
  201. <li class="toctree-l4"><a class="reference internal" href="webnotes.widgets.html#module-webnotes.widgets.menus"><tt class="docutils literal"><span class="pre">menus</span></tt> Module</a></li>
  202. <li class="toctree-l4"><a class="reference internal" href="webnotes.widgets.html#module-webnotes.widgets.page"><tt class="docutils literal"><span class="pre">page</span></tt> Module</a></li>
  203. <li class="toctree-l4"><a class="reference internal" href="webnotes.widgets.html#module-webnotes.widgets.page_body"><tt class="docutils literal"><span class="pre">page_body</span></tt> Module</a></li>
  204. <li class="toctree-l4"><a class="reference internal" href="webnotes.widgets.html#module-webnotes.widgets.query_builder"><tt class="docutils literal"><span class="pre">query_builder</span></tt> Module</a></li>
  205. <li class="toctree-l4"><a class="reference internal" href="webnotes.widgets.html#module-webnotes.widgets.search"><tt class="docutils literal"><span class="pre">search</span></tt> Module</a></li>
  206. <li class="toctree-l4"><a class="reference internal" href="webnotes.widgets.html#module-webnotes.widgets.tags"><tt class="docutils literal"><span class="pre">tags</span></tt> Module</a></li>
  207. <li class="toctree-l4"><a class="reference internal" href="webnotes.widgets.html#module-webnotes.widgets.todo"><tt class="docutils literal"><span class="pre">todo</span></tt> Module</a></li>
  208. </ul>
  209. </li>
  210. </ul>
  211. </li>
  212. </ul>
  213. </li>
  214. </ul>
  215. </div>
  216. </div>
  217. <div class="section" id="indices-and-tables">
  218. <h1>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Permalink to this headline">¶</a></h1>
  219. <ul class="simple">
  220. <li><a class="reference internal" href="genindex.html"><em>Index</em></a></li>
  221. <li><a class="reference internal" href="py-modindex.html"><em>Module Index</em></a></li>
  222. <li><a class="reference internal" href="search.html"><em>Search Page</em></a></li>
  223. </ul>
  224. </div>
  225. </div>
  226. </div>
  227. </div>
  228. <div class="sphinxsidebar">
  229. <div class="sphinxsidebarwrapper">
  230. <p class="logo"><a href="#">
  231. <img class="logo" src="_static/wnflogo200.gif" alt="Logo"/>
  232. </a></p>
  233. <h3><a href="#">Table Of Contents</a></h3>
  234. <ul>
  235. <li><a class="reference internal" href="#">Welcome to WNFramework documentation!</a><ul>
  236. </ul>
  237. </li>
  238. <li><a class="reference internal" href="#indices-and-tables">Indices and tables</a></li>
  239. </ul>
  240. <h4>Next topic</h4>
  241. <p class="topless"><a href="core.html"
  242. title="next chapter">core Package</a></p>
  243. <h3>This Page</h3>
  244. <ul class="this-page-menu">
  245. <li><a href="_sources/index.txt"
  246. rel="nofollow">Show Source</a></li>
  247. </ul>
  248. <div id="searchbox" style="display: none">
  249. <h3>Quick search</h3>
  250. <form class="search" action="search.html" method="get">
  251. <input type="text" name="q" size="18" />
  252. <input type="submit" value="Go" />
  253. <input type="hidden" name="check_keywords" value="yes" />
  254. <input type="hidden" name="area" value="default" />
  255. </form>
  256. <p class="searchtip" style="font-size: 90%">
  257. Enter search terms or a module, class or function name.
  258. </p>
  259. </div>
  260. <script type="text/javascript">$('#searchbox').show(0);</script>
  261. </div>
  262. </div>
  263. <div class="clearer"></div>
  264. </div>
  265. <div class="related">
  266. <h3>Navigation</h3>
  267. <ul>
  268. <li class="right" style="margin-right: 10px">
  269. <a href="genindex.html" title="General Index"
  270. >index</a></li>
  271. <li class="right" >
  272. <a href="py-modindex.html" title="Python Module Index"
  273. >modules</a> |</li>
  274. <li class="right" >
  275. <a href="core.html" title="core Package"
  276. >next</a> |</li>
  277. <li><a href="#">WNFramework v1.8 documentation</a> &raquo;</li>
  278. </ul>
  279. </div>
  280. <div class="footer">
  281. &copy; Copyright 2011, Rushabh Mehta, Web Notes Technologies.
  282. Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.7.
  283. </div>
  284. </body>
  285. </html>