Include Text - in Table of Contents

What you need to know first: You do not normally require to use this code on any document element where a Heading style has already been applied.

Code Used: [rpsN] and [rpe]

What does it do?

It marks text to be included in the table of contents. See also Invisible Text.

Where would it be used?

Wherever you wish a text item to be listed in the table of contents.

Usage in DBT:

[rps2]1.Migraine - can cause dizziness[rpe]

Produces in Braille:

#a4 ,migra9e -- c cause dizzi;s

And, when a table of contents is generated, this will contain:

  #a4 ,migra9e -- c cause dizzi;s

Let us Explain!

The [rps2] and [rpe] codes do not affect the braille document at the point where they appear, but when a table of contents is generated, DBT copies the text between these codes into the generated table of contents. In our example, it is copied as a level-2 entry, so it is indented automatically where it appears in the table of contents

For the more technical:

[rpsN] - marks the beginning of text to be included in the table of contents. N is the level of the text within the TOC hierarchy, defaulting to 0 (highest). Use [vss]...[vse] if the text is not also to appear at the current position within the document, i.e. it is to appear ONLY in the TOC, for example: [rps2][vss]This heading appears only in the TOC[vse][rpe].

[rpe] - marks the end of the text to be included in the table of contents. (This is ignored when no [rpsN] comes before it.)