/doc/core/gen_scomp.html

https://code.google.com/p/zotonic/ · HTML · 57 lines · 44 code · 13 blank · 0 comment · 0 complexity · 0d022bfd0af2050713d1352a9ac0d741 MD5 · raw file 

    

  1. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
    2. 

  2. <html>
    3. 

  3. <head>
    4. 

  4. <title>Module gen_scomp</title>
    5. 

  5. <link rel="stylesheet" type="text/css" href="stylesheet.css" title="EDoc">
    6. 

  6. </head>
    7. 

  7. <body bgcolor="white">
    8. 

  8. <div class="navbar"><a name="#navbar_top"></a><table width="100%" border="0" cellspacing="0" cellpadding="2" summary="navigation bar"><tr><td><a href="overview-summary.html" target="overviewFrame">Overview</a></td><td><a href="http://www.erlang.org/"><img src="erlang.png" align="right" border="0" alt="erlang logo"></a></td></tr></table></div>
    9. 

  9. <hr>
    10. 

  10. 

  11. <h1>Module gen_scomp</h1>
    12. 

  12. <ul class="index"><li><a href="#description">Description</a></li><li><a href="#index">Function Index</a></li><li><a href="#functions">Function Details</a></li></ul>Scomp behaviour definition.
    13. 

  13. <p>Copyright Š 2009 Marc Worrell
    14. 

  14.  
    15. 

  15.   Copyright 2009 Marc Worrell
    16. 

  16.  
    17. 

  17.   Licensed under the Apache License, Version 2.0 (the "License");
    18. 

  18.   you may not use this file except in compliance with the License.
    19. 

  19.   You may obtain a copy of the License at
    20. 

  20.  
    21. 

  21.       http://www.apache.org/licenses/LICENSE-2.0
    22. 

  22.  
    23. 

  23.   Unless required by applicable law or agreed to in writing, software
    24. 

  24.   distributed under the License is distributed on an "AS IS" BASIS,
    25. 

  25.   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    26. 

  26.   See the License for the specific language governing permissions and
    27. 

  27.   limitations under the License.
    28. 

  28.  </p>
    29. 

  29. 

  30. <p><b>Authors:</b> Marc Worrell (<a href="mailto:marc@worrell.nl"><tt>marc@worrell.nl</tt></a>).</p>
    31. 

  31. 

  32. <h2><a name="description">Description</a></h2><p>Scomp behaviour definition.  A scomp is a screen component that can optionally be cached.</p>
    33. 

  33.  
    34. 

  34.        <p>render(Params, Vars, Context) -&gt; {ok, NewContext} | {ok, io_list()} | {error, Error}</p>
    35. 

  35.  
    36. 

  36.        <p>vary(Params, Context) -&gt; {EssentialParams, MaxAge, Vary} | nocache | default</p>
    37. 

  37.  
    38. 

  38.        	Params = proplist()
    39. 

  39.            EssentialParams = proplist()  (proplist with params that make differences in the cache key)
    40. 

  40.        	MaxAge = integer()
    41. 

  41.            Vary = TermList  (used as dependencies for the depcache)
    42. 

  42. <h2><a name="index">Function Index</a></h2>
    43. 

  43. <table width="100%" border="1" cellspacing="0" cellpadding="2" summary="function index"><tr><td valign="top"><a href="#behaviour_info-1">behaviour_info/1</a></td><td></td></tr>
    44. 

  44. </table>
    45. 

  45. 

  46. <h2><a name="functions">Function Details</a></h2>
    47. 

  47. 

  48. <h3 class="function"><a name="behaviour_info-1">behaviour_info/1</a></h3>
    49. 

  49. <div class="spec">
    50. 

  50. <p><tt>behaviour_info(Other) -&gt; any()</tt></p>
    51. 

  51. </div>
    52. 

  52. <hr>
    53. 

  53. 

  54. <div class="navbar"><a name="#navbar_bottom"></a><table width="100%" border="0" cellspacing="0" cellpadding="2" summary="navigation bar"><tr><td><a href="overview-summary.html" target="overviewFrame">Overview</a></td><td><a href="http://www.erlang.org/"><img src="erlang.png" align="right" border="0" alt="erlang logo"></a></td></tr></table></div>
    55. 

  55. <p><i>Generated by EDoc, Aug 12 2011, 20:01:39.</i></p>
    56. 

  56. </body>
    57. 

  57. </html>
    58.