Changes between Version 71 and Version 72 of doc/app/nclparlist

Timestamp:

Nov 23, 2018 9:15:17 AM (6 years ago)

Author:

scharf

Comment:

--

doc/app/nclparlist

@@ -1 @@
-= List of parameters for PALM NCL scripts =
+= List of parameters for Palmplot =
 [[TracNav(doc/app/datatoc|nocollapse)]]
-The following lists give an overview of all existing parameters to steer the PALM NCL scripts. Further descriptions can be found in the configuration file [[source:palm/trunk/SCRIPTS/NCL/.ncl.config.default|.ncl.config.default]].\\
-Most parameters are allocated with a suitable default value in the configuration file but some need to be changed before running any script. These variables are [[#file_1|file_1]] and if available [[#file_2_pr|file_2]], ..., up to [[#file_6_pr|file_6]].\\
-In case of a job chain without extended output files, the scripts will automatically read all necessary files after indicating the first and the last cyclic number (see [[#start_f|start_f]] and [[#end_f|end_f]]).\\\\
+
+The following lists give an overview of all existing parameters to steer `palmplot`, the PALM NCL scripts. Further descriptions can be found in the configuration file [[source:palm/trunk/SCRIPTS/NCL/.ncl.config.default|.ncl.config.default]].\\
+Most parameters are allocated with a suitable default value in the configuration file but some need to be changed before running any script. These variables are [[#file_1|file_1]] and if available [[#file_2_pr|file_2]], ..., up to [[#file_6_pr|file_6]]. In case of a job chain without extended output files, the scripts will automatically read all necessary files after indicating the first and the last cyclic number (see [[#start_f|start_f]] and [[#end_f|end_f]]).\\\\
+
 The parameters are arranged in five different lists: 
-* Parameters which are [[#common|common]] for all the four existing scripts 
-* Parameters for output of [[#cross_sections|cross sections]]
-* Parameters for output of [[#profiles|profiles]]
-* Parameters for output of [[#spectra|spectra]]
-* Parameters for output of [[#timeseries|timeseries]]
+* Parameters which are [#Commonparameters common for all four scripts]
+* Parameters for plotting [#Parametersforplottingcrosssections cross sections]
+* Parameters for plotting [#Parametersforplottingprofiles profiles]
+* Parameters for plotting [#Parametersforplottingspectra spectra]
+* Parameters for plotting [#Parametersforplottingtimeseries timeseries]
+
 The following abbreviations for the NCL types are used in the lists: [=#NCL_types ]
 ||=Abbr.  =||=Explanation  =||=Example =||
@@ -16 +18 @@
 ||I  ||integer  ||2       || 
 ||S  ||string   ||"name"  ||
+
 The following abbreviations for the NCL scripts are used in the lists:
 ||=Abbr.  =||=Explanation  =||
@@ -22 +25 @@
 ||SP  ||spectra  || 
 ||TS  ||timeseries  || 
-\\
-[=#common '''Common parameters''']
+
+
+== Common parameters
 ||='''Parameter Name'''  =||='''[#NCL_types NCL]\\[#NCL_types Type]'''  =||='''Default\\Value'''  =||='''Explanation'''  =||
 |----------------
@@ -187 +191 @@
 Names of variables in the input file that shall be output. For output of u, v and w"pt" use '''var''' = 'u v w"pt"' in the prompt or '''var''' = ",u,v,w"+dq+"pt"+dq in [[../ncl#Using.ncl.config|.ncl.config]].
 }}}
-\\
-[=#cross_sections '''Parameters for plotting cross sections''']
+
+
+== Parameters for plotting cross sections
 ||='''Parameter Name'''  =||='''[#NCL_types NCL]\\[#NCL_types Type]'''  =||='''Default\\Value'''  =||='''Explanation'''  =||
 |----------------
@@ -529 +534 @@
 }}}
 |----------------
-[=#profiles '''Parameters for plotting profiles''']
+
+
+== Parameters for plotting profiles
 ||='''Parameter Name'''  =||='''[#NCL_types NCL]\\[#NCL_types Type]'''  =||='''Default\\Value'''  =||='''Explanation'''  =||
 |----------------
@@ -1010 +1017 @@
 }}}
 |----------------
-[=#spectra '''Parameters for plotting spectra''']
+
+
+== Parameters for plotting spectra
 ||='''Parameter Name'''  =||='''[#NCL_types NCL]\\[#NCL_types Type]'''  =||='''Default\\Value'''  =||='''Explanation'''  =||
 |----------------
@@ -1170 +1179 @@
 |----------------
 
-[=#timeseries '''Parameters for plotting timeseries''']
+
+== Parameters for plotting timeseries
 ||='''Parameter Name'''  =||='''[#NCL_types NCL]\\[#NCL_types Type]'''  =||='''Default\\Value'''  =||='''Explanation'''  =||
 |----------------