Mercurial > hg > nginx-site

changeset 2267:c30048802769

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Added links to njs reference from njs Compatibility.
author Yaroslav Zhuravlev <yar@nginx.com>
date Mon, 29 Oct 2018 21:34:03 +0300
parents 3fba786a8bd7
children cd1b26111884
files xml/en/docs/njs/compatibility.xml xml/en/docs/njs/reference.xml xml/ru/docs/njs/compatibility.xml
diffstat 3 files changed, 114 insertions(+), 76 deletions(-) [+]
line wrap: on
line diff
--- a/xml/en/docs/njs/compatibility.xml
+++ b/xml/en/docs/njs/compatibility.xml
@@ -9,7 +9,7 @@
 <article name="Compatibility"
         link="/en/docs/njs/compatibility.html"
         lang="en"
-        rev="2">
+        rev="3">
 
 <section>
 
@@ -59,28 +59,40 @@ ES6 <literal>Number</literal> and
 
 <listitem>
 ES5.1:
-<literal>fromCharCode</literal>, <literal>concat</literal>,
-<literal>slice</literal>, <literal>substring</literal>,
-<literal>substr</literal>, <literal>charAt</literal>,
-<literal>charCodeAt</literal>, <literal>indexOf</literal>,
-<literal>lastIndexOf</literal>, <literal>toLowerCase</literal>,
-<literal>toUpperCase</literal>, <literal>trim</literal>,
-<literal>search</literal>, <literal>match</literal>, <literal>split</literal>,
-<literal>replace</literal>
+<literal>fromCharCode</literal>,
+<link doc="reference.xml" id="string_concat"><literal>concat</literal></link>,
+<link doc="reference.xml" id="string_slice"><literal>slice</literal></link>,
+<link doc="reference.xml" id="string_substring"><literal>substring</literal></link>,
+<link doc="reference.xml" id="string_substr"><literal>substr</literal></link>,
+<literal>charAt</literal>,
+<link doc="reference.xml" id="string_indexof"><literal>indexOf</literal></link>,
+<link doc="reference.xml" id="string_lastindexof"><literal>lastIndexOf</literal></link>,
+<link doc="reference.xml" id="string_tolowercase"><literal>toLowerCase</literal></link>,
+<link doc="reference.xml" id="string_touppercase"><literal>toUpperCase</literal></link>,
+<link doc="reference.xml" id="string_trim"><literal>trim</literal></link>,
+<link doc="reference.xml" id="string_search"><literal>search</literal></link>,
+<link doc="reference.xml" id="string_match"><literal>match</literal></link>,
+<link doc="reference.xml" id="string_split"><literal>split</literal></link>,
+<link doc="reference.xml" id="string_replace"><literal>replace</literal></link>
 </listitem>
 
 <listitem>
 ES6:
-<literal>fromCodePoint</literal>, <literal>codePointAt</literal>,
-<literal>includes</literal>, <literal>startsWith</literal>,
-<literal>endsWith</literal>, <literal>repeat</literal>
+<link doc="reference.xml" id="string_fromcodepoint"><literal>fromCodePoint</literal></link>,
+<literal>codePointAt</literal>,
+<link doc="reference.xml" id="string_includes"><literal>includes</literal></link>,
+<link doc="reference.xml" id="string_startswith"><literal>startsWith</literal></link>,
+<link doc="reference.xml" id="string_endswith"><literal>endsWith</literal></link>,
+<link doc="reference.xml" id="string_repeat"><literal>repeat</literal></link>
 </listitem>
 
 <listitem>
 non-standard:
-<literal>bytesFrom</literal> (0.2.3)
-<literal>fromUTF8</literal>, <literal>toUTF8</literal>,
-<literal>fromBytes</literal>, <literal>toBytes</literal>
+<link doc="reference.xml" id="string_bytesfrom"><literal>bytesFrom</literal></link> (0.2.3)
+<link doc="reference.xml" id="string_fromutf8"><literal>fromUTF8</literal></link>,
+<link doc="reference.xml" id="string_toutf8"><literal>toUTF8</literal></link>,
+<link doc="reference.xml" id="string_frombytes"><literal>fromBytes</literal></link>,
+<link doc="reference.xml" id="string_tobytes"><literal>toBytes</literal></link>
 </listitem>
 </list>
 
