Previous: indent, Up: Quotations and Examples


10.14 @cartouche: Rounded Rectangles Around Examples

In a printed manual, the @cartouche command draws a box with rounded corners around its contents. In HTML, a normal rectangle is drawn (that's the best HTML can do). @cartouche has no effect in Info output.

You can use this command to further highlight an example or quotation. For instance, you could write a manual in which one type of example is surrounded by a cartouche for emphasis.

For example,

     @cartouche
     @example
     % pwd
     /usr/local/share/emacs
     @end example
     @end cartouche

surrounds the two-line example with a box with rounded corners, in the printed manual.

The output from the example looks like this (if you're reading this in Info, you'll see the @cartouche had no effect):

     % pwd
     /usr/local/info

For proper output in HTML, it's necessary to put the @cartouche around the @example, and not the other way around. This limitation of makeinfo may be removed one day.

@cartouche also implies @group (see group).