Skip to content

Commit c9af04c

Browse files
kenjiskenjis
committed
docs: shorten the width of tables
1 parent fec61fb commit c9af04c

1 file changed

Lines changed: 72 additions & 72 deletions

File tree

‎user_guide_src/source/outgoing/view_parser.rst‎

Lines changed: 72 additions & 72 deletions
Original file line numberDiff line numberDiff line change
@@ -402,66 +402,65 @@ Provided Filters
402402

403403
The following filters are available when using the parser:
404404

405-
+---------------+---------------------+--------------------------------------------------------------+-------------------------------------+
406-
+ **Filter** + **Arguments** + **Description** + **Example** +
407-
+---------------+---------------------+--------------------------------------------------------------+-------------------------------------+
408-
+ abs + + Displays the absolute value of a number. + { v|abs } +
409-
+---------------+---------------------+--------------------------------------------------------------+-------------------------------------+
410-
+ capitalize + + Displays the string in sentence case: all lowercase + { v|capitalize} +
411-
+ + + with firstletter capitalized. + +
412-
+---------------+---------------------+--------------------------------------------------------------+-------------------------------------+
413-
+ date + format (Y-m-d) + A PHP **date**-compatible formatting string. + { v|date(Y-m-d) } +
414-
+---------------+---------------------+--------------------------------------------------------------+-------------------------------------+
415-
+ date_modify + value to add + A **strtotime** compatible string to modify the date, + { v|date_modify(+1 day) } +
416-
+ + / subtract + like ``+5 day`` or ``-1 week``. + +
417-
+---------------+---------------------+--------------------------------------------------------------+-------------------------------------+
418-
+ default + default value + Displays the default value if the variable is empty or + { v|default(just in case) } +
419-
+ + + undefined. + +
420-
+---------------+---------------------+--------------------------------------------------------------+-------------------------------------+
421-
+ esc + html, attr, css, js + Specifies the context to escape the data. + { v|esc(attr) } +
422-
+---------------+---------------------+--------------------------------------------------------------+-------------------------------------+
423-
+ excerpt + phrase, radius + Returns the text within a radius of words from a given + { v|excerpt(green giant, 20) } +
424-
+ + + phrase. Same as **excerpt** helper function. + +
425-
+---------------+---------------------+--------------------------------------------------------------+-------------------------------------+
426-
+ highlight + phrase + Highlights a given phrase within the text using + { v|highlight(view parser) } +
427-
+ + + '<mark></mark>' tags. + +
428-
+---------------+---------------------+--------------------------------------------------------------+-------------------------------------+
429-
+ highlight_code+ + Highlights code samples with HTML/CSS. + { v|highlight_code } +
430-
+---------------+---------------------+--------------------------------------------------------------+-------------------------------------+
431-
+ limit_chars + limit + Limits the number of characters to $limit. + { v|limit_chars(100) } +
432-
+---------------+---------------------+--------------------------------------------------------------+-------------------------------------+
433-
+ limit_words + limit + Limits the number of words to $limit. + { v|limit_words(20) } +
434-
+---------------+---------------------+--------------------------------------------------------------+-------------------------------------+
435-
+ local_currency+ currency, locale + Displays a localized version of a currency. "currency" + { v|local_currency(EUR,en_US) } +
436-
+ + + valueis any 3-letter ISO 4217 currency code. + +
437-
+---------------+---------------------+--------------------------------------------------------------+-------------------------------------+
438-
+ local_number + type, precision, + Displays a localized version of a number. "type" can be + { v|local_number(decimal,2,en_US) } +
439-
+ + locale + one of: decimal, currency, percent, scientific, spellout, + +
440-
+ + + ordinal, duration. + +
441-
+---------------+---------------------+--------------------------------------------------------------+-------------------------------------+
442-
+ lower + + Converts a string to lowercase. + { v|lower } +
443-
+---------------+---------------------+--------------------------------------------------------------+-------------------------------------+
444-
+ nl2br + + Replaces all newline characters (\n) to an HTML <br/> tag. + { v|nl2br } +
445-
+---------------+---------------------+--------------------------------------------------------------+-------------------------------------+
446-
+ number_format + places + Wraps PHP **number_format** function for use within the + { v|number_format(3) } +
447-
+ + + parser. + +
448-
+---------------+---------------------+--------------------------------------------------------------+-------------------------------------+
449-
+ prose + + Takes a body of text and uses the **auto_typography()** + { v|prose } +
450-
+ + + method to turn it into prettier, easier-to-read, prose. + +
451-
+---------------+---------------------+--------------------------------------------------------------+-------------------------------------+
452-
+ round + places, type + Rounds a number to the specified places. Types of **ceil** + { v|round(3) } { v|round(ceil) } +
453-
+ + + and **floor** can be passed to use those functions instead. + +
454-
+---------------+---------------------+--------------------------------------------------------------+-------------------------------------+
455-
+ strip_tags + allowed chars + Wraps PHP **strip_tags**. Can accept a string of allowed + { v|strip_tags(<br>) } +
456-
+ + + tags. + +
457-
+---------------+---------------------+--------------------------------------------------------------+-------------------------------------+
458-
+ title + + Displays a "title case" version of the string, with all + { v|title } +
459-
+ + + lowercase, and each word capitalized. + +
460-
+---------------+---------------------+--------------------------------------------------------------+-------------------------------------+
461-
+ upper + + Displays the string in all uppercase. + { v|upper } +
462-
+---------------+---------------------+--------------------------------------------------------------+-------------------------------------+
463-
+ + + + +
464-
+---------------+---------------------+--------------------------------------------------------------+-------------------------------------+
405+
================ ================= =========================================================== ======================================
406+
Filter Arguments Description Example
407+
================ ================= =========================================================== ======================================
408+
abs Displays the absolute value of a number. { v|abs }
409+
410+
capitalize Displays the string in sentence case: all lowercase { v|capitalize}
411+
with firstletter capitalized.
412+
413+
date format (Y-m-d) A PHP **date**-compatible formatting string. { v|date(Y-m-d) }
414+
415+
date_modify value to add A **strtotime** compatible string to modify the date, { v|date_modify(+1 day) }
416+
/ subtract like ``+5 day`` or ``-1 week``.
417+
418+
default default value Displays the default value if the variable is empty or { v|default(just in case) }
419+
undefined.
420+
421+
esc html, attr, Specifies the context to escape the data. { v|esc(attr) }
422+
css, js
423+
424+
excerpt phrase, radius Returns the text within a radius of words from a given { v|excerpt(green giant, 20) }
425+
phrase. Same as **excerpt** helper function.
426+
427+
highlight phrase Highlights a given phrase within the text using { v|highlight(view parser) }
428+
'<mark></mark>' tags.
429+
430+
highlight_code Highlights code samples with HTML/CSS. { v|highlight_code }
431+
432+
limit_chars limit Limits the number of characters to $limit. { v|limit_chars(100) }
433+
434+
limit_words limit Limits the number of words to $limit. { v|limit_words(20) }
435+
436+
local_currency currency, locale Displays a localized version of a currency. "currency" { v|local_currency(EUR,en_US) }
437+
valueis any 3-letter ISO 4217 currency code.
438+
439+
local_number type, precision, Displays a localized version of a number. "type" can be { v|local_number(decimal,2,en_US) }
440+
locale one of: decimal, currency, percent, scientific, spellout,
441+
ordinal, duration.
442+
443+
lower Converts a string to lowercase. { v|lower }
444+
445+
nl2br Replaces all newline characters (\n) to an HTML <br/> tag. { v|nl2br }
446+
447+
number_format places Wraps PHP **number_format** function for use within the { v|number_format(3) }
448+
parser.
449+
450+
prose Takes a body of text and uses the **auto_typography()** { v|prose }
451+
method to turn it into prettier, easier-to-read, prose.
452+
453+
round places, type Rounds a number to the specified places. Types of **ceil** { v|round(3) } { v|round(ceil) }
454+
and **floor** can be passed to use those functions instead.
455+
456+
strip_tags allowed chars Wraps PHP **strip_tags**. Can accept a string of allowed { v|strip_tags(<br>) }
457+
tags.
458+
459+
title Displays a "title case" version of the string, with all { v|title }
460+
lowercase, and each word capitalized.
461+
462+
upper Displays the string in all uppercase. { v|upper }
463+
================ ================= =========================================================== ======================================
465464