@@ -153,7 +165,7 @@ ES5.1 <literal>Date</literal> methods
 </listitem>
 
 <listitem>
-ES5.1 <literal>JSON</literal> object
+ES5.1 <link doc="reference.xml" id="core_json"><literal>JSON</literal></link> object
 </listitem>
 
 <listitem>
@@ -164,8 +176,10 @@ ES5.1 <literal>arguments</literal> objec
 ES5.1 global functions:
 <literal>isFinite</literal>, <literal>isNaN</literal>,
 <literal>parseFloat</literal>, <literal>parseInt</literal>,
-<literal>decodeURI</literal>, <literal>decodeURIComponent</literal>,
-<literal>encodeURI</literal>, <literal>encodeURIComponent</literal>
+<link doc="reference.xml" id="decodeuri"><literal>decodeURI</literal></link>,
+<link doc="reference.xml" id="decodeuricomponent"><literal>decodeURIComponent</literal></link>,
+<link doc="reference.xml" id="encodeuri"><literal>encodeURI</literal></link>,
+<link doc="reference.xml" id="encodeuricomponent"><literal>encodeURIComponent</literal></link>
 </listitem>
 
 <listitem>
@@ -177,24 +191,28 @@ ES5.1 global functions:
 </listitem>
 
 <listitem>
-<literal>setTimeout()</literal> and <literal>clearTimeout()</literal> functions
-(0.2.0)
+<link doc="reference.xml" id="settimeout"><literal>setTimeout</literal></link>
+and
+<link doc="reference.xml" id="cleartimeout"><literal>clearTimeout</literal></link>
+functions (0.2.0)
 </listitem>
 
 <listitem>
 <link url="https://nodejs.org/api/fs.html#fs_file_system">Node.js style</link>
 <literal>File system</literal> methods:
-<literal>fs.readFile</literal>, <literal>fs.readFileSync</literal>,
-<literal>fs.appendFile</literal>, <literal>fs.appendFileSync</literal>,
-<literal>fs.writeFile</literal>, <literal>fs.writeFileSync</literal>
+<literal>fs.readFile</literal>,
+<link doc="reference.xml" id="readfilesync"><literal>fs.readFileSync</literal></link>,
+<literal>fs.appendFile</literal>,
+<link doc="reference.xml" id="appendfilesync"><literal>fs.appendFileSync</literal></link>,
+<literal>fs.writeFile</literal>,
+<link doc="reference.xml" id="writefilesync"><literal>fs.writeFileSync</literal></link>
 </listitem>
 
 <listitem>
 <link url="https://nodejs.org/api/crypto.html#crypto_class_hash">Node.js style</link>
 <literal>Crypto</literal> methods (0.2.0):
-<literal>crypto.createHash</literal>,
-<literal>crypto.createHmac</literal>
-
+<link doc="reference.xml" id="crypto_createhash"><literal>crypto.createHash</literal></link>,
+<link doc="reference.xml" id="crypto_createhmac"><literal>crypto.createHmac</literal></link>
 </listitem>
 
 </list>
--- a/xml/en/docs/njs/reference.xml
+++ b/xml/en/docs/njs/reference.xml
@@ -9,7 +9,7 @@
 <article name="Reference"
         link="/en/docs/njs/reference.html"
         lang="en"
-        rev="11">
+        rev="13">
 
 <section id="summary">
 
@@ -524,7 +524,7 @@ The encoding can be
 </example>
 </tag-desc>
 
