From df80cb60e638647607dbc28b0cf99e595209d2d2 Mon Sep 17 00:00:00 2001 From: gmantele <gmantele@ari.uni-heidelberg.de> Date: Fri, 27 Feb 2015 17:47:56 +0100 Subject: [PATCH] [TAP] Update the TAP configuration file documentation and the full and min example files. --- src/tap/config/tap_configuration_file.html | 15 +++++++++++---- src/tap/config/tap_full.properties | 9 ++++++--- src/tap/config/tap_min.properties | 9 ++++++--- 3 files changed, 23 insertions(+), 10 deletions(-) diff --git a/src/tap/config/tap_configuration_file.html b/src/tap/config/tap_configuration_file.html index fd8ab7c..f665039 100644 --- a/src/tap/config/tap_configuration_file.html +++ b/src/tap/config/tap_configuration_file.html @@ -258,9 +258,12 @@ <td>text</td> <td> <p><strong>Mandatory if</strong> the value of "metadata" is "xml".</p> - <p>Local file path to the TableSet XML document. This XML must implement the schema TableSet defined by <a href="http://www.ivoa.net/xml/VODataService/v1.1">VODataService</a>.</p> + <p>Local file path to the TableSet XML document.</p> + <p>The XML document must implement the schema TableSet defined by <a href="http://www.ivoa.net/xml/VODataService/v1.1">VODataService</a>.</p> + <p>The file path must be either an absolute local file path or a file path relative to WebContent + (i.e. the web application directory in which there are WEB-INF and META-INF).</p> </td> - <td>/home/foo/my_metadata.xml</td> + <td><ul><li>/home/foo/my_metadata.xml</li><li>my_metadata.xml</li><li>WEB-INF/my_metadata.xml</li></ul></td> </tr> <tr><td colspan="5">Files</td></tr> @@ -279,8 +282,12 @@ <td class="done">file_root_path</td> <td></td> <td>text</td> - <td>File path of the directory in which all TAP files (logs, errors, job results, backup, ...) must be.</td> - <td></td> + <td> + <p>Local file path of the directory in which all TAP files (logs, errors, job results, backup, ...) must be.</p> + <p>The file path must be either an absolute local directory path or a directory path relative to WebContent + (i.e. the web application directory in which there are WEB-INF and META-INF).</p> + </td> + <td><ul><li>/home/my_home_dir/tapFiles</li><li>tapFiles</li><li>WEB-INF/tapFiles</li></ul></td> </tr> <tr class="optional"> <td class="done">directory_per_user</td> diff --git a/src/tap/config/tap_full.properties b/src/tap/config/tap_full.properties index 666f8da..db0930d 100644 --- a/src/tap/config/tap_full.properties +++ b/src/tap/config/tap_full.properties @@ -2,7 +2,7 @@ # FULL TAP CONFIGURATION FILE # # # # TAP Version: 2.0 # -# Date: 19 Feb. 2015 # +# Date: 27 Feb. 2015 # # Author: Gregory Mantelet (ARI) # # # ########################################################## @@ -130,7 +130,9 @@ metadata = # [MANDATORY] # Mandatory if the value of "metadata" is "xml". -# Local file path to the TableSet XML document. This XML must implement the schema TableSet defined by VODataService (http://www.ivoa.net/xml/VODataService/v1.1). +# Local file path to the TableSet XML document. +# The XML document must implement the schema TableSet defined by VODataService. +# The file path must be either an absolute local file path or a file path relative to WebContent (i.e. the web application directory in which there are WEB-INF and META-INF). metadata_file = ######### @@ -148,7 +150,8 @@ metadata_file = file_manager = local # [MANDATORY] -# File path of the directory in which all TAP files (logs, errors, job results, backup, ...) must be. +# Local file path of the directory in which all TAP files (logs, errors, job results, backup, ...) must be. +# The file path must be either an absolute local directory path or a directory path relative to WebContent (i.e. the web application directory in which there are WEB-INF and META-INF). file_root_path = # [OPTIONAL] diff --git a/src/tap/config/tap_min.properties b/src/tap/config/tap_min.properties index 20f034c..2bfd5af 100644 --- a/src/tap/config/tap_min.properties +++ b/src/tap/config/tap_min.properties @@ -2,7 +2,7 @@ # MINIMUM TAP CONFIGURATION FILE # # # # TAP Version: 2.0 # -# Date: 18 Feb. 2015 # +# Date: 27 Feb. 2015 # # Author: Gregory Mantelet (ARI) # # # ########################################################## @@ -84,7 +84,9 @@ db_password = metadata = # Mandatory if the value of "metadata" is "xml". -# Local file path to the TableSet XML document. This XML must implement the schema TableSet defined by VODataService (http://www.ivoa.net/xml/VODataService/v1.1). +# Local file path to the TableSet XML document. +# The XML document must implement the schema TableSet defined by VODataService. +# The file path must be either an absolute local file path or a file path relative to WebContent (i.e. the web application directory in which there are WEB-INF and META-INF). metadata_file = ######### @@ -100,5 +102,6 @@ metadata_file = # Allowed values: local, a class name. file_manager = local -# File path of the directory in which all TAP files (logs, errors, job results, backup, ...) must be. +# Local file path of the directory in which all TAP files (logs, errors, job results, backup, ...) must be. +# The file path must be either an absolute local directory path or a directory path relative to WebContent (i.e. the web application directory in which there are WEB-INF and META-INF). file_root_path = -- GitLab