summaryrefslogtreecommitdiff
path: root/doc/guile-heredoc.texi
blob: a5c3fe22e12710e558595bc0d366c1fcaafbea2f (plain) (blame)
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
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
\input texinfo

@settitle "Here-document" syntax in Guile Scheme

@copying
CC BY-SA 4.0
@end copying

@dircategory The Algorithmic Language Scheme
@direntry
* guile-heredoc: (guile-heredoc).     "Here-document" syntax in Guile Scheme
@end direntry

@titlepage
@title "Here-document" syntax in Guile Scheme
@subtitle subtitle FIXME
@author EuAndreh and contributors
@insertcopying
@end titlepage

@contents


@c *****************************************************************************
@node Top
@top "Here-document" syntax in Guile Scheme

@menu
* Introduction::    What this is about.
* Examples::        Quick start.
* API Reference::   The Scheme programming interface..

* Concept Index::   Concepts.
* Procedure Index:: Scheme procedures.
@end menu


@c *****************************************************************************
@node Introduction
@chapter Introduction

@uref{https://euandreh.xyz/guile-heredoc/, guile-heredoc} provides GNU Guile
syntax to @uref{https://en.wikipedia.org/wiki/Here_document, Here document}.

@c *****************************************************************************
@node Examples
@chapter Examples

After enabling the syntax with @code{(enable-syntax)}, the reader for
@code{#""#} strings become active, and you can start using it:

@example
(define s1 #"
  a string
  with indentation
  that gets
  kept"#)

(let ((x #"-
           a string
           with chopped
           indentation"#))
  x)
@end example

@c *****************************************************************************
@node API Reference
@chapter API Reference

@cindex first index

This is the first paragraph.

@cindex index entry, another

This is the second paragraph.

@cindex second

Here i a numbered list:
@enumerate
@item egg
@item milk
@end enumerate

Some @code{code}:
@example
#!/bin/sh
set -eu

echo "$*"
@end example



@c *****************************************************************************
@node Concept Index
@unnumbered Concept Index
@printindex cp

@node Procedure Index
@unnumbered Procedure Index
@printindex fn

@bye