Merge pull request #50 from dynamsoft-docs/preview

update to internal commit b95ed39b

programming/cplusplus/api-reference/capture-vision-router/multiple-file-processing.md

@@ -245,14 +245,20 @@ int StartCapturing(const char* templateName = "", bool waitForThreadExit = false
 
 **Parameters**
 
-`[in] templateName` Specifies a template to use for capturing. If not specified, an empty string is used which means the factory default template.
+`[in] templateName` Specifies a `CaptureVisionTemplate` to use for capturing.
 
 `[in] waitForThreadExit` Indicates whether to wait for the capture process to complete before returning. The default value is false.
 
 `[out] errorMsgBuffer` Stores any error messages generated during the capturing process. If no buffer is provided, the error messages will not be output.
 
 `[in] errorMsgBufferLen` Specifies the length of the provided error message buffer. If no buffer is provided, this parameter is ignored.
 
+**Remarks**
+
+- There are two types of `CaptureVisionTemplate`: the [preset ones]({{ site.dcvb_cpp_api }}capture-vision-router/auxiliary-classes/preset-template.html) which come with the SDK and the custom ones that get initialized when the user calls [InitSettings]({{ site.dcvb_cpp_api }}capture-vision-router/settings.html#initsettings) / [InitSettingsFromFile]({{ site.dcvb_cpp_api }}capture-vision-router/settings.html#initsettingsfromfile).
+- Please be aware that the preset `CaptureVisionTemplates` will be overwritten should the user call `InitSettings` / `InitSettingsFromFile` and pass his own settings.
+- If parameter `templateName` is not specified, the preset one named 'Default' will be used. However, if the preset ones have been overwritten as described above, the first `CaptureVisionTemplate` from the user's own settings will be used instead.
+
 **Return Value**
 
 The function returns an integer value representing the success or failure of the capturing process. A value of 0 indicates success, while a non-zero value indicates failure. If an error message buffer is provided, any error messages generated during the capturing process will be stored in the buffer.

programming/cplusplus/api-reference/capture-vision-router/single-file-processing.md

@@ -28,14 +28,20 @@ CCapturedResult* Capture(const CImageData* pImageData, const char* templateName=
 
 `[in] filePath` Specifies the path of the file to process.
 
-`[in] templateName` Specifies the template to use for capturing. Default value is an empty string which means the factory default template.
+`[in] templateName` Specifies a `CaptureVisionTemplate` to use for capturing.
 
 `[in] fileBytes` Specifies the memory location containing the image to be processed.
 
 `[in] fileSize`  Specifies the size of the image in bytes.
 
 `[in] pImageData` Specifies the image data to process.
 
+**Remarks**
+
+- There are two types of `CaptureVisionTemplate`: the [preset ones]({{ site.dcvb_cpp_api }}capture-vision-router/auxiliary-classes/preset-template.html) which come with the SDK and the custom ones that get initialized when the user calls [InitSettings]({{ site.dcvb_cpp_api }}capture-vision-router/settings.html#initsettings) / [InitSettingsFromFile]({{ site.dcvb_cpp_api }}capture-vision-router/settings.html#initsettingsfromfile).
+- Please be aware that the preset `CaptureVisionTemplates` will be overwritten should the user call `InitSettings` / `InitSettingsFromFile` and pass his own settings.
+- If parameter `templateName` is not specified, the preset one named 'Default' will be used. However, if the preset ones have been overwritten as described above, the first `CaptureVisionTemplate` from the user's own settings will be used instead.
+
 **Return Value**
 
 Returns a pointer to a `CCapturedResult` object containing the captured items.

programming/dotnet/api-reference/capture-vision-router/multiple-file-processing.md

@@ -244,12 +244,18 @@ int StartCapturing(string templateName, bool waitForThreadExit, out string error
 
 **Parameters**
 
-`[in] templateName` Specifies a template to use for capturing. Setting an empty string means the factory default template.
+`[in] templateName` Specifies a `CaptureVisionTemplate` to use for capturing.
 
 `[in] waitForThreadExit` Indicates whether to wait for the capture process to complete before returning.
 
 `[out] errorMsgBuffer` Stores any error messages generated during the capturing process.
 
+**Remarks**
+
+- There are two types of `CaptureVisionTemplate`: the [preset ones]({{ site.dcvb_dotnet_api }}capture-vision-router/auxiliary-classes/preset-template.html) which come with the SDK and the custom ones that get initialized when the user calls [InitSettings]({{ site.dcvb_dotnet_api }}capture-vision-router/settings.html#initsettings) / [InitSettingsFromFile]({{ site.dcvb_dotnet_api }}capture-vision-router/settings.html#initsettingsfromfile).
+- Please be aware that the preset `CaptureVisionTemplates` will be overwritten should the user call `InitSettings` / `InitSettingsFromFile` and pass his own settings.
+- If parameter `templateName` is not specified, the preset one named 'Default' will be used. However, if the preset ones have been overwritten as described above, the first `CaptureVisionTemplate` from the user's own settings will be used instead.
+
 **Return Value**
 
 The function returns an integer value representing the success or failure of the capturing process. A value of 0 indicates success, while a non-zero value indicates failure. Any error messages generated during the capturing process will be returned in `errorMsgBuffer`.

programming/dotnet/api-reference/capture-vision-router/single-file-processing.md

@@ -27,12 +27,18 @@ CapturedResult Capture(ImageData imageData, string templateName="");
 
 `[in] filePath` Specifies the path of the file to process.
 
-`[in] templateName` Specifies the template to use for capturing. Default value is an empty string which means the factory default template.
+`[in] templateName` Specifies a `CaptureVisionTemplate` to use for capturing.
 
 `[in] fileBytes` Specifies the image file bytes in memory to be processed.
 
 `[in] imageData` Specifies the image data to process.
 
+**Remarks**
+
+- There are two types of `CaptureVisionTemplate`: the [preset ones]({{ site.dcvb_dotnet_api }}capture-vision-router/auxiliary-classes/preset-template.html) which come with the SDK and the custom ones that get initialized when the user calls [InitSettings]({{ site.dcvb_dotnet_api }}capture-vision-router/settings.html#initsettings) / [InitSettingsFromFile]({{ site.dcvb_dotnet_api }}capture-vision-router/settings.html#initsettingsfromfile).
+- Please be aware that the preset `CaptureVisionTemplates` will be overwritten should the user call `InitSettings` / `InitSettingsFromFile` and pass his own settings.
+- If parameter `templateName` is not specified, the preset one named 'Default' will be used. However, if the preset ones have been overwritten as described above, the first `CaptureVisionTemplate` from the user's own settings will be used instead.
+
 **Return Value**
 
 Returns a `CapturedResult` object containing the captured items.

programming/python/api-reference/capture-vision-router/multiple-file-processing.md

@@ -276,10 +276,16 @@ def start_capturing(self, template_name: str = "", wait_for_thread_exit: bool =
 
 **Parameters**
 
-`template_name` Specifies a template to use for capturing. Setting an empty string means the factory default template.
+`template_name` Specifies a `CaptureVisionTemplate` to use for capturing.
 
 `wait_for_thread_exit` Indicates whether to wait for the capture process to complete before returning.
 
+**Remarks**
+
+- There are two types of `CaptureVisionTemplate`: the [preset ones]({{ site.dcvb_python_api }}capture-vision-router/auxiliary-classes/preset-template.html) which come with the SDK and the custom ones that get initialized when the user calls [InitSettings]({{ site.dcvb_python_api }}capture-vision-router/settings.html#initsettings) / [InitSettingsFromFile]({{ site.dcvb_python_api }}capture-vision-router/settings.html#initsettingsfromfile).
+- Please be aware that the preset `CaptureVisionTemplates` will be overwritten should the user call `InitSettings` / `InitSettingsFromFile` and pass his own settings.
+- If parameter `template_name` is not specified, the preset one named 'Default' will be used. However, if the preset ones have been overwritten as described above, the first `CaptureVisionTemplate` from the user's own settings will be used instead.
+
 **Return Value**
 
 Returns a tuple containing following elements:

programming/python/api-reference/capture-vision-router/single-file-processing.md

@@ -25,13 +25,15 @@ def capture(self, *args) -> CapturedResult:
 
 `args` <*tuple*>: A variable-length argument list. Can be one of the following:
 
-- `file_path` <*str*>, `template_name` <*str*, optional>: Specifies the path of the file to process and the template to use for capturing.
-- `file_bytes` <*bytes*>, `template_name` <*str*, optional>: Specifies the image file bytes in memory to process and the template to use for capturing.
-- `image_data` <*ImageData*>, `template_name` <*str*, optional>: Specifies the image data to process and the template to use for capturing.
+- `file_path` <*str*>, `template_name` <*str*, optional>: Specifies the path of the file to process and a `CaptureVisionTemplate` to use for capturing.
+- `file_bytes` <*bytes*>, `template_name` <*str*, optional>: Specifies the image file bytes in memory to process and a `CaptureVisionTemplate` to use for capturing.
+- `image_data` <*ImageData*>, `template_name` <*str*, optional>: Specifies the image data to process and a `CaptureVisionTemplate` to use for capturing.
 
 **Remarks**
 
-Default value for `template_name` is an empty string which means the factory default template.
+- There are two types of `CaptureVisionTemplate`: the [preset ones]({{ site.dcvb_python_api }}capture-vision-router/auxiliary-classes/preset-template.html) which come with the SDK and the custom ones that get initialized when the user calls [InitSettings]({{ site.dcvb_python_api }}capture-vision-router/settings.html#initsettings) / [InitSettingsFromFile]({{ site.dcvb_python_api }}capture-vision-router/settings.html#initsettingsfromfile).
+- Please be aware that the preset `CaptureVisionTemplates` will be overwritten should the user call `InitSettings` / `InitSettingsFromFile` and pass his own settings.
+- If parameter `template_name` is not specified, the preset one named 'Default' will be used. However, if the preset ones have been overwritten as described above, the first `CaptureVisionTemplate` from the user's own settings will be used instead.
 
 **Return Value**