doc/guile-heredoc.texi: Init basic documentation skeleton

1 files changed, 105 insertions, 0 deletions

diff --git a/doc/guile-heredoc.texi b/doc/guile-heredoc.texi
index e69de29..a5c3fe2 100644
--- a/doc/guile-heredoc.texi
+++ b/doc/guile-heredoc.texi
@@ -0,0 +1,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