Difference between revisions of "Caption"

From SmartWiki
Jump to: navigation, search
 
(14 intermediate revisions by 3 users not shown)
Line 1: Line 1:
A '''Caption''' is the text used to identify a field.  
+
A '''Caption''' is the text used to identify a field.
  
For [[Custom Field|Custom Fields]] the '''Caption''' setting is used if you want to have a label for the field that is different than the field name. If the caption is not set, then the field name will be used as the caption.
+
For [[Custom Field|Custom Fields]] the '''Caption''' setting is used if you want to have a label for the field that is different than the field name. If the caption is not set, then the field name will be used as the caption.
 +
<!--
 +
: [[Image:CaptionSetting.png|link=]]
 +
:: will display as
 +
: [[Image:CaptionDisplay.png|link=]]-->
 +
<!--In the case of most [[Standard Field]]s (other than those within a [[UTA]]) the caption can only be changed on [[External]] Pages. -->
 +
If you want the '''Caption''' to appear above the field instead of to the left of a custom field, select the "Label Above Field" option in the custom field settings.
  
:[[Image:NormSetting.png]]
+
* '''Caption Location:''' Determines the location of the field <strong class="selflink">caption</strong>. Options include: Left of Field, Above Field, No Caption, Hide Caption. '''Note:''' this option was previously called '''Label Display'''. ([[Label Display Options|See examples here.]])
::will display as
 
:[[Image:NormDisplay.png]]
 
  
 +
If you are using a [[Custom Field Type: Layout - Title Bar|Layout - Title Bar]] Custom Field to define the number of columns, but don't want the actual Title Bar to appear, choose "Empty Title Bar" from the Caption Location option.
  
In the case of most [[Standard Field]]s (other than those within a [[UTA]]) the caption can only be changed on [[External]] Pages.  
+
Note that the ''Caption'' setting is resizable, so when entering larger captions for a field, the entire caption can be seen.
  
 +
==Disambiguation - Status and Template Captions==
 +
[[Templates]], [[Types]] and [[Statuses]] can be given captions as well. These captions will be used instead of the Template/Type/Status name when displayed to the end user.
  
If you want the '''Caption''' to appear above the field instead of to the left of the field, select the "Label Above Field" option in the custom field settings.
+
Where the name of the Template/Type or Status is returned by the variable @type@ or @status@, the caption can be returned using the [[Variable List|variable]] @typecaption@ or @statuscaption@.
{{LabelAboveField}}
 
 
 
:[[Image:TopSetting.png]]
 
::will display as
 
:[[Image:TopDisplay.png]]
 
 
 
 
 
If you are using a [[Custom Field Type: Title Bar – Multiple Columns|Title Bar – Multiple Columns]] Custom Field to define the number of columns, but don't want the actual Title Bar to appear, use a '''Hyphen (-)''' in the '''Caption''' field.
 
 
 
  
 +
==See Also==
 +
* [[Label Display Options]]
  
 
[[Category:Glossary]][[Category:Custom Fields]]
 
[[Category:Glossary]][[Category:Custom Fields]]

Latest revision as of 15:29, 19 September 2018

A Caption is the text used to identify a field.

For Custom Fields the Caption setting is used if you want to have a label for the field that is different than the field name. If the caption is not set, then the field name will be used as the caption. If you want the Caption to appear above the field instead of to the left of a custom field, select the "Label Above Field" option in the custom field settings.

  • Caption Location: Determines the location of the field caption. Options include: Left of Field, Above Field, No Caption, Hide Caption. Note: this option was previously called Label Display. (See examples here.)

If you are using a Layout - Title Bar Custom Field to define the number of columns, but don't want the actual Title Bar to appear, choose "Empty Title Bar" from the Caption Location option.

Note that the Caption setting is resizable, so when entering larger captions for a field, the entire caption can be seen.

Disambiguation - Status and Template Captions

Templates, Types and Statuses can be given captions as well. These captions will be used instead of the Template/Type/Status name when displayed to the end user.

Where the name of the Template/Type or Status is returned by the variable @type@ or @status@, the caption can be returned using the variable @typecaption@ or @statuscaption@.

See Also