Name Tutor/Markup/StructureMarkup/TableOfContents

Synopsis Generate a table of contents.

Syntax <toc Concept OptDepth>

Description Generate a table of contents for all subconcepts of Concept to a depth of OptLevel. When OptDepth is missing, 1000 will be used as default depth.

A table of contents can be generated for any concept at any level. This useful for summary pages.

Examples A table of contents of 1 level deep: <toc Tutor 1> will generate:

• Contents: Table of Contents.
• Authoring: Creating and writing a course using the RascalTutor.
• Concept: A concept is the basic building block of a course.
• Maintenance: How to maintain a course.
• Markup: Markup directives for creating concept pages.

The full table of contents is generated by <toc Tutor>

• Contents: Table of Contents.
• Authoring: Creating and writing a course using the RascalTutor.
• Concept: A concept is the basic building block of a course.
• Name: The name of a concept.
• Synopsis: One-line summary of the concept that is usable as a tool tip.
• Syntax: Part of the synopsis that summarizes syntax introduced by this concept.
• Types: Part of the synopsis that describes any types or typing rules introduced by this concept.
• Function: Part of the synopsis that describes function signatures introduced by this concept.
• Details: Links to more detailed concepts that complement the description of the current concept.
• Description: Gives a concise explanation of the concept.
• Examples: Examples to illustrate the concept.
• Benefits: Briefly lists known advantages of the concept.
• Pitfalls: Comprehensive list of known shortcomings or usage problems of the concept.
• Questions: Questions about the concept.
• Maintenance: How to maintain a course.
• Adding: Add a concept to a course
• Removing: Remove a concept from a course.
• Renaming: How to rename a concept.
• Markup: Markup directives for creating concept pages.
• InlineMarkup: Markup directives used in input lines.
• Bold: Create bold text.
• Callout: Create a numeric callout for the digits 1--9.
• Code: Create inline code fragments.
• ExternalURL: Refer to an external URL.
• Image: Include an image.
• Italic: Create italic text.
• ReferenceToConcept: Refer to a concept in this course or another course.
• Variable: Markup for a variable.
• StructureMarkup: Markup for structured text entities.
• BulletLists: A (possible nested) list of bullet points.
• figure: Markup of code that generates a figure.
• listing: Markup for a code listing.
• NamedParagraph: Mark up for a named paragraph.
• NewParagraph: Introduce a new paragraph.
• NumberedLists: A (possibly nested) list of numbered points.
• screen: Include the results of an interactive session of the Rascal interpreter.
• Table: Mark up for a table.
• TableOfContents: Generate a table of contents.
• warning: Mark up for a warning.
• QuestionMarkup: Mark up for interactive questions.
• TypeDescriptor: Description of a Rascal types used in type and value questions.
• Text: A text question with a free-format answer.
• Choice: Multiple-choice question.
• Type: A question about a Rascal type.
• Value: Question about the value of a Rascal expression or program.
• SourceCodeMarkup: Mark up in Rascal source code.
• DocAnnotations: A doc annotation attaches an inline concept description to a Rascal declaration.
• ConceptMapping: Map the concepts in Rascal source code to a subtree of a course.

A table of contents for StructureMarkup is generated by <toc Tutor/Markup/StructureMarkup 1>:

• BulletLists: A (possible nested) list of bullet points.
• figure: Markup of code that generates a figure.
• listing: Markup for a code listing.
• NamedParagraph: Mark up for a named paragraph.
• NewParagraph: Introduce a new paragraph.
• NumberedLists: A (possibly nested) list of numbered points.
• screen: Include the results of an interactive session of the Rascal interpreter.
• Table: Mark up for a table.
• TableOfContents: Generate a table of contents.
• warning: Mark up for a warning.

[Edit] | [New Subconcept] | [Recompile Course] | [Warnings]