Difference between revisions of "Help"

173 bytes removed ,  23:50, 22 February 2023
Changed the syntax and parameter values to use wiki tables.
(I am exploring a new presentation for parameters.)
(Changed the syntax and parameter values to use wiki tables.)
Line 4: Line 4:


==Syntax==
==Syntax==
{| class="wikitable"
|+style="text-align:left"|
<big>
<source>
<source>
Help <matchstring> <filter> <form type>
Help <matchstring> <filter> <form type>
</source>
</source>
 
</big>
{| class="wikitable"
|+style="text-align:left"|<big>Parameters</big>
|-  
|-  
! Type !! Name !! Value !! Description  
! Type !! Name !! Value !! Description  
Line 20: Line 21:
|}
|}


==Parameters==
===Parameters===
* '''matchstring:''' The word to search for may be in the command name or description.
{| class="wikitable"
* '''filter:''' Will filter results to the given category. The default filter is 0 when none is provided.
|+style="text-align:left"|
** '''0) All:''' This will return matches from all categories.
<big><code><filter></code></big>
** '''1) Functions:''' This will return matches from the function category.
|-
** '''2) Settings:''' This will return matches from the settings category.
! Value !! Description
** '''3) Globals:''' This will return matches from the [[Global]] category.
|-
** '''4) Other Forms:''' Specifies a ''form type'' to use as the [[Object]] category filter.
| 0 ''(Default)'' || All: This will return matches from all categories.
* '''form type:''' The form type is 4 characters and is ignored unless the filter is 4.
|-
| 1 || Functions: This will return matches from the function category.
|-
| 2 || Settings: This will return matches from the settings category.
|-
| 3 || Globals: This will return matches from the [[Global]] category.
|-
| 4 || Other Forms: Specifies a ''form type'' to use as the [[Object]] category filter.
|}


==Examples==
==Examples==
147

edits