466465
See `PHP's NumberFormatter <https://www.php.net/manual/en/numberformatter.create.php>`_ for details relevant to the
467466
"local_number" filter.
@@ -519,18 +518,19 @@ Provided Plugins
519518

520519
The following plugins are available when using the parser:
521520

522-
==================== ========================== ================================================================================== ================================================================
523-
Plugin Arguments Description Example
524-
==================== ========================== ================================================================================== ================================================================
525-
current_url Alias for the current_url helper function. {+ current_url +}
526-
previous_url Alias for the previous_url helper function. {+ previous_url +}
527-
siteURL Alias for the site_url helper function. {+ siteURL "login" +}
528-
mailto email, title, attributes Alias for the mailto helper function. {+ mailto email=foo@example.com title="Stranger Things" +}
529-
safe_mailto email, title, attributes Alias for the safe_mailto helper function. {+ safe_mailto email=foo@example.com title="Stranger Things" +}
530-
lang language string Alias for the lang helper function. {+ lang number.terabyteAbbr +}
531-
validation_errors fieldname(optional) Returns either error string for the field (if specified) or all validation errors. {+ validation_errors +} , {+ validation_errors field="email" +}
532-
route route name Alias for the route_to helper function. {+ route "login" +}
533-
==================== ========================== ================================================================================== ================================================================
521+
================== ========================= ============================================ ================================================================
522+
Plugin Arguments Description Example
523+
================== ========================= ============================================ ================================================================
524+
current_url Alias for the current_url helper function. {+ current_url +}
525+
previous_url Alias for the previous_url helper function. {+ previous_url +}
526+
siteURL Alias for the site_url helper function. {+ siteURL "login" +}
527+
mailto email, title, attributes Alias for the mailto helper function. {+ mailto email=foo@example.com title="Stranger Things" +}
528+
safe_mailto email, title, attributes Alias for the safe_mailto helper function. {+ safe_mailto email=foo@example.com title="Stranger Things" +}
529+
lang language string Alias for the lang helper function. {+ lang number.terabyteAbbr +}
530+
validation_errors fieldname(optional) Returns either error string for the field {+ validation_errors +} , {+ validation_errors field="email" +}
531+
(if specified) or all validation errors.
532+
route route name Alias for the route_to helper function. {+ route "login" +}
533+
================== ========================= ============================================ ================================================================
534534

535535
Registering a Plugin
536536
--------------------

0 commit comments

Comments
 (0)