From 88e0111605d7417807a8e381152d75a196cc2fe0 Mon Sep 17 00:00:00 2001 From: EuAndreh Date: Fri, 12 Aug 2022 18:19:18 -0300 Subject: doc/guile-heredoc.texi: Init basic documentation skeleton --- doc/guile-heredoc.texi | 105 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 105 insertions(+) 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 -- cgit v1.2.3