mirror of
https://github.com/GSA/notifications-admin.git
synced 2026-07-19 05:53:51 -04:00
37 lines
2.4 KiB
Markdown
37 lines
2.4 KiB
Markdown
|
|
# 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`, 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 org_template and settings_template that includes a sidebar.
|
|
- **/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.
|
|
|
|
### Old Layout Templates We Don't Need
|
|
- withoutnav_template.html Delete, it is now apart of base.html
|
|
- main_template.html Delete, it is now apart of base.html
|
|
- 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, Delete, it is now apart of withnav_template.html
|
|
- org_nav.html (move to /components/ directory)
|
|
- content_template.html Delete, it is now apart of base.html
|