diff options
authorArun Isaac2022-12-27 00:39:23 +0000
committerArun Isaac2022-12-27 00:39:23 +0000
commit3f3c210cdd4c2e8ec3590319616ad4f8c522fb54 (patch)
parent998a13eb34e148cfff83f2b5b1ee5e3f39053d50 (diff)
doc: Add identifiers to all chapters and sections.
* doc/tissue.skb: Add identifiers to all chapters and sections.
1 files changed, 7 insertions, 0 deletions
diff --git a/doc/tissue.skb b/doc/tissue.skb
index 41159ae..3c46c39 100644
--- a/doc/tissue.skb
+++ b/doc/tissue.skb
@@ -21,6 +21,7 @@
(document :title [tissue]
(chapter :title [Introduction]
+ :ident "chapter-introduction"
(p [tissue is an issue tracker and project information management
system built on plain text files and git. It is specifically intended
for small free software projects. It features a static site generator
@@ -30,6 +31,7 @@ built on the ,(ref :url "" :text "Xapian search
engine library"), and is available both as a command-line program and
as a web server.]))
(chapter :title [Gemtext markup for issues]
+ :ident "chapter-gemtext-markup"
(p [Issues must be written in ,(ref
:url ""
:text "gemtext markup") with added extra notation to specify issue
@@ -55,7 +57,9 @@ metadata.])
* \[ \] Then, do this.
* \[ \] Finally, do this.])))
(chapter :title [Reference]
+ :ident "chapter-reference"
(section :title [Object and record constructors]
+ :ident "section-constructors"
(docstring-function-documentation "tissue/tissue.scm" 'tissue-configuration)
(function-documentation 'file [filename writer]
@@ -69,6 +73,7 @@ output file to be created.]
argument and writes data destined for ,(var [filename]) into that
(section :title [Reader functions]
+ :ident "section-reader-functions"
(p [These functions produce ,(code [<document>]) objects (or
objects of classes inheriting from ,(code [<document>])) by reading
files or other data sources.])
@@ -77,6 +82,7 @@ files or other data sources.])
(docstring-function-documentation "tissue/file-document.scm" 'read-gemtext-document)
(docstring-function-documentation "tissue/commit.scm" 'commits-in-current-repository)))
(section :title [Writer functions]
+ :ident "section-writer-functions"
[These functions write output files and are meant to be
specified in a ,(code [<file>]) object.]
@@ -84,6 +90,7 @@ specified in a ,(code [<file>]) object.]
(docstring-function-documentation "tissue/web/static.scm" 'gemtext-exporter)
(docstring-function-documentation "tissue/web/static.scm" 'skribe-exporter)))
(section :title [Utility functions]
+ :ident "section-utility-functions"
[These miscellaneous functions are useful when writing tissue
configuration files.]