Skip to content

Commit c7f71c9

Browse files
benkeenbenkeen
committed
lots more metadata
1 parent 946d741 commit c7f71c9

File tree

73 files changed

+222
-31
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

73 files changed

+222
-31
lines changed

‎README.md

+41-7
Original file line numberDiff line numberDiff line change
@@ -58,18 +58,52 @@ categories: modules
5858
tags: permissions,visualization
5959
```
6060

61+
#### tags
62+
Arbitrary strings to pinpoint what the page is about. This is as fine-grained as it gets and it's the only one of these
63+
metadata properties that actually visually appears in each documentation page. The user can click on the pills containing
64+
these names and it lets them perform searches to filter the results to pages sharing the same tags.
65+
66+
This list should be kept up to date. Current tags:
67+
`permissions`, `views`, `fields`, `field_types`, `option_lists`, `validation`, `submissions`, `data_export`,
68+
`emails`, `filters`, `themes`, `modules`, `spam`, `email`, `security`, `deprecated`, `files`, `menus`
69+
70+
6171
#### versions
62-
`FT2` or `FT3`. Comma-delimited. If empty, it's assumed the page is relevant for any version of Form Tools.
72+
`FT2` or `FT3`. Comma-delimited. If empty, it's assumed the page is relevant for any version of Form Tools. This value
73+
is used in searching only.
6374

6475
#### page_type
6576
- `toc` - table of contents (a list of links for the section)
6677
- `introduction` - an introduction/overview to a component / subject. A good starting point for something.
6778

6879
#### categories
69-
Comma-delimited list of: `core`, `userdoc`, `modules`, `themes`, `api`, `theme_development`,
70-
`module_development`, `tutorial`, `installation`, `upgrading`, `translations`
80+
Comma-delimited list of: `core`, `userdoc`, `modules`, `themes`, `api`, `theme_development`, `module_development`,
81+
`tutorial`, `installation`, `upgrading`, `translations`, `basics`, `accounts`
82+
83+
These are presented in the search form to let you limit the results to a particular category.
84+
85+
86+
87+
88+
89+
90+
91+
92+
93+
94+
95+
96+
97+
98+
99+
100+
101+
102+
103+
104+
105+
106+
107+
108+
71109

72-
#### tags
73-
Arbitrary strings to pinpoint what the page is about. This is as fine-grained as it gets.
74-
`permissions`, `forms`, `views`, `fields`, `field_types`, `option_lists`, `validation`, `submissions`, `data_export`,
75-
`emails`, `filters`, `themes`, `spam`, `email`, `security`, `deprecated`

‎_includes/tags.html

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
<ul id="page-tags">
2+
{% assign pagetags = page.tags | split: "," | sort %}
3+
{% for item in pagetags %}
4+
<li><span class="{{item}}">{{item | replace: "_", " " | capitalize_all }}</span></li>
5+
{% endfor %}
6+
</ul>

‎_layouts/default.html

+1
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ <h4>DOCUMENTATION</h4>
2121
<div class="wrap">
2222

2323
{% include breadcrumbs.html %}
24+
{% include tags.html %}
2425

2526
<header>
2627
<h1 id="page-title">{{page.heading}}</h1>

‎_plugins/capitalize_all.rb

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
require 'liquid'
2+
require 'uri'
3+
4+
# Capitalize all words of the input
5+
module CapitalizeAll
6+
def capitalize_all(words)
7+
return words.split(' ').map(&:capitalize).join(' ')
8+
end
9+
end
10+
11+
Liquid::Template.register_filter(CapitalizeAll)

‎assets/css/docs.css

+95
Original file line numberDiff line numberDiff line change
@@ -915,3 +915,98 @@ img.mfp-img {
915915
.green {
916916
color: green;
917917
}
918+
919+
#page-tags {
920+
float: right;
921+
font-size: 12px;
922+
list-style: none;
923+
margin: 0;
924+
padding: 0;
925+
}
926+
#page-tags li {
927+
display: inline-block;
928+
line-height: 18px;
929+
}
930+
#page-tags li span {
931+
display: inline-block;
932+
border-radius: 3px;
933+
padding: 1px 8px;
934+
}
935+
936+
/* styles for tag */
937+
#page-tags li span.fields {
938+
background-color: #035994;
939+
color: white;
940+
}
941+
#page-tags li span.validation {
942+
background-color: #940303;
943+
color: white;
944+
}
945+
#page-tags li span.permissions {
946+
background-color: #f6eac7;
947+
color: #111111;
948+
}
949+
#page-tags li span.field_types {
950+
background-color: #c7e8f6;
951+
color: #222222;
952+
}
953+
#page-tags li span.emails {
954+
background-color: #569167;
955+
color: white;
956+
}
957+
#page-tags li span.files {
958+
background-color: #313e35;
959+
color: white;
960+
}
961+
#page-tags li span.security {
962+
background-color: #f38c3a;
963+
color: #111111;
964+
}
965+
#page-tags li span.option_lists {
966+
background-color: #704578;
967+
color: #ffffff;
968+
}
969+
#page-tags li span.views {
970+
background-color: #059986;
971+
color: #ffffff;
972+
}
973+
#page-tags li span.submissions {
974+
background-color: #e3cb02;
975+
color: #111111;
976+
}
977+
#page-tags li span.data_export {
978+
background-color: #42372f;
979+
color: #ffffff;
980+
}
981+
#page-tags li span.accounts {
982+
background-color: #9ed703;
983+
color: #111111;
984+
}
985+
#page-tags li span.filters {
986+
background-color: #cbd3b7;
987+
color: #222222;
988+
}
989+
#page-tags li span.settings {
990+
background-color: #c4b0f0;
991+
color: #222222;
992+
}
993+
#page-tags li span.deprecated {
994+
background-color: #000000;
995+
color: #ffffff;
996+
}
997+
#page-tags li span.menus {
998+
background-color: #799cff;
999+
color: #111111;
1000+
}
1001+
#page-tags li span.themes {
1002+
background-color: #5c40ec;
1003+
color: #ffffff;
1004+
}
1005+
#page-tags li span.spam {
1006+
background-color: #cc1616;
1007+
color: white;
1008+
}
1009+
#page-tags li span.basics {
1010+
background-color: #fe8081;
1011+
color: white;
1012+
}

‎modules/swift_mailer/configuration.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
prev: Security,/modules/swift_mailer/security
1010
next: Example Gmail Configuration,/modules/swift_mailer/gmail
1111
categories: modules
12-
tags: email
12+
tags: emails
1313
---
1414

1515
{% include open_section.html nav='nav_swift_mailer.html' selected='configuration' %}

‎modules/swift_mailer/file_attachments.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
prev: Example Gmail Configuration,/modules/swift_mailer/gmail/
1010
next: Handling Undeliverable Emails,/modules/swift_mailer/undeliverable_emails/
1111
categories: modules
12-
tags: email
12+
tags: emails,files
1313
---
1414

1515
{% include open_section.html nav='nav_swift_mailer.html' selected='file_attachments' %}

‎modules/swift_mailer/from_address.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
- From Address Overridden
99
prev: Handling Undeliverable Emails,/modules/swift_mailer/undeliverable_emails/
1010
categories: modules
11-
tags: email
11+
tags: emails
1212
---
1313

1414
{% include open_section.html nav='nav_swift_mailer.html' selected='from_address' %}

‎modules/swift_mailer/gmail.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
prev: Configuration,/modules/swift_mailer/configuration/
1010
next: File Attachments,/modules/swift_mailer/file_attachments/
1111
categories: modules
12-
tags: email
12+
tags: emails
1313
---
1414

1515
{% include open_section.html nav='nav_swift_mailer.html' selected='gmail' %}

‎modules/swift_mailer/index.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
- Swift Mailer
88
next: Security,/modules/swift_mailer/security
99
categories: modules
10-
tags: email
10+
tags: emails
1111
---
1212

1313
{% include open_section.html nav='nav_swift_mailer.html' selected='introduction' %}

‎modules/swift_mailer/security.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
prev: Introduction,/modules/swift_mailer/
99
next: Configuration,/modules/swift_mailer/configuration
1010
categories: modules
11-
tags: email,security
11+
tags: emails,security
1212
---
1313

1414
{% include open_section.html nav='nav_swift_mailer.html' selected='security' %}

‎modules/swift_mailer/undeliverable_emails.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
prev: File Attachments,/modules/swift_mailer/file_attachments/
1010
next: From Address Overridden,/modules/swift_mailer/from_address
1111
categories: modules
12-
tags: email
12+
tags: emails
1313
---
1414

1515
{% include open_section.html nav='nav_swift_mailer.html' selected='undeliverable_emails' %}

‎tutorials/adding_first_form/form_types.html

+1
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@
77
- Adding your first form
88
next: Picked your Submission Method?,/tutorials/adding_first_form/next_step/
99
categories: tutorial,api
10+
tags: basics
1011
---
1112

1213
{% include open_section.html nav='nav_tutorial_adding_first_form.html' selected='form_types' nav_width=3 %}

‎tutorials/adding_first_form/index.html

+1
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@
88
subnavSection: Adding your first form
99
next: POST forms and API forms,/tutorials/adding_first_form/form_types/
1010
categories: tutorial
11+
tags: basics
1112
---
1213

1314
{% include open_section.html nav='nav_tutorial_adding_first_form.html' selected='introduction' nav_width=3 %}

‎tutorials/adding_first_form/next_step.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
categories: tutorial
1010
---
1111

12-
{% include open_section.html nav='nav_tutorial_adding_first_form.html' selected='next_step' nav_width=4 %}
12+
{% include open_section.html nav='nav_tutorial_adding_first_form.html' selected='next_step' nav_width=3 %}
1313

1414
<p>
1515
Okay, picked your submission method? Great! Click on one of the following links to continue.

‎tutorials/adding_post_form/index.html

+1
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@
88
subnavSection: Adding a POST form
99
next: "Step 1: Checklist,/tutorials/adding_post_form/step1/"
1010
categories: tutorial
11+
tags: basics
1112
---
1213

1314
{% include open_section.html nav='nav_tutorial_adding_post_form.html' selected='overview' nav_width=3 %}

‎tutorials/adding_post_form/related_links.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
<h3>Related Links</h3>
1616

1717
<ul>
18-
<li><a href="https://docs.formtools.org/tutorials/post_form_captchas/">Adding CAPTCHAs to your POST form</a></li>
18+
<li><a href="{{site.baseurl}}/tutorials/post_form_captchas/">Adding CAPTCHAs to your POST form</a></li>
1919
</ul>
2020

2121
{% include close_section.html %}

‎tutorials/adding_post_form/step1.html

+1
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@
99
prev: Overview
1010
next: "Step 2: Form Information,/tutorials/adding_post_form/step2/"
1111
categories: tutorial
12+
tags: basics
1213
---
1314

1415
{% include open_section.html nav='nav_tutorial_adding_post_form.html' selected='step1' nav_width=3 %}

‎tutorials/adding_post_form/step2.html

+1
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@
99
prev: "Step 1: Checklist,/tutorials/adding_post_form/step1/"
1010
next: "Step 3: Test Submission,/tutorials/adding_post_form/step3/"
1111
categories: tutorial
12+
tags: basics
1213
---
1314

1415
{% include open_section.html nav='nav_tutorial_adding_post_form.html' selected='step2' nav_width=3 %}

‎tutorials/adding_post_form/step3.html

+1
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@
99
prev: "Step 2: Form Information,/tutorials/adding_post_form/step2/"
1010
next: "Step 4: Database Setup,/tutorials/adding_post_form/step4/"
1111
categories: tutorial
12+
tags: basics
1213
---
1314

1415
{% include open_section.html nav='nav_tutorial_adding_post_form.html' selected='step3' nav_width=3 %}

‎tutorials/adding_post_form/step4.html

+1
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@
99
prev: "Step 3: Test Submission,/tutorials/adding_post_form/step3/"
1010
next: "Step 5: Field Types,/tutorials/adding_post_form/step5/"
1111
categories: tutorial
12+
tags: basics
1213
---
1314

1415
{% include open_section.html nav='nav_tutorial_adding_post_form.html' selected='step4' nav_width=3 %}

‎tutorials/adding_post_form/step5.html

+1
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@
99
prev: "Step 4: Database Setup,/tutorials/adding_post_form/step4/"
1010
next: "Step 6: Finalize Form,/tutorials/adding_post_form/step6/"
1111
categories: tutorial
12+
tags: basics
1213
---
1314

1415
{% include open_section.html nav='nav_tutorial_adding_post_form.html' selected='step5' nav_width=3 %}

‎tutorials/adding_post_form/step6.html

+1
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@
99
prev: "Step 5: Field Types,/tutorials/adding_post_form/step5/"
1010
next: "Related Links,/tutorials/adding_post_form/related_links/"
1111
categories: tutorial
12+
tags: basics
1213
---
1314

1415
{% include open_section.html nav='nav_tutorial_adding_post_form.html' selected='step6' nav_width=3 %}

‎tutorials/api_refilling_form_fields/index.html

+1
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@
77
- Re-filling form fields using the API
88
categories: tutorial,api
99
versions: FT2
10+
tags: basics
1011
---
1112

1213
<p class="alert alert-warning">

‎tutorials/api_v2_refilling_form_fields/index.html

+1
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@
77
- Re-filling form fields using the API
88
categories: tutorial,api
99
versions: FT3
10+
tags: basics
1011
---
1112

1213
<p class="alert alert-warning">

‎tutorials/api_v2_single_page_form/index.html

+1
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@
88
next: Configuring your form page,/tutorials/api_v2_single_page_form/step1/
99
categories: tutorial,api
1010
versions: FT3
11+
tags: basics
1112
---
1213

1314
{% include open_section.html nav='nav_tutorial_aspf_api2.html' selected='introduction' nav_width=4 %}

‎tutorials/api_v2_single_page_form/step1.html

+1
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@
1010
next: Configuring your "thankyou" page,/tutorials/api_v2_single_page_form/step2/
1111
categories: tutorial,api
1212
versions: FT3
13+
tags: basics
1314
---
1415

1516
{% include open_section.html nav='nav_tutorial_aspf_api2.html' selected='step1' nav_width=4 %}

‎tutorials/api_v2_single_page_form/step2.html

+1
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@
1010
next: The test submission,/tutorials/api_v2_single_page_form/step3/
1111
categories: tutorial,api
1212
versions: FT3
13+
tags: basics
1314
---
1415

1516
{% include open_section.html nav='nav_tutorial_aspf_api2.html' selected='step2' nav_width=4 %}

‎tutorials/api_v2_single_page_form/step3.html

+1
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@
1010
next: Going live!,/tutorials/api_v2_single_page_form/step4/
1111
categories: tutorial,api
1212
versions: FT3
13+
tags: basics
1314
---
1415

1516
{% include open_section.html nav='nav_tutorial_aspf_api2.html' selected='step3' nav_width=4 %}

‎tutorials/api_v2_single_page_form/step4.html

+1
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@
1010
next: Related links,/tutorials/api_v2_single_page_form/related_links/
1111
categories: tutorial,api
1212
versions: FT3
13+
tags: basics
1314
---
1415

1516
{% include open_section.html nav='nav_tutorial_aspf_api2.html' selected='step4' nav_width=4 %}

0 commit comments

Comments
 (0)