blob: 815f54f17accca0e485a3b7713520892864f0f3d (
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
37
38
39
|
'\" t
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
.TH Text.middle_pad 3 2025-04-30 "Tomo man-pages"
.SH NAME
Text.middle_pad \- pad text, centered
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Text.middle_pad\ :\ func(text:\ Text,\ width:\ Int,\ pad:\ Text\ =\ "\ ",\ language:\ Text\ =\ "C"\ ->\ Text)
.fi
.SH DESCRIPTION
Pad some text on the left and right side so it reaches a target width.
.SH ARGUMENTS
.TS
allbox;
lb lb lbx lb
l l l l.
Name Type Description Default
text Text The text to pad. -
width Int The target width. -
pad Text The padding text. "\ "
language Text The ISO 639 language code for which character width to use. "C"
.TE
.SH RETURN
Text with length at least `width`, with extra padding on the left and right as needed. If `pad` has length greater than 1, it may be partially repeated to reach the exact desired length.
.SH EXAMPLES
.EX
>> "x".middle_pad(6)
= " x "
>> "x".middle_pad(10, "ABC")
= "ABCAxABCAB"
.EE
|
