docs(faq): fix FAQ accuracy issues - #1067
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>
2 tasks
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates a set of FAQ pages to correct audited accuracy issues by aligning code samples and guidance with the current Dynamic Web TWAIN API reference, fixing dead/broken links, and superseding the earlier print-from-viewer change from #1029.
Changes:
- Corrects multiple FAQ code samples to use current APIs/signatures (e.g., viewer page numbering, capabilities, async source selection, HTTPUpload arity).
- Fixes/refreshes numerous FAQ links and anchors to point at valid, current documentation pages/sections.
- Expands/clarifies certain feature docs (e.g., PDF/A variants, licensing/contact links) and updates
last_modifiedmetadata across edited pages.
Reviewed changes
Copilot reviewed 21 out of 21 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| _articles/faq/additional-form-fields.md | Fixes HTTPUpload() sample/prose to reflect current required parameters. |
| _articles/faq/customize-ui-elements-of-image-editor.md | Corrects editor settings snippets to use buttons.titles / buttons.visibility nesting. |
| _articles/faq/error-message-product-key-expired.md | Replaces a dead anchor link with a correct licensing doc link. |
| _articles/faq/flexible-to-custom-license.md | Replaces empty CTA hrefs with working Dynamsoft URLs. |
| _articles/faq/generate-pdf-files.md | Adds PDF/A variant info and example configuration for PDF/A output. |
| _articles/faq/http-servers-support.md | Fixes typos and refreshes server/upload guidance and links. |
| _articles/faq/image-viewer-object-defined.md | Fixes dead anchor to viewer configuration documentation. |
| _articles/faq/list-supported-resolution-DPI.md | Fixes capability result field usage (enums vs values) for enumeration types. |
| _articles/faq/print-images-from-viewer.md | Updates printing guidance to rely on PrintEx rather than Print. |
| _articles/faq/protect-sensitive-information.md | Fixes method casing in prose (Erase() vs erase()). |
| _articles/faq/remove-blank-page-automatically.md | Replaces deprecated capability negotiation properties with setCapabilities() and fixes OpenSource() call. |
| _articles/faq/resources-to-be-included-in-SDK.md | Updates resource-loading link to the newer resource loading page/anchor. |
| _articles/faq/securely-transfer-to-server.md | Fixes unclosed link markup and updates upload guidance link to the HTTP upload guide. |
| _articles/faq/service-is-blocked.md | Fixes verbose-log anchor to the correct heading slug. |
| _articles/faq/service-prompting-to-install-repeatedly.md | Updates service configuration links to non-dead anchors. |
| _articles/faq/show-page-number.md | Replaces nonexistent/deprecated showPageNumber usage with updatePageNumberStyle(). |
| _articles/faq/source-connected-to-maximum.md | Updates sample to use callback-style SelectSource() flow with error handling. |
| _articles/faq/support-wia-scanner-drivers.md | Fixes migration table method name and corrects deprecation guidance for WIATWAINSCANNER. |
| _articles/faq/type-error-appendchild.md | Adds the missing AutoLoad/Containers precondition and clarifies dynamic init guidance. |
| _articles/faq/unable-to-load-4-bit-tiff.md | Fixes the inconsistent version statement (19.1 support) and updates metadata. |
| _articles/faq/what-image-editing-operation-supported.md | Fixes dead link by pointing to the correct image-editing section. |
Comments suppressed due to low confidence (1)
_articles/faq/generate-pdf-files.md:71
- This inline comment says "pdf/a-3b" is since v19.4, but the API reference (
interfaces.md) indicatespdfaVersionis from v19.3 and includes "pdf/a-3b" as a supported value. Please align the version note with the reference docs.
version: "1.5", // [optional] 1.4 for "pdf/a-1b"; 1.5/1.6/1.7 for "pdf/a-2b"/"pdf/a-3b"
pdfaVersion: "pdf/a-2b" // "pdf/a-1b", "pdf/a-2b" (since v19.3), or "pdf/a-3b" (since v19.4)
});
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
ztyyLV
reviewed
Jul 29, 2026
…-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>
This was
linked to
issues
Jul 30, 2026
…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>
This was
unlinked from
issues
Jul 30, 2026
Contributor
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 35 out of 35 changed files in this pull request and generated no new comments.
Comments suppressed due to low confidence (8)
_articles/faq/generate-pdf-files.md:57
- The inline comment still says
pdf/a-3bis “since v19.4”, which conflicts with the API reference’s “From version 19.3” forpdfaVersion.
version: "1.5", // [optional] Only used for standard (non-PDF/A) PDFs; ignored once pdfaVersion is set
pdfaVersion: "pdf/a-2b" // "pdf/a-1b", "pdf/a-2b" (since v19.3), or "pdf/a-3b" (since v19.4)
});
_articles/faq/the-connection-with-the-server-was-terminated-abnormally.md:38
- The snippet assigns to
strHTTPServerwithout declaring it. In strict mode this throws a ReferenceError, and even in non-strict mode it creates an implicit global.
strHTTPServer = location.hostname;
DWTObject.HTTPPort = location.port == "" ? 80 : location.port;
_articles/faq/show-page-number.md:23
- This note appears to be carried over from the old
showPageNumberguidance. TheupdatePageNumberStyle()reference section doesn’t document asetViewMode/singlePageModelimitation, so keeping this note risks reintroducing an unsupported constraint.
**Note**: When [setViewMode](/_articles/info/api/WebTwain_Viewer.md#setviewmode){:target="_blank"} is set to -1 by -1 or [singlePageMode](/_articles/info/api/WebTwain_Viewer.md#singlepagemode){:target="_blank"} is true then this api will not work.
_articles/faq/index.md:103
- The PR description says it fixes
additional-form-fields.md, but that FAQ has been removed from the index and the page itself no longer exists. This will leave existing in-repo links broken (e.g._articles/general-usage/server-side-scripting.md:18and_articles/faq/upload-json-files-to-server.md:19still point to/_articles/faq/additional-form-fields.md).
1. [What image and document formats can I save my documents as?](/_articles/faq/image-document-formats-save.md)
2. [What type of HTTP servers do you support? Do you support other server types?](/_articles/faq/http-servers-support.md)
3. [How can I enable HTTPS support?](/_articles/faq/enable-https-support.md)
4. [How can I get the smallest size of documents in PDF, TIFF or JPEG format?](/_articles/faq/smallest-size-documents.md)
5. [How can I automatically trigger actions when images arrive on my server side?](/_articles/faq/trigger-actions-server-side.md)
_articles/faq/show-page-number.md:17
updatePageNumberStyle()takesPageNumberSettings.visibilityas a string (e.g. "visible"/"hidden"), not a boolean. The sentence currently says “visibility … to true”, which doesn’t match the API reference.
You could configure the `visibility` property to `true` with the [updatePageNumberStyle](/_articles/info/api/WebTwain_Viewer.md#updatepagenumberstyle){:target="_blank"} API to show the page number.
_articles/faq/generate-pdf-files.md:26
- The table marks
pdf/a-3bas available in v19.4+, but the API reference (_articles/info/api/interfaces.md"PDFWSettings") sayspdfaVersion(including "pdf/a-3b") is available “From version 19.3”. These two docs should be made consistent.
This issue also appears on line 55 of the same file.
| PDF/A Variant | Underlying PDF Version | Availability |
|:-------------:|-----------------------------|--------------|
| `pdf/a-1b` | **1.4** (fixed) | v19.3+ |
| `pdf/a-2b` | **1.7** (fixed) | v19.3+ |
| `pdf/a-3b` | **1.7** (fixed) | v19.4+ |
_articles/faq/upload-multiple-files-at-a-time.md:24
- This NOTE claims the final
HTTPUpload()call “doesn't need to specify which images to send” and implies a shorter signature, but the API reference (WebTwain_IO.md#httpupload) only documents overloads that still requireindices,type, anddataFormatat minimum. As written, the note (and the sample below) risks instructing readers to call an undocumented overload.
_articles/faq/use-blank-page-as-a-separator.md:110 - The tuning snippet uses
awaitat top level and referencesiwithout declaring it. Copied as-is, this will throw (or fail under strict mode) and doesn’t show the required async context.
tony-xlh
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
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.
Summary
Applies fixes for FAQ accuracy issues from the audit, incorporating review feedback/discussion on each issue as it came in, plus the print-images-from-viewer fix from #1029 (rewritten per review feedback to drop
Print()entirely rather than just noting it's deprecated). Each fix is its own commit. Closes #1029 in favor of this branch.Test plan
_articles/info/api/*.mdfor correct signatures/field names🤖 Generated with Claude Code