the tutorial is now built along with all other HTML documents if --enable-html-docs

* `--enable-html-manual` renamed to `--enable-html-docs`.
* It's also uploaded to the website and linked to in README.

7 files changed, 34 insertions, 22 deletions

diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
index ea5e8c2..6eeb38f 100644
--- a/.github/workflows/ci.yml
+++ b/.github/workflows/ci.yml
@@ -40,7 +40,7 @@ jobs:
         MALLOC_REPLACEMENT: ${{ matrix.interface == 'ncurses' && 'no' || 'check' }}
       run: |
         autoreconf -i
-        ./configure --with-interface=${{ matrix.interface }} --enable-debug --enable-html-manual \
+        ./configure --with-interface=${{ matrix.interface }} --enable-debug --enable-html-docs \
                     --enable-malloc-replacement=$MALLOC_REPLACEMENT ${{ matrix.compiler }}
 
     # NOTE: xvfb-run emulates an XServer and is required when building
@@ -81,7 +81,7 @@ jobs:
         CXX: clang++
       run: |
         autoreconf -i
-        ./configure --with-interface=ncurses --enable-debug --enable-html-manual
+        ./configure --with-interface=ncurses --enable-debug --enable-html-docs
 
     - run: make
     - run: sudo make install
@@ -128,7 +128,7 @@ jobs:
         PDCURSES_CFLAGS: -I/mingw32/include/pdcurses/
       run: |
         autoreconf -i
-        ./configure --with-interface=pdcurses-gui --enable-debug --enable-html-manual
+        ./configure --with-interface=pdcurses-gui --enable-debug --enable-html-docs
 
     - run: make
     - run: make install
diff --git a/.github/workflows/nightly.yml b/.github/workflows/nightly.yml
index ebaa30b..16527eb 100644
--- a/.github/workflows/nightly.yml
+++ b/.github/workflows/nightly.yml
@@ -116,7 +116,7 @@ jobs:
       # with `installer -pkg -target`.
       run: |
         autoreconf -i
-        ./configure --with-interface=ncurses --enable-static-executables --enable-html-manual \
+        ./configure --with-interface=ncurses --enable-static-executables --enable-html-docs \
                     --with-scitecodatadir=../share/sciteco
 
     - name: make
@@ -222,11 +222,11 @@ jobs:
         autoreconf -i
         mkdir build-wingui build-wincon
         (cd build-wingui
-         ../configure --with-interface=pdcurses-gui --enable-html-manual --program-prefix=g \
+         ../configure --with-interface=pdcurses-gui --enable-html-docs --program-prefix=g \
                       --with-scitecodatadir=. \
                       PDCURSES_LIBS="-lpdcurses_wingui -lgdi32 -lcomdlg32 -lwinmm")
         (cd build-wincon
-         ../configure --with-interface=pdcurses --enable-html-manual \
+         ../configure --with-interface=pdcurses --enable-html-docs \
                       --with-scitecodatadir=. \
                       PDCURSES_LIBS="-lpdcurses_wincon -lgdi32 -lwinmm")
 
@@ -308,7 +308,7 @@ jobs:
         LDFLAGS: -flto
       run: |
         autoreconf -i
-        ./configure --with-interface=gtk --enable-html-manual \
+        ./configure --with-interface=gtk --enable-html-docs \
                     --with-scitecodatadir=.
 
     - name: make
