diff options
| author | github-actions[bot] <github-actions[bot]@users.noreply.github.com> | 2023-07-18 17:16:03 +0000 |
|---|---|---|
| committer | github-actions[bot] <github-actions[bot]@users.noreply.github.com> | 2023-07-18 17:16:03 +0000 |
| commit | 62857a9f5472f91185287289e0366b7040409141 (patch) | |
| tree | 0e8ace61e992c60287f5b8396a060e0a86419237 | |
| parent | 90cff55b13e3dbe6d0181defd76899f7a7759c78 (diff) | |
Update website
| -rw-r--r-- | manual/index.html | 358 |
1 files changed, 282 insertions, 76 deletions
diff --git a/manual/index.html b/manual/index.html index 7aa1af6c..e044d591 100644 --- a/manual/index.html +++ b/manual/index.html @@ -4303,6 +4303,31 @@ in the input are not supported.</p> converted to the specified case.</p> + <div> + + <a data-toggle="collapse" href="#example63"> + <i class="glyphicon glyphicon-chevron-right"></i> + Example + </a> + <div id="example63" class="manual-example collapse"> + + <table> + <tr><th></th><td class="jqprogram">jq 'ascii_upcase'</td></tr> + <tr><th>Input</th><td>"useful but not for é"</td></tr> + + + <tr> + + <th>Output</th> + + <td>"USEFUL BUT NOT FOR é"</td> + </tr> + + </table> + + </div> + </div> + </section> <section id="while(cond;update)"> @@ -4320,11 +4345,11 @@ output for each input. See advanced topics below.</p> <div> - <a data-toggle="collapse" href="#example63"> + <a data-toggle="collapse" href="#example64"> <i class="glyphicon glyphicon-chevron-right"></i> Example </a> - <div id="example63" class="manual-example collapse"> + <div id="example64" class="manual-example collapse"> <table> <tr><th></th><td class="jqprogram">jq '[while(.<100; .*2)]'</td></tr> @@ -4360,11 +4385,11 @@ output for each input. See advanced topics below.</p> <div> - <a data-toggle="collapse" href="#example64"> + <a data-toggle="collapse" href="#example65"> <i class="glyphicon glyphicon-chevron-right"></i> Example </a> - <div id="example64" class="manual-example collapse"> + <div id="example65" class="manual-example collapse"> <table> <tr><th></th><td class="jqprogram">jq '[repeat(.*2, error)?]'</td></tr> @@ -4402,11 +4427,11 @@ output for each input. See advanced topics below.</p> <div> - <a data-toggle="collapse" href="#example65"> + <a data-toggle="collapse" href="#example66"> <i class="glyphicon glyphicon-chevron-right"></i> Example </a> - <div id="example65" class="manual-example collapse"> + <div id="example66" class="manual-example collapse"> <table> <tr><th></th><td class="jqprogram">jq '[.,1]|until(.[0] < 1; [.[0] - 1, .[1] * .[0]])|.[1]'</td></tr> @@ -4465,11 +4490,11 @@ input.</p> <div> - <a data-toggle="collapse" href="#example66"> + <a data-toggle="collapse" href="#example67"> <i class="glyphicon glyphicon-chevron-right"></i> Examples </a> - <div id="example66" class="manual-example collapse"> + <div id="example67" class="manual-example collapse"> <table> <tr><th></th><td class="jqprogram">jq 'recurse(.foo[])'</td></tr> @@ -4594,11 +4619,11 @@ input can be considered for alteration.</p> <div> - <a data-toggle="collapse" href="#example67"> + <a data-toggle="collapse" href="#example68"> <i class="glyphicon glyphicon-chevron-right"></i> Examples </a> - <div id="example67" class="manual-example collapse"> + <div id="example68" class="manual-example collapse"> <table> <tr><th></th><td class="jqprogram">jq 'walk(if type == "array" then sort else . end)'</td></tr> @@ -4647,11 +4672,11 @@ variables.</p> <div> - <a data-toggle="collapse" href="#example68"> + <a data-toggle="collapse" href="#example69"> <i class="glyphicon glyphicon-chevron-right"></i> Examples </a> - <div id="example68" class="manual-example collapse"> + <div id="example69" class="manual-example collapse"> <table> <tr><th></th><td class="jqprogram">jq '$ENV.PAGER'</td></tr> @@ -4697,11 +4722,11 @@ Rows are padded with nulls so the result is always rectangular.</p> <div> - <a data-toggle="collapse" href="#example69"> + <a data-toggle="collapse" href="#example70"> <i class="glyphicon glyphicon-chevron-right"></i> Example </a> - <div id="example69" class="manual-example collapse"> + <div id="example70" class="manual-example collapse"> <table> <tr><th></th><td class="jqprogram">jq 'transpose'</td></tr> @@ -4739,11 +4764,11 @@ interest.</p> <div> - <a data-toggle="collapse" href="#example70"> + <a data-toggle="collapse" href="#example71"> <i class="glyphicon glyphicon-chevron-right"></i> Examples </a> - <div id="example70" class="manual-example collapse"> + <div id="example71" class="manual-example collapse"> <table> <tr><th></th><td class="jqprogram">jq 'bsearch(0)'</td></tr> @@ -4804,11 +4829,11 @@ interpolated into the string.</p> <div> - <a data-toggle="collapse" href="#example71"> + <a data-toggle="collapse" href="#example72"> <i class="glyphicon glyphicon-chevron-right"></i> Example </a> - <div id="example71" class="manual-example collapse"> + <div id="example72" class="manual-example collapse"> <table> <tr><th></th><td class="jqprogram">jq '"The input was \(.), which is one less than \(.+1)"'</td></tr> @@ -4842,11 +4867,11 @@ unmodified, while <code>tojson</code> encodes strings as JSON strings.</p> <div> - <a data-toggle="collapse" href="#example72"> + <a data-toggle="collapse" href="#example73"> <i class="glyphicon glyphicon-chevron-right"></i> Examples </a> - <div id="example72" class="manual-example collapse"> + <div id="example73" class="manual-example collapse"> <table> <tr><th></th><td class="jqprogram">jq '[.[]|tostring]'</td></tr> @@ -4971,11 +4996,11 @@ not escaped, as they were part of the string literal.</p> <div> - <a data-toggle="collapse" href="#example73"> + <a data-toggle="collapse" href="#example74"> <i class="glyphicon glyphicon-chevron-right"></i> Examples </a> - <div id="example73" class="manual-example collapse"> + <div id="example74" class="manual-example collapse"> <table> <tr><th></th><td class="jqprogram">jq '@html'</td></tr> @@ -5093,11 +5118,11 @@ some systems. In particular, the <code>%u</code> and <code>%j</code> specifiers <div> - <a data-toggle="collapse" href="#example74"> + <a data-toggle="collapse" href="#example75"> <i class="glyphicon glyphicon-chevron-right"></i> Examples </a> - <div id="example74" class="manual-example collapse"> + <div id="example75" class="manual-example collapse"> <table> <tr><th></th><td class="jqprogram">jq 'fromdate'</td></tr> @@ -5226,11 +5251,11 @@ JavaScript's <code>===</code>, the "strict equality" operator.</p> <div> - <a data-toggle="collapse" href="#example75"> + <a data-toggle="collapse" href="#example76"> <i class="glyphicon glyphicon-chevron-right"></i> Examples </a> - <div id="example75" class="manual-example collapse"> + <div id="example76" class="manual-example collapse"> <table> <tr><th></th><td class="jqprogram">jq '. == false'</td></tr> @@ -5325,11 +5350,11 @@ once for each false or null.</p> <div> - <a data-toggle="collapse" href="#example76"> + <a data-toggle="collapse" href="#example77"> <i class="glyphicon glyphicon-chevron-right"></i> Example </a> - <div id="example76" class="manual-example collapse"> + <div id="example77" class="manual-example collapse"> <table> <tr><th></th><td class="jqprogram">jq 'if . == 0 then @@ -5370,11 +5395,11 @@ to, less than or equal to or less than their right argument <div> - <a data-toggle="collapse" href="#example77"> + <a data-toggle="collapse" href="#example78"> <i class="glyphicon glyphicon-chevron-right"></i> Example </a> - <div id="example77" class="manual-example collapse"> + <div id="example78" class="manual-example collapse"> <table> <tr><th></th><td class="jqprogram">jq '. < 5'</td></tr> @@ -5420,11 +5445,11 @@ evaluating a condition, see the <code>//</code> operator below.</p> <div> - <a data-toggle="collapse" href="#example78"> + <a data-toggle="collapse" href="#example79"> <i class="glyphicon glyphicon-chevron-right"></i> Examples </a> - <div id="example78" class="manual-example collapse"> + <div id="example79" class="manual-example collapse"> <table> <tr><th></th><td class="jqprogram">jq '42 and "a string"'</td></tr> @@ -5532,11 +5557,11 @@ operations).</p> <div> - <a data-toggle="collapse" href="#example79"> + <a data-toggle="collapse" href="#example80"> <i class="glyphicon glyphicon-chevron-right"></i> Examples </a> - <div id="example79" class="manual-example collapse"> + <div id="example80" class="manual-example collapse"> <table> <tr><th></th><td class="jqprogram">jq '.foo // 42'</td></tr> @@ -5586,11 +5611,11 @@ expression to try.</p> <div> - <a data-toggle="collapse" href="#example80"> + <a data-toggle="collapse" href="#example81"> <i class="glyphicon glyphicon-chevron-right"></i> Examples </a> - <div id="example80" class="manual-example collapse"> + <div id="example81" class="manual-example collapse"> <table> <tr><th></th><td class="jqprogram">jq 'try .a catch ". is not an object"'</td></tr> @@ -5681,11 +5706,11 @@ is lexical: the label has to be "visible" from the break.</p> <div> - <a data-toggle="collapse" href="#example81"> + <a data-toggle="collapse" href="#example82"> <i class="glyphicon glyphicon-chevron-right"></i> Examples </a> - <div id="example81" class="manual-example collapse"> + <div id="example82" class="manual-example collapse"> <table> <tr><th></th><td class="jqprogram">jq '[.[] | .a?]'</td></tr> @@ -5776,11 +5801,11 @@ for whether or not the regex matches the input.</p> <div> - <a data-toggle="collapse" href="#example82"> + <a data-toggle="collapse" href="#example83"> <i class="glyphicon glyphicon-chevron-right"></i> Examples </a> - <div id="example82" class="manual-example collapse"> + <div id="example83" class="manual-example collapse"> <table> <tr><th></th><td class="jqprogram">jq 'test("foo")'</td></tr> @@ -5847,11 +5872,11 @@ the following fields:</p> <div> - <a data-toggle="collapse" href="#example83"> + <a data-toggle="collapse" href="#example84"> <i class="glyphicon glyphicon-chevron-right"></i> Examples </a> - <div id="example83" class="manual-example collapse"> + <div id="example84" class="manual-example collapse"> <table> <tr><th></th><td class="jqprogram">jq 'match("(abc)+"; "g")'</td></tr> @@ -5961,11 +5986,11 @@ corresponding value.</p> <div> - <a data-toggle="collapse" href="#example84"> + <a data-toggle="collapse" href="#example85"> <i class="glyphicon glyphicon-chevron-right"></i> Example </a> - <div id="example84" class="manual-example collapse"> + <div id="example85" class="manual-example collapse"> <table> <tr><th></th><td class="jqprogram">jq 'capture("(?<a>[a-z]+)-(?<n>[0-9]+)")'</td></tr> @@ -5998,6 +6023,38 @@ To capture all the matches for each input string, use the idiom <code>[ expr ]</code>, e.g. <code>[ scan(regex) ]</code>.</p> + <div> + + <a data-toggle="collapse" href="#example86"> + <i class="glyphicon glyphicon-chevron-right"></i> + Example + </a> + <div id="example86" class="manual-example collapse"> + + <table> + <tr><th></th><td class="jqprogram">jq 'scan("c")'</td></tr> + <tr><th>Input</th><td>"abcdefabc"</td></tr> + + + <tr> + + <th>Output</th> + + <td>"c"</td> + </tr> + + <tr> + + <th></th> + + <td>"c"</td> + </tr> + + </table> + + </div> + </div> + </section> <section id="split(regex;flags)"> @@ -6010,6 +6067,31 @@ To capture all the matches for each input string, use the idiom <code>split</code> splits on a string, not a regex.</p> + <div> + + <a data-toggle="collapse" href="#example87"> + <i class="glyphicon glyphicon-chevron-right"></i> + Example + </a> + <div id="example87" class="manual-example collapse"> + + <table> + <tr><th></th><td class="jqprogram">jq 'split(", *"; null)'</td></tr> + <tr><th>Input</th><td>"ab,cd, ef"</td></tr> + + + <tr> + + <th>Output</th> + + <td>["ab","cd","ef"]</td> + </tr> + + </table> + + </div> + </div> + </section> <section id="splits(regex),splits(regex;flags)"> @@ -6021,6 +6103,52 @@ To capture all the matches for each input string, use the idiom but as a stream instead of an array.</p> + <div> + + <a data-toggle="collapse" href="#example88"> + <i class="glyphicon glyphicon-chevron-right"></i> + Example + </a> + <div id="example88" class="manual-example collapse"> + + <table> + <tr><th></th><td class="jqprogram">jq 'splits(", *")'</td></tr> + <tr><th>Input</th><td>"ab,cd, ef, gh"</td></tr> + + + <tr> + + <th>Output</th> + + <td>"ab"</td> + </tr> + + <tr> + + <th></th> + + <td>"cd"</td> + </tr> + + <tr> + + <th></th> + + <td>"ef"</td> + </tr> + + <tr> + + <th></th> + + <td>"gh"</td> + </tr> + + </table> + + </div> + </div> + </section> <section id="sub(regex;tostring),sub(regex;tostring;flags)"> @@ -6038,6 +6166,45 @@ as a JSON object (as constructed by <code>capture</code>) to would take the form: <code>"\(.x)"</code>.</p> + <div> + + <a data-toggle="collapse" href="#example89"> + <i class="glyphicon glyphicon-chevron-right"></i> + Examples + </a> + <div id="example89" class="manual-example collapse"> + + <table> + <tr><th></th><td class="jqprogram">jq 'sub("[^a-z]*(?<x>[a-z]+)"; "Z\(.x)"; "g")'</td></tr> + <tr><th>Input</th><td>"123abc456def"</td></tr> + + + <tr> + + <th>Output</th> + + <td>"ZabcZdef"</td> + </tr> + + </table> + + <table> + <tr><th></th><td class="jqprogram">jq '[sub("(?<a>.)"; "\(.a|ascii_upcase)", "\(.a|ascii_downcase)")]'</td></tr> + <tr><th>Input</th><td>"aB"</td></tr> + + + <tr> + + <th>Output</th> + + <td>["AB","aB"]</td> + </tr> + + </table> + + </div> + </div> + </section> <section id="gsub(regex;tostring),gsub(regex;tostring;flags)"> @@ -6050,6 +6217,45 @@ replaced by <code>tostring</code>, after interpolation. If the second argument i of jq strings, then <code>gsub</code> will produce a corresponding stream of JSON strings.</p> + <div> + + <a data-toggle="collapse" href="#example90"> + <i class="glyphicon glyphicon-chevron-right"></i> + Examples + </a> + <div id="example90" class="manual-example collapse"> + + <table> + <tr><th></th><td class="jqprogram">jq 'gsub("(?<x>.)[^a]*"; "+\(.x)-")'</td></tr> + <tr><th>Input</th><td>"Abcabc"</td></tr> + + + <tr> + + <th>Output</th> + + <td>"+A-+a-"</td> + </tr> + + </table> + + <table> + <tr><th></th><td class="jqprogram">jq '[gsub("p"; "a", "b")]'</td></tr> + <tr><th>Input</th><td>"p"</td></tr> + + + <tr> + + <th>Output</th> + + <td>["a","b"]</td> + </tr> + + </table> + + </div> + </div> + </section> </section> @@ -6154,11 +6360,11 @@ will not be visible where the old one was.</p> <div> - <a data-toggle="collapse" href="#example85"> + <a data-toggle="collapse" href="#example91"> <i class="glyphicon glyphicon-chevron-right"></i> Examples </a> - <div id="example85" class="manual-example collapse"> + <div id="example91" class="manual-example collapse"> <table> <tr><th></th><td class="jqprogram">jq '.bar as $x | .foo | . + $x'</td></tr> @@ -6270,11 +6476,11 @@ that occur during the final alternative are passed through.</p> <div> - <a data-toggle="collapse" href="#example86"> + <a data-toggle="collapse" href="#example92"> <i class="glyphicon glyphicon-chevron-right"></i> Examples </a> - <div id="example86" class="manual-example collapse"> + <div id="example92" class="manual-example collapse"> <table> <tr><th></th><td class="jqprogram">jq '.[] as {$a, $b, c: {$d, $e}} ?// {$a, $b, c: [{$d, $e}]} | {$a, $b, $d, $e}'</td></tr> @@ -6385,11 +6591,11 @@ See also the section below on scoping.</p> <div> - <a data-toggle="collapse" href="#example87"> + <a data-toggle="collapse" href="#example93"> <i class="glyphicon glyphicon-chevron-right"></i> Examples </a> - <div id="example87" class="manual-example collapse"> + <div id="example93" class="manual-example collapse"> <table> <tr><th></th><td class="jqprogram">jq 'def addvalue(f): . + [f]; map(addvalue(.[0]))'</td></tr> @@ -6467,11 +6673,11 @@ effect is similar to running something like this:</p> <div> - <a data-toggle="collapse" href="#example88"> + <a data-toggle="collapse" href="#example94"> <i class="glyphicon glyphicon-chevron-right"></i> Example </a> - <div id="example88" class="manual-example collapse"> + <div id="example94" class="manual-example collapse"> <table> <tr><th></th><td class="jqprogram">jq 'reduce .[] as $item (0; . + $item)'</td></tr> @@ -6502,11 +6708,11 @@ effect is similar to running something like this:</p> <div> - <a data-toggle="collapse" href="#example89"> + <a data-toggle="collapse" href="#example95"> <i class="glyphicon glyphicon-chevron-right"></i> Example </a> - <div id="example89" class="manual-example collapse"> + <div id="example95" class="manual-example collapse"> <table> <tr><th></th><td class="jqprogram">jq 'isempty(empty)'</td></tr> @@ -6537,11 +6743,11 @@ effect is similar to running something like this:</p> <div> - <a data-toggle="collapse" href="#example90"> + <a data-toggle="collapse" href="#example96"> <i class="glyphicon glyphicon-chevron-right"></i> Example </a> - <div id="example90" class="manual-example collapse"> + <div id="example96" class="manual-example collapse"> <table> <tr><th></th><td class="jqprogram">jq '[limit(3;.[])]'</td></tr> @@ -6575,11 +6781,11 @@ Note that <code>nth(n; expr)</code> doesn't support negative values of <code>n</ <div> - <a data-toggle="collapse" href="#example91"> + <a data-toggle="collapse" href="#example97"> <i class="glyphicon glyphicon-chevron-right"></i> Example </a> - <div id="example91" class="manual-example collapse"> + <div id="example97" class="manual-example collapse"> <table> <tr><th></th><td class="jqprogram">jq '[first(range(.)), last(range(.)), nth(./2; range(.))]'</td></tr> @@ -6612,11 +6818,11 @@ and last values from any array at <code>.</code>.</p> <div> - <a data-toggle="collapse" href="#example92"> + <a data-toggle="collapse" href="#example98"> <i class="glyphicon glyphicon-chevron-right"></i> Example </a> - <div id="example92" class="manual-example collapse"> + <div id="example98" class="manual-example collapse"> <table> <tr><th></th><td class="jqprogram">jq '[range(.)]|[first, last, nth(5)]'</td></tr> @@ -6659,11 +6865,11 @@ allows for partial reductions (see the example below).</p> <div> - <a data-toggle="collapse" href="#example93"> + <a data-toggle="collapse" href="#example99"> <i class="glyphicon glyphicon-chevron-right"></i> Example </a> - <div id="example93" class="manual-example collapse"> + <div id="example99" class="manual-example collapse"> <table> <tr><th></th><td class="jqprogram">jq '[foreach .[] as $item ([[],[]]; if $item == null then [[],.[0]] else [(.[0] + [$item]),[]] end; if $item == null then .[1] else empty end)]'</td></tr> @@ -6744,11 +6950,11 @@ generator construction, and sub-functions.</p> <div> - <a data-toggle="collapse" href="#example94"> + <a data-toggle="collapse" href="#example100"> <i class="glyphicon glyphicon-chevron-right"></i> Examples </a> - <div id="example94" class="manual-example collapse"> + <div id="example100" class="manual-example collapse"> <table> <tr><th></th><td class="jqprogram">jq 'def range(init; upto; by): def _range: if (by > 0 and . < upto) or (by < 0 and . > upto) then ., ((.+by)|_range) else . end; if by == 0 then init else init|_range end | select((by > 0 and . < upto) or (by < 0 and . > upto)); range(0; 10; 3)'</td></tr> @@ -6976,11 +7182,11 @@ given streaming expression.</p> <div> - <a data-toggle="collapse" href="#example95"> + <a data-toggle="collapse" href="#example101"> <i class="glyphicon glyphicon-chevron-right"></i> Example </a> - <div id="example95" class="manual-example collapse"> + <div id="example101" class="manual-example collapse"> <table> <tr><th></th><td class="jqprogram">jq '[1|truncate_stream([[0],1],[[1,0],2],[[1,0]],[[1]])]'</td></tr> @@ -7012,11 +7218,11 @@ outputs.</p> <div> - <a data-toggle="collapse" href="#example96"> + <a data-toggle="collapse" href="#example102"> <i class="glyphicon glyphicon-chevron-right"></i> Example </a> - <div id="example96" class="manual-example collapse"> + <div id="example102" class="manual-example collapse"> <table> <tr><th></th><td class="jqprogram">jq 'fromstream(1|truncate_stream([[0],1],[[1,0],2],[[1,0]],[[1]]))'</td></tr> @@ -7047,11 +7253,11 @@ outputs.</p> <div> - <a data-toggle="collapse" href="#example97"> + <a data-toggle="collapse" href="#example103"> <i class="glyphicon glyphicon-chevron-right"></i> Example </a> - <div id="example97" class="manual-example collapse"> + <div id="example103" class="manual-example collapse"> <table> |