-<tag-name><literal>String.fromCodePoint(<value>codePoint1</value>[, ...[,
+<tag-name id="string_fromcodepoint"><literal>String.fromCodePoint(<value>codePoint1</value>[, ...[,
 <value>codePoint2</value>]])</literal></tag-name>
 <tag-desc>
 Returns a string from one or more Unicode code points.
@@ -534,7 +534,7 @@ Returns a string from one or more Unicod
 </example>
 </tag-desc>
 
-<tag-name><literal>String.prototype.concat(<value>string1</value>[, ...,
+<tag-name id="string_concat"><literal>String.prototype.concat(<value>string1</value>[, ...,
 <value>stringN</value>])</literal></tag-name>
 <tag-desc>
 Returns a string that contains the concatenation of specified
@@ -545,7 +545,7 @@ Returns a string that contains the conca
 </example>
 </tag-desc>
 
-<tag-name><literal>String.prototype.endsWith(<value>searchString</value>[,
+<tag-name id="string_endswith"><literal>String.prototype.endsWith(<value>searchString</value>[,
 <value>length</value>])</literal></tag-name>
 <tag-desc>
 Returns <literal>true</literal> if a string ends with the characters
@@ -560,14 +560,14 @@ false
 </example>
 </tag-desc>
 
-<tag-name><literal>String.prototype.fromBytes(<value>start</value>[,
+<tag-name id="string_frombytes"><literal>String.prototype.fromBytes(<value>start</value>[,
 <value>end</value>])</literal></tag-name>
 <tag-desc>
 (njs specific) Returns a new Unicode string from a byte string
 where each byte is replaced with a corresponding Unicode code point.
 </tag-desc>
 
-<tag-name><literal>String.prototype.fromUTF8(<value>start</value>[,
+<tag-name id="string_fromutf8"><literal>String.prototype.fromUTF8(<value>start</value>[,
 <value>end</value>])</literal></tag-name>
 <tag-desc>
 (njs specific) Converts a byte string containing a valid UTF8 string
@@ -575,7 +575,7 @@ into a Unicode string,
 otherwise <literal>null</literal> is returned.
 </tag-desc>
 
-<tag-name><literal>String.prototype.includes(<value>searchString</value>[,
+<tag-name id="string_includes"><literal>String.prototype.includes(<value>searchString</value>[,
 <value>position</value>]))</literal></tag-name>
 <tag-desc>
 Returns <literal>true</literal> if a string is found within another string,
@@ -589,7 +589,7 @@ true
 </example>
 </tag-desc>
 
-<tag-name><literal>String.prototype.indexOf(<value>searchString</value>[,
+<tag-name id="string_indexof"><literal>String.prototype.indexOf(<value>searchString</value>[,
 <value>fromIndex</value>])</literal></tag-name>
 <tag-desc>
 Returns the position of the first occurrence
@@ -609,7 +609,7 @@ 3
 </example>
 </tag-desc>
 
-<tag-name><literal>String.prototype.lastIndexOf(<value>searchString</value>[,
+<tag-name id="string_lastindexof"><literal>String.prototype.lastIndexOf(<value>searchString</value>[,
 <value>fromIndex</value>])</literal></tag-name>
 <tag-desc>
 Returns the position of the last occurrence
@@ -633,7 +633,7 @@ 4
 </example>
 </tag-desc>
 
-<tag-name><literal>String.prototype.match([<value>regexp</value>])</literal></tag-name>
+<tag-name id="string_match"><literal>String.prototype.match([<value>regexp</value>])</literal></tag-name>
 <tag-desc>
 Matches a string against a <literal>regexp</literal>.
 <example>
@@ -666,7 +666,7 @@ to the start of the specified string (0.
 </example>
 </tag-desc>
 
-<tag-name><literal>String.prototype.repeat(<value>number</value>)</literal></tag-name>
+<tag-name id="string_repeat"><literal>String.prototype.repeat(<value>number</value>)</literal></tag-name>
 <tag-desc>
 Returns a string 
 with the specified <literal>number</literal> of copies of the string.
@@ -676,7 +676,7 @@ with the specified <literal>number</lite
 </example>
 </tag-desc>
 
-<tag-name><literal>String.prototype.replace([<value>regexp</value>|<value>string</value>[,
+<tag-name id="string_replace"><literal>String.prototype.replace([<value>regexp</value>|<value>string</value>[,
 <value>string</value>|<value>function</value>]])</literal></tag-name>
 <tag-desc>
 Returns a new string with matches of a pattern
@@ -688,7 +688,7 @@ replaced by a <literal>string</literal> 
 </example>
 </tag-desc>
 
-<tag-name><literal>String.prototype.search([<value>regexp</value>])</literal></tag-name>
+<tag-name id="string_search"><literal>String.prototype.search([<value>regexp</value>])</literal></tag-name>
 <tag-desc>
 Searches for a string using a <literal>regexp</literal>
 <example>
@@ -697,7 +697,7 @@ 3
 </example>
 </tag-desc>
 
-<tag-name><literal>String.prototype.slice(<value>start</value>[,
+<tag-name id="string_slice"><literal>String.prototype.slice(<value>start</value>[,
 <value>end</value>])</literal></tag-name>
 <tag-desc>
 Returns a new string containing a part of an
@@ -710,7 +710,7 @@ from <literal>start</literal> to the end
 </example>
 </tag-desc>
 
-<tag-name><literal>String.prototype.startsWith(<value>searchString</value>[,
+<tag-name id="string_startswith"><literal>String.prototype.startsWith(<value>searchString</value>[,
 <value>position</value>])</literal></tag-name>
 <tag-desc>
 Returns <literal>true</literal> if a string begins with the characters
@@ -726,7 +726,7 @@ false
 </example>
 </tag-desc>
 
-<tag-name><literal>String.prototype.substr(<value>start</value>[,
+<tag-name id="string_substr"><literal>String.prototype.substr(<value>start</value>[,
 <value>length</value>])</literal></tag-name>
 <tag-desc>
 Returns the part of the string of the specified <literal>length</literal>
@@ -738,7 +738,7 @@ or from <literal>start</literal> to the 
 </example>
 </tag-desc>
 
-<tag-name><literal>String.prototype.substring(<value>start</value>[,
+<tag-name id="string_substring"><literal>String.prototype.substring(<value>start</value>[,
 <value>end</value>])</literal></tag-name>
 <tag-desc>
 Returns the part of the string between
@@ -758,7 +758,7 @@ Returns <literal>null</literal> if a cha
 found in the string.
 </tag-desc>
 
-<tag-name><literal>String.prototype.toLowerCase()</literal></tag-name>
+<tag-name id="string_tolowercase"><literal>String.prototype.toLowerCase()</literal></tag-name>
 <tag-desc>
 Converts a string to lower case.
 The method supports only simple Unicode folding.
@@ -788,7 +788,7 @@ encodes a <link id="string_tobytes">byte
 </example>
 </tag-desc>
 
-<tag-name><literal>String.prototype.toUpperCase()</literal></tag-name>
+<tag-name id="string_touppercase"><literal>String.prototype.toUpperCase()</literal></tag-name>
 <tag-desc>
 Converts a string to upper case.
 The method supports only simple Unicode folding.
@@ -811,7 +811,7 @@ 4
 </example>
 </tag-desc>
 
-<tag-name><literal>String.prototype.trim()</literal></tag-name>
+<tag-name id="string_trim"><literal>String.prototype.trim()</literal></tag-name>
 <tag-desc>
 Removes whitespaces from both ends of a string.
 <example>
@@ -820,7 +820,7 @@ Removes whitespaces from both ends of a 
 </example>
 </tag-desc>
 
-<tag-name><literal>String.prototype.split(([<value>string</value>|<value>regexp</value>[,
+<tag-name id="string_split"><literal>String.prototype.split(([<value>string</value>|<value>regexp</value>[,
 <value>limit</value>]]))</literal></tag-name>
 <tag-desc>
 Returns match of a string against a <literal>regexp</literal>.
@@ -847,7 +847,7 @@ representing the UTF-8 encoding of the c
 </example>
 </tag-desc>
 
-<tag-name><literal>encodeURIComponent(<value>encodedURIString</value>)</literal></tag-name>
+<tag-name id="encodeuricomponent"><literal>encodeURIComponent(<value>encodedURIString</value>)</literal></tag-name>
 <tag-desc>
 Encodes a URI by replacing each instance of certain characters
 by one, two, three, or four escape sequences
@@ -858,7 +858,7 @@ representing the UTF-8 encoding of the c
 </example>
 </tag-desc>
 
-<tag-name><literal>decodeURI(<value>encodedURI</value>)</literal></tag-name>
+<tag-name id="decodeuri"><literal>decodeURI(<value>encodedURI</value>)</literal></tag-name>
 <tag-desc>
 Decodes a previously <link id="encodeuri">encoded</link> URI.
 <example>
@@ -867,7 +867,7 @@ Decodes a previously <link id="encodeuri
 </example>
 </tag-desc>
 
-<tag-name><literal>decodeURIComponent(<value>decodedURIString</value>)</literal></tag-name>
+<tag-name id="decodeuricomponent"><literal>decodeURIComponent(<value>decodedURIString</value>)</literal></tag-name>
 <tag-desc>
 Decodes an encoded component of a previously encoded URI.
 <example>
@@ -961,7 +961,7 @@ The Crypto module object is returned by 
 <para>
 <list type="tag">
 
-<tag-name><literal>crypto.createHash(<value>algorithm</value>)</literal></tag-name>
+<tag-name id="crypto_createhash"><literal>crypto.createHash(<value>algorithm</value>)</literal></tag-name>
 <tag-desc>
 Creates and returns a <link id="crypto_hash">Hash</link> object
 that can be used to generate hash digests
@@ -972,7 +972,7 @@ The algorighm can be
 <literal>sha256</literal>.
 </tag-desc>
 
-<tag-name><literal>crypto.createHmac(<value>algorithm</value>,
+<tag-name id="crypto_createhmac"><literal>crypto.createHmac(<value>algorithm</value>,
 <value>secret key</value>)</literal></tag-name>
 <tag-desc>
 Creates and returns an <link id="crypto_hmac">HMAC</link> object
--- a/xml/ru/docs/njs/compatibility.xml
+++ b/xml/ru/docs/njs/compatibility.xml
@@ -9,7 +9,7 @@
 <article name="Совместимость"
         link="/ru/docs/njs/compatibility.html"
         lang="ru"
-        rev="2">
+        rev="3">
 
 <section>
 
@@ -59,28 +59,40 @@ ES6 методы и свойства <literal>Number</literal> и
 
 <listitem>
 ES5.1:
-<literal>fromCharCode</literal>, <literal>concat</literal>,
-<literal>slice</literal>, <literal>substring</literal>,
-<literal>substr</literal>, <literal>charAt</literal>,
-<literal>charCodeAt</literal>, <literal>indexOf</literal>,
-<literal>lastIndexOf</literal>, <literal>toLowerCase</literal>,
-<literal>toUpperCase</literal>, <literal>trim</literal>,
-<literal>search</literal>, <literal>match</literal>, <literal>split</literal>,
-<literal>replace</literal>
+<literal>fromCharCode</literal>,
+<link doc="reference.xml" id="string_concat"><literal>concat</literal></link>,
+<link doc="reference.xml" id="string_slice"><literal>slice</literal></link>,
+<link doc="reference.xml" id="string_substring"><literal>substring</literal></link>,
+<link doc="reference.xml" id="string_substr"><literal>substr</literal></link>,
+<literal>charAt</literal>,
+<link doc="reference.xml" id="string_indexof"><literal>indexOf</literal></link>,
+<link doc="reference.xml" id="string_lastindexof"><literal>lastIndexOf</literal></link>,
+<link doc="reference.xml" id="string_tolowercase"><literal>toLowerCase</literal></link>,
+<link doc="reference.xml" id="string_touppercase"><literal>toUpperCase</literal></link>,
+<link doc="reference.xml" id="string_trim"><literal>trim</literal></link>,
+<link doc="reference.xml" id="string_search"><literal>search</literal></link>,
+<link doc="reference.xml" id="string_match"><literal>match</literal></link>,
+<link doc="reference.xml" id="string_split"><literal>split</literal></link>,
+<link doc="reference.xml" id="string_replace"><literal>replace</literal></link>
 </listitem>
 
 <listitem>
 ES6:
-<literal>fromCodePoint</literal>, <literal>codePointAt</literal>,
-<literal>includes</literal>, <literal>startsWith</literal>,
-<literal>endsWith</literal>, <literal>repeat</literal>
+<link doc="reference.xml" id="string_fromcodepoint"><literal>fromCodePoint</literal></link>,
+<literal>codePointAt</literal>,
+<link doc="reference.xml" id="string_includes"><literal>includes</literal></link>,
+<link doc="reference.xml" id="string_startswith"><literal>startsWith</literal></link>,
+<link doc="reference.xml" id="string_endswith"><literal>endsWith</literal></link>,
+<link doc="reference.xml" id="string_repeat"><literal>repeat</literal></link>
 </listitem>
 
 <listitem>
 нестандартные:
-<literal>bytesFrom</literal> (0.2.3),
-<literal>fromUTF8</literal>, <literal>toUTF8</literal>,
-<literal>fromBytes</literal>, <literal>toBytes</literal>
+<link doc="reference.xml" id="string_bytesfrom"><literal>bytesFrom</literal></link> (0.2.3)
+<link doc="reference.xml" id="string_fromutf8"><literal>fromUTF8</literal></link>,
+<link doc="reference.xml" id="string_toutf8"><literal>toUTF8</literal></link>,
+<link doc="reference.xml" id="string_frombytes"><literal>fromBytes</literal></link>,
+<link doc="reference.xml" id="string_tobytes"><literal>toBytes</literal></link>
 </listitem>
 </list>
 
@@ -153,7 +165,7 @@ ES5.1 методы <literal>Date</literal>
 </listitem>
 
 <listitem>
-ES5.1 объект <literal>JSON</literal>
+ES5.1 объект <link doc="reference.xml" id="core_json"><literal>JSON</literal></link>
 </listitem>
 
 <listitem>
@@ -164,8 +176,10 @@ ES5.1 объект <literal>arguments</literal> (0.2.5)
 ES5.1 глобальные функции:
 <literal>isFinite</literal>, <literal>isNaN</literal>,
 <literal>parseFloat</literal>, <literal>parseInt</literal>,
-<literal>decodeURI</literal>, <literal>decodeURIComponent</literal>,
-<literal>encodeURI</literal>, <literal>encodeURIComponent</literal>
+<link doc="reference.xml" id="decodeuri"><literal>decodeURI</literal></link>,
+<link doc="reference.xml" id="decodeuricomponent"><literal>decodeURIComponent</literal></link>,
+<link doc="reference.xml" id="encodeuri"><literal>encodeURI</literal></link>,
+<link doc="reference.xml" id="encodeuricomponent"><literal>encodeURIComponent</literal></link>
 </listitem>
 
 <listitem>
@@ -177,24 +191,30 @@ ES5.1 глобальные функции:
 </listitem>
 
 <listitem>
-Функции <literal>setTimeout()</literal> и <literal>clearTimeout()</literal>
+Функции
+<link doc="reference.xml" id="settimeout"><literal>setTimeout</literal></link>
+и
+<link doc="reference.xml" id="cleartimeout"><literal>clearTimeout</literal></link>
 (0.2.0)
 </listitem>
 
 <listitem>
 Методы <literal>File system</literal>
 <link url="https://nodejs.org/api/fs.html#fs_file_system">стиль Node.js</link>:
-<literal>fs.readFile</literal>, <literal>fs.readFileSync</literal>,
-<literal>fs.appendFile</literal>, <literal>fs.appendFileSync</literal>,
-<literal>fs.writeFile</literal>, <literal>fs.writeFileSync</literal>
+<literal>fs.readFile</literal>,
+<link doc="reference.xml" id="readfilesync"><literal>fs.readFileSync</literal></link>,
+<literal>fs.appendFile</literal>,
+<link doc="reference.xml" id="appendfilesync"><literal>fs.appendFileSync</literal></link>,
+<literal>fs.writeFile</literal>,
+<link doc="reference.xml" id="writefilesync"><literal>fs.writeFileSync</literal></link>
 </listitem>
 
 <listitem>
 Методы <literal>Crypto</literal>
 <link url="https://nodejs.org/api/crypto.html#crypto_class_hash">стиль Node.js</link>
 (0.2.0):
-<literal>crypto.createHash</literal>,
-<literal>crypto.createHmac</literal>
+<link doc="reference.xml" id="crypto_createhash"><literal>crypto.createHash</literal></link>,
+<link doc="reference.xml" id="crypto_createhmac"><literal>crypto.createHmac</literal></link>
 </listitem>
 
 </list>