Skip to content

Commit 04a0bed

Browse files
committed
search module docs
1 parent 9b9fa04 commit 04a0bed

File tree

2 files changed

+74
-1
lines changed

2 files changed

+74
-1
lines changed

docs/add-ons/search/advanced.md

Lines changed: 58 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -267,6 +267,63 @@ With this parameter, you can specify the css class you want the form to have, en
267267

268268
With this parameter, you can specify the css id you want the form to have.
269269

270+
### `orderby=`
271+
272+
orderby="entry_date"
273+
274+
The "orderby" parameter sets the display order of the entries. The available values for this property are `entry_date`, `most_comments`, `recent_comment`, `title`, `status`, `entry_id`, `url_title`, `edit_date`, `comment_total`, `expiration_date`, `view_count_one`, `view_count_two`, `view_count_three`, `view_count_four`.`
275+
276+
If this parameter is not set, it will default to ordering by entry date.
277+
278+
### `sort=`
279+
280+
sort="asc"
281+
282+
sort="desc"
283+
284+
The sort order can be "asc" (ascending order or "oldest item first") or "desc" (descending order or "newest item first"). If you do not use a sort order the default is desc.
285+
270286
## Variables
271287

272-
A full discussion of the available variables is not feasible there is a great deal of interdependence between the various form fields, variables, and javascript functions. The Parameters can be used to modify how the search behaves. If you wish to modify the search form itself, simply use the default form as a base and customize it from there.
288+
### `channel_names`
289+
290+
Pre-populated string containing list of `<option>` tags containing channels that can be used to select channel to search in.
291+
292+
### `lang:...`
293+
294+
Should you be willing to use the language string from ExpressionEngine language files to build the search, the following are available:
295+
296+
#### `lang:search_engine`
297+
#### `lang:search`
298+
#### `lang:search_by_keyword`
299+
#### `lang:search_in_titles`
300+
#### `lang:search_in_entries`
301+
#### `lang:search_everywhere`
302+
#### `lang:search_by_member_name`
303+
#### `lang:exact_name_match`
304+
#### `lang:exact_phrase_match`
305+
#### `lang:also_search_comments`
306+
#### `lang:any_date`
307+
#### `lang:today_and`
308+
#### `lang:this_week_and`
309+
#### `lang:one_month_ago_and`
310+
#### `lang:three_months_ago_and`
311+
#### `lang:six_months_ago_and`
312+
#### `lang:one_year_ago_and`
313+
#### `lang:channels`
314+
#### `lang:weblogs`
315+
#### `lang:categories`
316+
#### `lang:newer`
317+
#### `lang:older`
318+
#### `lang:sort_results_by`
319+
#### `lang:date`
320+
#### `lang:title`
321+
#### `lang:most_comments`
322+
#### `lang:recent_comment`
323+
#### `lang:descending`
324+
#### `lang:ascending`
325+
#### `lang:search_entries_from`
326+
#### `lang:any_category`
327+
#### `lang:search_any_words`
328+
#### `lang:search_all_words`
329+
#### `lang:search_exact_word`

docs/add-ons/search/simple.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -182,6 +182,22 @@ With this parameter, you can specify the css class you want the form to have, en
182182

183183
With this parameter, you can specify the css id you want the form to have.
184184

185+
### `orderby=`
186+
187+
orderby="entry_date"
188+
189+
The "orderby" parameter sets the display order of the entries. The available values for this property are `entry_date`, `most_comments`, `recent_comment`, `title`, `status`, `entry_id`, `url_title`, `edit_date`, `comment_total`, `expiration_date`, `view_count_one`, `view_count_two`, `view_count_three`, `view_count_four`.`
190+
191+
If this parameter is not set, it will default to ordering by entry date.
192+
193+
### `sort=`
194+
195+
sort="asc"
196+
197+
sort="desc"
198+
199+
The sort order can be "asc" (ascending order or "oldest item first") or "desc" (descending order or "newest item first"). If you do not use a sort order the default is desc.
200+
185201
## Variables
186202

187203
There are no specific variables associated with the Simple Search Form. You may use the [{path=''}](templates/globals/path.md) Global Variable to create a link to an Advanced Search Form if you wish.

0 commit comments

Comments
 (0)