Skip to content

Commit f01516f

Browse files
authored
docs(developer): add custom file format reference for crowdinType (#673)
1 parent 3aeffba commit f01516f

2 files changed

Lines changed: 4 additions & 4 deletions

File tree

src/content/docs/developer/modules/file-processing-modules/custom-file-format.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -61,11 +61,11 @@ For Crowdin Enterprise:
6161
</td>
6262
</tr>
6363
<tr>
64-
<td><code>type</code></td>
64+
<td><code id="custom-file-format-type-example">type</code></td>
6565
<td>
6666
<p><strong>Type:</strong> <code>string</code></p>
6767
<p><strong>Required:</strong> yes</p>
68-
<p><strong>Description:</strong> The custom file format identifier. Can be used in API to force the processing of the files by the Custom file format app. If the <code>type</code> parameter is used in API, the <code>signaturePatterns</code> will be ignored.</p>
68+
<p><strong>Description:</strong> The custom file format identifier. Can be used in API to force the processing of the files by the Custom file format app. If the <code>type</code> parameter is used in API, the <code>signaturePatterns</code> will be ignored. Values defined via this property can also be referenced by other modules, for example through <code>attributes.crowdinType</code> in the [File Post-Import Processing module](/developer/crowdin-apps-module-file-post-import-processing/).</p>
6969
</td>
7070
</tr>
7171
<tr>

src/content/docs/developer/modules/file-processing-modules/file-post-import-processing.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -301,8 +301,8 @@ Properties:
301301
<td><code class="whitespace-nowrap">attributes.crowdinType</code></td>
302302
<td>
303303
<p><strong>Type:</strong> <code>string</code></p>
304-
<p><strong>Allowed values:</strong> Mostly match the <code>type</code> values accepted by the <a href="/developer/api/v2/#operation/api.projects.files.post">Add File API method</a>, excluding the following: <code>auto</code>, <code>xml</code>, <code>csv</code>, <code>docx</code>, <code>xlsx</code>, <code>dita</code>, <code>idml</code>, <code>mif</code>, <code>svg</code>.</p>
305-
<p><strong>Description:</strong> Used to specify the file format type for a string when post-processing is needed. For example, if a JSON file contains strings with embedded HTML, setting <code>crowdinType</code> to <code>html</code> allows to re-parse the string using the HTML parser. This helps ensure correct rendering and prevents unwanted tags from being displayed. The value must match one of the supported Crowdin file types.</p>
304+
<p><strong>Allowed values:</strong> Mostly match the <code>type</code> values accepted by the <a href="/developer/api/v2/#operation/api.projects.files.post">Add File API method</a>, excluding the following: <code>auto</code>, <code>xml</code>, <code>csv</code>, <code>docx</code>, <code>xlsx</code>, <code>dita</code>, <code>idml</code>, <code>mif</code>, <code>svg</code>. Additionally, custom values defined via the <a href="/developer/crowdin-apps-module-custom-file-format/#custom-file-format-type-example"><code>type</code> property</a> in the Custom File Format module are also supported.</p>
305+
<p><strong>Description:</strong> Used to specify the file format type for a string when post-processing is needed. For example, if a JSON file contains strings with embedded HTML, setting <code>crowdinType</code> to <code>html</code> allows to re-parse the string using the HTML parser. This helps ensure correct rendering and prevents unwanted tags from being displayed. The value must match one of the supported Crowdin file types or a custom file format identifier.</p>
306306
</td>
307307
</tr>
308308
</tbody>

0 commit comments

Comments
 (0)