TAMU-CC Shared Site Configuration

TAMU-CC Shared Site Folders

Folders and files and their uses on the TAMU-CC Main site.

This folder holds the blocks that render content used across the page types.

accessibility_nav

This holds the hidden accessibility navigation links.
These are used to jump to different sections of pages. The links are read by screen readers and are visible only when accessed when using the TAB key to move through a page.

article-masthead

Folder Index block
Renders the Masthead image content on article and event pages, pulling an image in from the article-image-bank folder
The article-image-bank folder on the TAMU-CC Main site is located at:
TAMU-CC MAIN > images > article-image-bank

breadcrumbs

Folder Index block
Used to render the breadcrumb trail navigation

contact-block

Folder Index block
Used to render the Contact block when it is pulled into a page

current-page

Used to indicate the current page

page-navigation

Used to render the left column section navigation

svg

Holds the code for the SVG icons used throughout the site

This folder holds files used throughout the website for presentation and functionality.

php folder

bre.feedmanager.config.ini - This is the initlization file for database and API connections and caching.
brei.feedmanager.phar - This is the PHP archive file with functions for the API and caching.
common.php - This holds PHP functions for outputting/rendering page sections and functions:
- Global Header
- Global Footer
- Trial Finder (not used)
- Emergency Alert (not used)
item.program.ini - This is the initalization file for the program finder. This sets the name/value pairs for:
- general settings
- general filters
- approach filters
- sorting
program-modelview.php - This is the PHP file for rendering event, program, and news results and rendering components.

This folder holds the files used for transforming XML content to XHTML for display on the website.

articles folder

author
- Renders the h1 heading, author content, and social media icons
masthead
- Renders the masthead content

common folder

_common
- imports the following formats
  - debug
  - images
  - links
  - svg
  - truncation
  - youtube
debug
- Renders system error messages for debugging.
images
- Renders content from image selector fields: images, alt text, and image links.
links
- Renders the content of links from Link fields.
svg
- Renders SVG icons using <use xlink:href> tags for calling SVG icons by class.
truncation
- Used to truncate text field content and add an ellipsis
- Used when the length of content in a field exceeds the length to be displayed on the public-facing website
youtube
- Used to replace https://www.youtube.com/watch?v= with https://www.youtube.com/embed/ in the content entered into YouTube video fields

components folder

components
- imports the individual component formats in the components folder
accordions
- Used to assemble the content of accordion component fields as a block of XHTML code for display on the public facing website
media
- Used to assemble the content of media component fields as a block of XHTML code for display on the public facing website
quote
- Used to assemble the content of quote component fields as a block of XHTML code for display on the public facing website
research
- Used to assemble the content of research component fields as a block of XHTML code for display on the public facing website
rss-slideshow
- Used to assemble the content of image slideshows
wysiwyg
- Used to render the content from WYSIWYG editor fields

contact folder

contact-block
- Used to render the XSL-transformed content of a Contact block when it is selected to be pulled into the Contact area of a page
contact-macro
- Used to transform the content of a Contact block into XHTML for display on the pubic facing website
contact-page
- Used to render the XSL-transformed content of a Contact block when the content is input directly into the Contact area of a page

data folder

programs
- Renders the .json file that holds the data for the program search

dynamic folder

common
- pulls in the common.php file and sets error display and reporting values

includes folder

bottom-high
- Holds calls to .js files made through <script></script> tags
- .js files pulled from TAMU-CC Shared site: assets > js
- Tags placed at the bottom of pages using the High Level template
bottom-home
- Holds calls to .js files made through <script></script> tags
- .js files pulled from TAMU-CC Shared site: assets > js
- Tags placed at the bottom of pages using the Home Page template
bottom-program-finder
- Holds calls to .js files made through <script></script> tags
- .js files pulled from TAMU-CC Shared site: assets > js
- Tags placed at the bottom of pages using the Program Finder template
bottom-standard
- Holds calls to .js files made through <script></script> tags
- .js files pulled from TAMU-CC Shared site: assets > js
- Tags placed at the bottom of pages using the Standard Level template
top
- Holds calls to .js and .css files made through <script></script> and <link> tags
  - .js files pulled from TAMU-CC Shared site: assets > js
  - .css files pulled from TAMU-CC Shared site: assets > css
  - Tags placed at the bottom of pages using the High Level template
- Renders description and keywords meta tags using content entered into the Description and Keywords fields on the Metadata screen of pages

navigation folder

breadcrumbs
- Renders the XHTML of the breadcrumb trail navigation
page-navigation
- Determines the pages to display in the section navigation (displayed in left sidebar)
page-navigation-macro
- Renders the XHTML of the section navigation (displayed in left sidebar)

programs folder

masthead
- Renders the XHTML of the Masthead on program pages
results-php
- Renders the XHTML of the program results

Files in the root of the formats folder

- additional-content
  - Transforms the content pulled from the fields of the Additional Content component into XHTML
- cards
  - Transforms the content pulled from the fields of the Cards component into XHTML
  - The fields in the Cards component are page selectors and the content is pulled from the fields of the Preview component of the pages selected in the page selectors
