Skip to content

Commit 8e3a8fb

Browse files
committed
Update search_input tag
1 parent 41c2bae commit 8e3a8fb

File tree

1 file changed

+7
-27
lines changed

1 file changed

+7
-27
lines changed

tags/search_input.md

Lines changed: 7 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -36,13 +36,9 @@ Tag will accept the following attributes (**case-sensitive**) as well as the {%
3636
: **Default:** unset (no button is created).
3737

3838
`form="form name"`
39-
: Use specified form template to build a customized HTML form.
39+
: Use the specified form template to build a customized HTML form.
4040
: **Default:** `search_input` (if no form template is specified and no other attributes are used), otherwise unset (uses a built-in HTML `<form>`).
4141

42-
`html_id="id"` <span class="footnote warning">v4.0.7+</span>
43-
: The HTML `id` attribute assigned to the search form.
44-
: **Default:** unset.
45-
4642
`match="match type"` <span class="footnote warning">v4.3.0+</span>
4743
: Set the search mode. Choose from: \\
4844
`exact`: search terms must exactly match the words in the article in the order given. This mode is also automatically selected if the search term is surrounded with double quotes. \\
@@ -51,7 +47,7 @@ Tag will accept the following attributes (**case-sensitive**) as well as the {%
5147
: Default `exact`.
5248

5349
`placeholder="text"` <span class="footnote warning">v4.7.2+</span>
54-
: HTML `placeholder` attribute to be applied to search `input` field.
50+
: HTML `placeholder` attribute to be applied to the search `input` field.
5551
: **Default:** unset.
5652

5753
`section="section name"`
@@ -62,22 +58,6 @@ Tag will accept the following attributes (**case-sensitive**) as well as the {%
6258
: Sets the `size` attribute of the search `input` field.
6359
: **Default:** `15`.
6460

65-
### Common presentational attributes
66-
67-
These attributes, which affect presentation, are shared by many tags. Note that default values can vary among tags.
68-
69-
`class="class name"`
70-
: HTML `class` to apply to the `wraptag` attribute value.
71-
: **Default:** tag name or unset (see [class cross-reference](/tags/tag-attributes-cross-reference#class)).
72-
73-
`label="text"`
74-
: Label prepended to item.
75-
: **Default:** unset (but see [label cross-reference](/tags/tag-attributes-cross-reference#label) for exceptions).
76-
77-
`wraptag="element"`
78-
: HTML element to wrap markup, specified without brackets (e.g. `wraptag="div"`).
79-
: **Default:** unset (but see [wraptag cross-reference](/tags/tag-attributes-cross-reference#wraptag) for exceptions).
80-
8161
## Examples
8262

8363
### Example 1: Display a search input form
@@ -88,13 +68,13 @@ These attributes, which affect presentation, are shared by many tags. Note that
8868

8969
### Example 2: Elements required for building a customized HTML search form
9070

91-
You can build your own custom search form by specifying `form="form-name"` inside the `<txp:search_input />` tag:
71+
Build your own custom search form by specifying `form="your-form-name"` inside the `<txp:search_input />` tag:
9272

9373
~~~ html
94-
<txp:search_input form="form-name" />
74+
<txp:search_input form="search_box" />
9575
~~~
9676

97-
You would then need to build your Form (i.e. `form-name`), and the absolute minimum Textpattern tags and attributes required would be:
77+
You would then need to build your Form called `search_box`. It could contain any fields and markup you wish to suit your site. The absolute minimum Textpattern tags and attributes required would be:
9878

9979
~~~ html
10080
<form action="<txp:site_url />">
@@ -106,10 +86,10 @@ When using a customized form template, Textpattern doesn't automatically wrap th
10686

10787
Other tags used: [site_url](/tags/site_url).
10888

109-
Note: Textpattern will use a user defined form named `search_results`, or an internally defined default form if no search result form is defined by you.
89+
Note: When displaying search results, Textpattern will use a user defined form named `search_results`, or an internally defined default form if no search result form is nominated/defined.
11090
{: .alert-block .information}
11191

112-
### Example 3: Minimal search input form without label or button (but still accessible)
92+
### Example 3: Minimal search input form without label or button (yet still accessible)
11393

11494
~~~ html
11595
<txp:search_input aria_label="Search" placeholder="Search…" />

0 commit comments

Comments
 (0)