Skip to content

Commit 8355089

Browse files
committed
Add summary notes about non-charset ECI values to documentation
1 parent 4d92eca commit 8355089

1 file changed

Lines changed: 63 additions & 13 deletions

File tree

web/docs/index.html

Lines changed: 63 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -728,15 +728,20 @@ <h5><code>eci(value)</code> / <code>bytes(data)</code></h5>
728728
<a id="mode_eci"></a>
729729
<p>
730730
<code>mode.eci</code> lets you switch the Extended Channel Interpretation of the message (accepts
731-
integer IDs from 0 to 999999). After setting this, subsequent <code>mode.bytes</code> will be
731+
integer IDs from 0 to 811799). After setting this, subsequent <code>mode.bytes</code> will be
732732
interpreted in the specified character set (ECI values can also be used to control other aspects such as
733733
compression but these are rarely supported by QR code readers).
734734
</p>
735735
<pre><code><span class="keyword">const</span> code = <span class="method">generate</span>(mode.<span class="method">multi</span>(
736736
mode.<span class="method">eci</span>(<span class="value">24</span>), <span class="comment">// Arabic (Windows-1256)</span>
737737
mode.<span class="method">bytes</span>([<span class="value">0xD3</span>]), <span class="comment">// Shin character</span>
738738
));</code></pre>
739-
<p>Known ECI values for character sets:</p>
739+
<p>
740+
Known ECI values for character sets: (see also on
741+
<a href="https://en.wikipedia.org/wiki/Extended_Channel_Interpretation" target="_blank" rel="noopener"
742+
>Wikipedia</a
743+
>)
744+
</p>
740745
<table>
741746
<thead>
742747
<tr>
@@ -945,17 +950,6 @@ <h5><code>eci(value)</code> / <code>bytes(data)</code></h5>
945950
>due to a Chromium bug</a
946951
>.
947952
</p>
948-
<p>
949-
<a href="https://en.wikipedia.org/wiki/Extended_Channel_Interpretation" target="_blank" rel="noopener"
950-
>Wikipedia includes a list of common known ECI values</a
951-
>, and the full list of registered ECI values is
952-
<a
953-
href="https://web.aimglobal.org/external/wcpages/wcecommerce/eComItemDetailsPage.aspx?ItemID=805"
954-
target="_blank"
955-
rel="noopener"
956-
>available for purchase from AIM</a
957-
>.
958-
</p>
959953
<p>
960954
<code>mode.eci</code> will avoid outputting additional switches if the ECI already matches the requested
961955
value.
@@ -976,6 +970,62 @@ <h5><code>eci(value)</code> / <code>bytes(data)</code></h5>
976970
<code>mode.ascii</code> section (prefer <code>mode.iso8859_1</code> or <code>mode.utf8</code>, as these
977971
will explicitly set the ECI for their content).
978972
</p>
973+
<p>Though not supported by common readers, other ECI values exist for additional purposes:</p>
974+
<table>
975+
<thead>
976+
<tr>
977+
<th>ECI</th>
978+
<th>meaning</th>
979+
</tr>
980+
</thead>
981+
<tbody>
982+
<tr>
983+
<td>0&ndash;899</td>
984+
<td>Standardised character set interpretation (see above)</td>
985+
</tr>
986+
<tr>
987+
<td>900&ndash;399999</td>
988+
<td>Standardised transformation (e.g. compression, encryption)</td>
989+
</tr>
990+
<tr>
991+
<td>400000&ndash;799995</td>
992+
<td>Private use transformation</td>
993+
</tr>
994+
<tr>
995+
<td>799996</td>
996+
<td>Transformation prefix</td>
997+
</tr>
998+
<tr>
999+
<td>799997&ndash;799998</td>
1000+
<td>Invalid</td>
1001+
</tr>
1002+
<tr>
1003+
<td>799999</td>
1004+
<td>Null transformation (end current transformation without beginning a new one)</td>
1005+
</tr>
1006+
<tr>
1007+
<td>800000&ndash;810898</td>
1008+
<td>Standardised application file format interpretation</td>
1009+
</tr>
1010+
<tr>
1011+
<td>810899</td>
1012+
<td>Interpretive prefix</td>
1013+
</tr>
1014+
<tr>
1015+
<td>810900&ndash;811799</td>
1016+
<td>Private use transformation</td>
1017+
</tr>
1018+
</tbody>
1019+
</table>
1020+
<p>
1021+
The full list of standardised ECI values is available for purchase from AIM as
1022+
<a
1023+
href="https://web.aimglobal.org/external/wcpages/wcecommerce/eComItemDetailsPage.aspx?ItemID=805"
1024+
target="_blank"
1025+
rel="noopener"
1026+
>ECI Part 3: Register</a
1027+
>.
1028+
</p>
9791029
</section>
9801030
<section>
9811031
<h5><code>auto(text[, options])</code></h5>

0 commit comments

Comments
 (0)