From e9529184c63991cb646cc81b7b78f988392f0eb7 Mon Sep 17 00:00:00 2001 From: Greg Lueck Date: Sun, 28 Jul 2024 11:14:24 -0400 Subject: [PATCH] Some editorial cleanup * Remove the footer from the HTML build, which contained a confusing date. * Remove some unused Asciidoc attributes that I think we inherited from another project when we first copied our Asciidoc configuration files. * Fix some minor bugs in the "syclbase.adoc" file. I compared the HTML render, and the only change this introduces is due to the first bullet item above. The HTML output no longer contains the line "Last updated" with a confusing date. --- adoc/config/attribs.adoc | 4 ---- adoc/syclbase.adoc | 19 +++++++++++++++++-- 2 files changed, 17 insertions(+), 6 deletions(-) diff --git a/adoc/config/attribs.adoc b/adoc/config/attribs.adoc index 3ba4108e..48f03bf6 100644 --- a/adoc/config/attribs.adoc +++ b/adoc/config/attribs.adoc @@ -69,7 +69,3 @@ endif::backend-html5[] ifndef::backend-html5[] :wbro: endif::backend-html5[] - -// Placeholders for host synchronization block text -:externsynctitle: Host Synchronization -:externsyncprefix: Host access to diff --git a/adoc/syclbase.adoc b/adoc/syclbase.adoc index 903661af..1439f542 100644 --- a/adoc/syclbase.adoc +++ b/adoc/syclbase.adoc @@ -5,7 +5,7 @@ // This should be set by the Makefile based on values in // ../sycl_version.txt, passed into the asciidoctor command line. :SYCL_LANGUAGE_VERSION: [red]#Unknown SYCL_LANGUAGE_VERSION!# -:SYCL_NAMEA: [red]#Unknown SYCL_NAME!# +:SYCL_NAME: [red]#Unknown SYCL_NAME!# :SYCL_VERSION: [red]#Unknown SYCL_VERSION!# :SYCL_REVISION: [red]#Unknown SYCL_REVISION!# @@ -14,6 +14,21 @@ // http://discuss.asciidoctor.org/How-to-add-markup-to-author-information-in-document-title-td6488.html :regtitle: pass:q,r[^®^] +// Disable the footer for the HTML render. The footer for HTML is not well +// documented in Asciidoc, but it appears to insert a line "Last updated " +// at the very bottom of the HTML where the is the timestamp of the +// "syclbase.adoc" file. This date is confusing because it might be quite a bit +// older than the last modification to the specification. We already have the +// specification date in the HTML header, which shows the timestamp when the +// specification was built from Asciidoc sources. +// +// Note that we *do* want a footer in the PDF render, which contains completely +// different content. The PDF footer shows the page number and the current +// chapter. +ifdef::backend-html5[] +:nofooter: +endif::[] + = {SYCL_NAME}{tmtitle} {SYCL_VERSION} Specification (revision {SYCL_REVISION}) The Khronos{regtitle} {SYCL_NAME}{tmtitle} Working Group :data-uri: @@ -110,7 +125,7 @@ toc::[] :leveloffset: 1 -include::chapters/acknowledgements.adoc[][] +include::chapters/acknowledgements.adoc[] // \include{introduction} include::chapters/introduction.adoc[]