aboutsummaryrefslogtreecommitdiff
path: root/man/man3/tomo-Text.quoted.3
blob: 72f9321d834e68a88ebcafbf8f0cd2d4d00e9ed9 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
'\" t
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
.TH Text.quoted 3 2025-04-19T14:52:07.140226 "Tomo man-pages"
.SH NAME
Text.quoted \- Formats the text with quotation marks and escapes.

.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Text.quoted\ :\ func(text:\ Text,\ color:\ Bool\ =\ no,\ quotation_mark:\ Text\ =\ `"`\ ->\ Text)
.fi

.SH DESCRIPTION
Formats the text with quotation marks and escapes.


.TS
allbox;
lb lb lbx lb
l l l l.
Name	Type	Description	Default
text	Text	The text to be quoted. 	-
color	Bool	Whether to add color formatting. 	no
quotation_mark	Text	The quotation mark to use. 	`"`
.TE
.SH RETURN
The text formatted as a quoted text.

.SH EXAMPLES
.EX
>> "one\[rs]ntwo".quoted()
= "\[rs]"one\[rs]\[rs]ntwo\[rs]""
.EE