JKQTMathText: updated documentation with new (auto-generated) images, added CMake Custom Target to generate documentation images with jkqtmathtext_render, improved documentation

doc/CMakeLists.txt

@@ -0,0 +1,58 @@
+cmake_minimum_required(VERSION 3.16)
+
+
+if(JKQtPlotter_BUILD_TOOLS)
+
+    # custom target that generates the images for the JKQTMathText documentation
+    set(JKQTMathText_GenerateDocImages_DefaultOptions --resolution=96 --fontsize=20 --fontmathroman=XITS --background=white --sizeincrease=5)
+    set(JKQTMathText_GenerateDocImages_StdInputFiles
+        jkqtmathtext_docimages_accents.jkmt
+        jkqtmathtext_docimages_boxes.jkmt
+        jkqtmathtext_docimages_braces.jkmt
+        jkqtmathtext_docimages_formating.jkmt
+        jkqtmathtext_docimages_frac.jkmt
+        jkqtmathtext_docimages_math.jkmt
+        jkqtmathtext_docimages_matrix.jkmt
+        jkqtmathtext_docimages_misc.jkmt
+        jkqtmathtext_docimages_specialfonts.jkmt
+        jkqtmathtext_docimages_symbolsandencoding.jkmt
+    )
+
+
+    set(JKQTMathText_GenerateDocImages_COMMAND $<TARGET_FILE:jkqtmathtext_render> ${JKQTMathText_GenerateDocImages_DefaultOptions})
+    set(JKQTMathText_GenerateDocImages_OutputDir "${CMAKE_CURRENT_LIST_DIR}/images/jkqtmathtext/")
+    add_custom_target(JKQTMathText_GenerateDocImages
+        COMMENT "Building JKQTMathText Documentation Images ..."
+        DEPENDS jkqtmathtext_render
+    )
+
+    foreach(file ${JKQTMathText_GenerateDocImages_StdInputFiles})
+        string(REGEX MATCH ".*_([^_\.]+)\.[A-Za-z]+" dummy ${file})
+        set(loc_name ${CMAKE_MATCH_1})
+        string(TOUPPER ${loc_name} loc_name_upper ${file})
+        set(loc_target_name "JKQTMathText_GenerateDocImages_${loc_name}")
+
+        add_custom_target(${loc_target_name}
+            COMMENT "Building JKQTMathText Documentation Images: ${loc_name_upper}"
+            COMMAND ${JKQTMathText_GenerateDocImages_COMMAND} --inputfile="${CMAKE_CURRENT_LIST_DIR}/${file}" --outputdir="${JKQTMathText_GenerateDocImages_OutputDir}"
+            WORKING_DIRECTORY ${JKQtPlotter_QT_BINDIR}
+            DEPENDS jkqtmathtext_render
+        )
+
+        add_dependencies(JKQTMathText_GenerateDocImages ${loc_target_name})
+
+        unset(loc_name)
+        unset(loc_target_name)
+        unset(loc_name_upper)
+        unset(dummy)
+    endforeach()
+
+    add_custom_target(JKQTMathText_GenerateDocImages_listsymbols
+        COMMENT "Building JKQTMathText Documentation Images: LISTSYMBOLS"
+        COMMAND ${JKQTMathText_GenerateDocImages_COMMAND} --listsymbols="${CMAKE_CURRENT_LIST_DIR}/dox/jkqtmathtext_supportedlatexsymbols.dox" --outputdir="${JKQTMathText_GenerateDocImages_OutputDir}/symbols/"
+        WORKING_DIRECTORY ${JKQtPlotter_QT_BINDIR}
+        DEPENDS jkqtmathtext_render
+    )
+
+    add_dependencies(JKQTMathText_GenerateDocImages JKQTMathText_GenerateDocImages_listsymbols)
+endif()

doc/dox/jkqtmathtext_supportedlatex.dox

@@ -30,10 +30,17 @@
       - \c \\it{...} \c \\textit{...} \c \\mathit{...} :  draw the contained text in italic face \image html jkqtmathtext/jkqtmathtext_italic.png
       - \c \\rm{...} \c \\textrm{...} \c \\mathrm{...} \c \\mbox{...} :  draw the contained text in normal upright roman font face \image html jkqtmathtext/jkqtmathtext_fonts.png
       - \c \\sf{...} \c \\textsf{...} \c \\mathsf{...} :  draw the contained text in normal upright sans-serif font face \image html jkqtmathtext/jkqtmathtext_fonts.png
