git: bd3bd0e60c - main - doc: Add links for Split and Single HTML pages

[Danilo G. Baio]

The branch main has been updated by dbaio:

URL: https://cgit.FreeBSD.org/doc/commit/?id=bd3bd0e60cc0258d822b66cb5ebc3a758d3b58e8

commit bd3bd0e60cc0258d822b66cb5ebc3a758d3b58e8
Author:     Danilo G. Baio <dbaio at FreeBSD.org>
AuthorDate: 2021-07-11 19:14:59 +0000
Commit:     Danilo G. Baio <dbaio at FreeBSD.org>
CommitDate: 2021-07-11 20:07:38 +0000

    doc: Add links for Split and Single HTML pages
    
    [ Split HTML / Single HTML ]
    
    We have this only for the biggest books. They have this option of single
    or split pages, but currently, it's shown for users just the split pages
    without the link to the single HTML.
    
    This is an option we had before.
    
    Reviewed by:    carlavilla
    Differential Revision: https://reviews.freebsd.org/D31147
---
 documentation/content/en/books/arch-handbook/_index.adoc       |  1 +
 documentation/content/en/books/arch-handbook/book.adoc         |  1 +
 documentation/content/en/books/developers-handbook/_index.adoc |  1 +
 documentation/content/en/books/developers-handbook/book.adoc   |  1 +
 documentation/content/en/books/fdp-primer/_index.adoc          |  1 +
 documentation/content/en/books/fdp-primer/book.adoc            |  1 +
 documentation/content/en/books/handbook/_index.adoc            |  1 +
 documentation/content/en/books/handbook/book.adoc              |  1 +
 documentation/content/en/books/porters-handbook/_index.adoc    |  1 +
 documentation/content/en/books/porters-handbook/book.adoc      |  1 +
 documentation/themes/beastie/layouts/books/list.html           | 10 ++++++++++
 documentation/themes/beastie/layouts/books/single.html         | 10 ++++++++++
 12 files changed, 30 insertions(+)

diff --git a/documentation/content/en/books/arch-handbook/_index.adoc b/documentation/content/en/books/arch-handbook/_index.adoc
index e8bf6ce45f..5c9e8730de 100644
--- a/documentation/content/en/books/arch-handbook/_index.adoc
+++ b/documentation/content/en/books/arch-handbook/_index.adoc
@@ -7,6 +7,7 @@ description: For FreeBSD system developers. This book covers the architectural d
 tags: ["Arch Handbook", "FreeBSD", "Index"]
 next: books/arch-handbook/parti
 weight: 50
+add_single_page_link: true
 ---
 
 = FreeBSD Architecture Handbook
diff --git a/documentation/content/en/books/arch-handbook/book.adoc b/documentation/content/en/books/arch-handbook/book.adoc
index 338c62bd4a..04fcaf9f71 100644
--- a/documentation/content/en/books/arch-handbook/book.adoc
+++ b/documentation/content/en/books/arch-handbook/book.adoc
@@ -6,6 +6,7 @@ copyright: Copyright © 2000-2006, 2012-2013 The FreeBSD Documentation Project
 description: FreeBSD Architecture Handbook
 trademarks: ["freebsd", "apple", "microsoft", "unix", "general"]
 tags: ["Arch Handbook", "FreeBSD"]
+add_split_page_link: true
 ---
 
 = FreeBSD Architecture Handbook
