Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions .vale.ini
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,10 @@ mdx = md

[*.{md,mdx}]
BasedOnStyles = Google, Scandit
# Replaced by Scandit.Spacing: Google's rule cannot tell a sentence boundary
# from a dotted code identifier, and in these docs it is almost always the
# latter. See styles/Scandit/Spacing.yml for the measurement.
Google.Spacing = NO
# Docusaurus/MDX constructs Vale shouldn't lint as prose:
BlockIgnores = (?s)^import .*$, (?s)^export .*$, (?s):::.*?:::
TokenIgnores = (\{[^}]*\}), (<[^>]+>)
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ There are three types of input data you must configure:

## Standard Input

Standard inputs are fixed values or predefined fields. They are useful when you need to always attach the same kind of information (e.g., device ID, operator ID).
Standard inputs are fixed values or predefined fields. They are useful when you need to always attach the same kind of information (for example, device ID, operator ID).

| Field | Description |
|-------|-------------|
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ This guide explains how to configure output data for the **Custom Data Transfer*
|-------|-------------|
| `type` | Always set to `standard` for this configuration type. |
| `behavior` | Defines how new data is written. Options: <br></br> - `replace`: overwrite existing data <br></br> - `append`: add new rows or entries. |
| `target` | Defines the destination for the output (e.g., Google Sheets, CSV, API). |
| `target` | Defines the destination for the output (for example, Google Sheets, CSV, API). |
| `parserOptions` | (Optional) Array of parser configuration objects. |
| `timestampOptions` | (Optional) Controls how timestamps are handled. |
| `grouped` | Boolean (default: `true`). If `false`, the same barcode will be repeated when quantity > 1. |
Expand All @@ -40,7 +40,7 @@ When `type=barcodeValue`, the following `barcodeValue.type` options are availabl
| Type | Description |
|------|-------------|
| `barcodeData` | Raw scanned barcode data. |
| `symbology` | Symbology type (e.g., QR, Code128). |
| `symbology` | Symbology type (for example, QR, Code128). |
| `symbolCount` | Number of symbols in the barcode. |
| `quantity` | Quantity derived from scanning. |
| `timestamp` | Timestamp of the scan (see `timestampOptions`). |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ keywords:

# Custom Data Transfer

The **Custom Data Transfer** feature in Scandit Express lets you import and export data using a configurable CSV file or Google Sheet. By aligning data formats between Scandit Express and your system, this feature ensures seamless integration into your workflow without the need for coding or reformatting.
The **Custom Data Transfer** feature in Scandit Express lets you import and export data using a configurable CSV file or Google Sheet. By aligning data formats between Scandit Express and your system, this feature fits into your workflow without the need for coding or reformatting.

## Key Benefits

Expand Down
6 changes: 3 additions & 3 deletions docs/hosted/express/configuration/express-find.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ keywords:

# Find Items