+      - \c \\textcal{...} \c \\mathcal{...} :  draw the contained text in caligraphic font face \image html jkqtmathtext/jkqtmathtext_cal.png 
+      - \c \\textfrak{...} \c \\mathfrak{...} :  draw the contained text in fraktur font face \image html jkqtmathtext/jkqtmathtext_frak.png 
+      - \c \\textscript{...} \c \\mathscript{...} :  draw the contained text in script font face \image html jkqtmathtext/jkqtmathtext_script.png 
+      - \c \\textbb{...} \c \\mathbb{...} :  draw the contained text in blackboard font face \image html jkqtmathtext/jkqtmathtext_bb.png 
+        The class JKQTMathText also supports simulating blackboard fonts, if they are not available as an actual font on the system. Then the example would look like this: \image html jkqtmathtext/jkqtmathtext_bb_sim.png 
       - \c \\script{...} \c \\textscript{...} \c \\mathscript{...} :  draw the contained text in a script font face \image html jkqtmathtext/jkqtmathtext_fonts.png
       - \c \\sc{...} : draw the text in small caps \image html jkqtmathtext/jkqtmathtext_sc.png
       - \c \\ul{...} \c \\underline{...} \c \\underlined{...} : draw the text with underlining \image html jkqtmathtext/jkqtmathtext_ul.png
+      - \c \\uul{...} : draw the text with double-underlining \image html jkqtmathtext/jkqtmathtext_uul.png
       - \c \\ol{...} \c \\overline{...} \c \\overlined{...} : draw the text with overlining \image html jkqtmathtext/jkqtmathtext_ol.png
+      - \c \\ool{...} : draw the text with double-overlining \image html jkqtmathtext/jkqtmathtext_ool.png
       - \c \\tt{...} \c \\texttt{...} \c \\mathtt{...} : draw text in typewriter font \image html jkqtmathtext/jkqtmathtext_fonts.png
       - \c \\textcolor{color}{...} \c \\color{color} \c \\mathcolor{color}{...} : draw colored text \image html jkqtmathtext/jkqtmathtext_colored.png
       - \c \\userfont{font}{...} : draw text in a user-specific font, available on the system \image html jkqtmathtext/jkqtmathtext_userfont.png (generated by <code>default, \\userfont{Arial}{Arial}, \\userfont{Comic Sans MS}{Comic Sans MS}</code> )
@@ -64,9 +71,10 @@
     \section JKQTMathTextSuppoertedLaTeXVerbatim Verbatim Text
     Sometimes it is necessary to typeset text withou interpreting it as LaTeX markup. These instructions are implemented for that:
       - <code>\\verb!...!</code>: interpret enclosed text between \c ! as verbose. Instead of \ ! you can choose ANY character! \image html jkqtmathtext/jkqtmathtext_verb.png generated by <code>\\verb!\\LaTeX{} is not pares inside \\verb~..~! outside {\\backslash}verb</code>
-      - <code>\\begin{verbatim}...\\end{verbatim}</code>: interpret enclosed multi-line text as verbatim. \image html jkqtmathtext/jkqtmathtext_verbatim.png generated by <code>outside\\begin{verbatim}\ninside \\LaTeX verbatim\n  2nd verbaimline\n\t3rd line\n\\end{verbatim}</code>
+      - <code>\\begin{verbatim}...\\end{verbatim}</code>: interpret enclosed multi-line text as verbatim. \image html jkqtmathtext/jkqtmathtext_verbatim.png
-      - <code>\\begin{lstlisting}...\\end{lstlisting}</code>: actually menat for highlighted code, for now this is the same as \c \\begin{verbatim}...\\end{verbatim}. \image html jkqtmathtext/jkqtmathtext_lstlisting.png generated by <code>outside\\begin{lstlisting}\nint main() {\n  printf("Hello World\\n");\n}\n\\end{lstlisting}</code>
+      \endcode
-      - <code>\\begin{verbatim*}...\\end{verbatim*}</code>: interpret enclosed multi-line text as verbatim. Print with visible whitespace and tab characters \image html jkqtmathtext/jkqtmathtext_verbatimast.png generated by <code>outside\\begin{verbatim*}\ninside \\LaTeX verbatim\n  2nd verbaimline\n\t3rd line\n\\end{verbatim*}</code>
+      - <code>\\begin{lstlisting}...\\end{lstlisting}</code>: actually menat for highlighted code, for now this is the same as \c \\begin{verbatim}...\\end{verbatim}. \image html jkqtmathtext/jkqtmathtext_lstlisting.png
+      - <code>\\begin{verbatim*}...\\end{verbatim*}</code>: interpret enclosed multi-line text as verbatim. Print with visible whitespace and tab characters \image html jkqtmathtext/jkqtmathtext_verbatimast.png
     .
 
     
