add 'show-language-family style property

Author: mflatt

scribble-doc/scribblings/scribble/core.scrbl

@@ -497,6 +497,12 @@ The recognized @tech{style properties} are as follows:
        controls only when the viewing context indicates a language
        family not in the page's language families.}
 
+ @item{@indexed-racket['show-language-family] --- As a @tech{style
+       property} for the main part of a rendered page or any enclosing
+       part, causes the HTML output to include an indication of the
+       document's primary language family, as well as the language
+       family being used to navigate documentation.}
+
  @item{@indexed-racket['no-header-controls] --- Suppresses link and
        link-information icons (if any) as part of a section header in
        HTML output.}
@@ -608,8 +614,9 @@ The @racket[parts] field contains sub-parts.
          #:changed "1.54" @elem{Changed @racket[tag-prefix] field to allow a
                                 @tech{part context} hash table.}
          #:changed "1.57" @elem{Added @racket['no-header-controls] support.}
-         #:changed "1.59" @elem{Added @racket['no-navigation] and
-                                @racket['family-navigation] support.}]}
+         #:changed "1.59" @elem{Added @racket['no-navigation],
+                                @racket['family-navigation], and
+                                @racket['show-language-family] support.}]}
 
 
 @defstruct[paragraph ([style style?] [content content?])]{

scribble-lib/scribble/html-render.rkt

@@ -825,6 +825,9 @@
     (define/public (extract-part-source d ri)
       (extract-inherited d ri document-source? document-source-module-path))
 
+    (define/public (extract-show-language-family d ri)
+      (extract-inherited d ri (lambda (v) (eq? v 'show-language-family)) values))
+
     (define/public (part-nesting-depth d ri)
       0)
 
@@ -1028,7 +1031,8 @@
              ,@more)))))
       (define no-nav? (and (memq 'no-navigation (style-properties (part-style d))) #t))
       (define family-nav? (and (memq 'family-navigation (style-properties (part-style d))) #t))
-      (define fam (and family-nav?
+      (define show-fam? (extract-show-language-family d ri))
+      (define fam (and (or family-nav? show-fam?)
                        (or (search-extras (hash-ref (extend-part-context d) 'index-extras #hasheq()) 'language-family)
                            '("Racket"))))
       (define (wrap-family c)
@@ -1118,9 +1122,21 @@
       (define navbar
         `(div ([class ,(if top? "navsettop" "navsetbottom")])
            ,navleft ,navright nbsp)) ; need nbsp to make the navset bg visible
-      (if (include-navigation?)
-          (list navbar)
-          null))
+      (append
+       (if (include-navigation?)
+           (list navbar)
+           null)
+       (if (and top? show-fam?)
+           (let ([fam (or fam '("Racket"))])
+             (list `(div ([class "navfamily"]
+                          [data-fam ,(string-join fam ",")]
+                          [data-fam-path ,(if search-up-path "../" "")]
+                          [data-version ,(get-installation-name)])
+                         ,@(if (null? fam)
+                               null
+                               `((span ([class "docfamily"])
+                                       ,(car fam)))))))
+           null)))
 
     (define/override (render-one d ri fn)
       (render-one-part d ri fn null))

scribble-lib/scribble/manual-style.css

@@ -86,7 +86,7 @@ it fouls up loading for reasons mysterious */
 
 
 /* Sans-serif: */
-.version, .versionNoNav, .ssansserif {
+.version, .versionNoNav, .ssansserif, .navfamily, .famlink {
     font-family: 'Fira', sans-serif;
 }
 
@@ -311,6 +311,22 @@ a:hover {
     content: "v";
 }
 
+/* ---------------------------------------- */
+/* Language Family */
+
+.navfamily {
+    position: absolute;
+    float: none;
+    top: 0.25rem;
+    left: auto;
+    right: 0rem;
+    margin: 0em;
+    margin-right: 1rem;
+    height: auto;
+    width: auto;
+    font-size: 70%;
+    font-weight: lighter;
+}
 
 /* ---------------------------------------- */
 /* Margin notes */

scribble-lib/scribble/scribble-common.js

@@ -97,7 +97,9 @@ function GotoPLTRoot(ver, root_relative, here_to_root_relative) {
   var famroot = false;
   if (root_relative == "index.html") {
     famroot = (GetPageArg("fam", false) ? GetPageArg("famroot", false) : false)
-    root_relative = famroot + "/index.html";
+    if (famroot) {
+      root_relative = famroot + "/index.html";
+    }
   }
 
   var u = GetRootPath(ver);
@@ -217,3 +219,40 @@ AddOnLoad(function(){
     }
   }
 });
+
+AddOnLoad(function(){
+  var es = document.getElementsByClassName("navfamily");
+  for (var i=0; i < es.length; i++) {
+    var e = es[i];
+    if (e.dataset.fam != undefined) {
+      var fams = e.dataset.fam.split(/,/);
+      var fam = GetPageArg("fam", false);
+      if (!fam) fam = "Racket";
+      var link = document.createElement('a');
+      var root = GetRootPath(e.dataset.version)
+      var family_url;
+      if (root == null) {
+        family_url = new URL(e.dataset.famPath + "family/index.html", window.location.href);
+      } else {
+        family_url = new URL(root + "family/index.html", window.location.href);
+      }
+      family_url.searchParams.append("qfrom", window.location.href)
+      if (fams.indexOf(fam) == -1) {
+        var nav_as = document.createElement('div');
+        link.textContent = "navigating as " + fam;
+        link.href = family_url
+        nav_as.appendChild(link)
+        e.appendChild(nav_as)
+      } else {
+        var link = document.createElement('a');
+        var span = e.children[0]
+        link.textContent = span.textContent;
+        link.href = family_url
+        span.textContent = ''; // Clear span
+        e.removeChild(span);
+        link.appendChild(span);
+        e.appendChild(link);
+      }
+    }
+  }
+});

scribble-lib/scribble/scribble.css

@@ -22,7 +22,7 @@
 }
 
 /* Sans-serif: */
-.version, .versionNoNav, .ssansserif {
+.version, .versionNoNav, .ssansserif, .navfamily {
   font-family: sans-serif;
 }
 .ssansserif {
@@ -210,6 +210,23 @@ table td {
   content: "Version ";
 }
 
+/* ---------------------------------------- */
+/* Language Family */
+
+.navfamily {
+  float: right;
+  white-space: nowrap;
+  left: 2em;
+  height: 0em;
+  width: 13em;
+  margin: 0em -13em 0em 0em;
+  font-size: small;
+}
+
+.docfamily:after {
+  content: " language family";
+}
+
 /* ---------------------------------------- */
 /* Margin notes */