Skip to content

Commit d2e3643

Browse files
committed
rearrange all the things.
1 parent ee89b4c commit d2e3643

File tree

152 files changed

+87
-149
lines changed

Some content is hidden

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

152 files changed

+87
-149
lines changed

content/collections/tags/assets.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@ id: 5b748a3f-be0e-41c1-8877-73f6b7ee1d0a
33
title: Assets
44
overview: >
55
Used to retrieve Assets data from the [Asset Fieldtype](/docs/fieldtypes/assets). Your site's Assets are managed and stored independently of your pages and entries and have a joined relationship through their `id`. [Learn more about Assets](/guides/assets).
6+
description: Fetch image/file Assets from an Assets field.
67
variables:
78
-
89
name: id

content/collections/tags/cache.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ parameters:
77
name: scope
88
type: 'string *site*'
99
description: 'Sets the cache scope. You have your choice of the default `site` or `page`.'
10+
description: Cache a template chunk for performance.
1011
id: 1d0d2d1f-734b-4360-af7a-6792bf670bc7
1112
---
1213
## Usage {#usage}

content/collections/tags/collection-next.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
11
---
22
title: Next
3-
overview: >
4-
Iterate over the next entries that would
5-
show up in the listing.
3+
overview: Grab the next entries relative to current entry in a Collection.
64
parameters:
75
-
86
name: in|collection

content/collections/tags/collection-previous.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
11
---
22
title: Previous
3-
overview: >
4-
Iterate over the previous entries that
5-
would show up in the listing.
3+
overview: Grab the previous entries relative to current entry in a Collection.
64
id: 741cf972-c0bd-4e3c-81e2-8cc8bea60737
75
---
86
This Tag functions the same way as the [`collection:next`](/docs/tags/collection-next) tag, but in the opposite direction.

content/collections/tags/collection.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
title: Collection
33
is_parent_tag: true
44
overview: Entries are grouped into Collections and connected to this tag to provide you means to fetch, sort, filter, and arrange them in various ways. A Collection might contain blog posts, products, or even a pile of terrible knock-knock jokes. We don't judge, and neither does the Collection Tag.
5+
description: Grab and filter the entries in a specified Collection.
56
parameters:
67
-
78
name: from|folder|use

content/collections/tags/entries.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: Entries
33
id: 45e7802d-2399-4a60-9cf8-35441efa9aab
44
is_parent_tag: true
5-
overview: Iterate over entries in a collection.
5+
overview: Iterate over entries in a Collection.
66
parameters:
77
-
88
name: url

content/collections/tags/form-create.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: Create
33
id: aa96fcf1-510c-404b-9b63-cea8942e1bf8
44
overview: >
5-
This Tag will generate a `<form>` to allow your users to create submissions into a particular Form.
5+
Generate necessary `<form>` markup to accept form submissions.
66
parameters:
77
-
88
name: formset|in

content/collections/tags/form-errors.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ id: eff214d5-cd61-4318-b351-14f765bbe4fc
44
overview: >
55
When a form submission encounters a validation error, this Tag allows
66
you to show your user where everything went south.
7+
description: Display form errors.
78
parameters:
89
-
910
name: formset|in

content/collections/tags/form-set.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,7 @@
11
---
22
title: Formset
33
id: 0b9590a7-f8b3-4a11-92b5-60d6d43cf869
4-
overview: >
5-
A shortcut tag to allow all child Form tags to inherit the formset.
4+
overview: Wrap a group of form tags to set them all to the same formset.
65
parameters:
76
-
87
name: in|is|formset

content/collections/tags/form-submission.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,7 @@
11
---
22
title: Submission
33
id: 8720d9ed-3a5f-4c60-af74-7b82933146a2
4-
overview: >
5-
Allows you to output data from the form that was just successfully submitted.
4+
overview: Display data immediately following a successful submission.
65
parameters:
76
-
87
name: formset|in

content/collections/tags/form-submissions.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,7 @@
11
---
22
title: Submissions
33
id: afa2740e-2cf7-4ada-a92e-4fc92e827351
4-
overview: >
5-
Allows you to iterate over form submissions.
4+
overview: Iterate over and display data from form submissions.
65
parameters:
76
-
87
name: formset|in

content/collections/tags/form-success.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Success
33
id: e7430255-6237-4cc8-96c2-e8338758851f
4-
overview: A boolean tag used to check if a form submission was successful.
4+
overview: Boolean if a form submission was successful.
55
parameters:
66
-
77
name: formset|in