@@ -77,6 +85,10 @@
       - \c \\charDECIMAL and \c \\char\"HEX and \c \\char\'OCTAL : draws a unicode character from its 32-bit codepoint \image html jkqtmathtext/jkqtmathtext_char.png (generated by <code>A: \\char65, circonflex: \\char\"109 accent: \\char\'351</code>)
       - \c \\unicode{HEX} and \c \\usym{HEX} : draws a unicode character from its 32-bit codepoint \image html jkqtmathtext/jkqtmathtext_unicode.png (generated by <code>star: \\unicode{2605}, circonflex: \\unicode{109} emoticons: \\usym{1F440} \\usym{1F929}</code>)
       - \c \\utfeight{HEX} : draws a unicode character from its UTF-8 encoding \image html jkqtmathtext/jkqtmathtext_utf8.png (generated by <code>star: \\utfeight{e29885} emoticons \\utfeight{F09F9881} \\utfeight{f09f98bb}</code>)
+      - The usual LaTeX-accent commands are also implemented here and work as expected in text-mode, provided the matching unicode characters are available in the current font.
+        \image html jkqtmathtext/jkqtmathtext_textaccents.png
+      - In math-mode the text-accent commands do not work. here you have to use the math-mode commands:
+        \image html jkqtmathtext/jkqtmathtext_mathaccents.png
       - \c \\{ / \\} : display opening/closing brace
       - \c \\_ : display underscore
       - \c \\sum \c \\prod \c \\int ... : plot special symbol. Note that depending on the fontEncoding the available
@@ -123,7 +135,7 @@
       - \c \\left\\| \c \\right\\| \endcode : norm braces || ||, \image html jkqtmathtext/jkqtmathtext_brace_dblline.png
       - \c \\left\\llcorner \c \\right\\lrcorner : lower corner braces , \image html jkqtmathtext/jkqtmathtext_brace_lcorner.png
       - \c \\left\\ulcorner \c \\right\\urcorner : upper corner braces , \image html jkqtmathtext/jkqtmathtext_brace_ucorner.png
-      - You can use \c \\left. or \c \\right. to have only right or only left brace
+      - You can use \c \\left. or \c \\right. to have only right or only left brace , \image html jkqtmathtext/jkqtmathtext_brace_dot.png generated by <code>{\\backslash}left.: $\\left. a\\cdot x^2\\right)$\\ \\ \\ \\ \\ {\\backslash}right.: $\\left( a\\cdot x^2\\right.$</code>
     .
     
     In additional fixed-size parantheses are available with the following family of instructions:
@@ -133,7 +145,7 @@
       - \c \\Biggl([\\{\\langle... , \c \\Bigg([\\{\\langle... and \c \\Biggr)]\\}\\rangle... \image html jkqtmathtext/jkqtmathtext_brace_bbigg.png
     .
     They use the same rendering code as the standard \c \\left and \c \\right instructions. Here is an example:
-    \image html jkqtmathtext/jkqtmathtext_brace_bigfamily.png generated by <code> $\Biggl\langle\biggl\{\Bigl[\bigl( r^{123}\bigr)\Bigr]\biggr\}\Biggr\rangle$</code>
+    \image html jkqtmathtext/jkqtmathtext_brace_bigfamily.png generated by <code> $\\Biggl\\langle\\biggl\\{\\Bigl[\\bigl( r^{123}\\bigr)\\Bigr]\\biggr\\}\\Biggr\\rangle$</code>
 
     \subsection JKQTMathTextSuppoertedLaTeXRoots Roots
     There are also instructions that allow to write roots: