Command Nspire
sample.png

Command Summary

A short description of what the command does.

Command Syntax

The generic syntax of calling the command, with arguments.

Menu Location

Describe how to get the command from a menu.

(Include this disclaimer if command xxxxx doesn't appear correctly due to markup limitations. See iff for an example)

NOTE: Due to the limitations of the wiki markup language, the xxxxx command on this page does not appear as it would on the calculator. See Wiki Markup Limitations for more information.

A complete description of the basic uses of the command. All commonly used and documented ways of calling the command should be listed here; inputs, outputs, and anything else important should be mentioned.

:At least one piece of example code 
:should be included here.

Advanced Uses

Advanced uses include rarely used or undocumented ways of calling the command in question. If there's an unusual but effective way of using the command, that too should be listed. Another type of advanced use is a programming technique to which the command is critical. Finally, system variables modified by the program should be listed here. With each advanced use, you should have a piece of example code to show how it works, as well as an explanation.

If there is already a page on the advanced use of the command, give a short synopsis, then link to that page - you shouldn't include the entirety of that page here.


Separate unrelated advanced uses with a horizontal bar.

Optimization

This section includes both ways to optimize use of the command, and other common pieces of code that this command can replace in an optimization. Make sure to mention if the optimization improves speed of the program, size, or both. Sample code should be included too, preferably in the following format:

:unoptimized code
can be
:optimized code

Formulas

(this section is usually not present)
This section is unnecessary for most commands. The only ones that would require it are the ones on the high end of mathematical complexity, such as the statistics commands. Use the math template to type in a LaTeX formula that matches the rest of the page in background. For example, type [[include inc:nspire-math eqn = \sum_{i=1}^n\frac{a}{r^i}]] to get:

(1)
\begin{align} \sum_{i=1}^n\frac{a}{r^i} \end{align}

Error Conditions

For the non-generic errors that might occur when using this command (that is, syntax-type errors shouldn't be included). In a format similar to the following:

  • ERR:DIM MISMATCH is thrown if the two list arguments have different dimensions.
  • ERR:RESERVED is thrown if ∟RESID is supplied as an argument.

Related Commands

Several (around 3) commands have a similar function or are used in a similar context to this command. Make a bulleted list of them, with links to the other commands' pages. It will often be the case that several commands all link to each other.

  • Command 1
  • Command 2
  • Command 3

See Also

(this section is usually not present)
If a command can be used in a particular design concept or technique, you should mention it and provide a link to its respective page. This section should come at the end of the page, and be a bulleted list that contains all of the design or technique related links mentioned throughout the page.

  • Design Concept 1
  • Design Concept 2
  • Technique 1
Unless otherwise stated, the content of this page is licensed under Creative Commons Attribution-Noncommercial 2.5 License.