Topics are separate pages devoted to explain complex tasks or user interface to the user. Links to these pages are visible in the automatic content created for certain parameters:
As such, topics are normally accessible only when automatic content is allowed to be included in the final output:
A new, custom syntax for links allows you to create links to these topics elsewhere in your Markdown content:
[](topic:)
At the time of this writing, the following topics are available:
[](topic:parameter-image-finalcutpro)
[](topic:parameter-image-motion)
[](topic:parameter-image-premierepro)
[](topic:parameter-image-aftereffects)
[](topic:parameter-point-finalcutpro)
[](topic:parameter-point-motion)
[](topic:parameter-point-premierepro)
[](topic:parameter-point-aftereffects)
[](topic:image-formats)
[](topic:parameter-presets-popup)
[](topic:parameter-presets-browser)
[](topic:parameter-styled-text-editor)
[](topic:parameter-captions)
[](topic:transcode-media-finalcutpro)
[](topic:detector)
[](topic:object-tracker)
[](topic:onscreen-controls)
Leave the content between square brackets empty ([]
) to have the link use the default title of the corresponding topic. Enter your own text to customize the link, just as you would for links to external websites or sections.
Note that some topics will be presented in a more general format. For example, the type of user interface available for an Object Tracker varies according to how the parameter is configured. When the topic is automatically created for any given parameter, FxFactory can customize the contents of the topic page based on the parameter configuration. Because this information is not available in free-standing links to a topic, a generic version of the instructions is provided.
Sometimes it is desirable to turn off automatic content generation for any given parameter. When writing your own Markdown content, add links to a topic if they may be relevant to the user. While product documentation may be better off skipping automatically-generated parameter descriptions, it may be just as beneficial to retain links to in-depth explanations.