fix FAQs - #1069
Merged
Merged
Conversation
…r FAQ Print() was deprecated as of DWT v19.3 in favor of PrintEx(). Rather than presenting both with a deprecation note, drop Print() entirely and show only the current PrintEx() API, per review feedback on PR #1029. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
HTTPUpload() requires indices/type/dataFormat before its callbacks; the sample called it with only 3 args (url + 2 callbacks). Since each image was already attached as its own form field via ConvertToBlob/ SetHTTPFormField, pass an empty indices array so HTTPUpload doesn't attach an extra file of its own. Fixes #1030 Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Viewer.showPageNumber was deprecated as of v17.3 in favor of updatePageNumberStyle(), per _articles/info/schedule/deprecated.md. Fixes #1035 Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
…er-drivers FAQ - Migration table listed GetDeviceAsync() (nonexistent); the real method is GetDevicesAsync(), matching the link's own href. - WIATWAINSCANNER was described as "will continue to be supported" but Dynamsoft_Enum.md marks it deprecated since v18.2 in favor of WIASCANNER. Fixes #1036 Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
…l in remove-blank-page-automatically FAQ - Capability/CapType/CapValue/CapSet are deprecated (see _articles/info/schedule/deprecated.md); replaced the sample with the current setCapabilities() API. - DWTObject.OpenSource; was missing its call parentheses, making it a no-op. Fixes #1037 Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
CapabilityDetails documents "values" as corresponding to TWON_ARRAY and "enums" as the field for TWON_ENUMERATION; the sample read the wrong one for the ICAP_XRESOLUTION enumeration branch. Fixes #1038 Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
The linked image-processing/index.md#edit-options anchor doesn't exist (that page is just a 2-link table of contents). Point to the actual "Common Editing APIs" section in image-editing.md instead. Fixes #1043 Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
…ff FAQ Cause said "prior to 19.0" while Resolution said the fix landed in 19.1, self-contradicting. _articles/info/schedule/Stable.md confirms 4-bit TIFF support was added in 19.1, not 19.0. Fixes #1044 Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
…age-editor FAQ EditorSettings only defines top-level buttons/dialogText; titles and visibility must be nested as buttons.titles/buttons.visibility. The two short snippets showed them as bare top-level keys, inconsistent with the file's own complete example further down. Fixes #1046 Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
pdf/a-3b is a documented value of PDFWSettings.pdfaVersion, added in
v19.4 per _articles/info/schedule/Stable.md ("Added support for writing
PDF as PDF/A-3b"). The FAQ's supported-versions table only listed
pdf/a-1b and pdf/a-2b.
Fixes #1047
Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
The API doc's method is Erase() (capital E); the FAQ referenced it as lowercase erase(), which would mismatch for anyone copying the name into code. Fixes #1050 Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
…lectSource() WebTwain_Acquire.md recommends calling SelectSource() asynchronously via callbacks; the no-argument synchronous form is Windows-only. Per review feedback, rewrite the sample to use the async form exclusively rather than documenting the sync/no-args form as a caveat. Fixes #1051 Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
…-appendchild FAQ Dynamsoft_WebTwainEnv.md's CreateDWTObjectEx() caution note requires disabling auto-load (AutoLoad = false, Containers = []) first to avoid racing with the dynamic-initialization path -- exactly the race that produces the appendChild error this FAQ addresses. Option 1's sample omitted this step; rephrased the surrounding text as well. Fixes #1055 Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
…ired FAQ upgrade.md#update-the-license-key doesn't exist. Per review feedback, point to general-usage/license.md (no anchor) and rephrase the step. Fixes #1056 Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
viewer-configuration.md#create-the-viewer doesn't exist. Per review feedback, point to #configuring-viewer-instantiation instead. Fixes #1057 Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
image-export/index.md#upload doesn't exist (the content lives in the sibling server-upload.md). Per review feedback, point to the correct "Uploading over HTTP" section and refresh the surrounding copy (also fixed a grammar typo in the title: "do your support" -> "do you support"). Fixes #1058 Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
…se FAQ Both "this form" and "contact us" had empty href attributes. Filled in the quote-request form URL (per review feedback) and the standard Dynamsoft contact page. Fixes #1059 Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
general-troubleshooting-steps.md's verbose-log heading renders as #enable-and-collect-verbose-logs, not #how-to-enable-and-collect-verbose-log. Fixes #1062 Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
… FAQ dynamsoft-service-configuration.md#related-files-and-folders doesn't exist. Per review feedback, point to #installation-folder, which already documents the relevant files (log, DSConfiguration.ini, storage). Fixes #1063 Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
initialization.md#loading-the-core-js-files no longer exists -- that content moved to general-usage/resource-loading.md. Point to the "Loading from Official SDK Package" section, which documents the resource file layout referenced by this FAQ. Fixes #1064 Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
…to-server FAQ - Unclosed <a href="..."> swallowed the rest of the bullet's text into the hyperlink; converted to standard Markdown link syntax. - image-export/index.md#upload doesn't exist; pointed to the actual "Uploading over HTTP" section in server-upload.md instead. Fixes #1066 Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Louie-Dynamsoft <louie@dynamsoft.com>
Co-authored-by: Louie-Dynamsoft <louie@dynamsoft.com>
…les FAQ pdf/a-2b and pdf/a-3b are both fixed at PDF 1.7 (not a configurable 1.5-1.7 range as previously stated), and version is ignored entirely once pdfaVersion is set -- pdf/a-1b is likewise fixed at PDF 1.4 regardless of what version is passed. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
…iles FAQ Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
…page-as-a-separator FAQ Per issue discussion (lyzhang0113, tony-xlh), fully replace IsBlankImageExpress()/IsBlankImage() with IsBlankImageAsync() rather than just noting it as an alternative. The main sample's CheckBlankPage becomes async to await the new API. The "Using Page Standard Deviation" snippet only worked as a side effect of calling the old sync method to populate BlankImageCurrentStdDev, which IsBlankImageAsync explicitly does not affect -- replaced it with IsBlankImageAsync's own minBlockHeight/maxBlockHeight tuning options, with no mention of the deprecated stddev/threshold APIs. Fixes #1053 Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
…-browser FAQ Per issue discussion (lyzhang0113, ztyyLV), this FAQ documents IE/ActiveX-era troubleshooting that no longer applies since ActiveX support was discontinued in v19.0. Removed the article and its listing in index.md (renumbering the remaining Capture/Image Source entries). Fixes #1060 Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
…s FAQ Per issue discussion, HTTPDownloadDirectly() only exists in a custom version, isn't related to rasterization, and has been removed from the public API docs -- drop it from the "may trigger rasterization" list. Fixes #1039 Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
…erver-was-terminated-abnormally FAQ Per issue discussion, this FAQ remains relevant (ties to a real support ticket about PHP upload size limits). WebTWAIN was the old name for DWTObject in earlier SDK versions; renamed it to match current samples. strHTTPServer assignment kept as-is. Fixes #1052 Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Per issue discussion (lyzhang0113, tony-xlh), this issue is now fixed on both the Safari and DWT 19.3.1 sides, and the FAQ is minor enough to just delete rather than update. Removed the article and its listing in index.md (renumbering the remaining Error Troubleshooting entry). Fixes #1045 Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
…proaches - Converted raw <strong> section labels to proper ### headings, matching the convention used elsewhere in the FAQ set. - Replaced the incorrect claim that DWT's own `resize` event should trigger the size calculation (it actually fires after the resize) with the two approaches from the issue discussion (tony-xlh): percentage-based sizing, or a window resize listener with absolute pixel values. - Dropped the IE-specific window.innerWidth/innerHeight fallback note, since ActiveX/IE support was discontinued in v19.0. Fixes #1054 Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
…rce-list FAQ Per issue discussion (tony-xlh), GetDeviceType() was TWAIN-specific and deprecated since v18.0. Replaced with checking the CAP_CAMERAPREVIEWUI capability via getCapabilities() to identify camera sources, with no mention of the deprecated API. Reframed the existing source-name keyword check as the simpler workaround since it doesn't require opening each source. Fixes #1040 Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
…ser-machine FAQ Per issue discussion (lyzhang0113, tony-xlh): - Dropped the "Desktop Service Edition" framing entirely (dead anchor, and the concept itself is being retired). - Fixed the client-side upgrade link to point to extended-usage/dynamsoft-service-configuration.md. - Kept the Remote Scan mention but pointed it to the external Remote Scan docs site (same link index.md already uses) instead of the nonexistent internal how-to-enable-remote-scan.md. Fixes #1042 Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
…MLHttpRequest-cannot-load FAQ Per tony-xlh, this property doesn't exist and the note should just be removed. Fixes #1032 Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
…iles-at-a-time FAQ Per issue discussion (lyzhang0113, tony-xlh): HTTPUpload()'s multi-index upload only combines images for multi-page formats like PDF/TIFF, so the existing per-image ConvertToBlob + SetHTTPFormField loop is necessary to upload each scan as its own separate JPG file -- added a note explaining why. Fixed the final HTTPUpload() call to include the required indices/type/dataFormat parameters (empty indices since each image is already attached individually), and cast the image count to a string to match SetHTTPFormField's documented signature. Fixes #1031 Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
…-thumbnail-viewer-to-navigate-images FAQ
Per tony-xlh's confirmation: renamed hoverBackground to
hoverPageBackground (matches interfaces.md and the API doc's own
example), and replaced the nonexistent showPageNumber setting with a
thumbnail.updatePageNumberStyle({ visibility: "hidden" }) call, which
is the actual mechanism (ThumbnailViewer shares the same APIs as
Viewer).
Fixes #1033
Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
…fix content Per tony-xlh: the "flatbed" framing was a mistake -- the documented API (IfFeederLoaded) is entirely about the ADF feeder, not the flatbed, and there's no dedicated flatbed-paper-detection API. Renamed the file/URL and updated title/keywords/heading accordingly, updated the link in index.md, and added the missing IfFeederEnabled = true precondition (IfFeederLoaded is only valid when IfFeederEnabled and IfPaperDetectable are both true). Fixes #1034 Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
…ltiple-files-at-a-time FAQ" This reverts commit 5ea5e28.
Per correction: the original 3-arg HTTPUpload() call is valid here since each image is already attached individually as its own form field via SetHTTPFormField -- no revert of the code was needed, just clearer prose explaining the approach and why the final HTTPUpload() call doesn't need to specify indices. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
…ime FAQ SetHTTPFormField(name: string, value: string) documents value as a string; HowManyImagesInBuffer is a number. JS coerces this automatically so it worked in practice, but didn't match the documented signature. Fixes #1031 Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
docs(faq): fix FAQ accuracy issues
Ellie-dynamsoft
approved these changes
Jul 31, 2026
Ellie-dynamsoft
approved these changes
Jul 31, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.