CMS Header Templates Consistent With Portal & User Guides

[wesleyboar]

In GitLab by @tacc-wbomar on Jan 25, 2020, 17:10

JIRA

FP-346: Consistent Header Templates for CMS, Portal, Docs

Goal

• Use consistent template structure for header content on CMS, Portal, and User Guides.
• Organize header content into templates to facilitate future improvements and features.

Background

The CMS, Portal, and User Guides all need to use the same header; but, User Guides has Jinja templates, and CMS and Portal have Twig templates; also, CMS nav menu has CMS-specific template and Portal nav menu has Portal-specific template, and each uses a manual copy of the others' in part of a large template.

Requirements

1. The purpose of the JavaScript (in scripts/base.js) that manipulates the portal nav must be apparent.¹
2. The #s-cms-nav (auto-generated content) should not change.²
3. The .branding-header should be extracted to its own template.
   • If extracted, then it must have the same template name as the one in CMS (see Ticket FP-163).
4. The #s-portal-nav (cloned manual content) must be extracted to its own template.
   • When extracted, it must have the same template name as the one in CMS (see Ticket FP-163).
5. Styles, and CSS classes, should not change.
6. An issue to investigate or implement a solution for a Header Component may be created.

Direction

For the scripts/base.js purpose clarification, consider:

• script comments
• new script file name (leave base.js as it was)³

Estimate

1.5 hours (implement, test, review code while creating merge request)

Reference

• CMS issue
• Portal ticket
• User Guides ticket

Footnotes

Footnotes

1. See "Direction" for solution ideas. ↩

2. Because it is already well-extracted into cms_menu.html, an already common name for implementations of this CMS. ↩

3. Nothing is tying us to base.js; the organization of scripts for base i.e. "Core" functionality can be expressed in different ways, like an ID—current short-term solution for stylesheets, or template comments and script file names—current long-term solution for stylesheets ↩

[wesleyboar]

In GitLab by @tacc-wbomar on Feb 11, 2020, 00:04

changed title from {-Create a "Header" UI Component-} to {+Organize "Header" Templates+}

[wesleyboar]

In GitLab by @tacc-wbomar on Feb 11, 2020, 00:17

changed title from {-Organize "Header"-} Templates to {+Consistent Header+} Templates

[wesleyboar]

In GitLab by @tacc-wbomar on Feb 11, 2020, 00:32

changed title from Consistent Header Templates to Consistent Header Templates{+ for CMS, Portal, & User Guides+}

[wesleyboar]

In GitLab by @tacc-wbomar on Feb 11, 2020, 00:35

changed title from {-Consistent Header Templates for CMS, Portal,-} & User Guides to {+Portal Header Templates Consistent With Portal+} & User Guides

[wesleyboar]

In GitLab by @tacc-wbomar on Feb 11, 2020, 00:58

changed title from {-Portal-} Header Templates Consistent With Portal & User Guides to {+CMS+} Header Templates Consistent With Portal & User Guides

[wesleyboar]

In GitLab by @tacc-wbomar on May 6, 2020, 17:06

changed title from CMS Header Templates Consistent With Portal & User Guides to {+BLOCKED: +}CMS Header Templates Consistent With Portal & User Guides

[wesleyboar]

In GitLab by @tacc-wbomar on Jun 16, 2020, 16:57

changed title from {-BLOCKED: -}CMS Header Templates Consistent With Portal & User Guides to CMS Header Templates Consistent With Portal & User Guides

[wesleyboar]

In GitLab by @tacc-wbomar on Jul 4, 2020, 17:58

closed