content/collections/tags/form.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Form
33
is_parent_tag: true
4-
overview: The Form Tags allow you to create and display submissions grouped into different sections.
4+
overview: Create and display submissions grouped into different sections.
55
id: e4f4f91e-a442-4e15-9e16-3b9880a25522
66
---
77
For information on how to best use these tags, visit the [Trail Guide](/guides/forms).

content/collections/tags/get_content.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ id: a33dd9d3-f2f0-4114-b19d-1126361c327e
44
parse_content: false
55
overview: |
66
With nothing but a URI, or list of URIs, you can fetch all available data regardless of the content type. It is a friend to pages, entries, and taxonomies alike.
7+
description: Fetch data by one or more URLs regardless of content type.
78
parameters:
89
-
910
name: from

content/collections/tags/get_files.md

Lines changed: 0 additions & 3 deletions
This file was deleted.

content/collections/tags/get_value.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Get Value
3-
overview: Get an associative array value and loop through it, optionally applying filters along the way.
3+
overview: Grab an associative array value so you can filter and loop through it.
44
parameters:
55
-
66
name: field

content/collections/tags/glide.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
11
---
22
title: Glide
3-
overview: >
4-
Create on-the-fly image asset transforms
5-
using the fantastic Glide package.
3+
overview: Manipulate Asset images on the fly.
64
parameters:
75
-
86
name: src

content/collections/tags/nav-breadcrumbs.md

Lines changed: 9 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,47 +1,38 @@
11
overview: >
2-
Breadcrumbs are a common form of site
3-
navigation, usually used in situations
4-
where you have a lot of hierarchal
5-
content the user must navigate and you
6-
want to make sure they know where they
7-
are. They consist of a list of links,
8-
separated by a divider, leading you from
9-
the current page back up to the home
10-
page.
2+
Breadcrumbs are a common form of site navigation, usually used in situations where you have a lot of hierarchal content the user must navigate and you want to make sure they know where they are. They consist of a list of links, separated by a divider, leading you from the current page back up to the home page.
3+
description: Display breadcrumb-style navigation links to your current page.
114
parameters:
12-
-
5+
-
136
name: 'url '
147
type: string
158
description: >
16-
The starting point for your breadcrumbs
17-
is usually the current page, but can be
18-
overriden behavior if necessary.
19-
-
9+
Defaults to your current page, but can be set to anywhere if necessary.
10+
-
2011
name: include_home
2112
type: 'boolean *TRUE*'
2213
description: >
2314
You can choose to turn off the home page
2415
in the breadcrumbs, opting to start the
2516
crumbs from the first level nav item.
26-
-
17+
-
2718
name: reverse
2819
type: 'boolean *TRUE*'
2920
description: Reverse the output of the breadcrumbs.
30-
-
21+
-
3122
name: trim
3223
type: 'boolean *TRUE*'
3324
description: >
3425
Trim the whitespace from each iteration
3526
of the loop.
3627
variables:
37-
-
28+
-
3829
name: is_current
3930
type: boolean
4031
description: >
4132
Whether the current page is the URL
4233
being viewed. Useful for outputting
4334
active states.
44-
-
35+
-
4536
name: page data
4637
type: mixed
4738
description: >

content/collections/tags/nav-count.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
overview: 'Get the number of pages in a tree. '
2+
overview: Return the number of pages in a Nav tree.
33
title: Count
44
id: 684e2406-1d15-4f80-b72a-defc46c8d7c8
55
---
Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,7 @@
11
---
2-
overview: >
3-
Lets you test whether a set of
4-
parameters will result in a page tree.
2+
overview: Test whether a set of parameters will result in a page tree.
53
title: Exists
64
id: b0275e02-2a64-4233-a335-1da161f23216
75
---
86
It's useful for checking whether or not a certain tree should be displayed.
9-
It uses the same parameters to the `nav` tag.
7+
It uses the same parameters to the `nav` tag.

content/collections/tags/nav.md

Lines changed: 3 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,8 @@
11
---
2-
overview: >
3-
The nav tags are designed to help your
4-
users navigate through your hierarchy of
5-
pages. They work together to allow you
6-
to easily traverse your content upways
7-
and downways, sideways, slantways,
8-
longways, backways, squareways,
9-
frontways, and any other ways that you
10-
can think of.
112
title: Nav
3+
overview: >
4+
The nav tags are designed to help your users navigate through your hierarchy of pages. They work together to allow you to easily traverse your content upways and downways, sideways, slantways, longways, backways, squareways, frontways, and any other ways that you can think of.
5+
description: Create site navigation based off your Pages structure.
126
id: ed746608-87f9-448f-bf57-051da132fef7
137
is_parent_tag: true
148
parameters:

