Caption

Overview

The "caption" instance initiates a paragraph with Caption style applied in the output document. The "caption" can be used under "figure" or "table" instances.

Required properties

The caption text should be specified either under "body" property:

- caption:
    body:

Or using "source" instance.

- caption:
    source:
      # ...

Full source functionality is available at Components generation.

Optional properties

- caption:
    alignment:
    bold:
    colour:
    first_line_indent:
    font:
    highlight_color:
    italic:
    keep_together:
    keep_with_next:
    left_indent:
    line_spacing:
    line_spacing_rule:
    page_break_before:
    right_indent:
    size:
    space_after:
    space_before:
    underline:

Back to components

Required Properties:

Body

Type: string
Default: N/A
Description: The "body" property specifies the paragraph's text. Separate text parts can be parameterized using \command{text} format, for example \textit{Hello world!}. Parameters can overlap, for example \textbf{\textit{Hello world!}}. For the whole list of available parameterization please check the full documentation.
Example:

 body: Hello caption!

Source

Full source functionality is available at Components generation.

Optional Properties:

Alignment

Type: string
Default: N/A
Description: Specifies the alignment of the text. Can be 'left', 'center', 'right', or 'justify'.
Available options:

 ['left', 'center', 'right', 'justify', 'both', 'distribute', 'mediumKashida', 'highKashida', 'lowKashida', 'thaiDistribute']

Example:

 alignment: center

Bold

Type: boolean
Default: N/A
Description: Specifies whether the text is bold.
Available options:

 [True, False]

Example:

 bold: True

Colour

Type: string
Default: N/A
Description: Specifies the text color in RGB, HEX, or standard color names (e.g., 'red', 'green').
Example:

 colour: #FF5733

Font

