Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Info

To work with Captioned Item, you must install Numbered Caption application. For more information, see Installation.

This page provides you with information about the following articles:

...

Parameter Name

Default

Mandatory

Description

Caption name

Figure

Yes

Enter the name of the caption for the content. The Caption name functions as a base and the content is auto-numbered based on the caption name.

For example:

If you are captioning a table, specify the Caption name as the table.

All content withthe Caption name as a table is auto-numbered based on the position of the content.

Anchor name

Randomly generatedNone

No

(With constraints)

The name allows you to link the content to another section or a page. By default the name is automatically generated. To replace the name of your choice overwrite the parameter.

Info
  • You must specify Anchor to use the content as a reference on any other page or on the existing page.

  • This is only a reference name; it will not appear in the UI.

Caption

None

No

Enter the caption for the content. The caption serves as a description to the content and it is displayed alongside the Caption name.

Horizontal Alignment

RightCenter

No

Choose the horizontal alignment for the content from the drop-down menu.

The following are the available alignment options:

  • Left

  • Center

  • Right

Position

Bottom

No

Choose the position of the caption from the drop-down menu.

The following are the available position options:

  • Top

  • Bottom

...

Expand
titleCaption name: figure, Anchor name: default, caption: default, Horizontal alignment: default, Position: default

This will display the reference in the following format:

Caption name (number):

Image RemovedImage Added

Status
colourYellow
titleExample 2

Expand
titleCaption name: figure, Anchor name: default, caption: Reading book in the garden, Horizontal alignment: default, Position: default

This will display the reference in the following format:

Caption name (number): Caption

Image RemovedImage Added

Status
colourYellow
titleexample 3

Expand
titleCaption name: figure, Anchor name: book, caption: Reading book in the garden, Horizontal alignment: default, Position: top

This will display the reference in the following format:

Caption name (number): Caption

Image RemovedImage Added
Info

The anchor value has no effect on the format, but it must be specified if you want to refer to the image in a different section or page. For more information, refer Caption Reference.

...

To create a Captioned Item, Perform perform the following steps: StatuscolourPurpletitle1.

  1. Create a new page or go to Edit the page where you want to create caption

...

  1. .

  2. Click the + icon and search for the Captioned Item macro

...


  1. (or) you can type

...

  1. /caption, the list with caption macro suggestions is displayed, and you can select the Captioned Item macro.

...

...

colourPurple
title3.
  1. Select Captioned Item and click Insert. The Insert 'Captioned Item' Macro window is displayed.

...

  1.  

Status
colourPurple
title4.
  1. Enter the following details and click Insert.

Status
colourPurple
titleA
Caption name

Status
colourPurple
titleB
Info

For more information, refer Parameters.

a. Caption name

b. (Optional) Anchor name

Status
colourPurple
titleC
c. (Optional) Captionstatus
colourPurple
titled

d. (Optional)Horizontal Alignment

Status
colourPurple
titleE
e. (Optional)Position

Info

For more information, refer Parameters.

...

Easily add caption for the existing content, to add perform the following:

...

Select the content you want add a caption.

...

To caption text content, enter the text in the Insert text box.

To caption figures and tables, leave the Insert text box blank.

Panel
bgColor#FFFFFF

Editing ‘Captioned Item’ Macro

...

Info

You must be in the Edit mode to edit a macro block.

...

Tip

When you click the captioned item, you can add or edit the caption text in the displayed text box.

...

Status
colourPurple
title1.

...

  1.  Select the macro block and click

...

  1. the edit button. The Edit 'Captioned Item' Macro window is displayed

...

...

  1. .

  2. You can change any of the parameters that you want to change and then click the Save button.

 

Panel
bgColor#FFFFFF

Deleting ‘Captioned Item’ Macro

To delete a Captioned Item, select the macro block and click Remove remove button. The block is deleted.

...

Info

You must be in the Edit mode to delete a macro block.