- cards-research
- global-footer-markup
  - Transforms the content pulled from the Global Footer block into XHTML
  - Global Footer block location: TAMU-CC Shared > shared > Global Footer
- global-footer-on-page
  - Outputs the XHTML of the global-footer-markup on the public facing website
  - Published to the public facing website through publishing of the published-footer page
    - published-footer page location: TAMU-CC Shared > shared > published-footer
- global-header-markup
  - Transforms the content pulled from the Global Header block into XHTML
  - Global Footer block location: TAMU-CC Shared > shared > Global Header
- global-header-on-page
  - Outputs the XHTML of the global-footer-markup on the public facing website
  - Published to the public facing website through publishing of the published-footer page
    - published-footer page location: TAMU-CC Shared > shared > published-footer
- intro-high-level
  - Transforms the content of the Description field in the Masthead component into XHTML on the High Level page

intro-research
- Transforms the content of the Description field in the Masthead component into XHTML on the Research Detail page
intro-standard-level
- Transforms the content of the Description field in the Masthead component into XHTML on the Standard Level page
masthead
- Transforms the content of the image, video, and link fields in the Masthead component into XHTML
masthead-high-level
- Transforms the content of the image, video, and link fields in the Masthead component into XHTML on the High Level page
masthead-standard-level
- Transforms the content of the image, video, and link fields in the Masthead component into XHTML on the Standard Level page
memories
side-ctas
- Transforms the content of the image, video, and link fields in the Side CTAS component into XHTML on the Program Detail page
slider
- Transforms the content of the fields in the Slider component into XHTML
slider-college-landing
- Transforms the content of the fields in the Slider component into XHTML on the College Landing page
slider-research
- Transforms the content of the fields in the Slider component into XHTML on the Research Initiatives page
stacked-cards
- Transforms the content of the fields in the Stacked Cards component into XHTML on the Research initiatives page
the-island
- Transforms the content of the fields in the Welcome to the Island component into XHTML on the Home Page
title
- Transforms the content of the Title field into the <title> tag XHTML
- Appends | Texas A&M University-Corpus Christi to the content within the <title> tag
- Example: About Us | Texas A&M University-Corpus Christi

Global Footer
- Block that holds the content entry fields for managing the content of the global footer
Global Header
- Block that holds the content entry fields for managing the content of the global header
published-footer
- Page that holds the transformed XHTML content of the global footer
- Publishing this page publishes the content of the global footer to the public facing website
published-header
- Page that holds the transformed XHTML content of the global header
- Publishing this page publishes the content of the global header to the public facing website

article-details
- Template file for the Article Details page
- Holds XHTML structure and system regions
college-department
- Template file for the College/Department Landing page
- Holds XHTML structure and system regions
high-level
- Template file for the High Level page
- Holds XHTML structure and system regions
home
- Template file for the Home page
- Holds XHTML structure and system regions
json
program-details
- Template file for the Program Details page
- Holds XHTML structure and system regions
program-finder
- Template file for the Program Finder page
- Holds XHTML structure and system regions
research-initiatives
- Template file for the Research Initiatives page
- Holds XHTML structure and system regions
single-region
standard-level
- Template file for the Standard Level page
- Holds XHTML structure and system regions
user-portal
- Template file for the User Portal page
- Holds XHTML structure and system regions

TAMU-CC Shared Asset Factories

Configuration and set-up of the Asset Factories administered through Manage Site on the TAMU-CC Shared site.

These are the asset factories that would be used to create pages across all sites.

TAMU-CC Shared Configurations

Configuration and set-up of the Configurations administered through Manage Site on the TAMU-CC Shared site.

Region	Block	Format
ACCESSIBILITY_NAV	accessibility_nav
AUTHOR	current-page	author
BRERADCRUMBS	breadcrumbs	breadcrumbs
COMPONENTS	current-page	_components
DYNAMIC_HEAD		common
FOOTER	Global Footer	global-footer-on-page
HEADER	Global Header	global-header-on-page
INCLUDES_BOTTOM	current-page	bottom-standard
INCLUDES_TOP	current-page	top
MASTHEAD	article-masthead	masthead
SVG	scv
TITLE	current-page	title

These are regions in this page type.

ACCESSIBILITY_NAV
- Block: accessibility_nav
ADDITIONAL-CONTENT
- Block: current-page
- Format: additional-content
CHILD-PAGE-GRID
- Block: current-page
- Format: cards
DYNAMIC_HEAD
- Format: common
FOOTER
- Block: Global Footer
- Format: global-footer-on-page
HEADER
- Block: Global Header
- Format: global-header-on-page
INCLUDES_BOTTOM
- Block: current-page
- Format: bottom-standard
INCLUDES_TOP
- Block: current-page
- Format: top
INTRO
- Block: current-page
- Format: intro-high-level
MASTHEAD
- Block: article-masthead
- Format: masthead-high-level
SLIDER
- Block: current-page
- Format: slider-college-landing
SVG
- Block: svg
TITLE
- Block: current-page
- Format: title