Convert SSI includes to tt includes in manpages

This was a bigger effort, and involves a new target, manhtml.

Reviewed-by: Anton Arapov <anton@openssl.org>
Reviewed-by: Tomas Vavra <tvavra@openssl.org>
(Merged from https://github.com/openssl/web/pull/426)

diff --git a/Makefile b/Makefile
index 4cf48ea103019ab17bfb178fd7c4db9030767873..0af7b627fa7e53bc49e8ea5187f4df0d558aaad1 100644 (file)
--- a/Makefile
+++ b/Makefile
@@ -128,13 +128,13 @@ TECHNICAL_POLICIES=$(filter-out $(CHECKOUTS)/technical-policies/policies/README.
        @rm -f $@
        ./bin/from-tt $<
 
-all: suball subdocs manmaster mancross sitemap akamai-purge
+all: suball subdocs manmastertts mancross manhtml sitemap akamai-purge
 
 suball: $(SIMPLE) $(SRCLISTS)
 
 relupd: suball docs sitemap akamai-purge
 
-docs: subdocs manpages mancross
+docs: subdocs manpagetts mancross manhtml
 
 subdocs: $(SIMPLEDOCS)
 
@@ -171,9 +171,9 @@ bin/md-to-html5: inc/pandoc-template.html5
 ##
 ##  A lot of the work is made with generated rules.
 
-# makemanpages1 and makemanpages3 creates rules for targets like man-pages-1.1.1,
-# to build the set of man-pages.  makemanpages1 is used for pre-3.0 OpenSSL,
-# while makemanpages3 is used for OpenSSL 3.0 and on.
+# makemanpagetts1 and makemanpagetts3 creates rules for targets like man-pagetts-1.1.1,
+# to build the set of man-page templates.  makemanpagetts1 is used for pre-3.0 OpenSSL,
+# while makemanpagetts3 is used for OpenSSL 3.0 and on.
 # makemanapropos creates rules for targets like man-apropos-1.1.1, to build
 # 'apropos' like indexes for all the manpages.
 # makemanindexes creates rules for targets like man-index-1.1.1, to build the
@@ -182,26 +182,26 @@ bin/md-to-html5: inc/pandoc-template.html5
 # $(1) = input directory in CHECKOUTS, $(2) = release version
 
 # This variant is for pre-3.0 documentation
-define makemanpages1
-man-pages-$(2):
+define makemanpagetts1
+man-pagetts-$(2):
        @rm -rf docs/man$(2)
        @mkdir -p docs/man$(2) \
                  docs/man$(2)/man1 \
                  docs/man$(2)/man3 \
                  docs/man$(2)/man5 \
                  docs/man$(2)/man7
-       ./bin/mk-manpages $(CHECKOUTS)/$(1)/doc $(2) docs/man$(2)
+       ./bin/mk-manpagetts $(CHECKOUTS)/$(1)/doc $(2) docs/man$(2)
 endef
 # This variant is for 3.0 documentation
-define makemanpages3
-man-pages-$(2):
+define makemanpagetts3
+man-pagetts-$(2):
        @rm -rf docs/man$(2)
        @mkdir -p docs/man$(2) \
                  docs/man$(2)/man1 \
                  docs/man$(2)/man3 \
                  docs/man$(2)/man5 \
                  docs/man$(2)/man7
-       ./bin/mk-manpages3 $(CHECKOUTS)/$(1) $(2) docs/man$(2)
+       ./bin/mk-manpagetts3 $(CHECKOUTS)/$(1) $(2) docs/man$(2)
 endef
 define makemanapropos
 docs/man$(2)/man1/index.inc: bin/mk-apropos Makefile
@@ -246,19 +246,19 @@ endef
 define makemandirdata
 docs/man$(2)/man1/dirdata.yaml: docs/sub-dirdata.yaml.tt bin/from-tt Makefile
        ./bin/from-tt -d docs/man$(2)/man1 \
-                     releases='$(MANSERIES)' release='$(2)' \
+                     releases='$(MANSERIES)' release='$(2)' sectnum=1 \
                      < $$< > $$@
 docs/man$(2)/man3/dirdata.yaml: docs/sub-dirdata.yaml.tt bin/from-tt Makefile
        ./bin/from-tt -d docs/man$(2)/man3 \
-                     releases='$(MANSERIES)' release='$(2)' \
+                     releases='$(MANSERIES)' release='$(2)' sectnum=3 \
                      < $$< > $$@
 docs/man$(2)/man5/dirdata.yaml: docs/sub-dirdata.yaml.tt bin/from-tt Makefile
        ./bin/from-tt -d docs/man$(2)/man5 \
-                     releases='$(MANSERIES)' release='$(2)' \
+                     releases='$(MANSERIES)' release='$(2)' sectnum=5 \
                      < $$< > $$@
 docs/man$(2)/man7/dirdata.yaml: docs/sub-dirdata.yaml.tt bin/from-tt Makefile
        ./bin/from-tt -d docs/man$(2)/man7 \
-                     releases='$(MANSERIES)' release='$(2)' \
+                     releases='$(MANSERIES)' release='$(2)' sectnum=7 \
                      < $$< > $$@
 docs/man$(2)/dirdata.yaml: docs/sub-dirdata.yaml.tt bin/from-tt Makefile
        ./bin/from-tt -d docs/man$(2) \
@@ -266,13 +266,13 @@ docs/man$(2)/dirdata.yaml: docs/sub-dirdata.yaml.tt bin/from-tt Makefile
                      < $$< > $$@
 endef
 define makemanuals1
-$(eval $(call makemanpages1,$(1),$(2)))
+$(eval $(call makemanpagetts1,$(1),$(2)))
 $(eval $(call makemanapropos,$(1),$(2)))
 $(eval $(call makemanindexes,$(1),$(2)))
 $(eval $(call makemandirdata,$(1),$(2)))
 endef
 define makemanuals3
-$(eval $(call makemanpages3,$(1),$(2)))
+$(eval $(call makemanpagetts3,$(1),$(2)))
 $(eval $(call makemanapropos,$(1),$(2)))
 $(eval $(call makemanindexes,$(1),$(2)))
 $(eval $(call makemandirdata,$(1),$(2)))
@@ -292,19 +292,40 @@ $(foreach S,$(MANSERIES3),$(eval $(call makemanuals3,openssl-$(S),$(S))))
 # source from $(CHECKOUTS)/openssl-x.y.z-stable/doc
 $(foreach S,$(MANSERIES1),$(eval $(call makemanuals1,openssl-$(S)-stable,$(S))))
 
-MANMASTER_TARGETS = \
-        man-pages-master docs/manmaster/index.html \
-        $(foreach SEC,1 3 5 7, docs/manmaster/man$(SEC)/index.html)
-manmaster: $(MANMASTER_TARGETS)
-MANPAGES_TARGETS = \
+MANMASTER_DIRS = \
+       $(foreach SEC,1 3 5 7, docs/manmaster/man$(SEC))
+MANMASTERTT_TARGETS = \
+        man-pagetts-master \
+        docs/manmaster/dirdata.yaml docs/manmaster/index.html \
+        $(foreach D,$(MANMASTER_DIRS), $(D)/dirdata.yaml $(D)/index.html)
+manmastertts: $(MANMASTERTT_TARGETS)
+MANPAGE_DIRS = \
         $(foreach S,$(MANSERIES), \
-          man-pages-$(S) docs/man$(S)/index.html \
-          $(foreach SEC,1 3 5 7, docs/man$(S)/man$(SEC)/index.html))
-manpages: manmaster $(MANPAGES_TARGETS)
+          $(foreach SEC,1 3 5 7, docs/man$(S)/man$(SEC)))
+MANPAGETT_TARGETS = \
+        $(foreach S,$(MANSERIES), man-pagetts-$(S) \
+          docs/man$(S)/dirdata.yaml docs/man$(S)/index.html) \
+        $(foreach D,$(MANPAGE_DIRS), $(D)/dirdata.yaml $(D)/index.html)
+manpagetts: manmastertts $(MANPAGETT_TARGETS)
 
 mancross:
        ./bin/mk-mancross master $(MANSERIES)
 
+# We can't get all the files when make is started, but we can make the
+# patterns for a for loop.
+MANHTML_TTPATTERNS=$(foreach D,$(MANMASTER_DIRS) $(MANPAGE_DIRS), $(D)/*.md.tt)
+manhtml:
+       @set -e; for t in $(MANHTML_TTPATTERNS); do \
+               if ! [ -f "$$t" ]; then continue; fi; \
+               d="$$(dirname $$t)"; \
+               h="$$(basename "$$t" .md.tt)"; \
+               i=; \
+               if [ "$$h" = "index" ]; then i=" -i"; fi; \
+               echo "$$t -> $$h.html"; \
+               ./bin/from-tt -d "$$d" < "$$d/$$h.md.tt" \
+                       | ./bin/md-to-html5$$i -o "$$d/$$h.html"; \
+       done
+
 docs/manpages.md: docs/manpages.md.tt Makefile bin/from-tt
        @rm -f $@
        ./bin/from-tt releases='master $(MANSERIES)' $<

diff --git a/bin/mk-apropos b/bin/mk-apropos
index 64899a4d33ce81b01016ca2e1702976623695435..125faa17f9ba1af7a32d80723fcfb3c2d1555b2b 100755 (executable)
--- a/bin/mk-apropos
+++ b/bin/mk-apropos
@@ -4,15 +4,15 @@
 dir=$1
 cd $dir
 
-for m in `find . -name '*.html' | sort`; do
-    description=`grep -F '<!-- OSSL: description:' $m | sed -e 's|^[^:]*: *||' -e 's|^[^:]*: *||' -e 's| *-->||'`
+for m in `find . -name '*.md.tt' | sort`; do
+    description=`grep '^OSSL-description:' $m | sed -e 's|^[^:]*: *||' -e 's|^ *"||' -e 's|" *||'`
     # If there isn't a description, it isn't a manpage and should not be
     # included
     if [ "$description" = "" ]; then
        continue
     fi
     manfile=`echo $m | sed -e 's|\./||'`
-    manname=`basename $manfile .html`
+    manname=`basename $manfile .md.tt`
     origmanfile=`echo $manfile | sed -e "s|^$subdir|$origsubdir|"`
-    echo "<tr><td><a href=\"$manfile\">$manname</a></td><td>$description</td></tr>"
+    echo "| [$manname]($manname.html) | $description |"
 done

diff --git a/bin/mk-mancross b/bin/mk-mancross
index eaf72bf79da6a89d583b6d77d7d9e201c7f8368a..5e7c55aab7e62e9533b3dc7c6eac5ce97a625334 100755 (executable)
--- a/bin/mk-mancross
+++ b/bin/mk-mancross
@@ -21,39 +21,31 @@ for r in $releases; do
     echo >&2 -n "$r : "
     for s in 1 3 5 7; do
        echo >&2 -n $s
-       for f in docs/man$r/man$s/*.html; do
+       for f in docs/man$r/man$s/*.md.tt; do
            $debug -n '.'
-           # Check that it's a rendered manpage
-           if grep -F '<!-- OSSL: description:' $f > /dev/null; then
-               existsin=''
-               b=`basename $f .html`
-               for x in $releases; do
-                   if [ "$x" = "$r" ]; then
-                       continue
-                   fi
-                   if [ -f "docs/man$x/man$s/$b.html" ]; then
-                       existsin="$existsin $x"
-                   fi
-               done
-               (
-                   if [ "$existsin" != "" ]; then
-                       cat <<EOF
-  <section>
-    <h1>This manpage</h1>
-    <ul>
-EOF
-                       for x in $existsin; do
-                           cat <<EOF
-      <li><a href="/docs/man$x/man$s/$b.html">$x version</a></li>
+           existsin=''
+           b=`basename $f .md.tt`
+           for x in $releases; do
+               if [ "$x" = "$r" ]; then
+                   continue
+               fi
+               if [ -f "docs/man$x/man$s/$b.md.tt" ]; then
+                   existsin="$existsin $x"
+               fi
+           done
+           (
+               if [ "$existsin" != "" ]; then
+                   cat <<EOF
+sidebar: |
+  # This manpage
 EOF
-                       done
+                   for x in $existsin; do
                        cat <<EOF
-    </ul>
-  </section>
+  -   [$x version]([% top %]docs/man$x/man$s/$b.html)
 EOF
-                   fi
-               ) > docs/man$r/man$s/$b.cross
-           fi
+                   done
+               fi
+           ) > docs/man$r/man$s/$b.cross
        done
     done
     echo >&2

diff --git a/bin/mk-manpages b/bin/mk-manpagetts
similarity index 70%
rename from bin/mk-manpages
rename to bin/mk-manpagetts
index 59113427f5f0a2b80b3a6e147725f05a27817ffc..b63e291d56d878ef5fb09c4f0955f58c19239cd9 100755 (executable)
--- a/bin/mk-manpages
+++ b/bin/mk-manpagetts
@@ -64,83 +64,49 @@ sub main {
                 print $fh $out or $class->die("Can't print $outinc: $!");
                 close($fh) or $class->die("Can't close $outinc: $!");
 
-                my @htmlnames =
+                my @mdttnames =
                     map { (my $x = $_) =~ s|/|-|g; $x } @{$data{names}};
                 # Older OpenSSL pods have file names that do not correspond
                 # to any of the names in the NAME section.
                 # Strictly speaking, we shouldn't use that name, but HTML
                 # pages with that name have been produced in the past, so
                 # we keep doing so as long as it's relevant.
-                if (! grep { $_ eq $origbase } @htmlnames) {
-                    push @htmlnames, $origbase;
+                if (! grep { $_ eq $origbase } @mdttnames) {
+                    push @mdttnames, $origbase;
                 }
-                foreach my $htmlname (@htmlnames) {
-                    my $htmlfile = File::Spec->catdir( "man$data{sectnum}",
-                                                       "$htmlname.html" );
-                    my $outhtml = File::Spec->catfile( $wwwdir, $htmlfile );
-                    $out = $class->genhtml( $release, $title, $origbase,
-                                            $htmlname, %data );
-                    open( $fh, ">", $outhtml )
-                        or $class->die("Can't open $outhtml: $!");
-                    print $fh $out or $class->die("Can't print $outhtml: $!");
-                    close($fh) or $class->die("Can't close $outhtml: $!");
+                foreach my $mdttname (@mdttnames) {
+                    my $mdttfile = File::Spec->catdir( "man$data{sectnum}",
+                                                       "$mdttname.md.tt" );
+                    my $outmdtt = File::Spec->catfile( $wwwdir, $mdttfile );
+                    $out = $class->genmdtt( $release, $title, $origbase,
+                                            $mdttname, %data );
+                    open( $fh, ">", $outmdtt )
+                        or $class->die("Can't open $outmdtt: $!");
+                    print $fh $out or $class->die("Can't print $outmdtt: $!");
+                    close($fh) or $class->die("Can't close $outmdtt: $!");
                 }
             }
         }
     }
 }
 
-# Generate manpag HTML wrapper
-sub genhtml {
-    my ( $class, $release, $title, $origbase, $htmlbase, %data ) = @_;
+# Generate manpage markdown template wrapper
+sub genmdtt {
+    my ( $class, $release, $title, $origbase, $mdttbase, %data ) = @_;
+    # Note that the .inc file is pure HTML.
+    # That's OK, markdown can include HTML, by definition.
     return <<EOH;
-<!DOCTYPE html>
-<html lang="en">
-<!-- OSSL: original subdir: $data{subdir} -->
-<!-- OSSL: subdir: man$data{sectnum} -->
-<!-- OSSL: section: $data{sectnum} -->
-<!-- OSSL: description: $data{description} -->
-<!--#include virtual="/inc/head.shtml" -->
-<body>
-<!--#include virtual="/inc/banner.shtml" -->
-  <div id="main">
-    <div id="content">
-      <div class="blog-index">
-        <article>
-          <header><h2>$title</h2></header>
-          <div class="entry-content">
-            <p>
-<!--#include virtual="$origbase.inc" -->
-            </p>
-          </div>
-          <footer>
-            You are here: <a href="/">Home</a>
-            : <a href="/docs">Docs</a>
-            : <a href="/docs/manpages.html">Manpages</a>
-            : <a href="/docs/man$release/">$release</a>
-            : <a href="/docs/man$release/man$data{sectnum}">man$data{sectnum}</a>
-            : <a href="/docs/man$release/man$data{sectnum}/$htmlbase.html">$htmlbase</a>
-            <br/><a href="/sitemap.txt">Sitemap</a>
-          </footer>
-        </article>
-      </div>
-      <aside class="sidebar">
-        <section>
-          <h1><a href="/docs/man$release/">$release manpages</a></h1>
-          <ul>
-            <li><a href="../man1">Commands</a></li>
-            <li><a href="../man3">Libraries</a></li>
-            <li><a href="../man5">File Formats</a></li>
-            <li><a href="../man7">Overviews</a></li>
-          </ul>
-        </section>
-<!--#include virtual="$htmlbase.cross" -->
-      </aside>
-    </div>
-  </div>
-<!--#include virtual="/inc/footer.shtml" -->
-</body>
-</html>
+---
+OSSL-original-subdir: $data{subdir}
+OSSL-subdir: man$data{sectnum}
+OSSL-section: $data{sectnum}
+OSSL-description: "$data{description}"
+breadcrumb: $mdttbase
+[% INCLUDE "$mdttbase.cross" %]
+---
+## $title
+
+[% INCLUDE "$origbase.inc" %]
 EOH
 }
 
@@ -263,34 +229,44 @@ __END__
 
 =head1 NAME
 
-mk-manpages - htmlize man pages from POD for the OpenSSL website
+mk-manpagetts - man pages from POD into markdown/html templates
 
 =head1 SYNOPSIS
 
-mk-manpages [options] <SrcDir> <RelVer> <WwwDir>
+ mk-manpagetts [options] <SrcDir> <RelVer> <WwwDir>
 
   <SrcDir>   doc directory of release <RelVer>, example 'OpenSSL_1_0_2-stable/doc'
   <RelVer>   version number associated with <SrcDir>, example '1.0.2'
-  <WwwDir>   top level directory beneath which generated html is stored, example 'web'
+  <WwwDir>   top level directory beneath which generated template is stored,
+             example 'web'
 
     --help    display a brief help message
     --man     display full documentation
 
+This script is only useful with pre-3.0 OpenSSL.  For OpenSSL 3.0 and on,
+please use mk-manpagetts3.
+
 =head1 DESCRIPTION
 
-This utility is run on a web server generate the htmlized version of
-OpenSSL documentation from the original POD.  The resultant directory
+This utility is run on a web server generate the markdown/html template version
+of OpenSSL documentation from the original POD.  The resultant directory
 structure may look something like the following (where the contents of
 index.html do not come from this tool):
 
  $ ls some/path/to/web
  man1.0.2    man1.1.0    manmaster
  $ ls some/path/to/web/man1.0.2
- apps        crypto      index.html  ssl
+ index.html  man1        man3        man5        man7
  $ ls some/path/to/web/man1.0.2/apps
- CA.pl.html
- asn1parse.html
- c_rehash.html
+ CA.pl.md.tt
+ asn1parse.md.tt
+ c_rehash.md.tt
  ...
 
+The result needs further processing by other tools.  Among others, the .md.tt
+files rely on the presence of a corresponding .cross file, which is usually
+produced later, when all .md.tt files are in place.  To finish everything off,
+the .md.tt files need to be passed through C<tpage>, and the resulting markdown
+must be converted into pure html with a well chosen tool.
+
 =cut

diff --git a/bin/mk-manpages3 b/bin/mk-manpagetts3
similarity index 94%
rename from bin/mk-manpages3
rename to bin/mk-manpagetts3
index dda2be5ca77b7527002e28f58aab2c09c180863c..9cb32fbfc83ddecb4646f1002277925579226e69 100755 (executable)
--- a/bin/mk-manpages3
+++ b/bin/mk-manpagetts3
@@ -30,8 +30,8 @@ srcdir=tmp-install/share/doc/openssl/html
         description="$($HERE/all-html-man-names < $destdir/$G | sed -e 's|^.* - ||' -e 's|\&|\\\&|g')"
         names="$($HERE/all-html-man-names < $destdir/$G | sed -e 's| - .*||' -e 's|, *| |g' -e 's|/|-|g')"
         for name in $names; do
-            G=$Dn/$name.html
-           cat $HERE/../inc/manpage-template.html5 \
+            G=$Dn/$name.md.tt
+           cat $HERE/../inc/manpage-template.mdtt \
                 | sed -E \
                       -e "s|\\\$release\\\$|$series|g" \
                       -e "s|\\\$sectnum\\\$|$section|g" \

diff --git a/docs/sub-dirdata.yaml.tt b/docs/sub-dirdata.yaml.tt
index baec218f802ebb5a9413fdf22dad00ada9f9ae46..60f05dc898167b326df44e2f23564aa6a266ea8d 100644 (file)
--- a/docs/sub-dirdata.yaml.tt
+++ b/docs/sub-dirdata.yaml.tt
@@ -3,7 +3,8 @@ breadcrumbs: >-
   [Home]([% top %]) :
   [Documentation]([% top %]docs) :
   [Manpages]([% top %]docs/manpages.html)[% IF release.defined %] :
-  [[% release %]]([% top %]docs/man[% release %])[% END %]
+  [[% release %]]([% top %]docs/man[% release %])[% IF sectnum.defined %] :
+  [man[% sectnum %]]([% top %]docs/man[% release %]/man[% sectnum %])[% END %][% END %]
 sidebar: |
   # [Manpages]([% top %]docs/manpages.html)
 

diff --git a/docs/sub-man1-index.md.tt b/docs/sub-man1-index.md.tt
index bfe7b79fe6a930cb57fdb31ca24374e1d275d5ab..90f50d08710b85a726427f9c11cf5225525e2909 100644 (file)
--- a/docs/sub-man1-index.md.tt
+++ b/docs/sub-man1-index.md.tt
@@ -6,12 +6,6 @@ breadcrumb: commands
 The [openssl](openssl.html) manpage provides a general overview of all
 the commands.
 
-<p>
-<table style="border-spacing: 10px 0;">
-  <tr>
-    <td>NAME</td>
-    <td>Description</td>
-  </tr>
-  [% INCLUDE "index.inc" %]
-</table>
-</p>
+| NAME | Description |
+| ---- | ----------- |
+[% INCLUDE "index.inc" %]

diff --git a/docs/sub-man3-index.md.tt b/docs/sub-man3-index.md.tt
index ceca28aa2a73dfe3e595b802dd7f937d82554a8d..74d64a6478f5d0b85b15e34d3f2cd58b1f2e6330 100644 (file)
--- a/docs/sub-man3-index.md.tt
+++ b/docs/sub-man3-index.md.tt
@@ -7,12 +7,6 @@ This is the OpenSSL API for the SSL and Crypto libraries.
 The [ssl](../man7/ssl.html) and [crypto](../man7/crypto.html) manpages
 are general overviews of those libraries.
 
-<p>
-<table style="border-spacing: 10px 0;">
-  <tr>
-    <td>NAME</td>
-    <td>Description</td>
-  </tr>
-  [% INCLUDE "index.inc" %]
-</table>
-</p>
+| NAME | Description |
+| ---- | ----------- |
+[% INCLUDE "index.inc" %]

diff --git a/docs/sub-man5-index.md.tt b/docs/sub-man5-index.md.tt
index 3dd2b350a18cddd3e36d4d34bf1b42cdacffe64f..52389e5897ce884bd163a66be56c345172c5d97e 100644 (file)
--- a/docs/sub-man5-index.md.tt
+++ b/docs/sub-man5-index.md.tt
@@ -3,12 +3,6 @@ breadcrumb: file formats
 ---
 # OpenSSL file formats and conventions
 
-<p>
-<table style="border-spacing: 10px 0;">
-  <tr>
-    <td>NAME</td>
-    <td>Description</td>
-  </tr>
-  [% INCLUDE "index.inc" %]
-</table>
-</p>
+| NAME | Description |
+| ---- | ----------- |
+[% INCLUDE "index.inc" %]

diff --git a/docs/sub-man7-index.md.tt b/docs/sub-man7-index.md.tt
index c56471315245c9864f96fd5db21769870ead0366..ba23058428a574f53f5dc4821f9896d7c71e4640 100644 (file)
--- a/docs/sub-man7-index.md.tt
+++ b/docs/sub-man7-index.md.tt
@@ -3,12 +3,6 @@ breadcrumb: overviews
 ---
 # OpenSSL overviews
 
-<p>
-<table style="border-spacing: 10px 0;">
-  <tr>
-    <td>NAME</td>
-    <td>Description</td>
-  </tr>
-  [% INCLUDE "index.inc" %]
-</table>
-</p>
+| NAME | Description |
+| ---- | ----------- |
+[% INCLUDE "index.inc" %]

diff --git a/inc/manpage-template.html5 b/inc/manpage-template.html5
deleted file mode 100644 (file)
index f38e698..0000000
--- a/inc/manpage-template.html5
+++ /dev/null
@@ -1,46 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
-<!-- OSSL: subdir: man$sectnum$ -->
-<!-- OSSL: section: $sectnum$ -->
-<!-- OSSL: description: $description$ -->
-<!--#include virtual="/inc/head.shtml" -->
-<body>
-<!--#include virtual="/inc/banner.shtml" -->
-  <div id="main">
-    <div id="content">
-      <div class="blog-index">
-        <article>
-          <header><h2>$name$</h2></header>
-          <div class="entry-content">
-            <p>
-<!--#include virtual="$origname$.inc" -->
-            </p>
-          </div>
-          <footer>
-            You are here: <a href="/">Home</a>
-            : <a href="/docs">Docs</a>
-            : <a href="/docs/manpages.html">Manpages</a>
-            : <a href="/docs/man$release$/">$release$</a>
-            : <a href="/docs/man$release$/man$sectnum$">man$sectnum$</a>
-            : <a href="/docs/man$release$/man$sectnum$/$name$.html">$name$</a>
-            <br/><a href="/sitemap.txt">Sitemap</a>
-          </footer>
-        </article>
-      </div>
-      <aside class="sidebar">
-        <section>
-          <h1><a href="/docs/man$release$/">$release$ manpages</a></h1>
-          <ul>
-            <li><a href="../man1">Commands</a></li>
-            <li><a href="../man3">Libraries</a></li>
-            <li><a href="../man5">File Formats</a></li>
-            <li><a href="../man7">Overviews</a></li>
-          </ul>
-        </section>
-<!--#include virtual="$name$.cross" -->
-      </aside>
-    </div>
-  </div>
-<!--#include virtual="/inc/footer.shtml" -->
-</body>
-</html>

diff --git a/inc/manpage-template.mdtt b/inc/manpage-template.mdtt
new file mode 100644 (file)
index 0000000..333c1ad
--- /dev/null
+++ b/inc/manpage-template.mdtt
@@ -0,0 +1,10 @@
+---
+OSSL-subdir: man$sectnum$
+OSSL-section: $sectnum$
+OSSL-description: "$description$"
+breadcrumb: $name$
+[% INCLUDE "$name$.cross" %]
+---
+## $name$
+
+[% INCLUDE "$origname$.inc" %]