diff --git a/documentation/content/en/books/developers-handbook/_index.adoc b/documentation/content/en/books/developers-handbook/_index.adoc
index 43db14ab19..0e84ae38f4 100644
--- a/documentation/content/en/books/developers-handbook/_index.adoc
+++ b/documentation/content/en/books/developers-handbook/_index.adoc
@@ -8,6 +8,7 @@ trademarks: ["freebsd", "apple", "ibm", "ieee", "intel", "linux", "microsoft", "
 next: books/developers-handbook/parti
 weight: 25
 tags: ["FreeBSD Developers' Handbook"]
+add_single_page_link: true
 ---
 
 = FreeBSD Developers' Handbook
diff --git a/documentation/content/en/books/developers-handbook/book.adoc b/documentation/content/en/books/developers-handbook/book.adoc
index f874755ccd..4eced64bb6 100644
--- a/documentation/content/en/books/developers-handbook/book.adoc
+++ b/documentation/content/en/books/developers-handbook/book.adoc
@@ -6,6 +6,7 @@ copyright: 1995-2021 The FreeBSD Documentation Project
 description: FreeBSD Developers' Handbook
 trademarks: ["freebsd", "apple", "ibm", "ieee", "intel", "linux", "microsoft", "opengroup", "sun", "general"]
 tags: ["FreeBSD Developers' Handbook", "Index"]
+add_split_page_link: true
 ---
 
 = FreeBSD Developers' Handbook
diff --git a/documentation/content/en/books/fdp-primer/_index.adoc b/documentation/content/en/books/fdp-primer/_index.adoc
index 6b3ac39953..4807dad36a 100644
--- a/documentation/content/en/books/fdp-primer/_index.adoc
+++ b/documentation/content/en/books/fdp-primer/_index.adoc
@@ -8,6 +8,7 @@ description: Everything you need to know in order to start contributing to the F
 next: books/fdp-primer/preface
 weight: 10
 tags: ["FDP", "documentation", "FreeBSD", "Index"]
+add_single_page_link: true
 ---
 
 = FreeBSD Documentation Project Primer for New Contributors
diff --git a/documentation/content/en/books/fdp-primer/book.adoc b/documentation/content/en/books/fdp-primer/book.adoc
index 4e0466a240..fc47b2ed53 100644
--- a/documentation/content/en/books/fdp-primer/book.adoc
+++ b/documentation/content/en/books/fdp-primer/book.adoc
@@ -6,6 +6,7 @@ copyright: 1998-2021 DocEng
 description: FreeBSD Documentation Project Primer for New Contributors Index
 trademarks: ["general"]
 tags: ["FDP", "documentation", "FreeBSD", "Index"]
+add_split_page_link: true
 ---
 
 = FreeBSD Documentation Project Primer for New Contributors
diff --git a/documentation/content/en/books/handbook/_index.adoc b/documentation/content/en/books/handbook/_index.adoc
index af69a1236e..aff7230788 100644
--- a/documentation/content/en/books/handbook/_index.adoc
+++ b/documentation/content/en/books/handbook/_index.adoc
@@ -8,6 +8,7 @@ trademarks: ["freebsd", "ibm", "ieee", "redhat", "3com", "adobe", "apple", "inte
 tags: ["FreeBSD Handbook", "Handbook", "Index"]
 next: books/handbook/preface
 weight: 1
+add_single_page_link: true
 ---
 
 = FreeBSD Handbook
diff --git a/documentation/content/en/books/handbook/book.adoc b/documentation/content/en/books/handbook/book.adoc
index 7d80d890e7..776e1d5b8e 100644
--- a/documentation/content/en/books/handbook/book.adoc
+++ b/documentation/content/en/books/handbook/book.adoc
@@ -6,6 +6,7 @@ copyright: 1995-2021 The FreeBSD Documentation Project
 description: FreeBSD Handbook
 trademarks: ["freebsd", "ibm", "ieee", "redhat", "3com", "adobe", "apple", "intel", "linux", "microsoft", "opengroup", "sun", "realnetworks", "oracle", "3ware", "arm", "adaptec", "google", "heidelberger", "intuit", "lsilogic", "themathworks", "thomson", "vmware", "wolframresearch", "xiph", "xfree86", "general"]
 tags: ["FreeBSD Handbook", "Handbook"]
+add_split_page_link: true
 ---
 
 = FreeBSD Handbook
diff --git a/documentation/content/en/books/porters-handbook/_index.adoc b/documentation/content/en/books/porters-handbook/_index.adoc
index 00723abfb2..717a42203a 100644
--- a/documentation/content/en/books/porters-handbook/_index.adoc
+++ b/documentation/content/en/books/porters-handbook/_index.adoc
@@ -8,6 +8,7 @@ trademarks: ["freebsd", "sun", "unix", "general"]
 next: books/porters-handbook/porting-why
 weight: 15
 tags: ["FreeBSD Porter's Handbook", "Porting", "FreeBSD Ports Collection"]
+add_single_page_link: true
 ---
 
 = FreeBSD Porter's Handbook
diff --git a/documentation/content/en/books/porters-handbook/book.adoc b/documentation/content/en/books/porters-handbook/book.adoc
index 6466a433dc..9bde665213 100644
--- a/documentation/content/en/books/porters-handbook/book.adoc
+++ b/documentation/content/en/books/porters-handbook/book.adoc
@@ -6,6 +6,7 @@ copyright: 2000-2021 The FreeBSD Documentation Project
 description: FreeBSD Porter's Handbook
 trademarks: ["freebsd", "sun", "unix", "general"] 
 tags: ["FreeBSD Porter's Handbook", "Porting", "FreeBSD Ports Collection", "Index"]
+add_split_page_link: true
 ---
 
 = FreeBSD Porter's Handbook
diff --git a/documentation/themes/beastie/layouts/books/list.html b/documentation/themes/beastie/layouts/books/list.html
index 4135d93c79..e264c4b728 100644
--- a/documentation/themes/beastie/layouts/books/list.html
+++ b/documentation/themes/beastie/layouts/books/list.html
@@ -82,6 +82,16 @@
       {{ i18n "last-modified" }} {{ index $releaseInfo 3 }} {{ $hour }} {{ i18n "by" }} {{ index $releaseInfo 5 }}.
     {{ end }}
   </div>
+{{ if .Params.add_split_page_link }}
+  <div>
+    [ <a href="../">Split HTML</a> / Single HTML ]
+  </div>
+{{ end }}
+{{ if .Params.add_single_page_link }}
+  <div>
+    [ Split HTML / <a href="book/">Single HTML</a> ]
+  </div>
+{{ end }}
   {{ .Content }}
   <hr />
   <div class="navfooter">
diff --git a/documentation/themes/beastie/layouts/books/single.html b/documentation/themes/beastie/layouts/books/single.html
index 4135d93c79..e264c4b728 100644
--- a/documentation/themes/beastie/layouts/books/single.html
+++ b/documentation/themes/beastie/layouts/books/single.html
@@ -82,6 +82,16 @@
       {{ i18n "last-modified" }} {{ index $releaseInfo 3 }} {{ $hour }} {{ i18n "by" }} {{ index $releaseInfo 5 }}.
     {{ end }}
   </div>
+{{ if .Params.add_split_page_link }}
+  <div>
+    [ <a href="../">Split HTML</a> / Single HTML ]
+  </div>
+{{ end }}
+{{ if .Params.add_single_page_link }}
+  <div>
+    [ Split HTML / <a href="book/">Single HTML</a> ]
+  </div>
+{{ end }}
   {{ .Content }}
   <hr />
   <div class="navfooter">