Documentation update.

phmarek · Dec 3, 2019 · 146e625 · 146e625
1 parent 2b2ae88
commit 146e625
Show file tree

Hide file tree

Showing 2 changed files with 51 additions and 29 deletions.
diff --git a/doc.xml b/doc.xml
@@ -276,21 +276,6 @@ CL-USER&gt; (let* ((yason:*parse-json-arrays-as-vectors* t)
         </clix:description>
       </clix:special-variable>
 
-      <clix:special-variable name="*list-encoder*">
-        <clix:description>
-          Function to call to translate a CL list into JSON data.
-		  <clix:arg>'YASON:ENCODE-PLAIN-LIST-TO-ARRAY</clix:arg> is the default;
-		  <clix:arg>'YASON:ENCODE-PLIST</clix:arg> and
-		  <clix:arg>'YASON:ENCODE-ALIST</clix:arg> are available to produce
-		  JSON objects.
-		  <p>
-			  This is useful to translate a deeply recursive structure in a single
-			  <clix:arg>YASON:ENCODE</clix:arg> call.
-          </p>
-        </clix:description>
-      </clix:special-variable>
-
-
     </clix:subchapter>
   </clix:chapter>
 
@@ -383,6 +368,32 @@ CL-USER&gt; (let* ((yason:*parse-json-arrays-as-vectors* t)
             performance penalty of the indentation algorithm.
           </clix:description>
         </clix:function>
+
+      <clix:special-variable name="*list-encoder*">
+        <clix:description>
+          Function to call to translate a CL list into JSON data.
+		  <clix:arg>'YASON:ENCODE-PLAIN-LIST-TO-ARRAY</clix:arg> is the default;
+		  <clix:arg>'YASON:ENCODE-PLIST</clix:arg> and
+		  <clix:arg>'YASON:ENCODE-ALIST</clix:arg> are available to produce
+		  JSON objects.
+		  <p>
+			  This is useful to translate a deeply recursive structure in a single
+			  <clix:arg>YASON:ENCODE</clix:arg> call.
+          </p>
+        </clix:description>
+      </clix:special-variable>
+
+
+		<clix:special-variable name="*symbol-key-encoder*">
+          <clix:description>
+			  Defines the policy to encode symbols as keys (eg. in hash tables).
+			  The default is to error out, to provide backwards-compatible behaviour.
+			  <p>
+				  A useful function that can be bound to this variable is 
+				  <clix:ref>YASON:ENCODE-SYMBOL-AS-LOWERCASE.</clix:ref>
+			  </p>
+          </clix:description>
+        </clix:special-variable>
       </clix:subchapter>
     </clix:subchapter>
 

diff --git a/index.html b/index.html
@@ -302,20 +302,6 @@ <h4 xmlns=""><a name="parser-dict">Parser dictionary</a></h4>
           a key in the CL hash produced. IDENTITY is the default.
         </clix:description></blockquote></p>
 
-      <p xmlns="">
-      [Special variable]<br><a class="none" name="*list-encoder*"><b>*list-encoder*</b></a><blockquote><clix:description xmlns:clix="http://bknr.net/clixdoc">
-          Function to call to translate a CL list into JSON data.
-		  <code><i>'YASON:ENCODE-PLAIN-LIST-TO-ARRAY</i></code> is the default;
-		  <code><i>'YASON:ENCODE-PLIST</i></code> and
-		  <code><i>'YASON:ENCODE-ALIST</i></code> are available to produce
-		  JSON objects.
-		  <p xmlns="http://www.w3.org/1999/xhtml">
-			  This is useful to translate a deeply recursive structure in a single
-			  <code xmlns=""><i>YASON:ENCODE</i></code> call.
-          </p>
-        </clix:description></blockquote></p>
-
-
 
 
 
@@ -400,6 +386,30 @@ <h4 xmlns=""><a name="dom-encoder-dict">DOM encoder dictionary</a></h4>
             original stream is returned in order to avoid the
             performance penalty of the indentation algorithm.
           </clix:description></blockquote></p>
+
+      <p xmlns="">
+      [Special variable]<br><a class="none" name="*list-encoder*"><b>*list-encoder*</b></a><blockquote><clix:description xmlns:clix="http://bknr.net/clixdoc">
+          Function to call to translate a CL list into JSON data.
+		  <code><i>'YASON:ENCODE-PLAIN-LIST-TO-ARRAY</i></code> is the default;
+		  <code><i>'YASON:ENCODE-PLIST</i></code> and
+		  <code><i>'YASON:ENCODE-ALIST</i></code> are available to produce
+		  JSON objects.
+		  <p xmlns="http://www.w3.org/1999/xhtml">
+			  This is useful to translate a deeply recursive structure in a single
+			  <code xmlns=""><i>YASON:ENCODE</i></code> call.
+          </p>
+        </clix:description></blockquote></p>
+
+
+		<p xmlns="">
+      [Special variable]<br><a class="none" name="*symbol-key-encoder*"><b>*symbol-key-encoder*</b></a><blockquote><clix:description xmlns:clix="http://bknr.net/clixdoc">
+			  Defines the policy to encode symbols as keys (eg. in hash tables).
+			  The default is to error out, to provide backwards-compatible behaviour.
+			  <p xmlns="http://www.w3.org/1999/xhtml">
+				  A useful function that can be bound to this variable is 
+				  <code xmlns=""><a href="#yason:encode-symbol-as-lowercase.">YASON:ENCODE-SYMBOL-AS-LOWERCASE.</a></code>
+			  </p>
+          </clix:description></blockquote></p>
 
 
 
@@ -688,6 +698,7 @@ <h3 xmlns=""><a class="none" name="index">Symbol index</a></h3>
 <li><code><a href="#*parse-json-null-as-keyword*">*parse-json-null-as-keyword*</a></code></li>
 <li><code><a href="#*parse-object-as*">*parse-object-as*</a></code></li>
 <li><code><a href="#*parse-object-key-fn*">*parse-object-key-fn*</a></code></li>
+<li><code><a href="#*symbol-key-encoder*">*symbol-key-encoder*</a></code></li>
 <li><code><a href="#encode">encode</a></code></li>
 <li><code><a href="#encode-alist">encode-alist</a></code></li>
 <li><code><a href="#encode-array-element">encode-array-element</a></code></li>