diff --git a/JsonPreprocessor/JsonPreprocessor.pdf b/JsonPreprocessor/JsonPreprocessor.pdf index fb58dd65..6b0dfab9 100644 Binary files a/JsonPreprocessor/JsonPreprocessor.pdf and b/JsonPreprocessor/JsonPreprocessor.pdf differ diff --git a/JsonPreprocessor/version.py b/JsonPreprocessor/version.py index 912f823f..63175f97 100644 --- a/JsonPreprocessor/version.py +++ b/JsonPreprocessor/version.py @@ -19,5 +19,5 @@ # Version and date of JsonPreprocessor # VERSION = "0.3.0" -VERSION_DATE = "12.09.2023" +VERSION_DATE = "19.09.2023" diff --git a/packagedoc/additional_docs/History.tex b/packagedoc/additional_docs/History.tex index ea46b49c..c5179de2 100644 --- a/packagedoc/additional_docs/History.tex +++ b/packagedoc/additional_docs/History.tex @@ -12,15 +12,25 @@ % See the License for the specific language governing permissions and % limitations under the License. -\begin{center} -\begin{tabular}{| m{6em} | m{26em} |}\hline - \textbf{0.1.0} & 01/2022\\ \hline - \multicolumn{2}{| m{32em} |}{\textit{Initial version}}\\ \hline - \textbf{0.1.4} & 09/2022\\ \hline - \multicolumn{2}{| m{32em} |}{\textit{Updated documentation}}\\ \hline - \textbf{0.2.3} & 05/2023\\ \hline - \multicolumn{2}{| m{32em} |}{\textit{Added dotdict format}}\\ \hline - \textbf{0.2.4} & 06/2023\\ \hline - \multicolumn{2}{| m{32em} |}{\textit{Improved dotdict format and update log output}}\\ \hline -\end{tabular} -\end{center} +\begin{packagehistory} + +\historyversiondate{0.1.0}{01/2022} +\historychange{Initial version} + +\historyversiondate{0.1.4}{09/2022} +\historychange{Documentation updated} + +\historyversiondate{0.2.3}{05/2023} +\historychange{dotdict format added} + +\historyversiondate{0.2.4}{06/2023} +\historychange{Maintenance of dotdict format and log output} + +\historyversiondate{0.3.0}{09/2023} +\historychange{- Implicit creation of data structures\newline +- Dotdict feature bug fixing\newline +- Update nested parameters handling in key name and value\newline +- Nested parameter feature bug fixing\newline +- Nested parameters substitution and overwriting improvement} + +\end{packagehistory} diff --git a/packagedoc/additional_docs/The JSONP format.tex b/packagedoc/additional_docs/The JSONP format.tex index 9b817c52..a24ece51 100644 --- a/packagedoc/additional_docs/The JSONP format.tex +++ b/packagedoc/additional_docs/The JSONP format.tex @@ -471,9 +471,10 @@ \section{Overwrite parameters} \begin{itemize} \item Existing parameters are accessed by a dollar operator and a pair of curly brackets (\pcode{$\{...\}}) with the parameter name inside. - \item If the entire expression of the right hand side of the colon is such a dollar operator expression, the entire expression must \textit{not} - be encapsulated in quotes. - \item The dollar operator keeps the data type of the referenced parameter. + \item If the entire expression of the right hand side of the colon is such a dollar operator expression, it is not required any more + to encapsulate this expression in quotes. + \item Without quotes, the dollar operator keeps the data type of the referenced parameter. If you use quotes, the value of the used parameter + will be of type \pcode{str}. \end{itemize} \textbf{Outcome:} @@ -513,8 +514,8 @@ \section{Overwrite parameters} \newpage -Like mentioned in the rules above, dollar operator expressions must \textit{not} be encapsulated in quotes. -But nevertheless it is possible to use quotes. In case of: +Like mentioned in the rules above, it is not required any more to encapsulate dollar operator expressions at the right hand side of the +colon in quotes. But nevertheless it is possible to use quotes. In case of: \begin{pythoncode} "int_val_b" : "${int_val}", @@ -538,10 +539,6 @@ \section{Overwrite parameters} } \end{pythoncode} -\textbf{!!! CAUTION}: -\href{https://github.com/test-fullautomation/python-jsonpreprocessor/issues/85}{issues/85} -\textbf{!!!} - \textbf{Outcome:} \vspace{2ex} @@ -576,7 +573,7 @@ \section{Overwrite parameters} \end{pythoncode} The dollar operator syntax at the left hand side of the colon is the same than previously used on the right hand side. -The entire expression must \textit{not} be encapsulated in quotes. +The entire expression at the left hand side of the colon must \textit{not} be encapsulated in quotes in this case. \textbf{Outcome:} @@ -806,9 +803,6 @@ \section{\texttt{dotdict} notation} } \end{pythoncode} -\textbf{!!! Caution:} dotdict bug: -\href{https://github.com/test-fullautomation/python-jsonpreprocessor/issues/89}{issues/89} \textbf{!!!} - \newpage \textbf{Outcome:} @@ -873,9 +867,6 @@ \section{Substitution of dollar operator expressions} 'version': 1.23} \end{pythonlog} -\textbf{!!! Caution:} substitution bug: -\href{https://github.com/test-fullautomation/python-jsonpreprocessor/issues/91}{issues/91} \textbf{!!!} - \textit{We recommend to use simple data types for this kind of substitution only!} But nevertheless, on the right hand side of the colon also composite data types are possible. Here it might makes sense to use them.