Home
Reference
Find details on the SPL language, toolkits, APIs, commands, and more.
SPLDOC markup
You can use SPLDOC markup in the descriptions associated with the SPL artifacts in a toolkit. The spl-make-doc command generates HTML documentation from the marked up artifacts.
Text markup
You can use SPLDOC markup to format text into pages, sections, paragraphs, lists, and blocks of code. You can also apply different typefaces, such as italics, bold, and monospace.
Section
You can start a section by starting a line with a # character, followed by the section title.

Welcome
Learn about the core capabilities of Teracloud® Streams, its architecture, and key concepts.
Installing
Use this information to install, upgrade, and uninstall the Teracloud® Streams product.
Configuring
Create a basic or an enterprise domain which is a single point for configuring and managing common resources, security, and instances.
Administering
Administer the product by using the Teracloud® Streams graphical user interface, APIs, or the streamtool command-line interface.
Developing
Develop stream applications with the Streams Processing Language (SPL), Java, and Python.
Troubleshooting
Resolve problems with Teracloud® Streams using the troubleshooting tools provided with the product as well as the resources offered by Teracloud Support.
Reference
Find details on the SPL language, toolkits, APIs, commands, and more.
- APIs
  Application programming interfaces (APIs) provide functions that simplify applications development.
- Job configuration overlays
  You can specify or change configuration parameters when you use the submitjob or updateoperators operations. The settings control submission constraints, host constraints and locations, and operator status. Parameters are captured and updated in the configuration JSON file. When you change the values in the job configuration overlay file, the changes override any previously set values.
- Commands
  Teracloud® Streams provides a number of commands you use to perform tasks.
- Operator model
  An operator model is an XML document that describes the basic properties of a primitive operator.
- Streams Processing Language (SPL)
  Streams Processing Language (SPL) is a distributed data flow composition language that is used in Teracloud® Streams. SPL has primitive types, program structures, and definitions that are tailored for streaming data.
- Toolkits
  A toolkit is a set of SPL artifacts, which are organized into a package. Toolkits make SPL or native functions and primitive or composite operators reusable across different applications.
- SPLDOC markup
  You can use SPLDOC markup in the descriptions associated with the SPL artifacts in a toolkit. The spl-make-doc command generates HTML documentation from the marked up artifacts.
  - Quick reference for SPLDOC markup
    SPLDOC markup tags document SPL artifacts in a toolkit.
  - Comments
    This information describes the comment syntax for the SPL artifacts in SPL files. SPLDOC comments are delimited by the forward slash and asterisk characters.
  - Text markup
    You can use SPLDOC markup to format text into pages, sections, paragraphs, lists, and blocks of code. You can also apply different typefaces, such as italics, bold, and monospace.
    - Page
      You can start a page by starting a line with one or more + characters.
    - Section
      You can start a section by starting a line with a # character, followed by the section title.
    - Paragraphs
      You can separate text into distinct paragraphs by using blank lines.
    - Italics and bold typeface
      You can mark up text to emphasize it with italics and bold typeface. Italics are delimited by one asterisk ( * ). Bold typeface is delimited by two asterisks ( ** ).
    - Monospace typeface
      To display text in monospace typeface, such as the text of inline code, delimit the text with back quotation marks (` `).
    - Code block
      To format a block of code with SPLDOC markup, indent each line of code by four or more spaces or by pressing the Tab key.
    - Lists
      SPLDOC supports markup for ordered and unordered lists. You can use this markup to create lists, nest lists within other lists, and embed paragraphs and code blocks in lists.
    - Tables
      You can create tables by using three or more hyphens.
  - Escape
    To suppress interpretation by the spl-make-doc command, precede the SPLDOC markup character by a backslash ( \ ), which is the escape character.
  - Links
    You can use SPLDOC to mark up different kinds of links.
  - Annotation tags
    You can use the SPLDOC annotation tags to document the interfaces that are exposed by the SPL composite operators and to exclude toolkit artifacts. You can also use SPLDOC annotation tags to document SPL and native functions.
  - Images
    You can embed image files in the generated document by specifying the image file name and a label for the image.
  - Formatting conventions
    By following the formatting conventions when you mark up the toolkit artifacts, you ensure that the spl-make-doc command interprets the markup correctly and generates the expected results.
Glossary
Use this glossary to find terms and definitions for Teracloud® Streams.

Section

You can start a section by starting a line with a # character, followed by the section title.

Only one level of section heading can be specified.

# <section-heading>

Restriction: The section markup is supported only in the SPLDOC descriptions for toolkits, namespaces, primitive operators, and SPL files.

A new section is started by a # character.

The following SPLDOC markup starts a new section.

/**
...
 * 
 * # The title for a new section in the page
 * Text in the section.
 */

The spl-make-doc command renders the markup as a new section with a title.


The title for a new section in the page
Text in the section.