Powered by [MatrixScan Find](https://www.scandit.com/products/matrixscan-find/), a feature available in the Scandit Smart Data Capture SDK, this mode enables you to speed up finding and picking workflows by scanning multiple items at once and highlighting the correct item(s) in real-time using an AR overlay.
Powered by [MatrixScan Find](https://www.scandit.com/products/matrixscan-find/), a feature available in the Scandit Smart Data Capture SDK, this mode enables you to speed up finding and picking workflows by scanning multiple items at once and highlighting the correct items in real-time using an AR overlay.

## Create the Find List

Expand Down Expand Up @@ -61,7 +61,7 @@ Remember to use URL encoding for the list name and the list of barcodes:

### Integrate into Your App

You can also integrate the links for your Find List(s) (with the barcodes to find embedded in them) in your own application. Follow the instructions above to create your list, and then display the link in your app or your website. If a user clicks on the link it will start Scandit Express and show the list of codes that need to be found.
You can also integrate the links for your Find lists (with the barcodes to find embedded in them) in your own application. Follow the instructions above to create your list, and then display the link in your app or your website. If a user clicks on the link it will start Scandit Express and show the list of codes that need to be found.

To integrate specific barcodes to find, you need to:

Expand All @@ -85,7 +85,7 @@ You can also integrate the links for your Find List(s) (with the barcodes to fin
}
```

The space in QR codes is limited, so if you have more codes that can fit into a single QR code you can create multiple codes. A good rule of thumb is to limit to 2000 barcode characters for a single QR code. Simply adjust the “partsTotal” field (`"partsTotal": 2`) and number each code using the `"part"` field accordingly (`"part": 1` and `"part": 2`).
The space in QR codes is limited, so if you have more codes that can fit into a single QR code you can create multiple codes. A good rule of thumb is to limit to 2000 barcode characters for a single QR code. Adjust the “partsTotal” field (`"partsTotal": 2`) and number each code using the `"part"` field accordingly (`"part": 1` and `"part": 2`).

2. Generate a QR code from the JSON string and display it to the user.

Expand Down
4 changes: 2 additions & 2 deletions docs/hosted/express/configuration/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,8 +72,8 @@ This feature is only supported for Android devices, and must be enabled by the S

* Your Scandit account email address.
* The project name you want to enable the feature for.
* The device model(s) you want to enable the feature for.
* The key code(s) you want to use to trigger the barcode scanner.
* The device models you want to enable the feature for.
* The key codes you want to use to trigger the barcode scanner.

:::tip
You can identify the key code with key code identifier apps available in the Play Store, such as [KeyEvent Display](https://play.google.com/store/apps/details?id=aws.apps.keyeventdisplay).
Expand Down
2 changes: 1 addition & 1 deletion docs/hosted/express/configuration/inventory-count.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ On start, you will have two options:

* **Count without List** which will allow you to start scanning products and then export a list of them.
* **Load Order List** which allows you to load a predefined list of barcodes and then scan products to see if they are on the list. Lists can be loaded:
- From a **deep-link URL** (e.g. `https://express.scandit.com/count/list?listName=myList&data=123,456,789`)
- From a **deep-link URL** (for example, `https://express.scandit.com/count/list?listName=myList&data=123,456,789`)
- From a **QR code** encoding the same URL
- From **multiple QR codes** (for very large lists)

Expand Down
6 changes: 3 additions & 3 deletions docs/hosted/express/getting-started/rollout.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ To automatically synchronize your Scandit Express configuration with Scandit, yo
If your MDM system requires an AppConfig configuration, you can generate one [here](https://appconfig.jamfresearch.com/generator) by selecting Scandit Express as: `com.scandit.KeyboardWedge2/current`.
:::

### 3rd-Party Instructions
### Third-Party Instructions

This section provides links to the relevant sections of the documentation for popular MDM/EMM solutions:

Expand Down Expand Up @@ -95,7 +95,7 @@ To automatically synchronize your Scandit Express configuration with Scandit, yo

![Add Project Code](/img/express/rollout_android_2.png)

### 3rd-Party Instructions
### Third-Party Instructions

This section provides links to the relevant sections of the documentation for popular MDM/EMM solutions:

Expand All @@ -108,7 +108,7 @@ This section provides links to the relevant sections of the documentation for po

## Updating Configuration

To update the configuration of Scandit Express on all devices, simply change the configuration in the Scandit Dashboard. The new configuration will be automatically distributed to all devices.
To update the configuration of Scandit Express on all devices, change the configuration in the Scandit Dashboard. The new configuration will be automatically distributed to all devices.

Scandit Express automatically updates the license and configuration when restarted, but if you need to force a reload:

Expand Down
2 changes: 1 addition & 1 deletion docs/hosted/express/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ keywords:
- express
---

Scandit Express is an application that enables you to instantly add barcode scanning to any existing app or software tool on a smart device.It requires no software changes or coding effort, and is compatible with any app or system, even those that cannot be modified. By adding a keyboard that has a scan button above the standard keys (a keyboard wedge), it allows users to scan barcodes directly into any input field.
Scandit Express is an application that enables you to instantly add barcode scanning to any existing app or software tool on a smart device. It requires no software changes or coding effort, and is compatible with any app or system, even those that cannot be modified. By adding a keyboard that has a scan button above the standard keys (a keyboard wedge), it allows users to scan barcodes directly into any input field.


Scandit Express is built for enterprise use and supports distribution through mobile device management (MDM) and enterprise mobility management (EMM) systems.
Expand Down
2 changes: 1 addition & 1 deletion docs/hosted/id-bolt/callbacks.md
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ The `CapturedId` object contains the extracted data from the scanned document. T
| `dateOfExpiry` | `DateResult` | Expiration date of the document | 1.0 |
| `isExpired` | `boolean` | Whether the document is expired | 1.0 |
| `dateOfIssue` | `DateResult` | Date when the document was issued | 1.0 |
| `documentType` | `DocumentType` | Type of document (e.g. `"Passport"`, `"IdCard"`, `"DriverLicense"`, `"VisaIcao"`, `"ResidencePermit"`, `"HealthInsuranceCard"`, `"RegionSpecific"`) | 1.0 |
| `documentType` | `DocumentType` | Type of document (for example, `"Passport"`, `"IdCard"`, `"DriverLicense"`, `"VisaIcao"`, `"ResidencePermit"`, `"HealthInsuranceCard"`, `"RegionSpecific"`) | 1.0 |
| `documentSubtype` | `string \| null` | Subtype of the document, if applicable | 2.1 |
| `capturedResultTypes` | `string[]` | Types of data that were captured | 1.0 |
| `nationalityISO` | `string \| null` | ISO code of the nationality | 2.1 |
Expand Down
4 changes: 2 additions & 2 deletions docs/hosted/id-bolt/data-handling.md
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,7 @@ Each `AnonymizedFieldEntry` specifies a document type and the fields to anonymiz

| Property | Type | Description | Since |
| ---------- | ------------------- | ----------------------------------------------------------------------------------------------- | ----- |
| `document` | `IdCaptureDocument` | The document type this entry applies to (e.g. `new Passport(Region.Any)`, `new IdCard("USA")`). | 2.2 |
| `document` | `IdCaptureDocument` | The document type this entry applies to (for example, `new Passport(Region.Any)`, `new IdCard("USA")`). | 2.2 |
| `fields` | `IdFieldType[]` | The fields to anonymize for this document type. | 2.2 |

### Available Field Types
Expand Down Expand Up @@ -147,4 +147,4 @@ The `IdFieldType` enum defines the fields that can be anonymized:

### Result

The `CapturedId` object returned in the `onCompletion` callback includes an `anonymizedFields` propertyan array of `IdFieldType` values indicating which fields were actually anonymized for the scanned document.
The `CapturedId` object returned in the `onCompletion` callback includes an `anonymizedFields` propertyan array of `IdFieldType` values indicating which fields were actually anonymized for the scanned document.
6 changes: 3 additions & 3 deletions docs/hosted/id-bolt/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,9 @@ In addition to ID Bolt, Scandit provides an [ID Capture SDK for the Web](/sdks/w

ID Bolt offers the following features:

- **Fast Scanning**: ID Bolt scans an ID in just 1 second, ensuring a quick and seamless customer experience. Scans are performed from video streams for the fastest possible scanning.
- **Fast Scanning**: ID Bolt scans an ID in just 1 second, so the whole interaction takes about a second. Scans are performed from video streams for the fastest possible scanning.
- **On-Device Scanning/Processing**: ID Bolt scans IDs on-device, ensuring no identity information is collected by third-party servers, and handling all processing on the device for improved performance.
- **Device Handover**: ID Bolt works on both desktop and mobile devices, providing a unified solution. Desktop/laptop users can scan IDs using their mobile device camera.
- **Industry Leading UX**: ID Bolt provides a seamless user experience with a simple and intuitive interface, designed based on the millions of scans performed by Scandit customers each year.
- **Industry Leading UX**: ID Bolt presents a simple, intuitive interface, designed based on the millions of scans performed by Scandit customers each year.
- **Compliance**: ID Bolt ensures compliance with data protection regulations, such as GDPR, by processing all data on-device and not collecting any identity information on third-party servers.
- **White-Label Solution**: ID Bolt can be placed behind your own domain, allowing you to maintain brand consistency and provide a seamless, integrated experience to your customers while leveraging Scandit's powerful ID scanning capabilities.
- **White-Label Solution**: ID Bolt can be placed behind your own domain, allowing you to maintain brand consistency and provide an integrated experience to your customers while leveraging Scandit's powerful ID scanning capabilities.
4 changes: 2 additions & 2 deletions docs/hosted/id-bolt/theming.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ The `dimensions` object allows you to customize sizes and spacing:
| `radiusButton` | `string` | Border radius for buttons | 1.1 |
| `radiusCard` | `string` | Border radius for cards | 1.1 |

All values are string and must be valid CSS dimension expressions. E.g. "12px".
All values are string and must be valid CSS dimension expressions. For example, "12px."

## Image Customization

Expand Down Expand Up @@ -175,7 +175,7 @@ const theme = {

- Format: WOFF2, WOFF, TTF, or OTF (must be provided as data URLs)
- Maximum size: 100KB per font file (size of the base64 data url)
- Data URL format: Must start with appropriate mime type prefixes (e.g., `data:font/woff2`, `data:font/woff`)
- Data URL format: Must start with appropriate mime type prefixes (for example, `data:font/woff2`, `data:font/woff`)

## Style Overrides

Expand Down
2 changes: 1 addition & 1 deletion docs/sdks/net/android/add-sdk.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ You will always need to add the `Scandit.DataCapture.Core` package, which contai

In addition, depending on the data capture task, you will need a reference to:

| Functionality | Description | Required Module(s) |
| Functionality | Description | Required modules |
| --- | --- | --- |
| Barcode Capture | [ScanditBarcodeCapture API](https://docs.scandit.com/data-capture-sdk/dotnet.android/barcode-capture/api.html) if you want to use barcode-related functionality, such as barcode capture or MatrixScan. | _com.scandit.datacapture:barcode_ |
| Parser | [ScanditParser API](https://docs.scandit.com/data-capture-sdk/dotnet.android/parser/api.html) if you want to parse data strings, for instance, as found in barcodes, into a set of key-value mappings. | _com.scandit.datacapture:parser_ |
Expand Down
2 changes: 1 addition & 1 deletion docs/sdks/net/android/barcode-capture/get-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,7 @@ if (barcode.Data?.StartsWith("09:") == false)

## Use the Built-in Camera

The data capture context supports using different frame sources to perform recognition on. Most applications will use the built-in camera of the device, e.g. the world-facing camera of a device. The remainder of this tutorial will assume that you use the built-in camera.
The data capture context supports using different frame sources to perform recognition on. Most applications will use the built-in camera of the device, for example, the world-facing camera of a device. The remainder of this tutorial will assume that you use the built-in camera.

:::important
In Android, the user must explicitly grant permission for each app to access cameras. Your app needs to declare the use of the Camera permission in the AndroidManifest.xml file and request it at runtime so the user can grant or deny the permission. To do that follow the guidelines from [Permissions in Android](https://learn.microsoft.com/en-us/xamarin/android/app-fundamentals/permissions) to request the android.permission.CAMERA permission.
Expand Down
Loading
Loading