25개 이상의 토픽을 선택하실 수 없습니다. Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 

197 lines
10 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>webnotes — Webnotes Module &mdash; Documentation</title>
  7. <link rel="stylesheet" href="_static/sphinxdoc.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: '',
  13. COLLAPSE_MODINDEX: 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/doctools.js"></script>
  20. <link rel="top" title="Documentation" href="index.html" />
  21. <link rel="up" title="Server Side Internals" href="server_side_internals.html" />
  22. <link rel="next" title="doclist — Doclist Module" href="doclist.html" />
  23. <link rel="prev" title="auth — Authentication" href="auth.html" />
  24. </head>
  25. <body>
  26. <div style="background-color: #FFF; text-align: left; padding: 8px 0px"><img src="_static/banner300910.gif"></div>
  27. <div class="related">
  28. <h3>Navigation</h3>
  29. <ul>
  30. <li class="right" style="margin-right: 10px">
  31. <a href="genindex.html" title="General Index"
  32. accesskey="I">index</a></li>
  33. <li class="right" >
  34. <a href="modindex.html" title="Global Module Index"
  35. accesskey="M">modules</a> |</li>
  36. <li class="right" >
  37. <a href="doclist.html" title="doclist — Doclist Module"
  38. accesskey="N">next</a> |</li>
  39. <li class="right" >
  40. <a href="auth.html" title="auth — Authentication"
  41. accesskey="P">previous</a> |</li>
  42. <li><a href="index.html">Documentation</a> &raquo;</li>
  43. <li><a href="server_side_api.html" >3. Server Side API</a> &raquo;</li>
  44. <li><a href="server_side_internals.html" accesskey="U">Server Side Internals</a> &raquo;</li>
  45. </ul>
  46. </div>
  47. <div class="sphinxsidebar">
  48. <div class="sphinxsidebarwrapper">
  49. <h3><a href="index.html">Table Of Contents</a></h3>
  50. <ul>
  51. <li><a class="reference external" href=""><tt class="docutils literal"><span class="pre">webnotes</span></tt> &#8212; Webnotes Module</a><ul>
  52. <li><a class="reference external" href="#global-attributes">Global Attributes</a></li>
  53. <li><a class="reference external" href="#global-functions">Global Functions</a></li>
  54. </ul>
  55. </li>
  56. </ul>
  57. <h4>Previous topic</h4>
  58. <p class="topless"><a href="auth.html"
  59. title="previous chapter"><tt class="docutils literal docutils literal docutils literal"><span class="pre">auth</span></tt> &#8212; Authentication</a></p>
  60. <h4>Next topic</h4>
  61. <p class="topless"><a href="doclist.html"
  62. title="next chapter"><tt class="docutils literal docutils literal docutils literal"><span class="pre">doclist</span></tt> &#8212; Doclist Module</a></p>
  63. <h3>This Page</h3>
  64. <ul class="this-page-menu">
  65. <li><a href="_sources/webnotes.txt"
  66. rel="nofollow">Show Source</a></li>
  67. </ul>
  68. <div id="searchbox" style="display: none">
  69. <h3>Quick search</h3>
  70. <form class="search" action="search.html" method="get">
  71. <input type="text" name="q" size="18" />
  72. <input type="submit" value="Go" />
  73. <input type="hidden" name="check_keywords" value="yes" />
  74. <input type="hidden" name="area" value="default" />
  75. </form>
  76. <p class="searchtip" style="font-size: 90%">
  77. Enter search terms or a module, class or function name.
  78. </p>
  79. </div>
  80. <script type="text/javascript">$('#searchbox').show(0);</script>
  81. </div>
  82. </div>
  83. <div class="document">
  84. <div class="documentwrapper">
  85. <div class="bodywrapper">
  86. <div class="body">
  87. <div class="section" id="module-webnotes">
  88. <h1><tt class="xref docutils literal"><span class="pre">webnotes</span></tt> &#8212; Webnotes Module<a class="headerlink" href="#module-webnotes" title="Permalink to this headline">¶</a></h1>
  89. <div class="section" id="global-attributes">
  90. <h2>Global Attributes<a class="headerlink" href="#global-attributes" title="Permalink to this headline">¶</a></h2>
  91. <dl class="data">
  92. <dt id="webnotes.version">
  93. <tt class="descclassname">webnotes.</tt><tt class="descname">version</tt><a class="headerlink" href="#webnotes.version" title="Permalink to this definition">¶</a></dt>
  94. <dd>&#8216;v170&#8217;</dd></dl>
  95. <dl class="data">
  96. <dt id="webnotes.conn">
  97. <tt class="descclassname">webnotes.</tt><tt class="descname">conn</tt><a class="headerlink" href="#webnotes.conn" title="Permalink to this definition">¶</a></dt>
  98. <dd>The database connection <tt class="xref docutils literal"><span class="pre">webnotes.db.Database</span></tt> setup by <a title="Authentication module" class="reference external" href="auth.html#module-auth"><tt class="xref docutils literal"><span class="pre">auth</span></tt></a></dd></dl>
  99. <dl class="data">
  100. <dt id="webnotes.form">
  101. <tt class="descclassname">webnotes.</tt><tt class="descname">form</tt><a class="headerlink" href="#webnotes.form" title="Permalink to this definition">¶</a></dt>
  102. <dd>The cgi.FieldStorage() object (Dictionary representing the formdata from the URL)</dd></dl>
  103. <dl class="data">
  104. <dt id="webnotes.session">
  105. <tt class="descclassname">webnotes.</tt><tt class="descname">session</tt><a class="headerlink" href="#webnotes.session" title="Permalink to this definition">¶</a></dt>
  106. <dd><p>Global session dictionary.</p>
  107. <ul class="simple">
  108. <li>session[&#8216;user&#8217;] - Current user</li>
  109. <li>session[&#8216;data&#8217;] - Returns a dictionary of the session cache</li>
  110. </ul>
  111. </dd></dl>
  112. <dl class="data">
  113. <dt id="webnotes.is_testing">
  114. <tt class="descclassname">webnotes.</tt><tt class="descname">is_testing</tt><a class="headerlink" href="#webnotes.is_testing" title="Permalink to this definition">¶</a></dt>
  115. <dd>Flag to identify if system is in <a class="reference external" href="glossary.html#term-testing-mode"><em class="xref">Testing Mode</em></a></dd></dl>
  116. <dl class="data">
  117. <dt id="webnotes.add_cookies">
  118. <tt class="descclassname">webnotes.</tt><tt class="descname">add_cookies</tt><a class="headerlink" href="#webnotes.add_cookies" title="Permalink to this definition">¶</a></dt>
  119. <dd>Dictionary of additional cookies appended by custom code</dd></dl>
  120. <dl class="data">
  121. <dt id="webnotes.response">
  122. <tt class="descclassname">webnotes.</tt><tt class="descname">response</tt><a class="headerlink" href="#webnotes.response" title="Permalink to this definition">¶</a></dt>
  123. <dd><p>The JSON response object. Default is:</p>
  124. <div class="highlight-python"><div class="highlight"><pre><span class="p">{</span><span class="s">&#39;message&#39;</span><span class="p">:</span><span class="s">&#39;&#39;</span><span class="p">,</span> <span class="s">&#39;exc&#39;</span><span class="p">:</span><span class="s">&#39;&#39;</span><span class="p">}</span>
  125. </pre></div>
  126. </div>
  127. </dd></dl>
  128. <dl class="data">
  129. <dt id="webnotes.debug_log">
  130. <tt class="descclassname">webnotes.</tt><tt class="descname">debug_log</tt><a class="headerlink" href="#webnotes.debug_log" title="Permalink to this definition">¶</a></dt>
  131. <dd>List of exceptions to be shown in the <a class="reference external" href="glossary.html#term-error-console"><em class="xref">Error Console</em></a></dd></dl>
  132. <dl class="data">
  133. <dt id="webnotes.message_log">
  134. <tt class="descclassname">webnotes.</tt><tt class="descname">message_log</tt><a class="headerlink" href="#webnotes.message_log" title="Permalink to this definition">¶</a></dt>
  135. <dd>List of messages to be shown to the user in a popup box at the end of the request</dd></dl>
  136. </div>
  137. <div class="section" id="global-functions">
  138. <h2>Global Functions<a class="headerlink" href="#global-functions" title="Permalink to this headline">¶</a></h2>
  139. <dl class="function">
  140. <dt id="webnotes.errprint">
  141. <tt class="descclassname">webnotes.</tt><tt class="descname">errprint</tt><big>(</big><em>msg</em><big>)</big><a class="headerlink" href="#webnotes.errprint" title="Permalink to this definition">¶</a></dt>
  142. <dd>Append to the <tt class="xref docutils literal"><span class="pre">debug</span> <span class="pre">log</span></tt></dd></dl>
  143. <dl class="function">
  144. <dt id="webnotes.msgprint">
  145. <tt class="descclassname">webnotes.</tt><tt class="descname">msgprint</tt><big>(</big><em>msg</em><big>)</big><a class="headerlink" href="#webnotes.msgprint" title="Permalink to this definition">¶</a></dt>
  146. <dd>Append to the <a title="webnotes.message_log" class="reference internal" href="#webnotes.message_log"><tt class="xref docutils literal"><span class="pre">message_log</span></tt></a></dd></dl>
  147. </div>
  148. </div>
  149. </div>
  150. </div>
  151. </div>
  152. <div class="clearer"></div>
  153. </div>
  154. <div class="related">
  155. <h3>Navigation</h3>
  156. <ul>
  157. <li class="right" style="margin-right: 10px">
  158. <a href="genindex.html" title="General Index"
  159. >index</a></li>
  160. <li class="right" >
  161. <a href="modindex.html" title="Global Module Index"
  162. >modules</a> |</li>
  163. <li class="right" >
  164. <a href="doclist.html" title="doclist — Doclist Module"
  165. >next</a> |</li>
  166. <li class="right" >
  167. <a href="auth.html" title="auth — Authentication"
  168. >previous</a> |</li>
  169. <li><a href="index.html">Documentation</a> &raquo;</li>
  170. <li><a href="server_side_api.html" >3. Server Side API</a> &raquo;</li>
  171. <li><a href="server_side_internals.html" >Server Side Internals</a> &raquo;</li>
  172. </ul>
  173. </div>
  174. <div class="footer">
  175. &copy; Copyright 2010, Rushabh Mehta.
  176. Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 0.6.3.
  177. </div>
  178. </body>
  179. </html>