commit 386743f486f96044e233d7a46ccdd3947aa9c3b5
parent eea327242068759cae78c38d6097a36b23cd4beb
Author: Vincent Forest <vincent.forest@meso-star.com>
Date: Sat, 4 Oct 2025 17:40:21 +0200
Document the menu.tsv file in star-typesetting manual
Diffstat:
1 file changed, 60 insertions(+), 1 deletion(-)
diff --git a/doc/star-typesetting.7 b/doc/star-typesetting.7
@@ -101,6 +101,63 @@ and
files.
.\"""""""""""""""""""""""""""""
.Ss menu.tsv
+The menu.tsv file is mandatory for
+.Nm .
+It must be located at the root of the working directory.
+In fact, it is the presence of this file that defines a directory as the
+working directory for
+.Nm .
+.Pp
+This file defines the top-level entries in the navigation menu.
+It is a simple text file where each line is formatted into two fields
+separated by a tab which define the label of the entry followed by the
+content it targets, respectively.
+.Pp
+The linked content can be:
+.Bl -dash -offset Ds
+.It
+a local subdirectory, i.e. a section directory containing an
+.Pa index.tsv
+file
+.Po
+see the
+.Sx index.tsv
+section
+.Pc .
+.It
+a remote directory that remains relative to the current working
+directory once installed, but managed elsewhere.
+.It
+an external http[s] URL
+.El
+.Pp
+Empty lines are ignored, as are comments, i.e., text after the hash
+character
+.Pq # .
+Finally, the entries in the navigation menu follow the order of entries
+defined in the
+.Pa menu.tsv
+file.
+.Pp
+Below is an example of a
+.Pa menu.tsv
+file that defines four entries: two targeting sections, one external
+URL, and the last one a remote directory, local to the working tree
+once deployed, but managed elsewhere.
+Note that there is no difference between normal sections and the git
+entry, except that the latter targets a directory that is not local to
+the working tree before it is deployed to the remote server.
+.Bd -literal -offset Ds
+# Regular sections
+About my_section
+Doc man_pages
+
+# External link to the content license
+License http://creativecommons.org/licenses/by-nd/4.0/
+
+# Web interface for git repositories
+Git git
+.Ed
.\"""""""""""""""""""""""""""""
.Ss index.tsv
.\"""""""""""""""""""""""""""""
@@ -156,7 +213,9 @@ present in a section:
is supposed to store downloadable content for the section, such as
archives, PDFs, etc.
.It Pa hooks
-stores scripts to be executed by sty before generating the section's
+stores scripts to be executed by
+.Nm
+before generating the section's
content.
Refer to the section of the manual devoted to hooks for a complete
description.