content/collections/tags/obfuscate.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ id: 161f6255-465d-41bd-8028-d6aba01cebbf
44
parse_content: false
55
overview: |
66
Obfuscation is a method of encoding content so that the source code is hard or impossible to understand. This is generally used on email addresses to prevent spambots from recognizing it as an email address and keeping you safe from unwanted emails.
7+
description: Obfuscate content (usually email addresses) to prevent screenscraping.
78
---
89
## Usage {#usage}
910

content/collections/tags/old.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
11
---
22
title: Old
3-
overview: >
4-
Display form input values from the
5-
previous request.
3+
overview: Display any form input values from the previous request.
64
id: 90c44fc3-a6e4-434d-ac1f-1185c382cc5c
75
---
86
In Tags with form elements – for example, `{{ user:login_form }}` – you may encounter validation errors that will require you to resubmit your the form.

content/collections/tags/pages-listing.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
11
---
22
title: Listing
3-
overview: >
4-
An alias of the `pages` tag, for
5-
backwards compatibility.
3+
overview: An alias of the `pages` tag, for backwards compatibility.
64
id: 4b87448a-0bbd-46be-87ee-a194ea0ea14d
75
---
86
```

content/collections/tags/pages-next.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
11
---
22
title: Next
3-
overview: >
4-
Iterate over the next entries that would
5-
show up in the listing.
3+
overview: Grab the next Pages relative to your current Page.
64
parameters:
75
-
86
name: from|folder|url

content/collections/tags/pages-previous.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
11
---
22
title: Previous
3-
overview: >
4-
Iterate over the previous pages that
5-
would show up in the list.
3+
overview: Grab the previous Pages relative to your current Page.
64
id: 1172608e-0e75-487a-8cd6-872746542550
75
---
86
This Tag functions the same way as the [`pages:next`](/docs/tags/pages-next) tag, but in the opposite direction.

content/collections/tags/pages.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Pages
33
is_parent_tag: true
4-
overview: Iterate over child pages.
4+
overview: Grab and iterate over child pages.
55
parameters:
66
-
77
name: url

content/collections/tags/parent.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Parent
3-
overview: "Retrieve page variables for the current page's parent page."
3+
overview: Grab the current page's parent's page data. You follow that?
44
parameters:
55
-
66
name: field

content/collections/tags/partial.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Partial
3-
overview: "Display a partial from within the currently-selected theme's partials folder."
3+
overview: Render a partial template.
44
parameters:
55
-
66
name: partial

content/collections/tags/path.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
11
---
22
title: Path
3-
overview: >
4-
Contextualizes a path with the current
5-
site root.
3+
overview: Prepend a URL/string with the current site root.
64
parameters:
75
-
86
name: src

content/collections/tags/redirect.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Redirect
3-
overview: Redirects the page to another page.
3+
overview: Redirect to another page.
44
parameters:
55
-
66
name: url

content/collections/tags/relate.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
title: Relate
3+
description: Grab data through relationships.
34
overview: |
45
Relate allows you to fetch content from a relationship using a very simple tag syntax. Relate tags can even be nested inside each other.
56

content/collections/tags/routes.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Routes
33
is_parent_tag: true
4-
overview: Loop through your Template Routes and access any inline data with this helper tag.
4+
overview: Loop through your Template Routes and access inline data.
55
variables:
66
-
77
name: url

content/collections/tags/search-form.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
title: Form
3+
description: How to create a search form.
34
id: 1ab4aca4-1add-4b41-b40c-4f3e8170fd98
45
---
56
There's no special search form tag that you need to use. Simply create a form that performs a GET request to where your results will be listed.
@@ -11,4 +12,4 @@ There's no special search form tag that you need to use. Simply create a form th
1112
</form>
1213
```
1314

14-
Assuming that the `{{ search:results }}` tag is on `/search-results`, and that you searched for `majestic stags`, submitting this form will take you to `/search-results?q=majestic+stags`.
15+
Assuming that the `{{ search:results }}` tag is on `/search-results`, and that you searched for `majestic stags`, submitting this form will take you to `/search-results?q=majestic+stags`.

0 commit comments

Comments
 (0)