diff --git a/README b/README
index 0bb199d..899952c 100644
--- a/README
+++ b/README
@@ -163,6 +163,8 @@ Additional Documentation
   [__sciteco__(7)](https://rhaberkorn.github.io/sciteco/sciteco.7.html),
   [__grosciteco.tes__(1)](https://rhaberkorn.github.io/sciteco/grosciteco.tes.1.html),
   [__tedoc.tes__(1)](https://rhaberkorn.github.io/sciteco/tedoc.tes.1.html)
+* [Tutorial](https://rhaberkorn.github.io/sciteco/tutorial.html):
+  This is what you see when you launch SciTECO for the first time.
 * [Cheat Sheet and Language Overview](https://sciteco.sf.net/manuals/cheat-sheet.pdf).
   This can be printed on an A4 sheet of paper.
 * [Wiki at Github](https://github.com/rhaberkorn/sciteco/wiki)
diff --git a/configure.ac b/configure.ac
index 14ddb86..8620050 100644
--- a/configure.ac
+++ b/configure.ac
@@ -387,11 +387,11 @@ AC_ARG_WITH(teco-integer,
 AC_SUBST(TECO_INTEGER)
 AC_DEFINE_UNQUOTED(TECO_INTEGER, $TECO_INTEGER, [Storage size of TECO integers])
 
-AC_ARG_ENABLE(html-manual,
-	AS_HELP_STRING([--enable-html-manual],
+AC_ARG_ENABLE(html-docs,
+	AS_HELP_STRING([--enable-html-docs],
 		       [Generate and install HTML manuals using Groff [default=no]]),
-	[html_man=$enableval], [html_man=no])
-AM_CONDITIONAL(BUILD_HTMLMAN, [test $html_man = yes])
+	[html_docs=$enableval], [html_docs=no])
+AM_CONDITIONAL(BUILD_HTMLDOCS, [test $html_docs = yes])
 
 AC_ARG_ENABLE(bootstrap,
 	AS_HELP_STRING([--disable-bootstrap],
diff --git a/distribute.mk.in b/distribute.mk.in
index ab79262..cab74ae 100644
--- a/distribute.mk.in
+++ b/distribute.mk.in
@@ -129,7 +129,7 @@ mingw-binary : @PACKAGE@-@PACKAGE_VERSION@-win32.zip
 	             --disable-dependency-tracking \
 		     --with-interface=$(MINGW_UI) \
 		     --disable-bootstrap \
-		     --enable-html-manual \
+		     --enable-html-docs \
 		     CFLAGS="-g -O3 -flto" CXXFLAGS="-g -O3 -flto" \
 	             LDFLAGS="-flto"; \
 	)
diff --git a/doc/Makefile.am b/doc/Makefile.am
index 424d11e..41bb58c 100644
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -78,9 +78,9 @@ man_MANS = grosciteco.tes.1 tedoc.tes.1 sciteco.1 sciteco.7
 
 dist_noinst_SCRIPTS = htbl.tes
 
-if BUILD_HTMLMAN
+if BUILD_HTMLDOCS
 html_DATA = grosciteco.tes.1.html tedoc.tes.1.html \
-            sciteco.1.html sciteco.7.html
+            sciteco.1.html sciteco.7.html tutorial.html
 CLEANFILES += $(html_DATA)
 endif
 
@@ -93,6 +93,9 @@ SUFFIXES += .htbl .html
 .htbl.html:
 	@GROFF@ -wall -Thtml -man $< >$@
 
+.ms.html:
+	@GROFF@ -wall -Thtml -ms $< >$@
+
 # FIXME: We may want to build the cheat sheet automatically.
 # This would require a full Groff installation, though.
 EXTRA_DIST += cheat-sheet.mm
diff --git a/www/build.tes b/www/build.tes
index 9ef1ec4..84f5521 100755
--- a/www/build.tes
+++ b/www/build.tes
@@ -1,7 +1,7 @@
 #!/usr/local/bin/sciteco -m
 !*
  * Generate the website at https://rhaberkorn.github.io/sciteco
- * This reuses content from Markdown documents and the manpages.
+ * This reuses content from Markdown and grohtml-generated documents.
  * Everything else is cross-linked to Sourceforge.
  * It must currently be run from the www/ subdirectory of an in-tree-build.
  * The HTML manuals must be in ../doc.
@@ -78,41 +78,48 @@ EBscreenshots.html HK
   M[footer]
 EW
 
-[manpage-header]
+[grohtml-header]
   <p class="nf nf-fa-warning"> This documents the project's HEAD revision.</p>
   <div class="grohtml">
 
 EB../doc/sciteco.1.html
   S<body>S<h1  L 0,.K
-  [title]sciteco(1) M[header] G[manpage-header]
+  [title]sciteco(1) M[header] G[grohtml-header]
   FD<hr>S</body> .,ZK
   M[footer]
 EWsciteco.1.html
 
 EB../doc/sciteco.7.html
   S<body>S<h1  L 0,.K
-  [title]sciteco(7) M[header] G[manpage-header]
+  [title]sciteco(7) M[header] G[grohtml-header]
   FD<hr>S</body> .,ZK
   M[footer]
 EWsciteco.7.html
 
 !*
- * These manpages are not in the header bar, but still postprocessed
- * for consinstency.
+ * These grohtml-generated documents are not in the header bar,
+ * but still postprocessed for consinstency.
  *!
 
 EB../doc/grosciteco.tes.1.html
   S<body>S<h1  L 0,.K
-  [title]grosciteco.tes(1) M[header] G[manpage-header]
+  [title]grosciteco.tes(1) M[header] G[grohtml-header]
   FD<hr>S</body> .,ZK
   M[footer]
 EWgrosciteco.tes.1.html
 
 EB../doc/tedoc.tes.1.html
   S<body>S<h1  L 0,.K
-  [title]tedoc.tes(1) M[header] G[manpage-header]
+  [title]tedoc.tes(1) M[header] G[grohtml-header]
   FD<hr>S</body> .,ZK
   M[footer]
 EWtedoc.tes.1.html
 
+EB../doc/tutorial.html
+  S<body>S<h1  L 0,.K
+  [title]Tutorial M[header] G[grohtml-header]
+  FD<hr>S</body> .,ZK
+  M[footer]
+EWtutorial.html
+
 EX