Images

You can embed image files in the generated document by specifying the image file name and a label for the image.

The label is optional, and specifies the text that is displayed if the image cannot be loaded. The path to the image file is relative to the location of the SPL artifact. For example, if the SPL artifact is a primitive operator, the path is relative to the directory that contains the operator model file of the operator. To specify an absolute path, start the image file name with a forward slash ( / ).

The spl-make-doc command with the --copy-image-files parameter can be used to copy the image files into the output directory that contains the generated documentation.

The following example shows how you mark up an artifact to display the image file named figure-2.jpg. The example assumes that the figure-2.jpg file is in the directory that contains the operator model file. This example also shows the generated HTML code.
Markup for an embedded image is {image file name | label}
The `bufferSize` parameter is often used when the `Barrier` operator is 
used to synchronize streams that originate from different sources with 
potentially differing rates, as in:

{figure-2.jpg}
The spl-make-doc command generates HTML similar to this code.
<p>The <tt>bufferSize</tt> parameter is often used when the 
<tt> Barrier</tt> operator is used to synchronize streams that originate 
from different sources with potentially differing rates, as in:
</p>
<p><img src="file:///homes/examples/spl/spl/utility/Barrier/figure-2.jpg">
</p>