Template:ROOT/Template Documentation/RootInputLine

From Wikibooks, open books for an open world
Jump to navigation Jump to search
This is the documentation for the template RootInputLine designed for the book ROOT. Please embed this documentation on the template's page (or elsewhere) with {{ROOT/Template Documentation/RootInputLine}}. To edit the template documentation, please edit this page.

This is a template designed for the book ROOT. It should be used to format input during an interactive ROOT session.

Usage[edit]

Syntax[edit]

{{ROOT/RootInputLine|#1|#2}}
Parameter Default Value Mandatory Description
#1 0 no Line number.
#2   no Input line to be displayed.

Comments[edit]

  • Do not add a blank line before this template or you'll get ugly space.
  • To format multiple lines of code, use a new template for each line.
  • Well, this is annoying: You can't use the = sign, curly braces or a pipe inside the parameter. Encode them as HTML, eg. = for the equality sign. Please see [1] for a list of HTML replacements.

Convention on Line Numbers[edit]

Always start with line number 0. When using this template multiple times on a page, use continuous line numbers except there is a good reason to do different. (E.g. to emphasize a restart of ROOT.)

Examples[edit]

Example 1[edit]

In this example, we display a blank input line that gets the default line number 0.

Code[edit]

{{ROOT/RootInputLine}}

Result[edit]

root [0]

Example 2[edit]

In this example, we display an input line that acts as a "hello world" program.

Code[edit]

{{ROOT/RootInputLine|0|cout << "hello world" << endl;}}

Result[edit]

root [0] cout << "hello world" << endl;

See Also[edit]