Skip to content

Commit 76be8f9

Browse files
- All unit tests pass
- Add tests for integration of routes w/ templates - Add documentation for template variables -
1 parent e06fa14 commit 76be8f9

19 files changed

+1058
-297
lines changed

docs/templates.qmd

Lines changed: 321 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,321 @@
1+
---
2+
title: "Template Variables Documentation"
3+
---
4+
5+
This file documents the required context variables for each template in the application.
6+
7+
## Table of Contents
8+
9+
- [authentication](#authentication)
10+
- [components](#components)
11+
- [dashboard](#dashboard)
12+
- [dashboard > organizations](#dashboard-organizations)
13+
- [dashboard > organizations > members](#dashboard-organizations-members)
14+
- [emails](#emails)
15+
- [errors](#errors)
16+
- [root](#root)
17+
- [users](#users)
18+
19+
## authentication
20+
21+
### forgot_password.html
22+
23+
**Path:** `authentication/forgot_password.html`
24+
25+
**Required Variables:**
26+
27+
| Variable | Description |
28+
| --- | --- |
29+
| `show_form` | |
30+
| `url_for` | |
31+
32+
### login.html
33+
34+
**Path:** `authentication/login.html`
35+
36+
**Required Variables:**
37+
38+
| Variable | Description |
39+
| --- | --- |
40+
| `url_for` | |
41+
42+
### register.html
43+
44+
**Path:** `authentication/register.html`
45+
46+
**Required Variables:**
47+
48+
| Variable | Description |
49+
| --- | --- |
50+
| `password_pattern` | |
51+
| `url_for` | |
52+
53+
### reset_password.html
54+
55+
**Path:** `authentication/reset_password.html`
56+
57+
**Required Variables:**
58+
59+
| Variable | Description |
60+
| --- | --- |
61+
| `email` | |
62+
| `password_pattern` | |
63+
| `token` | |
64+
| `url_for` | |
65+
66+
## components
67+
68+
### footer.html
69+
70+
**Path:** `components/footer.html`
71+
72+
**Required Variables:**
73+
74+
| Variable | Description |
75+
| --- | --- |
76+
| `url_for` | |
77+
78+
### header.html
79+
80+
**Path:** `components/header.html`
81+
82+
**Required Variables:**
83+
84+
| Variable | Description |
85+
| --- | --- |
86+
| `url_for` | |
87+
| `user` | |
88+
89+
### logo.html
90+
91+
**Path:** `components/logo.html`
92+
93+
**No variables required**
94+
95+
### nav.html
96+
97+
**Path:** `components/nav.html`
98+
99+
**Required Variables:**
100+
101+
| Variable | Description |
102+
| --- | --- |
103+
| `url_for` | |
104+
105+
### organizations.html
106+
107+
**Path:** `components/organizations.html`
108+
109+
**Required Variables:**
110+
111+
| Variable | Description |
112+
| --- | --- |
113+
| `url_for` | |
114+
115+
### silhouette.html
116+
117+
**Path:** `components/silhouette.html`
118+
119+
**No variables required**
120+
121+
## dashboard
122+
123+
### index.html
124+
125+
**Path:** `dashboard/index.html`
126+
127+
**No variables required**
128+
129+
### organization_overview.html
130+
131+
**Path:** `dashboard/organization_overview.html`
132+
133+
**No variables required**
134+
135+
## dashboard > organizations
136+
137+
### create.html
138+
139+
**Path:** `dashboard/organizations/create.html`
140+
141+
**No variables required**
142+
143+
### delete.html
144+
145+
**Path:** `dashboard/organizations/delete.html`
146+
147+
**No variables required**
148+
149+
### detail.html
150+
151+
**Path:** `dashboard/organizations/detail.html`
152+
153+
**No variables required**
154+
155+
### edit.html
156+
157+
**Path:** `dashboard/organizations/edit.html`
158+
159+
**No variables required**
160+
161+
### members.html
162+
163+
**Path:** `dashboard/organizations/members.html`
164+
165+
**No variables required**
166+
167+
## dashboard > organizations > members
168+
169+
### delete.html
170+
171+
**Path:** `dashboard/organizations/members/delete.html`
172+
173+
**No variables required**
174+
175+
### edit.html
176+
177+
**Path:** `dashboard/organizations/members/edit.html`
178+
179+
**No variables required**
180+
181+
### invite.html
182+
183+
**Path:** `dashboard/organizations/members/invite.html`
184+
185+
**No variables required**
186+
187+
## emails
188+
189+
### base_email.html
190+
191+
**Path:** `emails/base_email.html`
192+
193+
**No variables required**
194+
195+
### reset_email.html
196+
197+
**Path:** `emails/reset_email.html`
198+
199+
**Required Variables:**
200+
201+
| Variable | Description |
202+
| --- | --- |
203+
| `reset_url` | |
204+
205+
### update_email_email.html
206+
207+
**Path:** `emails/update_email_email.html`
208+
209+
**Required Variables:**
210+
211+
| Variable | Description |
212+
| --- | --- |
213+
| `confirmation_url` | |
214+
| `current_email` | |
215+
| `new_email` | |
216+
217+
## errors
218+
219+
### error.html
220+
221+
**Path:** `errors/error.html`
222+
223+
**Required Variables:**
224+
225+
| Variable | Description |
226+
| --- | --- |
227+
| `detail` | |
228+
| `status_code` | |
229+
| `url_for` | |
230+
231+
### validation_error.html
232+
233+
**Path:** `errors/validation_error.html`
234+
235+
**Required Variables:**
236+
237+
| Variable | Description |
238+
| --- | --- |
239+
| `errors` | |
240+
| `url_for` | |
241+
242+
## root
243+
244+
### about.html
245+
246+
**Path:** `about.html`
247+
248+
**No variables required**
249+
250+
### auth_base.html
251+
252+
**Path:** `auth_base.html`
253+
254+
**No variables required**
255+
256+
### base.html
257+
258+
**Path:** `base.html`
259+
260+
**Required Variables:**
261+
262+
| Variable | Description |
263+
| --- | --- |
264+
| `url_for` | |
265+
266+
### index.html
267+
268+
**Path:** `index.html`
269+
270+
**Required Variables:**
271+
272+
| Variable | Description |
273+
| --- | --- |
274+
| `render_logo` | |
275+
| `url_for` | |
276+
277+
### privacy_policy.html
278+
279+
**Path:** `privacy_policy.html`
280+
281+
**No variables required**
282+
283+
### terms_of_service.html
284+
285+
**Path:** `terms_of_service.html`
286+
287+
**No variables required**
288+
289+
## users
290+
291+
### organization.html
292+
293+
**Path:** `users/organization.html`
294+
295+
**Required Variables:**
296+
297+
| Variable | Description |
298+
| --- | --- |
299+
| `organization` | |
300+
| `render_silhouette` | |
301+
| `url_for` | |
302+
303+
### profile.html
304+
305+
**Path:** `users/profile.html`
306+
307+
**Required Variables:**
308+
309+
| Variable | Description |
310+
| --- | --- |
311+
| `allowed_formats` | |
312+
| `email_update_requested` | |
313+
| `email_updated` | |
314+
| `max_dimension` | |
315+
| `max_file_size_mb` | |
316+
| `min_dimension` | |
317+
| `render_organizations` | |
318+
| `render_silhouette` | |
319+
| `show_form` | |
320+
| `url_for` | |
321+
| `user` | |

0 commit comments

Comments
 (0)