Merge pull request #413 from tayloraswift/date-byline

add date byline to doc pages

Author: tayloraswift

Assets/css/Main.css

@@ -19,7 +19,7 @@ extension Unidoc.RenderFormat.Assets
     /// To reduce cache churn, not all assets are versioned. For example, the fonts and
     /// the favicon do not use the version numbers.
     @inlinable public static
-    var version:MajorVersion { .v(36) }
+    var version:MajorVersion { .v(37) }
 }
 extension Unidoc.RenderFormat.Assets
 {

Assets/css/Main.css.map

@@ -41,6 +41,7 @@ extension Unidoc.BlogEndpoint.ArticlePage:Unidoc.RenderablePage
     {
         //  We need this for the relative links to work.
         head[.base] { $0.href = "\(self.location)/" ; $0.target = "_self" }
+        head[unsafe: .script] { $0.type = "ld+json" } = self.context.structuredData
     }
 }
 extension Unidoc.BlogEndpoint.ArticlePage:Unidoc.StaticPage
@@ -70,6 +71,7 @@ extension Unidoc.BlogEndpoint.ArticlePage:Unidoc.StaticPage
                 $0[.header, { $0.class = "hero" }]
                 {
                     $0[.h1] = self.apex.headline.safe
+                    $0[.time] { $0.class = "byline" } = self.context.byline(format.locale)
                 }
                 $0[.div, { $0.class = "docc" }]
                 {

Package.resolved

@@ -62,6 +62,7 @@ extension Unidoc.DocsEndpoint.ArticlePage:Unidoc.ApicalPage
             }
 
             $0[.h1] = self.apex.headline.safe
+            $0[.time] { $0.class = "byline" } = self.context.byline(format.locale)
             $0[.div] { $0.class = "docc" } = self.cone.overview
 
             if  let file:Unidoc.Scalar = self.apex.readme

Sources/UnidocRender/Formats/Unidoc.RenderFormat.Assets.swift

@@ -112,6 +112,7 @@ extension Unidoc.DocsEndpoint.DeclPage:Unidoc.ApicalPage
                 scalars: self.apex.scope)
 
             $0[.h1] = self.stem.last
+            $0[.time] { $0.class = "byline" } = self.context.byline(format.locale)
             $0[.div] { $0.class = "docc" } = self.cone.overview
 
             if  let location:SourceLocation<Unidoc.Scalar> = self.apex.location

Sources/UnidocUI/Endpoints/Blog/Unidoc.BlogEndpoint.ArticlePage.swift

@@ -108,6 +108,7 @@ extension Unidoc.DocsEndpoint.ModulePage:Unidoc.ApicalPage
                 $0[.h1] = self.name
             }
 
+            $0[.time] { $0.class = "byline" } = self.context.byline(format.locale)
             $0[.div] { $0.class = "docc" } = self.cone.overview
 
             if  let readme:Unidoc.Scalar = self.apex.readme

Sources/UnidocUI/Endpoints/Docs/Unidoc.DocsEndpoint.ArticlePage.swift

@@ -88,6 +88,7 @@ extension Unidoc.DocsEndpoint.PackagePage:Unidoc.ApicalPage
             }
 
             $0[.h1] = self.title
+            $0[.time] { $0.class = "byline" } = self.context.byline(format.locale)
 
             guard
             let repo:Unidoc.PackageRepo = self.context.repo

Sources/UnidocUI/Endpoints/Docs/Unidoc.DocsEndpoint.DeclPage.swift

@@ -56,6 +56,7 @@ extension Unidoc.DocsEndpoint.ProductPage:Unidoc.ApicalPage
             }
 
             $0[.h1] = self.apex.symbol
+            $0[.time] { $0.class = "byline" } = self.context.byline(format.locale)
         }
 
         main[.section] { $0.class = "notice canonical" } = self.context.canonical

Sources/UnidocUI/Endpoints/Docs/Unidoc.DocsEndpoint.ModulePage.swift

@@ -1,13 +1,50 @@
 import HTML
+import ISO
 import LexicalPaths
 import MarkdownABI
 import MarkdownRendering
 import Symbols
 import UnidocRender
+import UnixCalendar
 import URI
 
 extension Unidoc.VertexContext
 {
+    var structuredData:String
+    {
+        if  let tagged:Timestamp = self.volume.commit?.date?.timestamp
+        {
+            """
+            {
+            "@context": "https://schema.org",
+            "@type": "Article",
+            "datePublished": "\(tagged.date)"
+            }
+            """
+        }
+        else
+        {
+            """
+            {
+            "@context": "https://schema.org",
+            "@type": "Article"
+            }
+            """
+        }
+    }
+
+    func byline(_ locale:ISO.Locale) -> Unidoc.Byline?
+    {
+        guard
+        let tagged:Timestamp = self.volume.commit?.date?.timestamp
+        else
+        {
+            return nil
+        }
+
+        return .init(published: tagged, locale: locale)
+    }
+
     func card(decl id:Unidoc.Scalar) -> Unidoc.DeclCard?
     {
         guard

Sources/UnidocUI/Endpoints/Docs/Unidoc.DocsEndpoint.PackagePage.swift

@@ -54,6 +54,7 @@ extension Unidoc.VertexPage
         }
 
         head[unsafe: .script] = format.assets.script(volumes: json)
+        head[unsafe: .script] { $0.type = "ld+json" } = self.context.structuredData
     }
 
     public

Sources/UnidocUI/Endpoints/Docs/Unidoc.DocsEndpoint.ProductPage.swift

@@ -0,0 +1,31 @@
+import HTML
+import ISO
+import UnixCalendar
+
+extension Unidoc
+{
+    struct Byline:Equatable, Sendable
+    {
+        let published:Timestamp
+        let locale:ISO.Locale
+
+        init(published:Timestamp, locale:ISO.Locale)
+        {
+            self.published = published
+            self.locale = locale
+        }
+    }
+}
+extension Unidoc.Byline:HTML.OutputStreamable
+{
+    static func |= (time:inout HTML.AttributeEncoder, self:Self)
+    {
+        time.datetime = "\(self.published.date)"
+    }
+
+    static func += (time:inout HTML.ContentEncoder, self:Self)
+    {
+        time += "Published "
+        time += self.published.date.short(self.locale)
+    }
+}

Sources/UnidocUI/Page contexts/Unidoc.VertexContext (ext).swift

@@ -83,6 +83,17 @@
         margin-top: 0.5em;
     }
 
+    time.byline
+    {
+        display: block;
+        margin: 0.5rem 0;
+        color: var(--fg-semi);
+        font-style: italic;
+    }
+    time.byline + a.source
+    {
+        margin-top: 1rem;
+    }
     a.source + a.source
     {
         margin-top: 0.5rem;