Add title for pages and use chevron when sensible in headings (#943)

Author: jreichle

changelog.d/943

@@ -0,0 +1,11 @@
+synopsis: Add title for pages and use chevron when sensible in headings
+prs: #943
+issues: #602
+
+description: {
+
+- Add title for about, categories, specific categories, sign in, 404, searching
+- Change title for packages (add "— Flora.pm")
+- For specific categories have heading "Categories > Audio" instead of "Audio"
+
+}

src/web/FloraWeb/Components/PackageListHeader.hs

@@ -8,7 +8,7 @@ import FloraWeb.Components.Icons qualified as Icons
 import FloraWeb.Pages.Templates.Types
 
 presentationHeader
-  :: Text
+  :: FloraHTML
   -- ^ Title of the listing. It can be a Category name, a search term
   -> Text
   -- ^ Subtitle; It can be a category description, or being empty
@@ -19,7 +19,7 @@ presentationHeader title subtitle numberOfPackages = do
   div_ [class_ "divider"] $ do
     div_ [class_ "page-title"] $ do
       h1_ [class_ ""] $ do
-        span_ [class_ "headline"] $ toHtml title
+        span_ [class_ "headline"] title
     div_ [class_ "synopsis lg:text-xl text-center"] $
       p_ [class_ ""] (toHtml subtitle)
     p_ [class_ "package-count"] $ toHtml $ display numberOfPackages <> " results"

src/web/FloraWeb/Pages/Server.hs

@@ -51,7 +51,12 @@ aboutHandler (Headers session _) = do
           & #activeElements
           % #aboutNav
           .~ True
-  render templateEnv Home.about
+  render
+    templateEnv
+      { title = "About — Flora.pm"
+      , description = "About the Flora.pm project"
+      }
+    Home.about
 
 serveNotFound :: RequireCallStack => SessionWithCookies (Maybe User) -> FloraEff (Html ())
 serveNotFound (Headers session _) = web404 session

src/web/FloraWeb/Pages/Server/Categories.hs

@@ -17,7 +17,7 @@ import Flora.Model.Package.Query qualified as Query
 import Flora.Model.User (User)
 import FloraWeb.Common.Auth.Types (SessionWithCookies)
 import FloraWeb.Pages.Routes.Categories (Routes, Routes' (..))
-import FloraWeb.Pages.Templates (defaultTemplateEnv, render, templateFromSession)
+import FloraWeb.Pages.Templates (TemplateEnv (..), defaultTemplateEnv, render, templateFromSession)
 import FloraWeb.Pages.Templates.Error
 import FloraWeb.Pages.Templates.Screens.Categories qualified as Template
 import FloraWeb.Types (FloraEff)
@@ -34,8 +34,13 @@ indexHandler
   => SessionWithCookies (Maybe User)
   -> Eff es (Html ())
 indexHandler (Headers session _) = do
-  templateEnv <- templateFromSession session defaultTemplateEnv
+  templateEnv' <- templateFromSession session defaultTemplateEnv
   categories <- Query.getAllCategories
+  let templateEnv =
+        templateEnv'
+          { title = "Categories — Flora.pm"
+          , description = "Categories of packages in the Haskell ecosystem"
+          }
   render templateEnv $ Template.index categories
 
 showHandler
@@ -49,10 +54,16 @@ showHandler
   -> Text
   -> Eff es (Html ())
 showHandler (Headers session _) categorySlug = do
-  templateEnv <- templateFromSession session defaultTemplateEnv
+  templateEnv' <- templateFromSession session defaultTemplateEnv
+
   result <- Query.getCategoryBySlug categorySlug
   case result of
-    Nothing -> renderError templateEnv notFound404
+    Nothing -> renderError templateEnv' notFound404
     Just cat -> do
       packagesInfo <- Query.getPackagesFromCategoryWithLatestVersion cat.categoryId
+      let templateEnv =
+            templateEnv'
+              { title = "Categories › " <> cat.name <> " — Flora.pm"
+              , description = "Categories of packages in the Haskell ecosystem"
+              }
       render templateEnv $ Template.showCategory cat packagesInfo

src/web/FloraWeb/Pages/Server/Packages.hs

@@ -91,9 +91,14 @@ listPackagesHandler
 listPackagesHandler (Headers session _) pageParam = do
   Tracing.rootSpan alwaysSampled "list-all-packages" $ do
     let pageNumber = pageParam ?: PositiveUnsafe 1
-    templateDefaults <- templateFromSession session defaultTemplateEnv
+    templateEnv' <- templateFromSession session defaultTemplateEnv
     (count', results) <- Search.listAllPackages (fromPage pageNumber)
-    render templateDefaults $ Search.showAllPackages count' pageNumber results
+    let templateEnv =
+          templateEnv'
+            { title = "Packages — Flora.pm"
+            , description = "List of packages"
+            }
+    render templateEnv $ Search.showAllPackages count' pageNumber results
 
 showNamespaceHandler
   :: ( DB :> es
@@ -119,6 +124,7 @@ showNamespaceHandler (Headers session _) packageNamespace pageParam =
         let templateEnv =
               templateDefaults
                 { navbarSearchContent = Just $ "in:" <> display packageNamespace <> " "
+                , title = "Core packages — Flora.pm"
                 , description = description
                 }
         render templateEnv $
@@ -136,6 +142,7 @@ showNamespaceHandler (Headers session _) packageNamespace pageParam =
             let templateEnv =
                   templateDefaults
                     { navbarSearchContent = Just $ "in:" <> display packageNamespace <> " "
+                    , title = "Packages in " <> display packageNamespace <> " — Flora.pm"
                     , description = packageIndex.description
                     }
             render templateEnv $
@@ -215,7 +222,7 @@ showPackageVersion (Headers session _) packageNamespace packageName mversion =
 
     let templateEnv =
           templateEnv'
-            { title = display packageNamespace <> "/" <> display packageName
+            { title = display packageNamespace <> " › " <> display packageName <> " — Flora.pm"
             , description = release.synopsis
             , indexPage = isNothing mversion
             }
@@ -367,7 +374,7 @@ showVersionDependenciesHandler (Headers session _) packageNamespace packageName
     release <- guardThatReleaseExists package.packageId version $ const (web404 session)
     let templateEnv =
           templateEnv'
-            { title = display packageNamespace <> "/" <> display packageName
+            { title = display packageNamespace <> " › " <> display packageName <> " › dependencies — Flora.pm"
             , description = "Dependencies of " <> display packageNamespace <> display packageName
             }
     releaseDependencies <-

src/web/FloraWeb/Pages/Server/Search.hs

@@ -31,6 +31,7 @@ searchHandler (Headers session _) (Just searchString) pageParam = do
   let templateEnv =
         templateDefaults
           { navbarSearchContent = Just searchString
+          , title = "'" <> searchString <> "' search — Flora.pm"
           }
   let pagination = fromPage pageNumber
   case Search.parseSearchQuery searchString of

src/web/FloraWeb/Pages/Server/Sessions.hs

@@ -38,8 +38,13 @@ newSessionHandler (Headers session _) = do
   case mUser of
     Nothing -> do
       Log.logInfo_ "[+] No user logged-in"
-      templateDefaults <- templateFromSession session defaultTemplateEnv
-      html <- render templateDefaults Sessions.newSession
+      templateEnv' <- templateFromSession session defaultTemplateEnv
+      let templateEnv =
+            templateEnv'
+              { title = "Sign in — Flora.pm"
+              , description = "Sign in page"
+              }
+      html <- render templateEnv Sessions.newSession
       pure $ AuthenticationRequired html
     Just u -> do
       Log.logInfo_ $ "[+] User is already logged: " <> display u

src/web/FloraWeb/Pages/Templates/Error.hs

@@ -25,7 +25,11 @@ renderError
   -> Status
   -> Eff es a
 renderError env status = do
-  let templateEnv = env & (#title .~ "Flora :: *** Exception")
+  let templateEnv' = env & (#title .~ "Flora :: *** Exception")
+  let templateEnv =
+        templateEnv'
+          { title = "404 — Flora.pm"
+          }
   let body = mkErrorPage templateEnv $ showError status
   throwError $
     ServerError

src/web/FloraWeb/Pages/Templates/Screens/Categories/Show.hs

@@ -6,12 +6,18 @@ import Lucid
 
 import Flora.Model.Category.Types (Category (..))
 import Flora.Model.Package (PackageInfo)
+import FloraWeb.Components.Icons qualified as Icon
 import FloraWeb.Components.PackageListHeader (presentationHeader)
 import FloraWeb.Pages.Templates (FloraHTML)
 import FloraWeb.Pages.Templates.Packages (packageListing)
 
 showCategory :: Category -> Vector PackageInfo -> FloraHTML
 showCategory Category{name, synopsis} packagesInfo = do
   div_ [class_ "container"] $ do
-    presentationHeader name synopsis (fromIntegral $ V.length packagesInfo)
+    let title =
+          span_ [class_ "headline"] $ do
+            "Categories"
+            Icon.chevronRightOutline
+            toHtml name
+    presentationHeader title synopsis (fromIntegral $ V.length packagesInfo)
     packageListing Nothing packagesInfo

src/web/FloraWeb/Pages/Templates/Screens/Search.hs

@@ -31,7 +31,7 @@ showAllPackagesInNamespace
   -> FloraHTML
 showAllPackagesInNamespace namespace description count currentPage packagesInfo = do
   div_ [class_ "container"] $ do
-    presentationHeader (display namespace) description count
+    presentationHeader (toHtml $ display namespace) description count
     div_ [class_ ""] $ packageListing Nothing packagesInfo
     paginationNav count currentPage (ListAllPackagesInNamespace namespace)
 
@@ -46,7 +46,7 @@ showResults
   -> FloraHTML
 showResults searchString count currentPage exactMatches results = do
   div_ [class_ "container"] $ do
-    presentationHeader searchString "" count
+    presentationHeader (toHtml searchString) "" count
     packageListing (Just exactMatches) results
     when (count > 30) $
       paginationNav count currentPage (SearchPackages searchString)
@@ -60,7 +60,7 @@ showExecutableResults
   -> FloraHTML
 showExecutableResults executableName count currentPage results = do
   div_ [class_ "container"] $ do
-    presentationHeader executableName "" count
+    presentationHeader (toHtml executableName) "" count
     packageWithExecutableListing results
     when (count > 30) $
       paginationNav count currentPage (SearchExecutable executableName)
@@ -74,7 +74,7 @@ showAdvisorySearchResults
   -> FloraHTML
 showAdvisorySearchResults searchTerm count currentPage results = do
   div_ [class_ "container"] $ do
-    presentationHeader searchTerm "" count
+    presentationHeader (toHtml searchTerm) "" count
     packageAdvisoriesListing True results
     when (count > 30) $
       paginationNav count currentPage (SearchInAdvisories searchTerm)