From 3a2839cb17c44e7ad29ebdf7743fbfdafc9d78df Mon Sep 17 00:00:00 2001 From: Sarah Schneider Date: Wed, 14 Apr 2021 10:35:10 -0400 Subject: [PATCH] differentiate between title and shortTitle in siteTree --- includes/sidebar-specific-product.html | 14 +++++++----- lib/site-tree-titles.js | 31 +++++++++++++++++--------- lib/site-tree.js | 6 +++-- 3 files changed, 34 insertions(+), 17 deletions(-) diff --git a/includes/sidebar-specific-product.html b/includes/sidebar-specific-product.html index e4684187de..99dc1c4d41 100644 --- a/includes/sidebar-specific-product.html +++ b/includes/sidebar-specific-product.html @@ -19,13 +19,14 @@ {% capture fullPathToCategory %}{{category[1].href}}{% endcapture %}
  • + {% if category[1].shortTitle %}{% assign categoryTitle = category[1].shortTitle %}{% else %}{% assign categoryTitle = category[1].title %}{% endif %} {% if category[1].standalone %} - {{ category[1].title }} + {{ categoryTitle }} {% else %}
    - {{ category[1].title }} + {{ categoryTitle }} {% if breadcrumbs.category.href == category[1].href or forloop.index < 4 %} {% endif %} @@ -39,16 +40,18 @@ {% for maptopic in category[1].maptopics %} {% unless maptopic[1].hidden %} {% capture fullPathToMaptopic %}{{maptopic[1].href}}{% endcapture %} + {% if maptopic[1].shortTitle %}{% assign maptopicTitle = maptopic[1].shortTitle %}{% else %}{% assign maptopicTitle = maptopic[1].title %}{% endif %}
  • - {{ maptopic[1].title }} + {{ maptopicTitle }}
      {% for article in maptopic[1].articles %} {% unless article[1].hidden %} {% capture fullPathToArticle %}{{article[1].href}}{% endcapture %} + {% if article[1].shortTitle %}{% assign articleTitle = article[1].shortTitle %}{% else %}{% assign articleTitle = article[1].title %}{% endif %}
    • - {{ article[1].title }} + {{ articleTitle }}
      • {% endunless %} {% endfor %} @@ -63,8 +66,9 @@ {% for article in category[1].articles %} {% unless article[1].hidden %} {% capture fullPathToArticle %}{{article[1].href}}{% endcapture %} + {% if article[1].shortTitle %}{% assign articleTitle = article[1].shortTitle %}{% else %}{% assign articleTitle = article[1].title %}{% endif %}
    • - {{ article[1].title }} + {{ articleTitle }}
      • {% endunless %} {% endfor %} diff --git a/lib/site-tree-titles.js b/lib/site-tree-titles.js index 0d8148db64..b1990deb8b 100644 --- a/lib/site-tree-titles.js +++ b/lib/site-tree-titles.js @@ -2,18 +2,19 @@ const flat = require('flat') const renderContent = require('./render-content') const delimiter = '#' -// render localized and product-version-aware page title -// note this only supports titles with liquid, not short titles +// render localized and product-version-aware page title or shortTitle module.exports = async function siteTreeTitles (siteTree, siteData) { // use a non-period delimiter because versions contain periods (like 2.19) const flatTree = flat(siteTree, { delimiter: delimiter }) const titlesWithLiquid = Object.entries(flatTree) - .filter(([path, title]) => path.endsWith('title') && title.includes('{')) + .filter(([path, shortOrLongTitle]) => path.endsWith('itle') && shortOrLongTitle && shortOrLongTitle.includes('{')) - await Promise.all(titlesWithLiquid.map(async ([path, title]) => { - path = path.replace(`${delimiter}title`, '') // ignore the `title` path part for now + await Promise.all(titlesWithLiquid.map(async ([path, shortOrLongTitle]) => { + const isShortTitle = /shortTitle$/.test(path) + + path = path.replace(`${delimiter}(shortT|t)itle`, '') // ignore the `title` path part for now // derive values from path parts const [ @@ -31,29 +32,39 @@ module.exports = async function siteTreeTitles (siteTree, siteData) { // create context object for rendering of dynamic liquid data in page titles const ctx = { - page: { version }, + currentVersion: version, site: siteData[languageCode].site } - const renderedTitle = await renderContent(title, ctx, { textOnly: true }) + const renderedShortOrLongTitle = await renderContent(shortOrLongTitle, ctx, { textOnly: true }) // no product titles have liquid because we get them from lib/all-products.js // so we can assume all titles processed here will be either a category, maptopic, or article // we can also assume a category value will exist for any of these const currentCategory = siteTree[languageCode][version][products][product][categories][category] - if (!maptopic) currentCategory.title = renderedTitle + if (!maptopic) { + isShortTitle + ? currentCategory.shortTitle = renderedShortOrLongTitle + : currentCategory.title = renderedShortOrLongTitle + } let currentMaptopic if (maptopic) { currentMaptopic = currentCategory[maptopics][maptopic] - if (!article) currentMaptopic.title = renderedTitle + if (!article) { + isShortTitle + ? currentMaptopic.shortTitle = renderedShortOrLongTitle + : currentMaptopic.title = renderedShortOrLongTitle + } } let currentArticle if (article) { currentArticle = currentMaptopic[articles][article] - currentArticle.title = renderedTitle + isShortTitle + ? currentArticle.shortTitle = renderedShortOrLongTitle + : currentArticle.title = renderedShortOrLongTitle } })) } diff --git a/lib/site-tree.js b/lib/site-tree.js index 4d68c4fc85..a7d8fb84df 100644 --- a/lib/site-tree.js +++ b/lib/site-tree.js @@ -78,7 +78,8 @@ function buildCategoriesTree (tocItems, versionedProductHref, pageMap, redirects if (!page) return if (!getApplicableVersions(page.versions).includes(version)) return - category.title = page.shortTitle || page.title + category.title = page.title + category.shortTitle = page.shortTitle // support standalone pages at the category level, like actions/quickstart.md if (!page.tocItems) { @@ -157,7 +158,8 @@ function buildArticlesTree (tocItems, versionedCategoryHref, pageMap, redirects, if (!page) return if (!getApplicableVersions(page.versions).includes(version)) return - article.title = page.shortTitle || page.title + article.title = page.title + article.shortTitle = page.shortTitle article.hidden = page.hidden articleTree[article.href] = article