Type: string
Default: N/A
Description: Specifies the font family to be used.
Available options:

 ['Abadi MT', 'Agency FB', 'Aharoni Bold', 'Aldhabi', 'Algerian', 'Almanac MT', 'American Uncial', 'Andale Mono', 'Andalus', 'Andy', 'AngsanaUPC', 'Angsana New', 'Aparajita', 'Aptos', 'Arabic Transparent', 'Arabic Typesetting', 'Arial', 'Arial Black', 'Arial Narrow', 'Arial Narrow Special', 'Arial Nova', 'Arial Rounded MT', 'Arial Special', 'Arial Unicode MS', 'Augsburger Initials', 'Avenir Next LT Pro', 'Bahnschrift', 'Baskerville Old Face', 'Batang & BatangChe', 'Bauhaus 93', 'Beesknees ITC', 'Bell MT', 'Bembo', 'Berlin Sans FB', 'Bernard MT Condensed', 'Bickley Script', 'Biome', 'BIZ UDGothic', 'BIZ UDMincho Medium', 'Blackadder ITC', 'Bodoni MT', 'Bodoni MT Condensed', 'Bon Apetit MT', 'Bookman Old Style', 'Bookshelf Symbol', 'Book Antiqua', 'Bradley Hand ITC', 'Braggadocio', 'BriemScript', 'Britannic Bold', 'Broadway', 'BrowalliaUPC', 'Browallia New', 'Brush Script MT', 'Calibri', 'Californian FB', 'Calisto MT', 'Cambria', 'Cambria Math', 'Candara', 'Cariadings', 'Castellar', 'Cavolini', 'Centaur', 'Century', 'Century Gothic', 'Century Schoolbook', 'Chiller', 'Colonna MT', 'Comic Sans MS', 'Consolas', 'Constantia', 'Contemporary Brush', 'Cooper Black', 'Copperplate Gothic', 'Corbel', 'CordiaUPC', 'Cordia New', 'Courier New', 'Curlz MT', 'Dante', 'DaunPenh', 'David', 'Daytona', 'Desdemona', 'DFKai-SB', 'DilleniaUPC', 'Directions MT', 'DokChampa', 'Dotum & DotumChe', 'Ebrima', 'Eckmann', 'Edda', 'Edwardian Script ITC', 'Elephant', 'Engravers MT', 'Enviro', 'Eras ITC', 'Estrangelo Edessa', 'EucrosiaUPC', 'Euphemia', 'Eurostile', 'FangSong', 'Felix Titling', 'Fine Hand', 'Fixed Miriam Transparent', 'Flexure', 'Footlight MT', 'Forte', 'Franklin Gothic', 'Franklin Gothic Medium', 'FrankRuehl', 'FreesiaUPC', 'Freestyle Script', 'French Script MT', 'Futura', 'Gabriola', 'Gadugi', 'Garamond', 'Garamond MT', 'Gautami', 'Georgia', 'Georgia Ref', 'Gigi', 'Gill Sans MT', 'Gill Sans MT Condensed', 'Gisha', 'Gloucester', 'Goudy Old Style', 'Goudy Stout', 'Gradl', 'Grotesque', 'Gulim & GulimChe', 'Gungsuh & GungsuhChe', 'Hadassah Friedlaender', 'Haettenschweiler', 'Harlow Solid Italic', 'Harrington', 'HGGothicE', 'HGMinchoE', 'HGSoeiKakugothicUB', 'High Tower Text', 'Holidays MT', 'HoloLens MDL2 Assets', 'Impact', 'Imprint MT Shadow', 'Informal Roman', 'IrisUPC', 'Iskoola Pota', 'JasmineUPC', 'Javanese Text', 'Jokerman', 'Juice ITC', 'KaiTi', 'Kalinga', 'Kartika', 'Keystrokes MT', 'Khmer UI', 'Kigelia', 'Kino MT', 'KodchiangUPC', 'Kokila', 'Kristen ITC', 'Kunstler Script', 'Lao UI', 'Latha', 'LCD', 'Leelawadee', 'Levenim MT', 'LilyUPC', 'Lucida Blackletter', 'Lucida Bright', 'Lucida Bright Math', 'Lucida Calligraphy', 'Lucida Console', 'Lucida Fax', 'Lucida Handwriting', 'Lucida Sans', 'Lucida Sans Typewriter', 'Lucida Sans Unicode', 'Magneto', 'Maiandra GD', 'Malgun Gothic', 'Mangal', 'Map Symbols', 'Marlett', 'Matisse ITC', 'Matura MT Script Capitals', 'McZee', 'Mead Bold', 'Meiryo', 'Mercurius Script MT Bold', 'Microsoft GothicNeo', 'Microsoft Himalaya', 'Microsoft JhengHei', 'Microsoft JhengHei UI', 'Microsoft New Tai Lue', 'Microsoft PhagsPa', 'Microsoft Sans Serif', 'Microsoft Tai Le', 'Microsoft Uighur', 'Microsoft YaHei', 'Microsoft YaHei UI', 'Microsoft Yi Baiti', 'MingLiU', 'MingLiU-ExtB', 'MingLiU_HKSCS', 'MingLiU_HKSCS-ExtB', 'Minion Web', 'Miriam', 'Miriam Fixed', 'Mistral', 'Modern Love', 'Modern No. 20', 'Mongolian Baiti', 'Monotype.com', 'Monotype Corsiva', 'Monotype Sorts', 'MoolBoran', 'MS Gothic', 'MS LineDraw', 'MS Mincho', 'MS Outlook', 'MS PGothic', 'MS PMincho', 'MS Reference', 'MS UI Gothic', 'MT Extra', 'MV Boli', 'Myanmar Text', 'Narkisim', 'News Gothic MT', 'New Caledonia', 'Niagara', 'Nirmala UI', 'Nyala', 'OCR-B-Digits', 'OCRB', 'OCR A Extended', 'Old English Text MT', 'Onyx', 'Palace Script MT', 'Palatino Linotype', 'Papyrus', 'Parade', 'Parchment', 'Parties MT', 'Peignot Medium', 'Pepita MT', 'Perpetua', 'Perpetua Titling MT', 'Placard Condensed', 'Plantagenet Cherokee', 'Playbill', 'PMingLiU', 'PMingLiU-ExtB', 'Poor Richard', 'Posterama', 'Pristina', 'Quire Sans', 'Raavi', 'Rage Italic', 'Ransom', 'Ravie', 'RefSpecialty', 'Rockwell', 'Rockwell Nova', 'Rod', 'Runic MT Condensed', 'Sabon Next LT', 'Sagona', 'Sakkal Majalla', 'Script MT Bold', 'Segoe Chess', 'Segoe Print', 'Segoe Script', 'Segoe UI', 'Segoe UI Symbol', 'Selawik', 'Shonar Bangla', 'Showcard Gothic', 'Shruti', 'Signs MT', 'SimHei', 'Simplified Arabic Fixed', 'SimSun', 'SimSun-ExtB', 'Sitka', 'NSimSun', 'Snap ITC', 'Sports MT', 'STCaiyun', 'Stencil', 'STFangsong', 'STHupo', 'STKaiti', 'Stop', 'STXihei', 'STXingkai', 'STXinwei', 'STZhongsong', 'Sylfaen', 'Symbol', 'Tahoma', 'Tempo Grunge', 'Tempus Sans ITC', 'Temp Installer Font', 'The Hand', 'The Serif Hand', 'Times New Roman', 'Times New Roman Special', 'Tisa Offc Serif Pro', 'Traditional Arabic', 'Transport MT', 'Trebuchet MS', 'Tunga', 'Tw Cen MT', 'Univers', 'Urdu Typesetting', 'Utsaah', 'Vacation MT', 'Vani', 'Verdana', 'Verdana Ref', 'Vijaya', 'Viner Hand ITC', 'Vivaldi', 'Vixar ASCI', 'Vladimir Script', 'Vrinda', 'Walbaum', 'Webdings', 'Westminster', 'Wide Latin', 'Wingding']

