title

The title command sets the title that James stores in the mesh file.

Syntax

title <text>

text is the rest of the line, exactly as written, comment markers included.

What it does

James keeps the text as the title of the whole run. The neutral file writer stores it on the second line of the file, and the Exodus II writer stores it in the title attribute. A script that never gives a title stores none.

When James applies it

When it is read. The title in force when write runs is the one the file carries. It is legal in any phase: Control, Part or Merge.

Rules James adds

  • A second title replaces the first with no diagnostic, as a second para replaces a parameter. The header holds one title, and the last text written is the one the file carries.
  • The text is raw: a $, a # or a c inside it is part of the title, not the start of a comment.

Diagnostics

  • None: James raises no diagnostic for title.

Example

The script tests/corpus/145-title-second-replaces/input.tg, which make test runs:

title first title
title second title
block 1 2;1 2;1 2;0 1;0 1;0 1;
merge
neutral
write

The IR header holds title "second title", and the neutral file written from this script has title second title on its second line. The first title left no trace.

See also

  • caption: the command that looks similar and stores nothing.
  • echo: prints text without storing it.
  • Merge and output: what the writers store.

James 0.3.1.

This site uses Just the Docs, a documentation theme for Jekyll.