app/templates/new/templates_glossary.md


# New Templates Glossary

This document serves as a glossary for the templates directory structure of the project.

## Directory Structure

- `/templates`
  - `base.html`: The main base template from which all other templates inherit. This template is a combination of `main_template`, `admin_template`, `withoutnav_template`, `settings_templates`, and `content_template`.
  - **/layouts**: Contains shared layouts used across the site. Simply put, it defines the overall structure or skeleton of the application (less frequently revised).
    - `withnav_template.html`: A variation of the base layout that includes a sidebar.
    - `org_template.html`: A variaton of the withnav_template
  - **/components**: Houses reusable UI components that can be included in multiple templates and can be tailored with different content or links depending on the context.(more frequently revised or customized)
    - `head.html`: Template for the site's <head>, included in `base.html`.
    - `header.html`: Template for the site's header, included in `base.html`.
    - `footer.html`: Template for the site's footer, included in `base.html`.
    - `settings_navigation.html`: The settings navigation used in `withnav_template.html` that previously extended `settings_template.html`.
    - `org_nav.html`: The organization's navigation used solely in `org_template.html`.
    - `main_nav.html`: The main navigation used in `withnav_template.html`
    - `service_navigation.html`: The service navigation used in `withnav_template.html`. In withnav_template.html, the `serviceNavigation` block will be left empty in any child templates that previously extended `settings_template.html`.
  - **/views** (or **/pages**): Individual page templates that use the base layouts, components, and partials to present content.

### Best Practices

- Use **inheritance** `{% extends %}` to build on base layouts.
- Employ **components** `{% include %}` for reusable UI elements to keep the code DRY and facilitate easier updates.

### Observation Notes
- The macro-options.json files in the header and footer component act as structural guides. They aren't directly used as data passed to the usaFooter function/macro. Instead, these files outline the expected properties and provide a description of their purpose. The `usaFooter` macro component is currently only invoked in the `admin_template`, which will eventually serve as the `base.html` template. This will simplify the approach when we change the footer macros to componenets by eliminating the need to dynamically pass this data from the base.html template. This is also true for `usaHeader` macro component.


### Old Layout Templates We Don't Need
- withoutnav_template.html Delete
- main_template.html Delete
- settings_templates.html `withnav_template` can be used to replace `settings_template`.
- settings_nav.html (move to /components/ directory)
- main_nav.html (move to /components/ directory)
- service_navigation.html (move to /components/ directory)
- org_template, could be under it's own directory called /layout/organization
- org_nav.html (move to /components/ directory)
- content_template.html Delete
base.hmtl created 2024-02-29 10:49:30 -08:00
			`# New Templates Glossary`

			`This document serves as a glossary for the templates directory structure of the project.`

			`## Directory Structure`

			- `/templates`
header marco to html 2024-03-21 21:03:32 -07:00			- `base.html`: The main base template from which all other templates inherit. This template is a combination of `main_template`, `admin_template`, `withoutnav_template`, `settings_templates`, and `content_template`.
			`- /layouts: Contains shared layouts used across the site. Simply put, it defines the overall structure or skeleton of the application (less frequently revised).`
updated base.html template to also include admin-template 2024-02-29 16:36:11 -08:00			- `withnav_template.html`: A variation of the base layout that includes a sidebar.
added notes and org_template 2024-03-04 11:03:22 -08:00			- `org_template.html`: A variaton of the withnav_template
base.hmtl created 2024-02-29 10:49:30 -08:00			`- /components: Houses reusable UI components that can be included in multiple templates and can be tailored with different content or links depending on the context.(more frequently revised or customized)`
1258 - Updated the <head> template 2024-03-12 12:28:30 -04:00			- `head.html`: Template for the site's <head>, included in `base.html`.
base.hmtl created 2024-02-29 10:49:30 -08:00			- `header.html`: Template for the site's header, included in `base.html`.
			- `footer.html`: Template for the site's footer, included in `base.html`.
revised notes 2024-04-10 10:41:35 -07:00			- `settings_navigation.html`: The settings navigation used in `withnav_template.html` that previously extended `settings_template.html`.
			- `org_nav.html`: The organization's navigation used solely in `org_template.html`.
			- `main_nav.html`: The main navigation used in `withnav_template.html`
			- `service_navigation.html`: The service navigation used in `withnav_template.html`. In withnav_template.html, the `serviceNavigation` block will be left empty in any child templates that previously extended `settings_template.html`.
base.hmtl created 2024-02-29 10:49:30 -08:00			`- /views (or /pages): Individual page templates that use the base layouts, components, and partials to present content.`

			`### Best Practices`

header marco to html 2024-03-21 21:03:32 -07:00			- Use inheritance `{% extends %}` to build on base layouts.
			- Employ components `{% include %}` for reusable UI elements to keep the code DRY and facilitate easier updates.
base.hmtl created 2024-02-29 10:49:30 -08:00
relative path update 2024-03-01 10:38:07 -08:00			`### Observation Notes`
header marco to html 2024-03-21 21:03:32 -07:00			- The macro-options.json files in the header and footer component act as structural guides. They aren't directly used as data passed to the usaFooter function/macro. Instead, these files outline the expected properties and provide a description of their purpose. The `usaFooter` macro component is currently only invoked in the `admin_template`, which will eventually serve as the `base.html` template. This will simplify the approach when we change the footer macros to componenets by eliminating the need to dynamically pass this data from the base.html template. This is also true for `usaHeader` macro component.
updated base.html template to also include admin-template 2024-02-29 16:36:11 -08:00


			`### Old Layout Templates We Don't Need`
			`- withoutnav_template.html Delete`
			`- main_template.html Delete`
added notes and org_template 2024-03-04 11:03:22 -08:00			- settings_templates.html `withnav_template` can be used to replace `settings_template`.
moved settings_nav to /new/components 2024-04-09 15:28:36 -07:00			`- settings_nav.html (move to /components/ directory)`
			`- main_nav.html (move to /components/ directory)`
			`- service_navigation.html (move to /components/ directory)`
added notes and org_template 2024-03-04 11:03:22 -08:00			`- org_template, could be under it's own directory called /layout/organization`
moved settings_nav to /new/components 2024-04-09 15:28:36 -07:00			`- org_nav.html (move to /components/ directory)`
added notes and org_template 2024-03-04 11:03:22 -08:00			`- content_template.html Delete`