Example:

 font: Arial

Highlight Color

Type: string
Default: N/A
Description: Specifies the color used for text highlighting.
Available options:

 ['black', 'blue', 'green', 'darkBlue', 'darkRed', 'darkYellow', 'lightGray', 'darkGray', 'darkGreen', 'magenta', 'red', 'darkCyan', 'cyan', 'darkMagenta', 'white', 'yellow']

Example:

 highlight_color: yellow

Italic

Type: boolean
Default: N/A
Description: Specifies whether the text is italicized.
Available options:

 [True, False]

Example:

 italic: False

Keep Together

Type: boolean
Default: N/A
Description: Specifies whether the paragraph should remain in one piece and not break across pages.
Available options:

 [True, False]

Example:

 keep_together: True

Keep With Next

Type: boolean
Default: N/A
Description: Specifies whether the paragraph should remain together with the next paragraph on the same page.
Available options:

 [True, False]

Example:

 keep_with_next: True

Left Indent

Type: number
Default: N/A
Description: Specifies the space between the left margin and the left side of the paragraph (in centimeters).
Example:

 left_indent: 1.5

Line Spacing

Type: number
Default: N/A
Description: Specifies the spacing between lines in the paragraph (in points).
Example:

 line_spacing: 1.5

Page Break Before

Type: boolean
Default: N/A
Description: Specifies if a page break should occur before the paragraph.
Available options:

 [True, False]

Example:

 page_break_before: False

Right Indent

Type: number
Default: N/A
Description: Specifies the space between the right margin and the right side of the paragraph (in centimeters).
Example:

 right_indent: 1.0

Size

Type: integer
Default: N/A
Description: Specifies the font height in English Metric Units (EMU).
Example:

 size: 240

Underline

Type: string
Default: N/A
Description: Specifies the underline type. Can be 'single', 'double', 'wavy', or 'none'.
Available options:

 [True, False, 'single', 'words', 'double', 'dotted', 'thick', 'dash', 'dot_dash', 'dot_dot_dash', 'wavy', 'dotted_heavy', 'dash_heavy', 'dot_dash_heavy', 'dot_dot_dash_heavy', 'wavy_heavy', 'dash_long', 'wavy_double', 'dash_long_heavy']

Example:

 underline: single

Continue to Bullet List

Back to top

Back to homepage