mod_esi(3erl) [linux man page]

mod_esi(3erl)						     Erlang Module Definition						     mod_esi(3erl)

NAME

       mod_esi - Erlang Server Interface

DESCRIPTION

       This  module  defines  the  API - Erlang Server Interface (ESI). Which is a more efficient way of writing erlang scripts for your Inets web
       server than writing them as common CGI scripts.

EXPORTS

       deliver(SessionID, Data) -> ok | {error, Reason}

	      Types  SessionID = term()
		     Data = string() | io_list()
		     Reason = term()

	      This function is only intended to be used from functions called by the Erl Scheme interface to deliver parts of the content  to  the
	      user.

	      Sends data from a Erl Scheme script back to the client.

   Note:
       Note that if any HTTP-header fields should be added by the script they must be in the first call to deliver/2 and the data in the call must
       be a string. Do not assume anything about the data type of SessionID, the SessionID must be the value given as input to the esi	call  back
       function that you implemented.

ESI CALLBACK FUNCTIONS

EXPORTS

       Module:Function(SessionID, Env, Input)-> _

	      Types  SessionID = term()
		     Env = [EnvironmentDirectives] ++ ParsedHeader
		     EnvironmentDirectives = {Key,Value}
		     Key  = query_string | content_length | server_software | gateway_interface | server_protocol | server_port | request_method |
		     remote_addr | script_name
		     Input = string()

	      The Module must be found in the code path and export Function with an arity of two. An erlScriptAlias must also be  set  up  in  the
	      configuration file for the Web server.

	      If  the  HTTP request is a post request and a body is sent then content_length will be the length of the posted data. If get is used
	      query_string will be the data after ? in the url.

	      ParsedHeader is the HTTP request as a key value tuple list. The keys in parsed header will be the in lower case.

	      SessionID is a identifier the server use when deliver/2 is called, do not assume any-thing about the datatype.

	      Use this callback function to dynamically generate dynamic web content. when a part of the page is generated send the data  back	to
	      the  client  through  deliver/2  . Note that the first chunk of data sent to the client must at least contain all HTTP header fields
	      that the response will generate. If the first chunk not contains End of HTTP header that is "

" the server will  assume  that
	      no HTTP header fields will be generated.

       Module:Function(Env, Input)-> Response

	      Types  Env = [EnvironmentDirectives] ++ ParsedHeader
		     EnvironmentDirectives = {Key,Value}
		     Key  = query_string | content_length | server_software | gateway_interface | server_protocol | server_port | request_method |
		     remote_addr | script_name. <v>Input = string()
		     Response = string()

	      This callback format consumes quite much memory since the whole response must be generated before it is sent to the user. This func-
	      tions is deprecated and only keept for backwards compatibility. For new development Module:Function/3 should be used.

Ericsson AB							    inets 5.5.2 						     mod_esi(3erl)

edoc_extract(3erl)					     Erlang Module Definition						edoc_extract(3erl)

NAME

       edoc_extract - EDoc documentation extraction.

DESCRIPTION

       EDoc documentation extraction.

DATA TYPES

	 edoc_env() = edoc_env() (see module edoc_lib) :

	 filename() = filename() (see module file) :

	 proplist() = property() (see module proplists) :

	 syntaxTree() = syntaxTree() (see module erl_syntax) :

	 t() = t1() :

	   Some docs of t/0; Further docs of t/0. The same thing using -type: -type t() :: t1(). % Some docs of t/0; Further docs of t/0.

EXPORTS

       file(File::filename(), Context, Env::edoc_env(), Options::proplist()) -> {ok, Tags} | {error, Reason}

	      Types  Context = overview | package
		     Tags = [term()]
		     Reason = term()

	      Reads  a	text file and returns the list of tags in the file. Any lines of text before the first tag are ignored. Env is an environ-
	      ment created by edoc_lib:get_doc_env/4 . Upon error, Reason is an atom returned from the call to file:read_file/1 .

	      See text/4 for options.

       header(File::filename(), Env::edoc_env(), Options::proplist()) -> {ok, Tags} | {error, Reason}

	      Types  Tags = [term()]
		     Reason = term()

	      Similar to header/5 , but reads the syntax tree and the comments from the specified file.

	      See also: header/4 , edoc:read_comments/2 , edoc:read_source/2 .

       header(Forms, File::filename(), Env::edoc_env(), Options::proplist()) -> {ok, Tags} | {error, Reason}

	      Types  Forms = syntaxTree() | [syntaxTree()]
		     Tags = [term()]
		     Reason = term()

	      Extracts EDoc documentation from commented header file syntax trees. Similar to source/5 , but ignores any documentation that occurs
	      before  a  module  declaration or a function definition. (Warning messages are printed if content may be ignored.) Env is assumed to
	      already be set up with a suitable module context.

	      See also: erl_recomment(3erl) , header/5 .

       header(Forms, Comments::[comment() (see module edoc)], File::filename(), Env::edoc_env(), Options::proplist()) -> {ok, Tags} | {error, Rea-
       son}

	      Types  Forms = syntaxTree() | [syntaxTree()]
		     Tags = [term()]
		     Reason = term()

	      Similar  to header/4 , but first inserts the given comments in the syntax trees. The syntax trees must contain valid position infor-
	      mation. (Cf. edoc:read_comments/2 .)

	      See also: erl_recomment(3erl) , header/3 , header/4 .

       source(File::filename(), Env::edoc_env(), Options::proplist()) -> {ModuleName, edoc_module() (see module edoc)}

	      Types  ModuleName = atom()
		     [term()]

	      Like source/5 , but reads the syntax tree and the comments from the specified file.

	      See also: source/4 , edoc:read_comments/2 , edoc:read_source/2 .

       source(Forms, File::filename(), Env::edoc_env(), Options::proplist()) -> {ModuleName, edoc_module() (see module edoc)}

	      Types  Forms = syntaxTree() | [syntaxTree()]
		     ModuleName = atom()

	      Extracts EDoc documentation from commented source code syntax trees. The given Forms must be a single syntax tree of type  form_list
	      ,  or  a	list  of  syntax  trees  representing  "program  forms"  (cf.  edoc:read_source/2  .  Env  is  an  environment	created by
	      edoc_lib:get_doc_env/4 . The File argument is used for error reporting and output file name generation only.

	      See edoc:get_doc/2 for descriptions of the def , hidden , private , and todo options.

	      See also: erl_recomment(3erl) , source/5 , edoc:read_comments/2 , edoc:read_source/2 .

       source(Forms, Comments::[comment() (see module edoc)], File::filename(), Env::edoc_env(), Options::proplist())  ->  {ModuleName,  edoc_mod-
       ule() (see module edoc)}

	      Types  Forms = syntaxTree() | [syntaxTree()]
		     ModuleName = atom()

	      Like  source/4 , but first inserts the given comments in the syntax trees. The syntax trees must contain valid position information.
	      (Cf. edoc:read_comments/2 .)

	      See also: erl_recomment(3erl) , source/3 , source/4 , edoc:read_comments/2 , edoc:read_source/2 .

       text(Text::string(), Context, Env::edoc_env(), Options::proplist()) -> Tags

	      Types  Context = overview | package
		     Tags = [term()]

	      Returns the list of tags in the text. Any lines of text before the  first  tag  are  ignored.  Env  is  an  environment  created	by
	      edoc_lib:get_doc_env/4 .

	      See source/4 for a description of the def option.

SEE ALSO

       edoc

AUTHORS

       Richard Carlsson <richardc@it.uu.se >

								    edoc 0.7.7							edoc_extract(3erl)