diff options
| author | Ricardo Wurmus <rekado@elephly.net> | 2021-01-03 15:57:07 +0100 |
|---|---|---|
| committer | Ricardo Wurmus <rekado@elephly.net> | 2021-01-03 15:57:20 +0100 |
| commit | 5e6b5ce6b9cd03d92d8e1b23bd28e7d617a011d0 (patch) | |
| tree | 0d6679c6480437f530084330d957aa35c90dd3d5 | |
| parent | c44ef31172ceb42804331bd2b13649287c48a211 (diff) | |
Document text.
| -rw-r--r-- | Makefile.am | 2 | ||||
| -rw-r--r-- | doc/images/text.svg.scm | 3 | ||||
| -rw-r--r-- | doc/picture-language.texi | 23 |
3 files changed, 25 insertions, 3 deletions
diff --git a/Makefile.am b/Makefile.am index ff1609e..a8b7072 100644 --- a/Makefile.am +++ b/Makefile.am @@ -34,7 +34,7 @@ info_TEXINFOS = doc/picture-language.texi DOC_IMAGES = $(addsuffix .svg.scm, $(addprefix $(top_srcdir)/doc/images/, \ line hline vline polyline polyline2 polygon \ - triangle octagon circle ellipse rectangle \ + triangle octagon circle ellipse rectangle text \ boring-triangles modifiers)) infoimagedir = $(infodir)/images diff --git a/doc/images/text.svg.scm b/doc/images/text.svg.scm new file mode 100644 index 0000000..93b1428 --- /dev/null +++ b/doc/images/text.svg.scm @@ -0,0 +1,3 @@ +(hc-append (text "hello" #:color "blue" #:font-family "serif") + (text "bye" #:color "orange") + (text "! " #:color "lime")) diff --git a/doc/picture-language.texi b/doc/picture-language.texi index c3005da..448203c 100644 --- a/doc/picture-language.texi +++ b/doc/picture-language.texi @@ -403,8 +403,27 @@ drawn by the @code{rectangle} procedure, except that it does not have an outline and is filled with the provided @var{COLOR}. @end deffn -There are more primitive shapes that still need to be documented: -@code{text}. + +@cindex text, simple shape +@deffn {Scheme Procedure} text @ + @var{TXT} @ + [#:color @var{"black"} #:font-family @var{"sans-serif"} #:font-size @var{32} @ + #:font-style @var{"normal"} #:font-weight @var{"normal"}] + +This procedure renders the text @var{TXT}. The height of the text is +always a full line height, which depends on the selected +@var{FONT-FAMILY} and is generally larger than the provided +@var{FONT-SIZE}. The keys @var{FONT-STYLE} (a string), +@var{FONT-WEIGHT} (a string), and @var{COLOR} (also a string) are +also accepted. +@end deffn + +@cindex text, example +Here are a few snippets of text, combined horizontally (see below). +@example +@verbatiminclude images/text.svg.scm +@image{images/text.svg.scm,,,A few snippets of text.} +@end example @c ********************************************************************* @node Modifiers |
