Caution
+ Under the Open XML Document presentation style, + the SVG image file format is not supported. +
diff --git a/.gitattributes b/.gitattributes index 1ff0c42..1be6e5f 100644 --- a/.gitattributes +++ b/.gitattributes @@ -2,7 +2,6 @@ # Set default behavior to automatically normalize line endings. ############################################################################### * text=auto - ############################################################################### # Set default behavior for command prompt diff. # @@ -11,7 +10,6 @@ # Note: This is only used by command line ############################################################################### #*.cs diff=csharp - ############################################################################### # Set the merge driver for project and solution files # @@ -34,7 +32,6 @@ #*.modelproj merge=binary #*.sqlproj merge=binary #*.wwaproj merge=binary - ############################################################################### # behavior for image files # @@ -43,7 +40,6 @@ #*.jpg binary #*.png binary #*.gif binary - ############################################################################### # diff behavior for common document formats # @@ -61,3 +57,6 @@ #*.PDF diff=astextplain #*.rtf diff=astextplain #*.RTF diff=astextplain +.jpg filter=lfs diff=lfs merge=lfs -text +.svg filter=lfs diff=lfs merge=lfs -text +.json filter=lfs diff=lfs merge=lfs -text diff --git a/README.md b/README.md index 1a01dfc..036fbd8 100644 --- a/README.md +++ b/README.md @@ -1,29 +1,19 @@ # Novacta.Shfb.LatexTools -This repo contains the source code for **Novacta.Shfb.LatexTools**, a .NET library that -enables adding LaTeX content in documentation files created via the -[Sandcastle Help File Builder](https://github.com/EWSoftware/SHFB) project. - -The tools support SHFB, version 2021.10.23.0 or later. +**Novacta.Shfb.LatexTools** is a .NET library that +provides types to manage +[LaTeX](https://www.latex-project.org/) equations in reference and conceptual content files generated by the +[Sandcastle Help File Builder](https://github.com/EWSoftware/SHFB). ## Features -* The - [LatexComponent](https://novacta.github.io/shfb-latex-tools/html/T_Novacta_Shfb_LatexTools_LatexComponent.htm) - enables the representation of LaTeX equations - as images in SHFB documentation files. - Supported image formats are - [PNG](https://en.wikipedia.org/wiki/Portable_Network_Graphics) - and - [SVG](https://en.wikipedia.org/wiki/Scalable_Vector_Graphics). -* The - [LatexPlugIn](https://novacta.github.io/shfb-latex-tools/html/T_Novacta_Shfb_LatexTools_LatexPlugIn.htm), - which is responsible to support the *SVG* image file format for the *MSHelpViewer* help output. -* The presentation styles - [VS2010WithLatex](https://novacta.github.io/shfb-latex-tools/html/T_Novacta_Shfb_LatexTools_PresentationStyles_VS2010WithLatex.htm) - and - [VS2013WithLatex](https://novacta.github.io/shfb-latex-tools/html/T_Novacta_Shfb_LatexTools_PresentationStyles_VS2013WithLatex.htm), - which add to styles *VS2010* and *VS2013*, respectively, the ability to manage LaTeX content. +Available versions of the **LatexTools** have different features, as described in the following table. + +| Feature | v2.0.0 | v1.0.0 | +| ------- | ------ | ------ | +| Supported [SHFB](https://github.com/EWSoftware/SHFB) versions | 2022.8.14.0 or later | 2021.11.7.0 - 2022.2.6.0 | +| Target presentation styles | Default 2022, Markdown, OpenXml, VS2013 | Customized versions of VS2010 and VS2013 styles | +| Documentation comments able to include LaTeX contents | MAML/XML | MAML/XML | ## Installation @@ -31,7 +21,7 @@ The library is available as a [NuGet package](https://www.nuget.org/packages/Nov ## Documentation -[Adding LaTeX equations](https://novacta.github.io/shfb-latex-tools/html/47a5afe5-726c-4f74-9ab1-90740bf0a692.htm) +[Adding LaTeX equations](https://novacta.github.io/shfb-latex-tools/html/781b55db-9cd4-401d-9c24-a5e4b93fe476.htm) includes topics showing how to define LaTeX content in help files. Full documentation is located [here](http://novacta.github.io/shfb-latex-tools/). diff --git a/docs/GeneralError.html b/docs/GeneralError.html new file mode 100644 index 0000000..b0d8c4d --- /dev/null +++ b/docs/GeneralError.html @@ -0,0 +1,32 @@ + + +
+ + + + + + + + +Please try to load the page again. If the error persists, please contact the site administrator.
+The URL might be misspelled or the page you are looking for is no longer available. If you typed in the +URL, check that it does not contain a typo. You can return to the main page to +use the table of contents or the search option to try and locate the page.
++ Version 2.0.0 was released on December 11 2023. +
Adding LaTeX equations |
- The instructions on this page - demonstrate how to install the - - Novacta.Shfb.LatexTools - , - and how to use them - to insert Latex content in documentation topics. -
Install a supported version of SHFB
- The current release of - Novacta.Shfb.LatexTools - targets SHFB, version 2021.10.23.0 or later. -
- Make sure that a supported SHFB version of your choice - is currently installed on your host machine. -
- You can download the required SHFB release - here. -
Install a full LaTeX distribution
- You need a full TeX distribution installed on your host machine. - You can find a list of TeX implementations - here. -
- In particular, the LatexTools - have been tested using the - MiKTeX distribution. -
Create a SHFB documentation project
- Documentation projects can be created via the - SHFB standalone GUI, - or via the - SHFB Visual Studio package. -
Add the Latex Tools to the SHFB documentation project
- Right click on node Component Packages of your project - and, from the contextual menu, select Manage Component Packages... - (if your are using the SHFB standalone GUI), or - Manage NuGet Packages... (if you are - inside Visual Studio). Hence search package - Novacta.Shfb.LatexTools and install it. -
- In this way, a reference to - the Novacta.Shfb.LatexTools - NuGet package will be added to your documentation project, and the following - SHFB extensions will be available while processing help files. -
- The LatexComponent - enables the representation of LaTeX equations - as images in SHFB documentation topics. - Supported image formats are - PNG and - SVG. -
- The LatexPlugIn, which - is responsible to support the SVG - image file format for the MSHelpViewer - help output. -
- The presentation styles - VS2010WithLatex and - VS2013WithLatex, - which add the ability to manage LaTeX content to styles - VS2010 and - VS2013, respectively. -
Selecting a LaTeX-aware presentation style
- To select a presentation style able to manage LaTeX content, open - the project properties and click on the - Build tab. From the list - of available presentation styles, select the one - of your choice among those defined - as VS2010 + LaTeX or - VS2010 + LaTeX. - For example, the following figure shows a project - in which the - VS2013 + LaTeX style - has been selected. -
Configuring the LatexComponent
- The - LatexComponent - must be added to a documentation project - in order to manage LaTeX content in documentation topics. -
- To such purpose, open the project properties and click on the - Components tab. From the list - of available components, select the one - referred to as - Novacta.Shfb.LaTeXComponent - and click the Add button. - Now the Latex component is inserted in the list of the - components executed during - the build process of the documentation project. - Such list is showed on the right side - of the tab, as exemplified in the following figure. -
- Once the LaTeX component has been committed for execution, - it must be configured. By clicking the - Configure button, the following - pop-up window will be displayed. -
- Through that window, configuration options can be set as follows. -
Option | Description |
---|---|
- Image file format - | - Through this option, one of the - image formats supported for LaTeX - content representation can be selected. - |
- Image depth correction - | - When a LaTeX element is in-lined, - then the corresponding image depth, i.e. the distance of the - bottom of the image from its baseline, must be modified in - order for the text represented in the image to have the same - baseline of the surrounding text. - - The initial image depth is returned by the DviPng executable of - the LaTeX distribution. Then, the difference between such value and - that set for the Image Depth Correction option - is taken as the final image depth. - By default, the Image Depth Correction option - is set to 0, - a value that works well for the default text size. - - Such behavior can be overridden for each specific equation, - as discussed in the following section. - |
- Image scale percentage - | - This option controls the size of the text in a LaTeX equation. - The default value is 100, - and is equivalent to apply the \normalsize - text sizing LaTeX command while adopting - 10pt as the size of the main font in the document. - Values other than - 100 modify the size, - but negative values are not allowed. - - Such behavior can be overridden for each specific equation, - as discussed in the following section. - |
- Redirect file processors - | - If checked, this option enables the redirection of - LaTeX console outputs to the SHFB - Help Build Log Content. - |
- Default LaTeX Mode - | - This option controls if a LaTeX equation must be interpreted, - by default, as entered in inline mode, or - in display mode. - The default configuration sets this option - to display. - - Such behavior can be overridden for each specific equation, - as discussed in the following section. - |
- Additional Preamble Commands - | - If needed, this option enables the addition of specific - commands to the preamble - of the documents processed to get the - LaTeX equations required in the documentation. - |
- LaTeX bin folder - | - Through this option, you can specify the folder where - are contained the binary files of the installed - LaTeX distribution. - |
- DviSvgm bin folder - | - Through this option, you can specify the folder where - are contained the binary files of - - DviSvgm, - a converter of DVI files to the SVG graphics format. - - The converter has been added to several LaTeX distributions. - If the installed distribution includes the tool, you can - specify here the same path set for option - LaTeX bin folder. - Otherwise, you can download the converter - here, - save it in a folder and set the option - accordingly. - - These binaries are only needed if you - select the SVG image file format. - |
The LatexPlugIn
- The - LatexPlugIn - must be added to a documentation project - only if the project needs to support the SVG - image file format for the MSHelpViewer - help output. -
- To do so, open the project properties and click on the - Plug-Ins tab. From the list - of available plug-ins, select the one - referred to as - Novacta.Shfb.LatexPlugIn - and click the Add button. - Now the Latex plug-in is inserted in the list of the - plug-ins executed during - the build process of the documentation project. - The plug-ins committed for execution are listed on the right side - of the tab, as exemplified in the following figure. -
- LaTeX equations can be added to the XML comments on your - source code by inserting custom XML elements, referred - to as the LaTeX elements. -
- The start-tag of such elements - is <latex>. - The basic form of a LaTeX element, - i.e. a form with no XML - attributes, is as follows. -
<latex>X_{(0)}=2^{-1/3}</latex>
- When LaTeX elements are processed, - their content is interpreted as having document class - article, - with an option of - 10pt for the size of the - main font in the document, and the - \pagestyle set to - empty. You can also - assume as available the packages - amsmath - and - amsfonts. -
- When the default configuration - is active and the latex element is in basic form, then its content - is interpreted as inserted in a displayed mathematical - environment (separated by the main text), and sized - applying the \normalsize LaTeX command. -
- Such behavior can be overridden by adding attributes - to the latex element or overriding the default configuration. -
- If you want a LaTeX formula displayed in-line, - that is, within the body of text where it is declared, - you can add a mode attribute - having the "inline" value, as in the following - example. -
/// Let us assume that the random variable -/// <latex mode="inline">Y_{i}</latex> has distribution function -/// <latex mode="inline">F_{Y_{i}}</latex>.
- If a LaTeX element has - no mode attribute, then its - mode is set, by default, according to the - - Default LaTeX mode - - configuration option. -
- The Novacta - LatexComponent - inserts images in help files - to represent your equations. - When - a LaTeX element is in-lined, - then the corresponding image - depth is, by default, set according to the - - Image depth correction - - configuration option. - However, the image depth for a given - LaTeX element - can be hard coded by adding a depth attribute, - as in the following example. -
<latex depth="10">F_{Y_{i}}</latex>
- In a LaTeX element, - the size of the text is controlled, by default, - through the - - Image scale percentage - - configuration option. - However, the size of a given - LaTeX element can be - overridden by adding to it - a scale attribute. - For example, if you want its size being the - 70% of the basic size, you can write - a LaTeX element as follows. -
<latex scale="scriptsize">F_{Y_{i}}</latex>
- More thoroughly, you can set the value of the - scale attribute - using any of the predefined values shown in the following table, - where the corresponding percentages are also reported. -
Predefined LaTeX size | Percentage | Example |
---|---|---|
- tiny - | - 50 - | |
- scriptsize - | - 70 - | |
- footnotesize - | - 80 - | |
- small - | - 90 - | |
- normalsize - | - 100 - | |
- large - | - 120 - | |
- Large - | - 144 - | |
- LARGE - | - 172.8 - | |
- huge - | - 207.4 - | |
- Huge - | - 248.8 - |
- As an example, the following file printout shows the source code for - type - IntegerOperation, - as defined in project - SampleClassLibrary: -
1using System; - 2 - 3namespace SampleClassLibrary - 4{ - 5 /// <summary> - 6 /// Provides a method to operate on integers. - 7 /// </summary> - 8 public static class IntegerOperation - 9 { -10 /// <summary> -11 /// Applies the specified function to the given operand. -12 /// </summary> -13 /// <param name="func">The function.</param> -14 /// <param name="operand">The operand.</param> -15 /// <returns>The result of the operation.</returns> -16 /// <exception cref="ArgumentNullException"> -17 /// <paramref name="func"/> is <b>null</b>.</exception> -18 /// <example> -19 /// <para> -20 /// In the following example, the applied function, say -21 /// <latex mode='inline'>f:\mathbb{N}\rightarrow \mathbb{N},</latex> is defined as -22 /// <latex mode='display'> -23 /// \forall n \in \mathbb{N}: n \mapsto f\left(n\right)=n^2. -24 /// </latex> -25 /// An integer is thus squared -26 /// executing the <see cref="Operate(Func{int, int}, int)"/> method. -27 /// In addition, input validation is also checked. -28 /// </para> -29 /// <para> -30 /// <code language="cs"> -31 /// using System; -32 /// namespace SampleClassLibrary.CodeExamples -33 /// { -34 /// public class IntegerOperationExample -35 /// { -36 /// public void Main() -37 /// { -38 /// // Define an operator that squares its operand -39 /// Func<![CDATA[<]]>int, int> square = (int operand) => operand * operand; -40 /// -41 /// // Define an operand -42 /// int integer = 2; -43 /// -44 /// // Operate on it -45 /// Console.WriteLine("Squaring {0}...", integer); -46 /// int result = IntegerOperation.Operate(square, integer); -47 /// Console.WriteLine("...the result is {0}.", result); -48 /// -49 /// // Check that an operator cannot be null -50 /// try -51 /// { -52 /// IntegerOperation.Operate(null, 0); -53 /// } -54 /// catch (Exception e) -55 /// { -56 /// Console.WriteLine(); -57 /// Console.WriteLine("Cannot apply a null function:"); -58 /// Console.WriteLine(e.Message); -59 /// } -60 /// } -61 /// } -62 /// } -63 /// -64 /// // Executing method Main() produces the following output: -65 /// // -66 /// // Squaring 2... -67 /// // ...the result is 4. -68 /// // -69 /// // Cannot apply a null function: -70 /// // Value cannot be null. -71 /// // Parameter name: func -72 /// </code> -73 /// </para> -74 /// </example> -75 public static int Operate(Func<int, int> func, int operand) -76 { -77 if (func==null) -78 { -79 throw new ArgumentNullException(nameof(func)); -80 } -81 return func(operand); -82 } -83 } -84}
- Note the LaTeX elements at line 21-24 - in the XML comments on method - Operate. - You can check - here - how the - corresponding documentation looks like. -
- Elements in - MAML - conceptual topics must be qualified using a namespace. - To qualify LaTeX elements, - add to the topic's document element a namespace attribute - associated with prefix ltx, - as shown in the following example. -
<topic id="303c996a-2911-4c08-b492-6496c82b3edb" revisionNumber="1"> - <!-- This element name will change based on the document type --> - <developerConceptualDocument - xmlns="http://ddue.schemas.microsoft.com/authoring/2003/5" - xmlns:xlink="http://www.w3.org/1999/xlink" - xmlns:ltx="http://www.novacta.net/2018/XSL/ShfbLatexTools"> - - <!-- The content goes here --> - - </developerConceptualDocument> -</topic>
- Now LaTeX elements can be added - by prefixing their tags with ltx, - as follows. -
<ltx:latex scale="LARGE" mode="inline">X_{(0)}</ltx:latex>
- As an example, the following file printout shows the source code for - a conceptual topic about - IntegerOperation, - as defined in project - SampleClassLibrary: -
1<?xml version="1.0" encoding="utf-8"?> - 2<topic id="b10d4d75-3729-4247-a58a-b9e5b6e4bb4d" revisionNumber="1"> - 3 <developerConceptualDocument - 4 xmlns="http://ddue.schemas.microsoft.com/authoring/2003/5" - 5 xmlns:xlink="http://www.w3.org/1999/xlink" - 6 xmlns:ltx="http://www.novacta.net/2018/XSL/ShfbLatexTools"> - 7 - 8 <introduction> - 9 <para> -10 Class <codeEntityReference qualifyHint="false"> -11 T:SampleClassLibrary.IntegerOperation -12 </codeEntityReference> provides method -13 <codeEntityReference qualifyHint="false"> -14 M:SampleClassLibrary.IntegerOperation.Operate(System.Func{System.Int32,System.Int32},System.Int32) -15 </codeEntityReference> -16 to manage operations on integer values. -17 </para> -18 <para> -19 In the following example, an integer is squared -20 executing the <codeEntityReference qualifyHint="false"> -21 M:SampleClassLibrary.IntegerOperation.Operate(System.Func{System.Int32,System.Int32},System.Int32) -22 </codeEntityReference> method. -23 This is equivalent to define the applied function, -24 say <ltx:latex mode="inline">f:\mathbb{N}\rightarrow \mathbb{N},</ltx:latex> -25 as <ltx:latex>\forall n \in \mathbb{N}: n \mapsto f\left(n\right)=n^2.</ltx:latex> -26 In addition, input validation is also checked. -27 </para> -28 <code source="..\SampleClassLibrary\IntegerOperationExample.cs.txt" -29 language="cs" title="C#" /> -30 </introduction> -31 -32 <relatedTopics> -33 <link xlink:href="4c3871a5-d7c6-477c-96ee-e71f0a67f7a8" /> -34 </relatedTopics> -35 -36 </developerConceptualDocument> -37</topic>
- Note the LaTeX elements at lines 24-25. - You can check - here - how such conceptual topic looks like. -
+ Class IntegerArrayOperation provides method + Operate(FuncInt32, Int32, Int32) + to manage operations on integer values. +
+ In the following example, an integer is squared
+ executing the Operate(FuncInt32, Int32, Int32) method.
+ This is equivalent to define the applied function,
+ say
+ as
+ In addition, input validation is also checked.
+
using System;
+using SampleClassLibrary.Advanced;
+
+namespace SampleClassLibrary.CodeExamples.Advanced
+{
+ public class IntegerArrayOperationExample
+ {
+ public void Main()
+ {
+ // Define an operator that squares its operand
+ Func<int, int> square = (int operand) => operand * operand;
+
+ // Define an array of operands
+ int[] operands = new int[3] { 2, 4, 8 };
+
+ // Operate on it
+ int[] results = IntegerArrayOperation.Operate(square, operands);
+
+ // Show results
+ for (int i = 0; i < results.Length; i++)
+ {
+ Console.WriteLine(
+ "The result of squaring {0} is {1}.",
+ operands[i],
+ results[i]);
+ }
+
+ // Check that an operator cannot be null
+ try
+ {
+ IntegerArrayOperation.Operate(null, new int[1]);
+ }
+ catch (Exception e)
+ {
+ Console.WriteLine();
+ Console.WriteLine("Cannot apply a null function:");
+ Console.WriteLine(e.Message);
+ }
+
+ // Check that an array of operands cannot be null
+ try
+ {
+ IntegerArrayOperation.Operate(square, null);
+ }
+ catch (Exception e)
+ {
+ Console.WriteLine();
+ Console.WriteLine("Cannot apply a function to a null array:");
+ Console.WriteLine(e.Message);
+ }
+
+ }
+ }
+}
+
+// Executing method Main() produces the following output:
+//
+// The result of squaring 2 is 4.
+// The result of squaring 4 is 16.
+// The result of squaring 8 is 64.
+//
+// Cannot apply a null function:
+// Value cannot be null.
+// Parameter name: func
+//
+// Cannot apply a function to a null array:
+// Value cannot be null.
+// Parameter name: operands
The topics in this section describe the various changes made to the + Novacta.Shfb.LatexTools over the life of the project. +
Select a version below to see a description of its changes.
Novacta.Shfb.LatexTools is a .NET library + that provides types to manage + LaTeX + equations in reference and conceptual content files + generated by the + Sandcastle Help File Builder. +
+ The project supports SHFB, version 2021.11.7.0 or later. +
+ The library is licensed under + the + MIT license. +
+ The current documentation includes the following topics. +
Adding LaTeX equations includes topics showing how to define LaTeX + content in documentation files. +
SampleClassLibrary Namespaces + points to a sample documentation obtained + through the Novacta.Shfb.LatexTools library. +
Version 1.0.0 was released on November 15 2021. +
Initial release of the assembly.
License agreement |
- This software is licensed under the following terms. -
- Copyright (c) 2021 Giovanni Lafratta. All rights reserved. -
- Permission is hereby granted, free of charge, to any person - obtaining a copy of this software and associated documentation - files (the "Software"), to deal in the Software without - restriction, including without limitation the rights to use, - copy, modify, merge, publish, distribute, sublicense, - and/or sell copies of the Software, and to permit persons - to whom the Software is furnished to do so, subject to the - following conditions: -
- The above copyright notice and this permission notice shall - be included in - all copies or substantial portions of the Software. -
- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR - IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, - FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE - AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER - LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, - OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN - THE SOFTWARE. -
Version History |
- The topics in this section describe the various changes made to - Novacta.Shfb.LatexTools over the - life of the project. -
Select a version below to see a description of its changes.
+ Class IntegerOperation provides method + Operate(FuncInt32, Int32, Int32) + to manage operations on integer values. +
+ In the following example, an integer is squared
+ executing the Operate(FuncInt32, Int32, Int32) method.
+ This is equivalent to define the applied function,
+ say
+ as
+ In addition, input validation is also checked.
+
using System;
+namespace SampleClassLibrary.CodeExamples
+{
+ public class IntegerOperationExample
+ {
+ public void Main()
+ {
+ // Define an operator that squares its operand
+ Func<int, int> square = (int operand) => operand * operand;
+
+ // Define an operand
+ int integer = 2;
+
+ // Operate on it
+ Console.WriteLine("Squaring {0}...", integer);
+ int result = IntegerOperation.Operate(square, integer);
+ Console.WriteLine("...the result is {0}.", result);
+
+ // Check that an operator cannot be null
+ try
+ {
+ IntegerOperation.Operate(null, 0);
+ }
+ catch (Exception e)
+ {
+ Console.WriteLine();
+ Console.WriteLine("Cannot apply a null function:");
+ Console.WriteLine(e.Message);
+ }
+ }
+ }
+}
+
+// Executing method Main() produces the following output:
+//
+// Squaring 2...
+// ...the result is 4.
+//
+// Cannot apply a null function:
+// Value cannot be null.
+// Parameter name: func
+ This software is licensed under the following terms. +
+ Copyright (c) 2021 Giovanni Lafratta. All rights reserved. +
+ Permission is hereby granted, free of charge, to any person + obtaining a copy of this software and associated documentation + files (the "Software"), to deal in the Software without + restriction, including without limitation the rights to use, + copy, modify, merge, publish, distribute, sublicense, + and/or sell copies of the Software, and to permit persons + to whom the Software is furnished to do so, subject to the + following conditions: +
+ The above copyright notice and this permission notice shall + be included in + all copies or substantial portions of the Software. +
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN + THE SOFTWARE. +
Namespaces |
[Missing <summary> documentation for "G:"]
Namespace | Description |
---|---|
Novacta.Shfb | Provide support to LaTeX content in files generated by the Sandcastle Help File Builder. |
SampleClassLibrary | Provide information about a library containing sample code whose documentation has been created exploiting the Novacta SHFB LaTeX Tools. |
Novacta.Shfb Namespaces |
Namespace | Description |
---|---|
Novacta.Shfb.LatexTools | Provides types able to represent LaTeX content in files generated by the Sandcastle Help File Builder. |
Novacta.Shfb.LatexTools.PresentationStyles | Provides presentation styles able to manage LaTeX content in files generated by the Sandcastle Help File Builder. |
SampleClassLibrary Namespaces |
Namespace | Description |
---|---|
SampleClassLibrary | Provides support for operations on integers. |
SampleClassLibrary.Advanced | Provides support for operations on integer arrays. |
SampleClassLibrary | Provides support for operations on integers. |
SampleClassLibrary.Advanced | Provides support for operations on integer arrays. |
Please try to load the page again. If the error persists, please contact the site administrator.
-DviPngProcessorArguments Method |
- Namespace: - Novacta.Shfb.LatexTools
public override string Arguments( - string fileName, - string additionalInfo -)
DviPngProcessor Constructor |
- Namespace: - Novacta.Shfb.LatexTools
public DviPngProcessor( - string latexBinPath, - string workingPath, - string defaultImageResolution -)
DviSvgmProcessorArguments Method |
- Namespace: - Novacta.Shfb.LatexTools
public override string Arguments( - string fileName, - string additionalInfo -)
DviSvgmProcessor Constructor |
- Namespace: - Novacta.Shfb.LatexTools
public DviSvgmProcessor( - string dvisvgmBinPath, - string workingPath, - string defaultZoomFactor, - bool redirectFileProcessors -)
FileProcessorArguments Method |
- Namespace: - Novacta.Shfb.LatexTools
public abstract string Arguments( - string fileName, - string additionalInfo -)
FileProcessorRun Method (String) |
- Namespace: - Novacta.Shfb.LatexTools
public string Run( - string fileName -)
Exception | Condition |
---|---|
InvalidOperationException | - The process exited with errors. - |
FileProcessorRun Method (String, String) |
- Namespace: - Novacta.Shfb.LatexTools
public string Run( - string fileName, - string additionalInfo -)
Exception | Condition |
---|---|
InvalidOperationException | - The process exited with errors. - |
FileProcessor Constructor |
- Namespace: - Novacta.Shfb.LatexTools
protected FileProcessor()
LatexComponentApply Method |
- Namespace: - Novacta.Shfb.LatexTools
public override void Apply( - XmlDocument document, - string key -)
LatexComponentFactoryCreate Method |
- Namespace: - Novacta.Shfb.LatexTools
public override BuildComponentCore Create()
LatexComponentFactory Constructor |
- Namespace: - Novacta.Shfb.LatexTools
public Factory()
LatexComponentInitialize Method |
- Namespace: - Novacta.Shfb.LatexTools
public override void Initialize( - XPathNavigator configuration -)
LatexComponent Constructor |
- Namespace: - Novacta.Shfb.LatexTools
protected LatexComponent( - BuildAssemblerCore buildAssembler -)
LatexPlugInDispose Method |
- Namespace: - Novacta.Shfb.LatexTools
LatexPlugInExecute Method |
- Namespace: - Novacta.Shfb.LatexTools
public void Execute( - ExecutionContext context -)
LatexPlugInFinalize Method |
- Namespace: - Novacta.Shfb.LatexTools
LatexPlugInInitialize Method |
- Namespace: - Novacta.Shfb.LatexTools
public void Initialize( - BuildProcess buildProcess, - XElement configuration -)
LatexPlugIn Constructor |
- Namespace: - Novacta.Shfb.LatexTools
public LatexPlugIn()
LatexProcessorArguments Method |
- Namespace: - Novacta.Shfb.LatexTools
public override string Arguments( - string fileName, - string additionalInfo -)
LatexProcessor Constructor |
- Namespace: - Novacta.Shfb.LatexTools
public LatexProcessor( - string latexBinFolder, - string workingFolder -)
VS2010WithLatex Constructor |
- Namespace: - Novacta.Shfb.LatexTools.PresentationStyles
public VS2010WithLatex()
VS2013WithLatex Constructor |
- Namespace: - Novacta.Shfb.LatexTools.PresentationStyles
public VS2013WithLatex()
IntegerArrayOperationOperate Method |
- Namespace: - SampleClassLibrary.Advanced
public static int[] Operate( +
public static int[] Operate(
Func<int, int> func,
int[] operands
-)
Exception | Condition |
---|---|
ArgumentNullException | func is null. - -or- operands is null. - |
+)
Public Shared Function Operate (
+ func As Func(Of Integer, Integer),
+ operands As Integer()
+) As Integer()
public:
+static array<int>^ Operate(
+ Func<int, int>^ func,
+ array<int>^ operands
+)
static member Operate :
+ func : Func<int, int> *
+ operands : int[] -> int[]
In the following example, the applied function, say
- is defined as
-
+ is defined as
+
Integers in a given array are thus squared
- executing the Operate(FuncInt32, Int32, Int32) method.
+ executing the Operate(FuncInt32, Int32, Int32) method.
In addition, input validation is also checked.
-
using System; -using SampleClassLibrary.Advanced; +C#using System; +using SampleClassLibrary.Advanced; -namespace SampleClassLibrary.CodeExamples.Advanced +namespace SampleClassLibrary.CodeExamples.Advanced { - public class IntegerArrayOperationExample + public class IntegerArrayOperationExample { - public void Main() + public void Main() { - // Define an operator that squares its operand - Func<int, int> square = (int operand) => operand * operand; + // Define an operator that squares its operand + Func<int, int> square = (int operand) => operand * operand; - // Define an array of operands - int[] operands = new int[3] { 2, 4, 8 }; + // Define an array of operands + int[] operands = new int[3] { 2, 4, 8 }; - // Operate on it - int[] results = IntegerArrayOperation.Operate(square, operands); + // Operate on it + int[] results = IntegerArrayOperation.Operate(square, operands); - // Show results - for (int i = 0; i < results.Length; i++) + // Show results + for (int i = 0; i < results.Length; i++) { Console.WriteLine( - "The result of squaring {0} is {1}.", + "The result of squaring {0} is {1}.", operands[i], results[i]); } - // Check that an operator cannot be null - try + // Check that an operator cannot be null + try { - IntegerArrayOperation.Operate(null, new int[1]); + IntegerArrayOperation.Operate(null, new int[1]); } - catch (Exception e) + catch (Exception e) { Console.WriteLine(); - Console.WriteLine("Cannot apply a null function:"); + Console.WriteLine("Cannot apply a null function:"); Console.WriteLine(e.Message); } - // Check that an array of operands cannot be null - try + // Check that an array of operands cannot be null + try { - IntegerArrayOperation.Operate(square, null); + IntegerArrayOperation.Operate(square, null); } - catch (Exception e) + catch (Exception e) { Console.WriteLine(); - Console.WriteLine("Cannot apply a function to a null array:"); + Console.WriteLine("Cannot apply a function to a null array:"); Console.WriteLine(e.Message); } } } } -// Executing method Main() produces the following output: -// -// The result of squaring 2 is 4. -// The result of squaring 4 is 16. -// The result of squaring 8 is 64. -// -// Cannot apply a null function: -// Value cannot be null. -// Parameter name: func -// -// Cannot apply a function to a null array: -// Value cannot be null. -// Parameter name: operands
ArgumentNullException | func is null. + -or- operands is null. + |
IntegerOperationOperate Method |
- Namespace: - SampleClassLibrary
public static int Operate( +
public static int Operate(
Func<int, int> func,
int operand
-)
Exception | Condition |
---|---|
ArgumentNullException | func is null. |
+)
Public Shared Function Operate (
+ func As Func(Of Integer, Integer),
+ operand As Integer
+) As Integer
public:
+static int Operate(
+ Func<int, int>^ func,
+ int operand
+)
static member Operate :
+ func : Func<int, int> *
+ operand : int -> int
In the following example, the applied function, say
- is defined as
-
+ is defined as
+
An integer is thus squared
- executing the Operate(FuncInt32, Int32, Int32) method.
+ executing the Operate(FuncInt32, Int32, Int32) method.
In addition, input validation is also checked.
-
using System; -namespace SampleClassLibrary.CodeExamples +C#using System; +namespace SampleClassLibrary.CodeExamples { - public class IntegerOperationExample + public class IntegerOperationExample { - public void Main() + public void Main() { - // Define an operator that squares its operand - Func<int, int> square = (int operand) => operand * operand; + // Define an operator that squares its operand + Func<int, int> square = (int operand) => operand * operand; - // Define an operand - int integer = 2; + // Define an operand + int integer = 2; - // Operate on it - Console.WriteLine("Squaring {0}...", integer); - int result = IntegerOperation.Operate(square, integer); - Console.WriteLine("...the result is {0}.", result); + // Operate on it + Console.WriteLine("Squaring {0}...", integer); + int result = IntegerOperation.Operate(square, integer); + Console.WriteLine("...the result is {0}.", result); - // Check that an operator cannot be null - try + // Check that an operator cannot be null + try { - IntegerOperation.Operate(null, 0); + IntegerOperation.Operate(null, 0); } - catch (Exception e) + catch (Exception e) { Console.WriteLine(); - Console.WriteLine("Cannot apply a null function:"); + Console.WriteLine("Cannot apply a null function:"); Console.WriteLine(e.Message); } } } } -// Executing method Main() produces the following output: -// -// Squaring 2... -// ...the result is 4. -// -// Cannot apply a null function: -// Value cannot be null. -// Parameter name: func
ArgumentNullException | func is null. |
DviPngProcessor Methods |
The DviPngProcessor type exposes the following members.
- - | Name | Description |
---|---|---|
Arguments |
- Returns the process arguments for the specified file.
- (Overrides FileProcessorArguments(String, String).) | |
Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) | |
Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) | |
GetHashCode | Serves as the default hash function. (Inherited from Object.) | |
GetType | Gets the Type of the current instance. (Inherited from Object.) | |
MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) | |
Run(String) |
- Runs the processor on the specified file.
- (Inherited from FileProcessor.) | |
Run(String, String) |
- Runs the processor on the specified file applying
- command-line arguments specific to that file.
- (Inherited from FileProcessor.) | |
ToString | Returns a string that represents the current object. (Inherited from Object.) |
DviSvgmProcessor Methods |
The DviSvgmProcessor type exposes the following members.
- - | Name | Description |
---|---|---|
Arguments |
- Returns the process arguments for the specified file.
- (Overrides FileProcessorArguments(String, String).) | |
Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) | |
Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) | |
GetHashCode | Serves as the default hash function. (Inherited from Object.) | |
GetType | Gets the Type of the current instance. (Inherited from Object.) | |
MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) | |
Run(String) |
- Runs the processor on the specified file.
- (Inherited from FileProcessor.) | |
Run(String, String) |
- Runs the processor on the specified file applying
- command-line arguments specific to that file.
- (Inherited from FileProcessor.) | |
ToString | Returns a string that represents the current object. (Inherited from Object.) |
FileProcessor Methods |
The FileProcessor type exposes the following members.
- - | Name | Description |
---|---|---|
Arguments |
- Returns the process arguments for the specified file.
- | |
Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) | |
Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) | |
GetHashCode | Serves as the default hash function. (Inherited from Object.) | |
GetType | Gets the Type of the current instance. (Inherited from Object.) | |
MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) | |
Run(String) |
- Runs the processor on the specified file.
- | |
Run(String, String) |
- Runs the processor on the specified file applying
- command-line arguments specific to that file.
- | |
ToString | Returns a string that represents the current object. (Inherited from Object.) |
LatexComponent Methods |
The LatexComponent type exposes the following members.
- - | Name | Description |
---|---|---|
Apply |
- Performs the component tasks.
- (Overrides BuildComponentCore.Apply(XmlDocument, String).) | |
Dispose |
- This implements the Dispose() interface to properly dispose of the build component.
- (Inherited from BuildComponentCore.) | |
Dispose(Boolean) |
- This can be overridden by derived classes to add their own disposal code if necessary.
- (Inherited from BuildComponentCore.) | |
Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) | |
Finalize |
- This handles garbage collection to ensure proper disposal of the build component if not done
- explicitly with Dispose.
- (Inherited from BuildComponentCore.) | |
GetHashCode | Serves as the default hash function. (Inherited from Object.) | |
GetType | Gets the Type of the current instance. (Inherited from Object.) | |
Initialize |
- Initializes the build component.
- (Overrides BuildComponentCore.Initialize(XPathNavigator).) | |
MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) | |
OnComponentEvent |
- This can be used to raise the ComponentEvent
- event with the specified event arguments.
- (Inherited from BuildComponentCore.) | |
ToString | Returns a string that represents the current object. (Inherited from Object.) | |
WriteMessage(MessageLevel, String, Object) |
- This can be used to report a message
- (Inherited from BuildComponentCore.) | |
WriteMessage(String, MessageLevel, String, Object) |
- This can be used to report a message for a specific topic ID
- (Inherited from BuildComponentCore.) |
Factory Methods |
The LatexComponentFactory type exposes the following members.
- - | Name | Description |
---|---|---|
Create |
- This is implemented to provide a build component factory
- (Overrides BuildComponentFactory.Create.) | |
Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) | |
GetHashCode | Serves as the default hash function. (Inherited from Object.) | |
GetType | Gets the Type of the current instance. (Inherited from Object.) | |
ToString | Returns a string that represents the current object. (Inherited from Object.) |
LatexPlugIn Methods |
The LatexPlugIn type exposes the following members.
- - | Name | Description |
---|---|---|
Dispose |
- Performs application-defined tasks associated with freeing,
- releasing, or resetting unmanaged resources.
- | |
Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) | |
Execute |
- Executes the plug-in during the build process.
- | |
Finalize |
- Allows this instance to try to free resources and perform other
- cleanup operations before it is reclaimed by garbage collection.
- (Overrides ObjectFinalize.) | |
GetHashCode | Serves as the default hash function. (Inherited from Object.) | |
GetType | Gets the Type of the current instance. (Inherited from Object.) | |
Initialize |
- Initializes the plug-in at the start of the build process.
- | |
ToString | Returns a string that represents the current object. (Inherited from Object.) |
LatexProcessor Methods |
The LatexProcessor type exposes the following members.
- - | Name | Description |
---|---|---|
Arguments |
- Returns the process arguments for the specified file.
- (Overrides FileProcessorArguments(String, String).) | |
Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) | |
Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) | |
GetHashCode | Serves as the default hash function. (Inherited from Object.) | |
GetType | Gets the Type of the current instance. (Inherited from Object.) | |
MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) | |
Run(String) |
- Runs the processor on the specified file.
- (Inherited from FileProcessor.) | |
Run(String, String) |
- Runs the processor on the specified file applying
- command-line arguments specific to that file.
- (Inherited from FileProcessor.) | |
ToString | Returns a string that represents the current object. (Inherited from Object.) |
VS2010WithLatex Methods |
The VS2010WithLatex type exposes the following members.
- - | Name | Description |
---|---|---|
CheckForErrors |
- This is used to check the presentation style for errors
- (Inherited from PresentationStyleSettings.) | |
CopyHelpContent |
- This is used to copy the presentation style help file content to the given destination folder
- (Inherited from PresentationStyleSettings.) | |
Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) | |
GetHashCode | Serves as the default hash function. (Inherited from Object.) | |
GetType | Gets the Type of the current instance. (Inherited from Object.) | |
ResolvePath |
- This is used to resolve a presentation style path
- (Inherited from PresentationStyleSettings.) | |
ToString | Returns a string that represents the current object. (Inherited from Object.) |
VS2013WithLatex Methods |
The VS2013WithLatex type exposes the following members.
- - | Name | Description |
---|---|---|
CheckForErrors |
- This is used to check the presentation style for errors
- (Inherited from PresentationStyleSettings.) | |
CopyHelpContent |
- This is used to copy the presentation style help file content to the given destination folder
- (Inherited from PresentationStyleSettings.) | |
Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) | |
GetHashCode | Serves as the default hash function. (Inherited from Object.) | |
GetType | Gets the Type of the current instance. (Inherited from Object.) | |
ResolvePath |
- This is used to resolve a presentation style path
- (Inherited from PresentationStyleSettings.) | |
ToString | Returns a string that represents the current object. (Inherited from Object.) |
IntegerArrayOperation Methods |
The IntegerArrayOperation type exposes the following members.
- - | Name | Description |
---|---|---|
Operate |
+ Novacta.Shfb.LatexTools Documentation Integer |
IntegerOperation Methods |
The IntegerOperation type exposes the following members.
- - | Name | Description |
---|---|---|
Operate |
+ Novacta.Shfb.LatexTools Documentation Integer |
Novacta.Shfb.LatexTools Namespace |
- - | Class | Description |
---|---|---|
DviPngProcessor |
- Represents a DviPng process.
- | |
DviSvgmProcessor |
- Represents a DviSvgm process.
- | |
FileProcessor |
- Represents a process that supports file elaborations.
- | |
LatexComponent |
- Provides support for LaTeX formatted formulas in
- reference XML comments and conceptual content topics.
- | |
LatexComponentFactory |
- Provides a factory method to create LatexComponent instances.
- | |
LatexPlugIn |
- Provides support in MS Help Viewer files for LaTeX content
- represented via the SVG image format.
- | |
LatexProcessor |
- Represents a LaTeX process.
- |
Novacta.Shfb.LatexTools.PresentationStyles Namespace |
- - | Class | Description |
---|---|---|
VS2010WithLatex |
- Represents a VS2010-based presentation style that supports
- LaTeX formatted formulas in reference XML comments and conceptual content topics.
- | |
VS2013WithLatex |
- Represents a VS2013-based presentation style that supports
- LaTeX formatted formulas in reference XML comments and conceptual content topics.
- |
SampleClassLibrary Namespace |
- - | Class | Description | ||
---|---|---|---|---|
IntegerOperation |
+ Novacta.Shfb.LatexTools Documentation Sample |
IntegerOperation | Provides a method to operate on integers. - |
SampleClassLibrary.Advanced Namespace |
- - | Class | Description | ||
---|---|---|---|---|
IntegerArrayOperation |
+ Novacta.Shfb.LatexTools Documentation Sample |
IntegerArrayOperation | Provides a method to operate on arrays of integers. - |
FileProcessorRun Method |
- - | Name | Description |
---|---|---|
Run(String) |
- Runs the processor on the specified file.
- | |
Run(String, String) |
- Runs the processor on the specified file applying
- command-line arguments specific to that file.
- |
DviPngProcessorExecutable Property |
- Namespace: - Novacta.Shfb.LatexTools
public override string Executable { get; }
DviPngProcessorWorkingDirectory Property |
- Namespace: - Novacta.Shfb.LatexTools
public override string WorkingDirectory { get; }
DviSvgmProcessorExecutable Property |
- Namespace: - Novacta.Shfb.LatexTools
public override string Executable { get; }
DviSvgmProcessorWorkingDirectory Property |
- Namespace: - Novacta.Shfb.LatexTools
public override string WorkingDirectory { get; }
FileProcessorExecutable Property |
- Namespace: - Novacta.Shfb.LatexTools
public abstract string Executable { get; }
FileProcessorWorkingDirectory Property |
- Namespace: - Novacta.Shfb.LatexTools
public abstract string WorkingDirectory { get; }
LatexComponentFactoryDefaultConfiguration Property |
- Namespace: - Novacta.Shfb.LatexTools
public override string DefaultConfiguration { get; }
LatexPlugInExecutionPoints Property |
- Namespace: - Novacta.Shfb.LatexTools
public IEnumerable<ExecutionPoint> ExecutionPoints { get; }
LatexProcessorExecutable Property |
- Namespace: - Novacta.Shfb.LatexTools
public override string Executable { get; }
LatexProcessorWorkingDirectory Property |
- Namespace: - Novacta.Shfb.LatexTools
public override string WorkingDirectory { get; }
VS2010WithLatexLocation Property |
- Namespace: - Novacta.Shfb.LatexTools.PresentationStyles
public override string Location { get; }
VS2013WithLatexLocation Property |
- Namespace: - Novacta.Shfb.LatexTools.PresentationStyles
public override string Location { get; }
The URL might be misspelled or the page you are looking for is no longer available. If you entered -the web address, check that it doesn't contain a typo. You can use the search box at the top of the page to -try and locate the page.
-DviPngProcessor Properties |
The DviPngProcessor type exposes the following members.
- - | Name | Description |
---|---|---|
Executable |
- Gets the path of the processor.
- (Overrides FileProcessorExecutable.) | |
WorkingDirectory |
- Gets the working directory of the processor.
- (Overrides FileProcessorWorkingDirectory.) |
DviSvgmProcessor Properties |
The DviSvgmProcessor type exposes the following members.
- - | Name | Description |
---|---|---|
Executable |
- Gets the path of the processor.
- (Overrides FileProcessorExecutable.) | |
WorkingDirectory |
- Gets the working directory of the processor.
- (Overrides FileProcessorWorkingDirectory.) |
FileProcessor Properties |
The FileProcessor type exposes the following members.
- - | Name | Description |
---|---|---|
Executable |
- Gets the path of the processor.
- | |
WorkingDirectory |
- Gets the working directory of the processor.
- |
LatexComponent Properties |
The LatexComponent type exposes the following members.
- - | Name | Description |
---|---|---|
BuildAssembler |
- This read-only property returns a reference to the build assembler instance using the component
- (Inherited from BuildComponentCore.) | |
GroupId |
- This is used to set an optional group ID for use with component events
- (Inherited from BuildComponentCore.) |
Factory Properties |
The LatexComponentFactory type exposes the following members.
- - | Name | Description |
---|---|---|
ConceptualBuildPlacement |
- This is used to get or set a placement action for conceptual content builds
- (Inherited from BuildComponentFactory.) | |
DefaultConfiguration |
- This read-only property can be overridden to define a default configuration for the build component
- (Overrides BuildComponentFactory.DefaultConfiguration.) | |
Dependencies |
- This read-only property can be overridden to provide a list of build components on which this
- component depends.
- (Inherited from BuildComponentFactory.) | |
ReferenceBuildPlacement |
- This is used to get or set a placement action for reference content builds
- (Inherited from BuildComponentFactory.) |
LatexPlugIn Properties |
The LatexPlugIn type exposes the following members.
- - | Name | Description |
---|---|---|
ExecutionPoints |
- Returns a collection of execution points that define
- when the plug-in should be invoked during the build process.
- |
LatexProcessor Properties |
The LatexProcessor type exposes the following members.
- - | Name | Description |
---|---|---|
Executable |
- Gets the path of the processor.
- (Overrides FileProcessorExecutable.) | |
WorkingDirectory |
- Gets the working directory of the processor.
- (Overrides FileProcessorWorkingDirectory.) |
VS2010WithLatex Properties |
The VS2010WithLatex type exposes the following members.
- - | Name | Description |
---|---|---|
ApiTableOfContentsGenerator |
- This is used to get or set the table of content generator for API content
- (Inherited from PresentationStyleSettings.) | |
BasePath |
- This is used to get or set the presentation style base path used to resolve relative paths within the
- presentation style.
- (Inherited from PresentationStyleSettings.) | |
BuildAssemblerConfiguration |
- This is used to get or set the BuildAssembler configuration filename
- (Inherited from PresentationStyleSettings.) | |
ContentFiles |
- This read-only property returns the list of help content file locations
- (Inherited from PresentationStyleSettings.) | |
DocumentModelApplicator |
- This is used to get or set the document model applicator
- (Inherited from PresentationStyleSettings.) | |
Location |
- This is overridden in derived classes to provide the location of the presentation style files
- (Overrides PresentationStyleSettings.Location.) | |
PlugInDependencies |
- This read-only property returns any plug-in dependencies required by the presentation style
- (Inherited from PresentationStyleSettings.) | |
ResourceItemsPath |
- This is used to get or set the path in which BuildAssembler resource item files are stored
- (Inherited from PresentationStyleSettings.) | |
SupportedFormats |
- This is used to get or set the help file formats supported by the presentation style
- (Inherited from PresentationStyleSettings.) | |
SupportsCodeSnippetGrouping |
- This is used to get or set whether or not code snippet grouping is supported by the presentation
- style.
- (Inherited from PresentationStyleSettings.) | |
SupportsNamespaceGrouping |
- This is used to get or set whether or not namespace grouping is supported by the presentation style
- (Inherited from PresentationStyleSettings.) | |
ToolResourceItemsPath |
- This is used to get or set the path in which help file builder resource item files are stored
- (Inherited from PresentationStyleSettings.) | |
TransformComponentArguments |
- This read-only property returns the transform component arguments if any
- (Inherited from PresentationStyleSettings.) |
VS2013WithLatex Properties |
The VS2013WithLatex type exposes the following members.
- - | Name | Description |
---|---|---|
ApiTableOfContentsGenerator |
- This is used to get or set the table of content generator for API content
- (Inherited from PresentationStyleSettings.) | |
BasePath |
- This is used to get or set the presentation style base path used to resolve relative paths within the
- presentation style.
- (Inherited from PresentationStyleSettings.) | |
BuildAssemblerConfiguration |
- This is used to get or set the BuildAssembler configuration filename
- (Inherited from PresentationStyleSettings.) | |
ContentFiles |
- This read-only property returns the list of help content file locations
- (Inherited from PresentationStyleSettings.) | |
DocumentModelApplicator |
- This is used to get or set the document model applicator
- (Inherited from PresentationStyleSettings.) | |
Location |
- This is overridden in derived classes to provide the location of the presentation style files
- (Overrides PresentationStyleSettings.Location.) | |
PlugInDependencies |
- This read-only property returns any plug-in dependencies required by the presentation style
- (Inherited from PresentationStyleSettings.) | |
ResourceItemsPath |
- This is used to get or set the path in which BuildAssembler resource item files are stored
- (Inherited from PresentationStyleSettings.) | |
SupportedFormats |
- This is used to get or set the help file formats supported by the presentation style
- (Inherited from PresentationStyleSettings.) | |
SupportsCodeSnippetGrouping |
- This is used to get or set whether or not code snippet grouping is supported by the presentation
- style.
- (Inherited from PresentationStyleSettings.) | |
SupportsNamespaceGrouping |
- This is used to get or set whether or not namespace grouping is supported by the presentation style
- (Inherited from PresentationStyleSettings.) | |
ToolResourceItemsPath |
- This is used to get or set the path in which help file builder resource item files are stored
- (Inherited from PresentationStyleSettings.) | |
TransformComponentArguments |
- This read-only property returns the transform component arguments if any
- (Inherited from PresentationStyleSettings.) |
DviPngProcessor Class |
- Namespace: - Novacta.Shfb.LatexTools
public class DviPngProcessor : FileProcessor
The DviPngProcessor type exposes the following members.
- - | Name | Description |
---|---|---|
DviPngProcessor |
- Initializes a new instance of the DviPngProcessor class.
- |
- - | Name | Description |
---|---|---|
Executable |
- Gets the path of the processor.
- (Overrides FileProcessorExecutable.) | |
WorkingDirectory |
- Gets the working directory of the processor.
- (Overrides FileProcessorWorkingDirectory.) |
- - | Name | Description |
---|---|---|
Arguments |
- Returns the process arguments for the specified file.
- (Overrides FileProcessorArguments(String, String).) | |
Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) | |
Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) | |
GetHashCode | Serves as the default hash function. (Inherited from Object.) | |
GetType | Gets the Type of the current instance. (Inherited from Object.) | |
MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) | |
Run(String) |
- Runs the processor on the specified file.
- (Inherited from FileProcessor.) | |
Run(String, String) |
- Runs the processor on the specified file applying
- command-line arguments specific to that file.
- (Inherited from FileProcessor.) | |
ToString | Returns a string that represents the current object. (Inherited from Object.) |
DviSvgmProcessor Class |
- Namespace: - Novacta.Shfb.LatexTools
public class DviSvgmProcessor : FileProcessor
The DviSvgmProcessor type exposes the following members.
- - | Name | Description |
---|---|---|
DviSvgmProcessor |
- Initializes a new instance of the DviSvgmProcessor class.
- |
- - | Name | Description |
---|---|---|
Executable |
- Gets the path of the processor.
- (Overrides FileProcessorExecutable.) | |
WorkingDirectory |
- Gets the working directory of the processor.
- (Overrides FileProcessorWorkingDirectory.) |
- - | Name | Description |
---|---|---|
Arguments |
- Returns the process arguments for the specified file.
- (Overrides FileProcessorArguments(String, String).) | |
Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) | |
Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) | |
GetHashCode | Serves as the default hash function. (Inherited from Object.) | |
GetType | Gets the Type of the current instance. (Inherited from Object.) | |
MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) | |
Run(String) |
- Runs the processor on the specified file.
- (Inherited from FileProcessor.) | |
Run(String, String) |
- Runs the processor on the specified file applying
- command-line arguments specific to that file.
- (Inherited from FileProcessor.) | |
ToString | Returns a string that represents the current object. (Inherited from Object.) |
FileProcessor Class |
- Namespace: - Novacta.Shfb.LatexTools
public abstract class FileProcessor
The FileProcessor type exposes the following members.
- - | Name | Description |
---|---|---|
FileProcessor | Initializes a new instance of the FileProcessor class |
- - | Name | Description |
---|---|---|
Executable |
- Gets the path of the processor.
- | |
WorkingDirectory |
- Gets the working directory of the processor.
- |
- - | Name | Description |
---|---|---|
Arguments |
- Returns the process arguments for the specified file.
- | |
Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) | |
Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) | |
GetHashCode | Serves as the default hash function. (Inherited from Object.) | |
GetType | Gets the Type of the current instance. (Inherited from Object.) | |
MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) | |
Run(String) |
- Runs the processor on the specified file.
- | |
Run(String, String) |
- Runs the processor on the specified file applying
- command-line arguments specific to that file.
- | |
ToString | Returns a string that represents the current object. (Inherited from Object.) |
LatexComponent Class |
- Namespace: - Novacta.Shfb.LatexTools
public class LatexComponent : BuildComponentCore
The LatexComponent type exposes the following members.
- - | Name | Description |
---|---|---|
LatexComponent |
- Initializes a new instance of the LatexComponent class
- with the specified build assembler.
- |
- - | Name | Description |
---|---|---|
BuildAssembler |
- This read-only property returns a reference to the build assembler instance using the component
- (Inherited from BuildComponentCore.) | |
GroupId |
- This is used to set an optional group ID for use with component events
- (Inherited from BuildComponentCore.) |
- - | Name | Description |
---|---|---|
Apply |
- Performs the component tasks.
- (Overrides BuildComponentCore.Apply(XmlDocument, String).) | |
Dispose |
- This implements the Dispose() interface to properly dispose of the build component.
- (Inherited from BuildComponentCore.) | |
Dispose(Boolean) |
- This can be overridden by derived classes to add their own disposal code if necessary.
- (Inherited from BuildComponentCore.) | |
Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) | |
Finalize |
- This handles garbage collection to ensure proper disposal of the build component if not done
- explicitly with Dispose.
- (Inherited from BuildComponentCore.) | |
GetHashCode | Serves as the default hash function. (Inherited from Object.) | |
GetType | Gets the Type of the current instance. (Inherited from Object.) | |
Initialize |
- Initializes the build component.
- (Overrides BuildComponentCore.Initialize(XPathNavigator).) | |
MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) | |
OnComponentEvent |
- This can be used to raise the ComponentEvent
- event with the specified event arguments.
- (Inherited from BuildComponentCore.) | |
ToString | Returns a string that represents the current object. (Inherited from Object.) | |
WriteMessage(MessageLevel, String, Object) |
- This can be used to report a message
- (Inherited from BuildComponentCore.) | |
WriteMessage(String, MessageLevel, String, Object) |
- This can be used to report a message for a specific topic ID
- (Inherited from BuildComponentCore.) |
LatexComponentFactory Class |
- Namespace: - Novacta.Shfb.LatexTools
public sealed class Factory : BuildComponentFactory
The LatexComponentFactory type exposes the following members.
- - | Name | Description |
---|---|---|
LatexComponentFactory |
- Initializes a new instance of the LatexComponentFactory class.
- |
- - | Name | Description |
---|---|---|
ConceptualBuildPlacement |
- This is used to get or set a placement action for conceptual content builds
- (Inherited from BuildComponentFactory.) | |
DefaultConfiguration |
- This read-only property can be overridden to define a default configuration for the build component
- (Overrides BuildComponentFactory.DefaultConfiguration.) | |
Dependencies |
- This read-only property can be overridden to provide a list of build components on which this
- component depends.
- (Inherited from BuildComponentFactory.) | |
ReferenceBuildPlacement |
- This is used to get or set a placement action for reference content builds
- (Inherited from BuildComponentFactory.) |
- - | Name | Description |
---|---|---|
Create |
- This is implemented to provide a build component factory
- (Overrides BuildComponentFactory.Create.) | |
Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) | |
GetHashCode | Serves as the default hash function. (Inherited from Object.) | |
GetType | Gets the Type of the current instance. (Inherited from Object.) | |
ToString | Returns a string that represents the current object. (Inherited from Object.) |
LatexPlugIn Class |
- Namespace: - Novacta.Shfb.LatexTools
public sealed class LatexPlugIn : IPlugIn, - IDisposable
The LatexPlugIn type exposes the following members.
- - | Name | Description |
---|---|---|
LatexPlugIn | Initializes a new instance of the LatexPlugIn class |
- - | Name | Description |
---|---|---|
ExecutionPoints |
- Returns a collection of execution points that define
- when the plug-in should be invoked during the build process.
- |
- - | Name | Description |
---|---|---|
Dispose |
- Performs application-defined tasks associated with freeing,
- releasing, or resetting unmanaged resources.
- | |
Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) | |
Execute |
- Executes the plug-in during the build process.
- | |
Finalize |
- Allows this instance to try to free resources and perform other
- cleanup operations before it is reclaimed by garbage collection.
- (Overrides ObjectFinalize.) | |
GetHashCode | Serves as the default hash function. (Inherited from Object.) | |
GetType | Gets the Type of the current instance. (Inherited from Object.) | |
Initialize |
- Initializes the plug-in at the start of the build process.
- | |
ToString | Returns a string that represents the current object. (Inherited from Object.) |
LatexProcessor Class |
- Namespace: - Novacta.Shfb.LatexTools
public class LatexProcessor : FileProcessor
The LatexProcessor type exposes the following members.
- - | Name | Description |
---|---|---|
LatexProcessor |
- Initializes a new instance of the LatexProcessor class.
- |
- - | Name | Description |
---|---|---|
Executable |
- Gets the path of the processor.
- (Overrides FileProcessorExecutable.) | |
WorkingDirectory |
- Gets the working directory of the processor.
- (Overrides FileProcessorWorkingDirectory.) |
- - | Name | Description |
---|---|---|
Arguments |
- Returns the process arguments for the specified file.
- (Overrides FileProcessorArguments(String, String).) | |
Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) | |
Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) | |
GetHashCode | Serves as the default hash function. (Inherited from Object.) | |
GetType | Gets the Type of the current instance. (Inherited from Object.) | |
MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) | |
Run(String) |
- Runs the processor on the specified file.
- (Inherited from FileProcessor.) | |
Run(String, String) |
- Runs the processor on the specified file applying
- command-line arguments specific to that file.
- (Inherited from FileProcessor.) | |
ToString | Returns a string that represents the current object. (Inherited from Object.) |
VS2010WithLatex Class |
- Namespace: - Novacta.Shfb.LatexTools.PresentationStyles
public sealed class VS2010WithLatex : PresentationStyleSettings
The VS2010WithLatex type exposes the following members.
- - | Name | Description |
---|---|---|
VS2010WithLatex |
- Initializes a new instance of the VS2010WithLatex class.
- |
- - | Name | Description |
---|---|---|
ApiTableOfContentsGenerator |
- This is used to get or set the table of content generator for API content
- (Inherited from PresentationStyleSettings.) | |
BasePath |
- This is used to get or set the presentation style base path used to resolve relative paths within the
- presentation style.
- (Inherited from PresentationStyleSettings.) | |
BuildAssemblerConfiguration |
- This is used to get or set the BuildAssembler configuration filename
- (Inherited from PresentationStyleSettings.) | |
ContentFiles |
- This read-only property returns the list of help content file locations
- (Inherited from PresentationStyleSettings.) | |
DocumentModelApplicator |
- This is used to get or set the document model applicator
- (Inherited from PresentationStyleSettings.) | |
Location |
- This is overridden in derived classes to provide the location of the presentation style files
- (Overrides PresentationStyleSettings.Location.) | |
PlugInDependencies |
- This read-only property returns any plug-in dependencies required by the presentation style
- (Inherited from PresentationStyleSettings.) | |
ResourceItemsPath |
- This is used to get or set the path in which BuildAssembler resource item files are stored
- (Inherited from PresentationStyleSettings.) | |
SupportedFormats |
- This is used to get or set the help file formats supported by the presentation style
- (Inherited from PresentationStyleSettings.) | |
SupportsCodeSnippetGrouping |
- This is used to get or set whether or not code snippet grouping is supported by the presentation
- style.
- (Inherited from PresentationStyleSettings.) | |
SupportsNamespaceGrouping |
- This is used to get or set whether or not namespace grouping is supported by the presentation style
- (Inherited from PresentationStyleSettings.) | |
ToolResourceItemsPath |
- This is used to get or set the path in which help file builder resource item files are stored
- (Inherited from PresentationStyleSettings.) | |
TransformComponentArguments |
- This read-only property returns the transform component arguments if any
- (Inherited from PresentationStyleSettings.) |
- - | Name | Description |
---|---|---|
CheckForErrors |
- This is used to check the presentation style for errors
- (Inherited from PresentationStyleSettings.) | |
CopyHelpContent |
- This is used to copy the presentation style help file content to the given destination folder
- (Inherited from PresentationStyleSettings.) | |
Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) | |
GetHashCode | Serves as the default hash function. (Inherited from Object.) | |
GetType | Gets the Type of the current instance. (Inherited from Object.) | |
ResolvePath |
- This is used to resolve a presentation style path
- (Inherited from PresentationStyleSettings.) | |
ToString | Returns a string that represents the current object. (Inherited from Object.) |
VS2013WithLatex Class |
- Namespace: - Novacta.Shfb.LatexTools.PresentationStyles
public sealed class VS2013WithLatex : PresentationStyleSettings
The VS2013WithLatex type exposes the following members.
- - | Name | Description |
---|---|---|
VS2013WithLatex |
- Initializes a new instance of the VS2013WithLatex class.
- |
- - | Name | Description |
---|---|---|
ApiTableOfContentsGenerator |
- This is used to get or set the table of content generator for API content
- (Inherited from PresentationStyleSettings.) | |
BasePath |
- This is used to get or set the presentation style base path used to resolve relative paths within the
- presentation style.
- (Inherited from PresentationStyleSettings.) | |
BuildAssemblerConfiguration |
- This is used to get or set the BuildAssembler configuration filename
- (Inherited from PresentationStyleSettings.) | |
ContentFiles |
- This read-only property returns the list of help content file locations
- (Inherited from PresentationStyleSettings.) | |
DocumentModelApplicator |
- This is used to get or set the document model applicator
- (Inherited from PresentationStyleSettings.) | |
Location |
- This is overridden in derived classes to provide the location of the presentation style files
- (Overrides PresentationStyleSettings.Location.) | |
PlugInDependencies |
- This read-only property returns any plug-in dependencies required by the presentation style
- (Inherited from PresentationStyleSettings.) | |
ResourceItemsPath |
- This is used to get or set the path in which BuildAssembler resource item files are stored
- (Inherited from PresentationStyleSettings.) | |
SupportedFormats |
- This is used to get or set the help file formats supported by the presentation style
- (Inherited from PresentationStyleSettings.) | |
SupportsCodeSnippetGrouping |
- This is used to get or set whether or not code snippet grouping is supported by the presentation
- style.
- (Inherited from PresentationStyleSettings.) | |
SupportsNamespaceGrouping |
- This is used to get or set whether or not namespace grouping is supported by the presentation style
- (Inherited from PresentationStyleSettings.) | |
ToolResourceItemsPath |
- This is used to get or set the path in which help file builder resource item files are stored
- (Inherited from PresentationStyleSettings.) | |
TransformComponentArguments |
- This read-only property returns the transform component arguments if any
- (Inherited from PresentationStyleSettings.) |
- - | Name | Description |
---|---|---|
CheckForErrors |
- This is used to check the presentation style for errors
- (Inherited from PresentationStyleSettings.) | |
CopyHelpContent |
- This is used to copy the presentation style help file content to the given destination folder
- (Inherited from PresentationStyleSettings.) | |
Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) | |
GetHashCode | Serves as the default hash function. (Inherited from Object.) | |
GetType | Gets the Type of the current instance. (Inherited from Object.) | |
ResolvePath |
- This is used to resolve a presentation style path
- (Inherited from PresentationStyleSettings.) | |
ToString | Returns a string that represents the current object. (Inherited from Object.) |
IntegerArrayOperation Class |
- Namespace: - SampleClassLibrary.Advanced
public static class IntegerArrayOperation
The IntegerArrayOperation type exposes the following members.
- - | Name | Description |
---|---|---|
Operate |
+ DefinitionNamespace: SampleClassLibrary.Advanced Assembly: SampleClassLibrary (in SampleClassLibrary.dll) Version: 1.0.0+047146f69ce826e7c039a4ea23475129ef4a7285 C#
VB
C++
F#
MethodsSee Also
\ No newline at end of file
+ |
IntegerOperation Class |
- Namespace: - SampleClassLibrary
public static class IntegerOperation
The IntegerOperation type exposes the following members.
- - | Name | Description |
---|---|---|
Operate |
+ DefinitionNamespace: SampleClassLibrary Assembly: SampleClassLibrary (in SampleClassLibrary.dll) Version: 1.0.0+047146f69ce826e7c039a4ea23475129ef4a7285 C#
VB
C++
F#
MethodsSee Also Reference |
Operating on integers |
- Class IntegerOperation provides method - Operate - to manage operations on integer values. -
- In the following example, an integer is squared - executing the Operate method. - This is equivalent to define the applied function, - say - as - In addition, input validation is also checked. -
using System; -namespace SampleClassLibrary.CodeExamples -{ - public class IntegerOperationExample - { - public void Main() - { - // Define an operator that squares its operand - Func<int, int> square = (int operand) => operand * operand; - - // Define an operand - int integer = 2; - - // Operate on it - Console.WriteLine("Squaring {0}...", integer); - int result = IntegerOperation.Operate(square, integer); - Console.WriteLine("...the result is {0}.", result); - - // Check that an operator cannot be null - try - { - IntegerOperation.Operate(null, 0); - } - catch (Exception e) - { - Console.WriteLine(); - Console.WriteLine("Cannot apply a null function:"); - Console.WriteLine(e.Message); - } - } - } -} - -// Executing method Main() produces the following output: -// -// Squaring 2... -// ...the result is 4. -// -// Cannot apply a null function: -// Value cannot be null. -// Parameter name: func
Install a supported version of SHFB
+ Version 1.0.0 of the + LatexTools + targets SHFB, versions 2021.10.23.0 to 2022.2.6.0. +
+ Make sure that a supported SHFB version of your choice + is currently installed on your host machine. +
+ You can download the required SHFB release + here. + Notice that version 1.0.0 requires packages + amsmath, + amsfonts, and + preview. +
Install a full LaTeX distribution
+ You need a full TeX distribution installed on your host machine. + + You can find a list of TeX implementations + here. +
Create a SHFB documentation project
+ Documentation projects can be created via the + SHFB standalone GUI, + or via the + SHFB Visual Studio package. +
Add the Latex Tools to the SHFB documentation project
+ Right click on node Component Packages of your project + and, from the contextual menu, select Manage Component Packages... + (if your are using the SHFB standalone GUI), or + Manage NuGet Packages... (if you are + inside Visual Studio). Hence search package + Novacta.Shfb.LatexTools and install it. +
+ This way, a reference to + the Novacta.Shfb.LatexTools + NuGet package will be added to your documentation project, and the following + SHFB extensions will be available while processing help files. +
+ The Novacta.Shfb.LatexComponent + enables the representation of LaTeX equations + as images in SHFB documentation topics. + Supported image formats are + PNG and + SVG. +
+ The Novacta.Shfb.LatexPlugIn + supports the SVG + image file format for the MSHelpViewer + help output. +
+ The presentation styles + VS2010 + Latex and + VS2013 + Latex, which add the + ability to manage LaTeX content to styles + VS2010 and + VS2013, respectively. +
Selecting a LaTeX-aware presentation style
+ To select a presentation style able to manage LaTeX content, open + the project properties and click on the + Build tab. From the list + of available presentation styles, select the one + of your choice among those defined + as VS2010 + LaTeX or + VS2010 + LaTeX. + For example, the following figure shows a project + in which the + VS2013 + LaTeX style + has been selected. +
Adding and configuring the LatexComponent
+ The + + Novacta.Shfb.LatexComponent + + must be added to a documentation project + in order to manage LaTeX content in documentation topics. +
+ To such purpose, open the project properties and click on the + Components tab. From the list + of available components, select the one + referred to as + Novacta.Shfb.LatexComponent + and click the Add button. + Now the Latex component is inserted in the list of the + components executed during + the build process of the documentation project. + Such list is showed on the right side + of the tab, as exemplified in the following figure. +
+ Once the LaTeX component has been committed for execution, + it must be configured. By clicking the + Configure button, the following + pop-up window will be displayed. +
+ Through that window, configuration options can be set as follows. +
Option | Description |
---|---|
+ Image file format + | + Through this option, one of the + image formats supported for LaTeX + content representation can be selected. + |
+ Image depth correction + | + When a LaTeX element is in-lined, + then the corresponding image depth, i.e. the distance of the + bottom of the image from its baseline, must be modified in + order for the text represented in the image to have the same + baseline of the surrounding text. + + The initial image depth is returned by the DviPng executable of + the LaTeX distribution. Then, the difference between such value and + that set for the Image Depth Correction option + is taken as the final image depth. + By default, the Image Depth Correction option + is set to 0, + a value that works well for the default text size. + + Such behavior can be overridden for each specific equation, + as discussed in the following section. + |
+ Image scale percentage + | + This option controls the size of the text in a LaTeX equation. + The default value is 100, + and is equivalent to apply the \normalsize + text sizing LaTeX command while adopting + 10pt as the size of the main font in the document. + Values other than + 100 modify the size, + but negative values are not allowed. + + Such behavior can be overridden for each specific equation, + as discussed in the following section. + |
+ Redirect file processors + | + If checked, this option enables the redirection of + LaTeX console outputs to the SHFB + Help Build Log Content. + |
+ Default LaTeX Mode + | + This option controls if a LaTeX equation must be interpreted, + by default, as entered in inline mode, or + in display mode. + The default configuration sets this option + to display. + + Such behavior can be overridden for each specific equation, + as discussed in the following section. + |
+ Additional Preamble Commands + | + If needed, this option enables the addition of specific + commands to the preamble + of the documents processed to get the + LaTeX equations required in the documentation. + |
+ LaTeX bin folder + | + Through this option, you can specify the folder where + are contained the binary files of the installed + LaTeX distribution. + |
+ DviSvgm bin folder + | + Through this option, you can specify the folder where + are contained the binary files of + + DviSvgm, + a converter of DVI files to the SVG graphics format. + + The converter has been added to several LaTeX distributions. + If the installed distribution includes the tool, you can + specify here the same path set for option + LaTeX bin folder. + Otherwise, you can download the converter + here, + save it in a folder and set the option + accordingly. + + These binaries are only needed if you + select the SVG image file format. + |
The LatexPlugIn
+ The + + Novacta.Shfb.LatexPlugIn + + must be added to a documentation project + only if the project needs to support the SVG + image file format for the MSHelpViewer + help output. +
+ To do so, open the project properties and click on the + Plug-Ins tab. From the list + of available plug-ins, select the one + referred to as + Novacta.Shfb.LatexPlugIn + and click the Add button. + Now the Latex plug-in is inserted in the list of the + plug-ins executed during + the build process of the documentation project. + The plug-ins committed for execution are listed on the right side + of the tab, as exemplified in the following figure. +
+ LaTeX equations can be added to the XML comments on your + source code by inserting custom XML elements, referred + to as the LaTeX elements. +
+ The start-tag of such elements + is <latex>. + The basic form of a LaTeX element, + i.e. a form with no XML + attributes, is as follows. +
<latex>X_{(0)}=2^{-1/3}</latex>
+ When <latex> elements are + processed, + their content is interpreted as having document class + article, + with an option of + 10pt for the size of the + main font in the document, and the + \pagestyle set to + empty. You can also + assume as loaded packages + amsmath + and + amsfonts. + Also, package + preview + is loaded with options active, + textmath, and + displaymath enabled. +
+ When the default configuration + is active and the latex element is in basic form, then its content + is interpreted as inserted in a displayed mathematical + environment (separated by the main text), and sized + applying the \normalsize LaTeX command. +
+ Such behavior can be overridden by adding attributes + to the latex element or overriding the default configuration. +
+ If you want a LaTeX formula displayed in-line, + that is, within the body of text where it is declared, + you can add a mode attribute + having the "inline" value, as in the following + example. +
/// Let us assume that the random variable
+/// <latex mode="inline">Y_{i}</latex> has distribution function
+/// <latex mode="inline">F_{Y_{i}}</latex>.
+ If a LaTeX element has + no mode attribute, then its + mode is set, by default, according to the + + Default LaTeX mode + + configuration option. +
+ The Novacta.Shfb.LatexComponent + inserts images in help files + to represent your equations. + When + a LaTeX element is in-lined, + then the corresponding image + depth is, by default, set according to the + + Image depth correction + + configuration option. + However, the image depth for a given + LaTeX element + can be hard coded by adding a depth attribute, + as in the following example. +
<latex depth="10">F_{Y_{i}}</latex>
+ In a LaTeX element, + the size of the text is controlled, by default, + through the + + Image scale percentage + + configuration option. + However, the size of a given + LaTeX element can be + overridden by adding to it + a scale attribute. + For example, if you want its size being the + 70% of the basic size, you can write + a LaTeX element as follows. +
<latex scale="scriptsize">F_{Y_{i}}</latex>
+ More thoroughly, you can set the value of the + scale attribute + using any of the predefined values shown in the following table, + where the corresponding percentages are also reported. +
Predefined LaTeX size | Percentage | Example |
---|---|---|
+ tiny + | + 50 + | |
+ scriptsize + | + 70 + | |
+ footnotesize + | + 80 + | |
+ small + | + 90 + | |
+ normalsize + | + 100 + | |
+ large + | + 120 + | |
+ Large + | + 144 + | |
+ LARGE + | + 172.8 + | |
+ huge + | + 207.4 + | |
+ Huge + | + 248.8 + |
+ As an example, the following file printout shows the source code for + type + IntegerOperation, + as defined in project + SampleClassLibrary: +
1 +2 +3 +4 +5 +6 +7 +8 +9 +10 +11 +12 +13 +14 +15 +16 +17 +18 +19 +20 +21 +22 +23 +24 +25 +26 +27 +28 +29 +30 +31 +32 +33 +34 +35 +36 +37 +38 +39 +40 +41 +42 +43 +44 +45 +46 +47 +48 +49 +50 +51 +52 +53 +54 +55 +56 +57 +58 +59 +60 +61 +62 +63 +64 +65 +66 +67 +68 +69 +70 +71 +72 +73 +74 +75 +76 +77 +78 +79 +80 +81 +82 +83 +84
using System;
+
+namespace SampleClassLibrary
+{
+ /// <summary>
+ /// Provides a method to operate on integers.
+ /// </summary>
+ public static class IntegerOperation
+ {
+ /// <summary>
+ /// Applies the specified function to the given operand.
+ /// </summary>
+ /// <param name="func">The function.</param>
+ /// <param name="operand">The operand.</param>
+ /// <returns>The result of the operation.</returns>
+ /// <exception cref="ArgumentNullException">
+ /// <paramref name="func"/> is <b>null</b>.</exception>
+ /// <example>
+ /// <para>
+ /// In the following example, the applied function, say
+ /// <latex mode='inline'>f:\mathbb{N}\rightarrow \mathbb{N},</latex> is defined as
+ /// <latex mode='display'>
+ /// \forall n \in \mathbb{N}: n \mapsto f\left(n\right)=n^2.
+ /// </latex>
+ /// An integer is thus squared
+ /// executing the <see cref="Operate(Func{int, int}, int)"/> method.
+ /// In addition, input validation is also checked.
+ /// </para>
+ /// <para>
+ /// <code language="cs">
+ /// using System;
+ /// namespace SampleClassLibrary.CodeExamples
+ /// {
+ /// public class IntegerOperationExample
+ /// {
+ /// public void Main()
+ /// {
+ /// // Define an operator that squares its operand
+ /// Func<![CDATA[<]]>int, int> square = (int operand) => operand * operand;
+ ///
+ /// // Define an operand
+ /// int integer = 2;
+ ///
+ /// // Operate on it
+ /// Console.WriteLine("Squaring {0}...", integer);
+ /// int result = IntegerOperation.Operate(square, integer);
+ /// Console.WriteLine("...the result is {0}.", result);
+ ///
+ /// // Check that an operator cannot be null
+ /// try
+ /// {
+ /// IntegerOperation.Operate(null, 0);
+ /// }
+ /// catch (Exception e)
+ /// {
+ /// Console.WriteLine();
+ /// Console.WriteLine("Cannot apply a null function:");
+ /// Console.WriteLine(e.Message);
+ /// }
+ /// }
+ /// }
+ /// }
+ ///
+ /// // Executing method Main() produces the following output:
+ /// //
+ /// // Squaring 2...
+ /// // ...the result is 4.
+ /// //
+ /// // Cannot apply a null function:
+ /// // Value cannot be null.
+ /// // Parameter name: func
+ /// </code>
+ /// </para>
+ /// </example>
+ public static int Operate(Func<int, int> func, int operand)
+ {
+ if (func==null)
+ {
+ throw new ArgumentNullException(nameof(func));
+ }
+ return func(operand);
+ }
+ }
+}
+ Note the LaTeX elements at line 21-24 + in the XML comments on method + Operate. + You can check + here + how the + corresponding documentation looks like. +
+ Elements in + MAML + conceptual topics must be qualified using a namespace. + To qualify LaTeX elements, + add to the topic's document element a namespace attribute + associated with prefix ltx, + as shown in the following example. +
<topic id="303c996a-2911-4c08-b492-6496c82b3edb" revisionNumber="1">
+ <!-- This element name will change based on the document type -->
+ <developerConceptualDocument
+ xmlns="http://ddue.schemas.microsoft.com/authoring/2003/5"
+ xmlns:xlink="http://www.w3.org/1999/xlink"
+ xmlns:ltx="http://www.novacta.net/2018/XSL/ShfbLatexTools">
+
+ <!-- The content goes here -->
+
+ </developerConceptualDocument>
+</topic>
+ Now LaTeX elements can be added + by prefixing their tags with ltx, + as follows. +
<ltx:latex scale="LARGE" mode="inline">X_{(0)}</ltx:latex>
+ As an example, the following file printout shows the source code for + a conceptual topic about + IntegerOperation, + as defined in project + SampleClassLibrary: +
1 +2 +3 +4 +5 +6 +7 +8 +9 +10 +11 +12 +13 +14 +15 +16 +17 +18 +19 +20 +21 +22 +23 +24 +25 +26 +27 +28 +29 +30 +31 +32 +33 +34 +35 +36 +37
<?xml version="1.0" encoding="utf-8"?>
+<topic id="b10d4d75-3729-4247-a58a-b9e5b6e4bb4d" revisionNumber="1">
+ <developerConceptualDocument
+ xmlns="http://ddue.schemas.microsoft.com/authoring/2003/5"
+ xmlns:xlink="http://www.w3.org/1999/xlink"
+ xmlns:ltx="http://www.novacta.net/2018/XSL/ShfbLatexTools">
+
+ <introduction>
+ <para>
+ Class <codeEntityReference qualifyHint="false">
+ T:SampleClassLibrary.IntegerOperation
+ </codeEntityReference> provides method
+ <codeEntityReference qualifyHint="false">
+ M:SampleClassLibrary.IntegerOperation.Operate(System.Func{System.Int32,System.Int32},System.Int32)
+ </codeEntityReference>
+ to manage operations on integer values.
+ </para>
+ <para>
+ In the following example, an integer is squared
+ executing the <codeEntityReference qualifyHint="false">
+ M:SampleClassLibrary.IntegerOperation.Operate(System.Func{System.Int32,System.Int32},System.Int32)
+ </codeEntityReference> method.
+ This is equivalent to define the applied function,
+ say <ltx:latex mode="inline">f:\mathbb{N}\rightarrow \mathbb{N},</ltx:latex>
+ as <ltx:latex>\forall n \in \mathbb{N}: n \mapsto f\left(n\right)=n^2.</ltx:latex>
+ In addition, input validation is also checked.
+ </para>
+ <code source="..\SampleClassLibrary\IntegerOperationExample.cs.txt"
+ language="cs" title="C#" />
+ </introduction>
+
+ <relatedTopics>
+ <link xlink:href="4c3871a5-d7c6-477c-96ee-e71f0a67f7a8" />
+ </relatedTopics>
+
+ </developerConceptualDocument>
+</topic>
+ Note the LaTeX elements at lines 24-25. + You can check + here + how such conceptual topic looks like. +
Version 1.0.0 |
- Version 1.0.0 was released on November 15 2021. -
Initial release of the assembly.
Install a supported version of SHFB
+ Version 2.0.0 of the + LatexTools + targets SHFB, version 2021.8.14.0 or later. +
+ Make sure that a supported SHFB version of your choice + is currently installed on your host machine. +
+ You can download the required SHFB release + here. + Notice that version 2.0.0 requires package + preview. +
Install a full LaTeX distribution
+ You need a full TeX distribution installed on your host machine. + + You can find a list of TeX implementations + here. +
Create a SHFB documentation project
+ Documentation projects can be created via the + SHFB standalone GUI, + or via the + SHFB Visual Studio package. +
Add the Latex Tools to the SHFB documentation project
+ Right click on node Component Packages of your project + and, from the contextual menu, select Manage Component Packages... + (if your are using the SHFB standalone GUI), or + Manage NuGet Packages... (if you are + inside Visual Studio). Hence search package + Novacta.Shfb.LatexTools and install it. +
+ This way, a reference to + the Novacta.Shfb.LatexTools + NuGet package will be added to your documentation project, and the following + SHFB extensions will be available while processing help files. +
Selecting a presentation style
+ The LatexTools support the following SHFB + presentation styles: Default 2022, + Markdown Content, + Open XML Document, and + VS2013. Open + the project properties and click on the + Build tab. From the list + of available presentation styles, select the one + of your choice. +
Adding and configuring the LatexComponent
+ The + + Novacta LaTeX Component + + must be added to a documentation project + in order to manage LaTeX content in documentation topics. +
+ To such purpose, open the project properties and click on the + Components tab. From the list + of available components, select the one + referred to as + Novacta LaTeX Component + and click the Add button. + Now the Latex component is inserted in the list of the + components executed during + the build process of the documentation project. + Such list is showed on the right side + of the tab, as exemplified in the following figure. +
+ Once the LaTeX component has been committed for execution, + it must be configured. By clicking the + Configure button, the following + pop-up window will be displayed. +
+ Through that window, configuration options can be set as follows. +
Option | Description |
---|---|
+ Image file format + | + Through this option, one of the + image formats supported for LaTeX + content representation can be selected. + |
+ Image depth correction + | + When a LaTeX element is in-lined, + then the corresponding image depth, i.e. the distance of the + bottom of the image from its baseline, must be modified in + order for the text represented in the image to have the same + baseline of the surrounding text. + + The initial image depth is returned by the DviPng executable of + the LaTeX distribution. Then, the difference between such value and + that set for the Image Depth Correction option + is taken as the final image depth. + By default, the Image Depth Correction option + is set to 0, + a value that works well for the default text size. + + Such behavior can be overridden for each specific equation, + as discussed in the following section. + |
+ Image scale percentage + | + This option controls the size of the text in a LaTeX equation. + The default value is 100, + and is equivalent to apply the \normalsize + text sizing LaTeX command while adopting + 10pt as the size of the main font in the document. + Values other than + 100 modify the size, + but negative values are not allowed. + + Such behavior can be overridden for each specific equation, + as discussed in the following section. + |
+ Redirect file processors + | + If checked, this option enables the redirection of + LaTeX console outputs to the SHFB + Help Build Log Content. + |
+ Default LaTeX Mode + | + This option controls if a LaTeX equation must be interpreted, + by default, as entered in inline mode, or + in display mode. + The default configuration sets this option + to display. + + Such behavior can be overridden for each specific equation, + as discussed in the following section. + |
+ Additional Preamble Commands + | + If needed, this option enables the addition of specific + commands to the preamble + of the documents processed to get the + LaTeX equations required in the documentation. + |
+ LaTeX bin folder + | + Through this option, you can specify the folder where + are contained the binary files of the installed + LaTeX distribution. + |
Adding the LatexPlugIn
+ The + + Novacta LaTeX PlugIn + + must be added to a documentation project + in order to manage LaTeX content in documentation topics. +
+ To do so, open the project properties and click on the + Plug-Ins tab. From the list + of available plug-ins, select the one + referred to as + Novacta LaTeX PlugIn + and click the Add button. + Now the Latex plug-in is inserted in the list of the + plug-ins executed during + the build process of the documentation project. + The plug-ins committed for execution are listed on the right side + of the tab, as exemplified in the following figure. +
+ LaTeX equations can be added to the XML comments on your + source code by inserting custom XML elements, referred + to as the LaTeX elements. +
+ The start-tag of such elements + is <latex>. + The basic form of a LaTeX element, + i.e. a form with no XML + attributes, is as follows. +
<latex>X_{(0)}=2^{-1/3}</latex>
+ When <latex> elements are + processed, + their content is interpreted as having document class + article, + with an option of + 10pt for the size of the + main font in the document, and the + \pagestyle set to + empty. You can also + assume as loaded package + preview + with options active, + textmath, and + displaymath enabled. +
+ When the default configuration + is active and the latex element is in basic form, then its content + is interpreted as inserted in a displayed mathematical + environment (separated by the main text), and sized + applying the \normalsize LaTeX command. +
+ Such behavior can be overridden by adding attributes + to the latex element or overriding the default configuration. +
+ If you want a LaTeX formula displayed in-line, + that is, within the body of text where it is declared, + you can add a mode attribute + having the "inline" value, as in the following + example. +
/// Let us assume that the random variable
+/// <latex mode="inline">Y_{i}</latex> has distribution function
+/// <latex mode="inline">F_{Y_{i}}</latex>.
+ If a LaTeX element has + no mode attribute, then its + mode is set, by default, according to the + + Default LaTeX mode + + configuration option. +
+ The LatexTools + insert images in help files + to represent your equations. + When + a LaTeX element is in-lined, + then the corresponding image + depth is, by default, set according to the + + Image depth correction + + configuration option. + However, the image depth for a given + LaTeX element + can be hard coded by adding a depth attribute, + as in the following example. +
<latex depth="10">F_{Y_{i}}</latex>
+ In a LaTeX element, + the size of the text is controlled, by default, + through the + + Image scale percentage + + configuration option. + However, the size of a given + LaTeX element can be + overridden by adding to it + a scale attribute. + For example, if you want its size being the + 70% of the basic size, you can write + a LaTeX element as follows. +
<latex scale="scriptsize">F_{Y_{i}}</latex>
+ More thoroughly, you can set the value of the + scale attribute + using any of the predefined values shown in the following table, + where the corresponding percentages are also reported. +
Predefined LaTeX size | Percentage | Example |
---|---|---|
+ tiny + | + 50 + | |
+ scriptsize + | + 70 + | |
+ footnotesize + | + 80 + | |
+ small + | + 90 + | |
+ normalsize + | + 100 + | |
+ large + | + 120 + | |
+ Large + | + 144 + | |
+ LARGE + | + 172.8 + | |
+ huge + | + 207.4 + | |
+ Huge + | + 248.8 + |
+ As an example, the following file printout shows the source code for + type + IntegerOperation, + as defined in project + SampleClassLibrary: +
1 +2 +3 +4 +5 +6 +7 +8 +9 +10 +11 +12 +13 +14 +15 +16 +17 +18 +19 +20 +21 +22 +23 +24 +25 +26 +27 +28 +29 +30 +31 +32 +33 +34 +35 +36 +37 +38 +39 +40 +41 +42 +43 +44 +45 +46 +47 +48 +49 +50 +51 +52 +53 +54 +55 +56 +57 +58 +59 +60 +61 +62 +63 +64 +65 +66 +67 +68 +69 +70 +71 +72 +73 +74 +75 +76 +77 +78 +79 +80 +81 +82 +83 +84
using System;
+
+namespace SampleClassLibrary
+{
+ /// <summary>
+ /// Provides a method to operate on integers.
+ /// </summary>
+ public static class IntegerOperation
+ {
+ /// <summary>
+ /// Applies the specified function to the given operand.
+ /// </summary>
+ /// <param name="func">The function.</param>
+ /// <param name="operand">The operand.</param>
+ /// <returns>The result of the operation.</returns>
+ /// <exception cref="ArgumentNullException">
+ /// <paramref name="func"/> is <b>null</b>.</exception>
+ /// <example>
+ /// <para>
+ /// In the following example, the applied function, say
+ /// <latex mode='inline'>f:\mathbb{N}\rightarrow \mathbb{N},</latex> is defined as
+ /// <latex mode='display'>
+ /// \forall n \in \mathbb{N}: n \mapsto f\left(n\right)=n^2.
+ /// </latex>
+ /// An integer is thus squared
+ /// executing the <see cref="Operate(Func{int, int}, int)"/> method.
+ /// In addition, input validation is also checked.
+ /// </para>
+ /// <para>
+ /// <code language="cs">
+ /// using System;
+ /// namespace SampleClassLibrary.CodeExamples
+ /// {
+ /// public class IntegerOperationExample
+ /// {
+ /// public void Main()
+ /// {
+ /// // Define an operator that squares its operand
+ /// Func<![CDATA[<]]>int, int> square = (int operand) => operand * operand;
+ ///
+ /// // Define an operand
+ /// int integer = 2;
+ ///
+ /// // Operate on it
+ /// Console.WriteLine("Squaring {0}...", integer);
+ /// int result = IntegerOperation.Operate(square, integer);
+ /// Console.WriteLine("...the result is {0}.", result);
+ ///
+ /// // Check that an operator cannot be null
+ /// try
+ /// {
+ /// IntegerOperation.Operate(null, 0);
+ /// }
+ /// catch (Exception e)
+ /// {
+ /// Console.WriteLine();
+ /// Console.WriteLine("Cannot apply a null function:");
+ /// Console.WriteLine(e.Message);
+ /// }
+ /// }
+ /// }
+ /// }
+ ///
+ /// // Executing method Main() produces the following output:
+ /// //
+ /// // Squaring 2...
+ /// // ...the result is 4.
+ /// //
+ /// // Cannot apply a null function:
+ /// // Value cannot be null.
+ /// // Parameter name: func
+ /// </code>
+ /// </para>
+ /// </example>
+ public static int Operate(Func<int, int> func, int operand)
+ {
+ if (func==null)
+ {
+ throw new ArgumentNullException(nameof(func));
+ }
+ return func(operand);
+ }
+ }
+}
+ Note the LaTeX elements at line 21-24 + in the XML comments on method + Operate. + You can check + here + how the + corresponding documentation looks like. +
+ Elements in + MAML + conceptual topics must be qualified using a namespace. + To qualify LaTeX elements, + add to the topic's document element a namespace attribute + associated with prefix ltx, + as shown in the following example. +
<topic id="303c996a-2911-4c08-b492-6496c82b3edb" revisionNumber="1">
+ <!-- This element name will change based on the document type -->
+ <developerConceptualDocument
+ xmlns="http://ddue.schemas.microsoft.com/authoring/2003/5"
+ xmlns:xlink="http://www.w3.org/1999/xlink"
+ xmlns:ltx="http://www.novacta.net/2018/XSL/ShfbLatexTools">
+
+ <!-- The content goes here -->
+
+ </developerConceptualDocument>
+</topic>
+ Now LaTeX elements can be added + by prefixing their tags with ltx, + as follows. +
<ltx:latex scale="LARGE" mode="inline">X_{(0)}</ltx:latex>
+ As an example, the following file printout shows the source code for + a conceptual topic about + IntegerOperation, + as defined in project + SampleClassLibrary: +
1 +2 +3 +4 +5 +6 +7 +8 +9 +10 +11 +12 +13 +14 +15 +16 +17 +18 +19 +20 +21 +22 +23 +24 +25 +26 +27 +28 +29 +30 +31 +32 +33 +34 +35 +36 +37
<?xml version="1.0" encoding="utf-8"?>
+<topic id="b10d4d75-3729-4247-a58a-b9e5b6e4bb4d" revisionNumber="1">
+ <developerConceptualDocument
+ xmlns="http://ddue.schemas.microsoft.com/authoring/2003/5"
+ xmlns:xlink="http://www.w3.org/1999/xlink"
+ xmlns:ltx="http://www.novacta.net/2018/XSL/ShfbLatexTools">
+
+ <introduction>
+ <para>
+ Class <codeEntityReference qualifyHint="false">
+ T:SampleClassLibrary.IntegerOperation
+ </codeEntityReference> provides method
+ <codeEntityReference qualifyHint="false">
+ M:SampleClassLibrary.IntegerOperation.Operate(System.Func{System.Int32,System.Int32},System.Int32)
+ </codeEntityReference>
+ to manage operations on integer values.
+ </para>
+ <para>
+ In the following example, an integer is squared
+ executing the <codeEntityReference qualifyHint="false">
+ M:SampleClassLibrary.IntegerOperation.Operate(System.Func{System.Int32,System.Int32},System.Int32)
+ </codeEntityReference> method.
+ This is equivalent to define the applied function,
+ say <ltx:latex mode="inline">f:\mathbb{N}\rightarrow \mathbb{N},</ltx:latex>
+ as <ltx:latex>\forall n \in \mathbb{N}: n \mapsto f\left(n\right)=n^2.</ltx:latex>
+ In addition, input validation is also checked.
+ </para>
+ <code source="..\SampleClassLibrary\IntegerOperationExample.cs.txt"
+ language="cs" title="C#" />
+ </introduction>
+
+ <relatedTopics>
+ <link xlink:href="4c3871a5-d7c6-477c-96ee-e71f0a67f7a8" />
+ </relatedTopics>
+
+ </developerConceptualDocument>
+</topic>
+ Note the LaTeX elements at lines 24-25. + You can check + here + how such conceptual topic looks like. +
Welcome |
Novacta.Shfb.LatexTools is a .NET library - that provides types to manage LaTeX equations in reference and conceptual content files - generated by the - Sandcastle Help File Builder. -
- The project supports SHFB, version 2021.10.23.0 or later. -
- The library is licensed under - the - MIT license. -
- The current documentation includes the following topics. -
Adding LaTeX equations includes topics showing how to define LaTeX - content in documentation files. -
Library reference - contains reference information about library - types by namespace. -
SampleClassLibrary Namespaces - points to a sample documentation obtained - through the Novacta.Shfb.LatexTools library. -
If you are not redirected automatically, follow this link to the default topic.
+If you are not redirected automatically, follow this link to the default topic.
diff --git a/docs/media/LatexComponentConfig.png b/docs/media/LatexComponentConfiguration.png similarity index 100% rename from docs/media/LatexComponentConfig.png rename to docs/media/LatexComponentConfiguration.png diff --git a/docs/media/LatexComponentConfiguration_v2.png b/docs/media/LatexComponentConfiguration_v2.png new file mode 100644 index 0000000..1a3dc07 Binary files /dev/null and b/docs/media/LatexComponentConfiguration_v2.png differ diff --git a/docs/media/LatexComponent_v2.png b/docs/media/LatexComponent_v2.png new file mode 100644 index 0000000..3033791 Binary files /dev/null and b/docs/media/LatexComponent_v2.png differ diff --git a/docs/media/LatexPlugIn_v2.png b/docs/media/LatexPlugIn_v2.png new file mode 100644 index 0000000..cba83c8 Binary files /dev/null and b/docs/media/LatexPlugIn_v2.png differ diff --git a/docs/media/clatex_11.svg b/docs/media/clatex_11.svg deleted file mode 100644 index 69adf3d..0000000 --- a/docs/media/clatex_11.svg +++ /dev/null @@ -1,37 +0,0 @@ - - - \ No newline at end of file diff --git a/docs/media/clatex_0.svg b/docs/media/clatex_288.svg similarity index 99% rename from docs/media/clatex_0.svg rename to docs/media/clatex_288.svg index 31ab93d..288764f 100644 --- a/docs/media/clatex_0.svg +++ b/docs/media/clatex_288.svg @@ -1,5 +1,5 @@ - +