Merge pull request #319 from cmhughes/develop

V3.13.5

.github/workflows/build-documentation-and-windows-exe.yaml

@@ -113,6 +113,7 @@ jobs:
           cp documentation/*.tex latexindent/documentation/
           cp documentation/*.png latexindent/documentation/
           cp documentation/readme.txt latexindent/README
+          cp documentation/*.json latexindent/documentation/
       - name: downloading latexindent.exe
         uses: actions/download-artifact@master
         with:

.github/workflows/pull-request-check.yaml

@@ -1,7 +1,14 @@
-# purpose:
-#    comment on pull requests to the main
-#    branch, asking them to be submitted 
-#    to develop. 
+name: latexindent.pl main branch pull request monitor and feedback
+# PURPOSE:
+#
+#       comment on pull requests to the MAIN
+#       branch, asking them to be submitted 
+#       to develop. 
+#
+# Note: 
+#       
+#       this action runs only on MAIN branch
+#
 
 on:
   pull_request:

LatexIndent/Version.pm

@@ -19,6 +19,6 @@ use warnings;
 use Exporter qw/import/;
 our @EXPORT_OK = qw/$versionNumber $versionDate/;
 
-our $versionNumber = '3.13.4';
-our $versionDate = '2021-12-22';
+our $versionNumber = '3.13.5';
+our $versionDate = '2022-01-02';
 1

defaultSettings.yaml

@@ -1,4 +1,4 @@
-# defaultSettings.yaml for latexindent.pl, version 3.13.4, 2021-12-22
+# defaultSettings.yaml for latexindent.pl, version 3.13.5, 2022-01-02
 #                      a script that aims to
 #                      beautify .tex, .sty, .cls files
 #

documentation/appendices.rst

@@ -266,6 +266,46 @@ To add ``latexindent.exe`` to the path for Windows, follow these steps:
 
 To *remove* the directory from your ``%path%``, run ``remove-from-path.bat`` as administrator.
 
+latexindent-yaml-schema.json
+----------------------------
+
+``latexindent.pl`` ships with ``latexindent-yaml-schema.json`` which might help you when constructing your YAML files.
+
+VSCode demonstration
+~~~~~~~~~~~~~~~~~~~~
+
+To use ``latexindent-yaml-schema.json`` with ``VSCode``, you can use the following steps:
+
+#. download ``latexindent-yaml-schema.json`` from the ``documentation`` folder of (“Home of Latexindent.pl” n.d.), save it in whichever directory you would like, noting it for reference;
+
+#. following the instructions from (“How to Create Your Own Auto-Completion for Json and Yaml Files on Vs Code with the Help of Json Schema” n.d.), for example, you should install the VSCode YAML
+   extension (“VSCode Yaml Extension” n.d.);
+
+#. set up your ``settings.json`` file using the directory you saved the file by adapting :numref:`lst:settings.json`; on my Ubuntu laptop this file lives at
+   ``/home/cmhughes/.config/Code/User/settings.json``.
+
+.. literalinclude:: settings.json
+ 	:class: .baseyaml
+ 	:caption: ``settings.json`` 
+ 	:name: lst:settings.json
+
+Alternatively, if you would prefer not to download the json file, you might be able to use an adapted version of :numref:`lst:settings-alt.json`.
+
+.. literalinclude:: settings-alt.json
+ 	:class: .baseyaml
+ 	:caption: ``settings-alt.json`` 
+ 	:name: lst:settings-alt.json
+
+Finally, if your TeX distribution is up to date, then ``latexindent-yaml-schema.json`` *should* be in the documentation folder of your installation, so an adapted version of
+:numref:`lst:settings-alt1.json` may work.
+
+.. literalinclude:: settings-alt1.json
+ 	:class: .baseyaml
+ 	:caption: ``settings-alt1.json`` 
+ 	:name: lst:settings-alt1.json
+
+If you have details of how to implement this schema in other editors, please feel encouraged to contribute to this documentation.
+
 Using conda
 -----------
 
@@ -466,6 +506,12 @@ To specify ``noAdditionalIndent`` for display-math environments in Version 2.2,
 
       “Home of Latexindent.pl.” n.d. Accessed January 23, 2017. https://github.com/cmhughes/latexindent.pl.
 
+   .. container::
+      :name: ref-vscode-yaml-demo
+
+      “How to Create Your Own Auto-Completion for Json and Yaml Files on Vs Code with the Help of Json Schema.” n.d. Accessed January 1, 2022.
+      https://dev.to/brpaz/how-to-create-your-own-auto-completion-for-json-and-yaml-files-on-vs-code-with-the-help-of-json-schema-k1i.
+
    .. container::
       :name: ref-jun-sheaf
 
@@ -481,6 +527,11 @@ To specify ``noAdditionalIndent`` for display-math environments in Version 2.2,
 
       “Perlbrew.” n.d. Accessed January 23, 2017. http://perlbrew.pl/.
 
+   .. container::
+      :name: ref-vscode-yaml-extentions
+
+      “VSCode Yaml Extension.” n.d. Accessed January 1, 2022. https://marketplace.visualstudio.com/items?itemName=redhat.vscode-yaml.
+
    .. container::
       :name: ref-bersbersbers
 

documentation/appendices.tex

@@ -207,17 +207,60 @@
 		To \emph{remove} the directory from your \lstinline!%path%!, run
 		\texttt{remove-from-path.bat} as administrator.
 
-        \section{Using conda}
-        If you use conda you'll only need
+	\section{latexindent-yaml-schema.json}
 
-        \begin{commandshell}
+	 \texttt{latexindent.pl}
+	 \announce*{2022-01-02}{latexindent-yaml-schema.json} ships with
+	 \texttt{latexindent-yaml-schema.json}
+	 which might help you when constructing your YAML files.
+
+	\subsection{VSCode demonstration}
+		To use \texttt{latexindent-yaml-schema.json} with \texttt{VSCode}, you can use the
+		following steps:
+		\begin{enumerate}
+			\item download \texttt{latexindent-yaml-schema.json} from the \texttt{documentation} folder of
+			      \cite{latexindent-home}, save it in whichever directory you would like, noting it for
+			      reference;
+			\item following the instructions from \cite{vscode-yaml-demo}, for example, you should install
+			      the VSCode YAML extension \cite{vscode-yaml-extentions};
+			\item set up your \texttt{settings.json} file using the directory you saved the file by
+			      adapting \cref{lst:settings.json}; on my Ubuntu laptop this file lives at
+			      \texttt{/home/cmhughes/.config/Code/User/settings.json}.
+		\end{enumerate}
+
+		\begin{widepage}
+			\cmhlistingsfromfile*{settings.json}[yaml-TCB]{\texttt{settings.json}}{lst:settings.json}
+		\end{widepage}
+
+		Alternatively, if you would prefer not to download the json file, you might be able to
+		use an adapted version of \cref{lst:settings-alt.json}.
+
+		\begin{widepage}
+			\cmhlistingsfromfile*{settings-alt.json}[yaml-TCB]{\texttt{settings-alt.json}}{lst:settings-alt.json}
+		\end{widepage}
+
+		Finally, if your TeX distribution is up to date, then
+		\texttt{latexindent-yaml-schema.json} \emph{should} be in the documentation folder of
+		your installation, so an adapted version of \cref{lst:settings-alt1.json} may work.
+
+		\begin{widepage}
+			\cmhlistingsfromfile*{settings-alt1.json}[yaml-TCB]{\texttt{settings-alt1.json}}{lst:settings-alt1.json}
+		\end{widepage}
+
+		If you have details of how to implement this schema in other editors, please feel
+		encouraged to contribute to this documentation.
+
+	\section{Using conda}
+	 If you use conda you'll only need
+
+	 \begin{commandshell}
 conda install latexindent.pl -c conda-forge
 \end{commandshell}
-this will install the executable and all its dependencies (including perl) in the activate environment.
-You don't even have to worry about \texttt{defaultSettings.yaml} as it included too,
-you can thus skip \cref{sec:requiredmodules,sec:updating-path}.
+	 this will install the executable and all its dependencies (including perl) in the
+	 activate environment. You don't even have to worry about \texttt{defaultSettings.yaml} as
+	 it included too, you can thus skip \cref{sec:requiredmodules,sec:updating-path}.
 
-You can get a conda installation for example from \cite{conda} or from \cite{anacoda}.
+	 You can get a conda installation for example from \cite{conda} or from \cite{anacoda}.
 
 	\section{logFilePreferences}\label{app:logfile-demo}
 	 \Vref{lst:logFilePreferences} describes the options for customising the information given

documentation/changelog.md

@@ -1,5 +1,9 @@
 # changelog.md
 
+## V3.13.5, January 2, 2022
+`latexindent-yaml-schema.json` created and documented, discussion at 
+[issue 206](https://github.com/cmhughes/latexindent.pl/issues/206).
+
 ## V3.13.4, December 22, 2021
 documentation updated to include: https://github.com/cmhughes/latexindent.pl/pull/310 and https://github.com/cmhughes/latexindent.pl/pull/311
 

documentation/conf.py

@@ -62,9 +62,9 @@
 # built documents.
 #
 # The short X.Y version.
-version = u'3.13.4'
+version = u'3.13.5'
 # The full version, including alpha/beta/rc tags.
-release = u'3.13.4'
+release = u'3.13.5'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

documentation/latex-indent.bib

@@ -71,3 +71,13 @@ @online{anacoda
 	url     = "https://www.anaconda.com/products/individual",
 	urldate = {2021-12-22},
 }
+@online{vscode-yaml-demo,
+	title   = "How to create your own auto-completion for JSON and YAML files on VS Code with the help of JSON Schema",
+	url     = "https://dev.to/brpaz/how-to-create-your-own-auto-completion-for-json-and-yaml-files-on-vs-code-with-the-help-of-json-schema-k1i",
+	urldate = {2022-01-01},
+}
+@online{vscode-yaml-extentions,
+	title   = "VSCode YAML extension",
+	url     = "https://marketplace.visualstudio.com/items?itemName = redhat.vscode-yaml",
+	urldate = {2022-01-01},
+}