From a2a1883e04aaa923b385cbbc496395ed5bf1dc17 Mon Sep 17 00:00:00 2001 From: tmanevik Date: Mon, 6 Jul 2015 21:21:27 +0200 Subject: Inets Reference Manual Editorial changes --- lib/inets/doc/src/mod_alias.xml | 58 ++++++++++++++++++++++------------------- 1 file changed, 31 insertions(+), 27 deletions(-) (limited to 'lib/inets/doc/src/mod_alias.xml') diff --git a/lib/inets/doc/src/mod_alias.xml b/lib/inets/doc/src/mod_alias.xml index d073b5c5b8..d48276874a 100644 --- a/lib/inets/doc/src/mod_alias.xml +++ b/lib/inets/doc/src/mod_alias.xml @@ -32,8 +32,8 @@ mod_alias URL aliasing. -

Erlang Webserver Server internal API for handling of things - such as interaction data exported by the mod_alias module.

+

Erlang web server internal API for handling of, for example, + interaction data exported by module mod_alias.

 @@ -41,7 +41,7 @@ default_index(ConfigDB, Path) -> NewPath - Return a new path with the default resource or file appended. + Returns a new path with the default resource or file appended. ConfigDB = config_db() Path = NewPath = string() @@ -50,14 +50,14 @@

If Path is a directory, default_index/2, it starts searching for resources or files that are specified in the config - directive DirectoryIndex. + directive DirectoryIndex. If an appropriate resource or file is found, it is appended to the end of Path and then returned. Path is - returned unaltered, if no appropriate - file is found, or if Path is not a directory. + returned unaltered if no appropriate + file is found or if Path is not a directory. config_db() is the server config file in ETS table format as described in - Inets Users Guide..

+ Inets User’s Guide.

@@ -65,7 +65,7 @@ path(PathData, ConfigDB, RequestURI) -> Path - Return the actual file path to a URL. + Returns the file path to a URL. PathData = interaction_data() ConfigDB = config_db() @@ -73,15 +73,16 @@ -

path/3 returns the actual file Path in the - RequestURI (See RFC 1945). If the interaction data - {real_name,{Path,AfterPath}} has been exported by - mod_alias; +

path/3 returns the file Path in the + RequestURI (see + RFC 1945). + If the interaction data {real_name,{Path,AfterPath}} + has been exported by mod_alias, Path is returned. If no interaction data has been - exported, ServerRoot is used to + exported, ServerRoot is used to generate a file Path. config_db() and interaction_data() are as defined in - Inets Users Guide.

+ Inets User’s Guide.

 @@ -89,7 +90,7 @@ real_name(ConfigDB, RequestURI, Aliases) -> Ret - Expand a request uri using Alias config directives. + Expands a request URI using Aliases config directives. ConfigDB = config_db() RequestURI = string() @@ -101,18 +102,18 @@

real_name/3 traverses Aliases, typically extracted from ConfigDB, and matches each - FakeName with RequestURI. If a match is found + FakeName with RequestURI. If a match is found, FakeName is replaced with RealName in the - match. The resulting path is split into two parts, that - is ShortPath and AfterPath as defined in + match. The resulting path is split into two parts, + ShortPath and AfterPath, as defined in httpd_util:split_path/1. - Path is generated from ShortPath, that is + Path is generated from ShortPath, that is, the result from default_index/2 with ShortPath as an argument. config_db() is the server config file in ETS table format as described in - Inets User Guide..

+ Inets User’s Guide.

@@ -120,7 +121,8 @@ real_script_name(ConfigDB, RequestURI, ScriptAliases) -> Ret - Expand a request uri using ScriptAlias config directives. + Expands a request URI using ScriptAliases + config directives. ConfigDB = config_db() RequestURI = string() @@ -132,14 +134,16 @@

real_script_name/3 traverses ScriptAliases, typically extracted from ConfigDB, and matches each - FakeName with RequestURI. If a match is found + FakeName with RequestURI. If a match is found, FakeName is replaced with RealName in the - match. If the resulting match is not an executable script - not_a_script is returned. If it is a script the - resulting script path is in two parts, that is - ShortPath and AfterPath as defined in httpd_util:split_script_path/1. + match. If the resulting match is not an executable script, + not_a_script is returned. If it is a script, the + resulting script path is in two parts, + ShortPath and AfterPath, as defined in + httpd_util:split_script_path/1. config_db() is the server config file in ETS table - format as described in Inets Users Guide..

+ format as described in + Inets User’s Guide.

 -- cgit v1.2.3 From b15bc9dc1b3a6e0b1076652050a87e5d03e30eac Mon Sep 17 00:00:00 2001 From: Ingela Anderton Andin Date: Tue, 8 Sep 2015 09:46:20 +0200 Subject: inets: Use ASSCI ' --- lib/inets/doc/src/mod_alias.xml | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) (limited to 'lib/inets/doc/src/mod_alias.xml') diff --git a/lib/inets/doc/src/mod_alias.xml b/lib/inets/doc/src/mod_alias.xml index d48276874a..a7b01efe06 100644 --- a/lib/inets/doc/src/mod_alias.xml +++ b/lib/inets/doc/src/mod_alias.xml @@ -57,7 +57,7 @@ file is found or if Path is not a directory. config_db() is the server config file in ETS table format as described in - Inets User’s Guide.

+ Inets User's Guide.

@@ -82,7 +82,7 @@ exported, ServerRoot is used to generate a file Path. config_db() and interaction_data() are as defined in - Inets User’s Guide.

+ Inets User's Guide.

@@ -113,7 +113,7 @@ ShortPath as an argument. config_db() is the server config file in ETS table format as described in - Inets User’s Guide.

+ Inets User's Guide.

@@ -143,7 +143,7 @@ httpd_util:split_script_path/1. config_db() is the server config file in ETS table format as described in - Inets User’s Guide.

+ Inets User's Guide.

-- cgit v1.2.3 From 628f8cff34f9784cfa34857bcd7133305acc3d27 Mon Sep 17 00:00:00 2001 From: Ingela Anderton Andin Date: Mon, 7 Sep 2015 15:51:35 +0200 Subject: inets: Fix broken links --- lib/inets/doc/src/mod_alias.xml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'lib/inets/doc/src/mod_alias.xml') diff --git a/lib/inets/doc/src/mod_alias.xml b/lib/inets/doc/src/mod_alias.xml index a7b01efe06..87c950cc6b 100644 --- a/lib/inets/doc/src/mod_alias.xml +++ b/lib/inets/doc/src/mod_alias.xml @@ -106,7 +106,7 @@ FakeName is replaced with RealName in the match. The resulting path is split into two parts, ShortPath and AfterPath, as defined in - httpd_util:split_path/1. + httpd_util:split_path/1. Path is generated from ShortPath, that is, the result from default_index/2 with @@ -140,7 +140,7 @@ not_a_script is returned. If it is a script, the resulting script path is in two parts, ShortPath and AfterPath, as defined in - httpd_util:split_script_path/1. + httpd_util:split_script_path/1. config_db() is the server config file in ETS table format as described in Inets User's Guide.

-- cgit v1.2.3