Following is a list of MadCap-specific tag properties.
|
mc-auto-number-class Determines the span class for the generated autonumber. |
|
|
mc-auto-number-format Opens the autonumber format dialog, which lets you enter an autonumber format or select an existing one. |
|
|
|
|
|
mc-auto-number-position Determines where the autonumber will be positioned in relation to the paragraph. |
|
|
mc-breadcrumbs-count Determines the number of breadcrumbs to show (i.e., how many levels of file and folder names you wish to display from the TOC). For example, the default setting is 3, so 3 breadcrumbs would appear in the following manner: You are here: First Topic > Second Topic > Third Topic. |
|
|
mc-breadcrumbs-divider Determines the text or characters that appear between breadcrumbs. |
|
|
mc-breadcrumbs-prefix Determines the text or characters that appear before the breadcrumbs. |
|
|
mc-caption-continuation You can add continuation text to the end of table captions that span multiple pages in printed output (other than the caption appearing on the first page where a table occurs). Typically this text would be something like "(continued)." |
|
|
mc-caption-repeat You can use styles to repeat captions on tables that span multiple pages in print-based output. |
|
|
mc-closed-image Lets you select an image to be shown next to the following types of links when they are in a "closed" state: drop-down text, expanding text, glossary term links, togglers. |
|
|
mc-closed-image-alt-text Lets you set alternate text on the following types of links when they are in a "closed" state: drop-down text, expanding text, glossary term links, togglers. |
|
|
mc-code-border Lets you control the look of the vertical border to the right of the numbers (if they are included) in a code snippet. Typically, this would be associated with the MadCap|codeSnippetBody style, or a class of it. |
|
|
mc-code-lang Lets you select the coding language to be used by default with the associated style. Typically, this would be associated with the MadCap|codeSnippetBody style, or a class of it. |
|
|
mc-column-count Lets you select the number of columns to be used for indexes in Microsoft Word output. This is the default setting for the column count, but it can be overridden on a specific Index proxy. For other print-based outputs, you can set the number of columns for an index in a page layout instead. |
|
|
mc-community-features Specifies whether or not community features are enabled for a topic. This setting is applied to the html style in the stylesheet. |
|
|
mc-concepts-list-headings If a concept proxy has been inserted into the topic, this property lets you choose whether the style to which it is applied will display headings in the list of concepts. |
|
|
mc-conditions Normally you would apply a condition to a piece of content or a file. This property lets you also set conditions on styles, which you can then apply to content. This is simply another alternative and might be more efficient for some authors. You might even find that you use both methods in your projects. |
|
|
mc-disable-glossary-terms Lets you choose whether glossary terms are converted to links automatically when they are found in topics. By default, the setting is turned on for h1 through h6 styles and all hyperlink tags. Setting the property to "True" disables the conversion of glossary terms to links. Setting the property to "False" enables the conversion of glossary terms to links. |
|
|
mc-dita-type Lets you select the tag used for exporting the style in DITA. By default, this property is either not set or set to the style to which this property is applied. However, using this property, you can override the default settings. For example, you can set a p style to a table style for DITA export. |
|
|
mc-exclude-action Displays the kind of "exclude" action tied to the condition tag. In most cases, the exclude action is "remove." However, in some instances, this action might be "unbind." For example, you might have the unbind action for a condition tag if you have applied the tag to a hyperlink and want the link to be removed from the text in some outputs, but you still want the text to be shown in those outputs. When you set a condition tag on a style, you can optionally set an exclude action on the tag, as well. |
|
|
mc-expandable Determines whether the glossary entries to which the designated style is applied are expandable. |
|
|
mc-feader-type This property is used with the MadCap|pageFooter and MadCap|pageHeader styles when building Microsoft Word output. This property specifies which types of pages a page footer or header is displayed on (all, even pages, first page, odd pages). You can always override the page type used at the spot where a particular page footer or header proxy is inserted. This setting simply lets you control the default setting. |
|
|
mc-float Determines where the text to which the style is applied will be displayed in relation to the paragraph. |
|
|
mc-footnote-comment-format Determines the footnote format for the numbers in the comment. The default is the setting used in mc-footnote-format. |
|
|
mc-footnote-comment-style Determines the span class for the footnote numbers inside the footnote comment. The default is the setting used in mc-footnote-style. |
|
|
mc-footnote-format Determines the footnote format for numbers in the text. For example, you can change the format to uppercase alpha (e.g., A, B, C) or lowercase Roman (e.g., i, ii, iii). You can also replace the number with a symbol, such as an asterisk. |
|
|
mc-footnote-number Determines where you can restart the footnote numbering at a certain location in the output (e.g., at the end of the next chapter or section). |
|
|
mc-footnote-position Determines the location where the footnote comments are placed in the output (e.g., end of page, document, chapter, section, book). |
|
|
mc-footnote-style Determines the span class for the footnote number. |
|
|
|
|
|
|
|
|
mc-heading-level Determines which topic headings will be displayed at which level in the generated TOC. The higher the number, the lower in the hierarchy the heading will be displayed in the print TOC. If you select 0, the heading will not be included in the print TOC. |
|
|
mc-help-control-display Lets you specify whether the default setting for Help control links should be "list" or "popup" This can also be specified at the spot where you insert the Help control, but if you want all Help controls to automatically use the same display, you can edit this style property instead. |
|
|
mc-hidden Determines whether a style class is hidden in the interface (such as from the Styles window pane or the ribbon). This does not hide the content itself. You might want to use this if you have created a style but do not want it to be editable, or if you do not want it to be selectable in the interface (e.g., a rarely used company-mandated style that should not be edited). Hiding a style is somewhat different from disabling a style. Although neither hidden nor disabled styles are visible in the interface, disabled styles can only be renabled from the Disable Styles dialog, because they are also removed from the stylesheet. Hidden styles are still visible in the stylesheet, and are not counted among "disabled" styles in the Disable Styles dialog. Disabling a style is preferable to hiding a style if you want to "clean up" your stylesheet and only show the styles you regularly use. |
|
|
mc-hide-bottom-ruling Lets you hide the bottom border on tables when crossing page breaks. By default, if you have a table that crosses multiple pages in print-based output, the bottom border is shown before the table continues on the next page. However, you also have the option to hide the bottom border when the table continues on another page. Hiding the Bottom Border on Tables When Crossing Page Breaks |
|
|
|
|
|
mc-hyphenate-maximum-adjacent-line-count Determines the maximum number of lines next to each other that are allowed to end with a hyphenated word. |
|
|
mc-hyphenate-shortest-prefix Determines the minimum number of characters that must remain on the initial line when a word is hyphenated. |
|
|
mc-hyphenate-shortest-suffix Determines the minimum number of characters that must be carried over to the second line when a word is hyphenated. |
|
|
mc-hyphenate-shortest-word Determines the minimum number of characters that a word must have in order to be hyphenated. |
|
|
mc-image Determines the image used for the selected style. These are used most often with help controls (i.e., concept links or related topic links) and links (i.e., drop-down text, expanding text, or togglers). |
|
|
mc-image-alt-text Lets you set alternate text on images for related topic links. |
|
|
mc-image-position Determines how the image to which the style is applied is positioned, (i.e., right, left, center). |
|
|
mc-image-spacing Determines the spacing around the images used for drop-down text, expanding text, shortcuts, and other dynamic effects. |
|
|
mc-index-headings This property is used with the MadCap|indexProxy style when building print-based output that includes a generated index (i.e., an Index proxy). This property specifies whether the generated index should include headings above the alphabetical groups of entries. The default setting is "True," meaning that index headings will be included. However, you can always override this setting at the spot where a particular Index proxy is inserted. If you want all index proxies to not include headings by default, you can edit this style property, setting it to "False." |
|
|
mc-italic-correction You can correct the spacing in a line when italic formatting is involved. Often, when you italicize a word in the middle of a sentence, the last letter of the italicized word appears to have less space behind it. This is typically due to the fact that the blank space immediately after the word is italicized and the word that comes after is not. Using italic correction, you can increase this space between the italicized word and the non-italicized word. |
|
|
mc-label Determines the text labels for links. For example, the default setting for the MadCap|relationshipsHeading style is "Related Information", which is the text that appears in the output when you insert a concept link. However, you can use this property to change that text. |
|
|
mc-language Determines the language used when spell checking. You can enter inherit, none, or a language code (e.g., en-us). A benefit to assigning a language setting to a certain style is if you want to use this property to prevent Flare Desktop from spell checking a certain style (e.g., styles used for code snippets). |
|
|
mc-leader-align Determines how the page numbers are aligned at the end of the leader. The default setting is right alignment. Editing Relationship Link Styles Editing the Look of a List of Concepts Editing the Look of a List of Elements |
|
|
mc-leader-format Determines the material that is shown between a topic name and the page number where it can be found. The default setting is a series of dots. Editing Relationship Link Styles Editing the Look of a List of Concepts Editing the Look of a List of Elements |
|
|
mc-leader-indent Determines the amount of space from the end of the list entry to the start of the leader. Editing Relationship Link Styles Editing the Look of a List of Concepts Editing the Look of a List of Elements |
|
|
mc-leader-offset Determines the amount of space from the end of the leader to the page number following it. Editing Relationship Link Styles Editing the Look of a List of Concepts Editing the Look of a List of Elements |
|
|
mc-multiline-indent Determines the amount of indentation for all lines of text following the initial indentation. |
|
|
mc-open-image Lets you select an image to be shown next to the following types of links when they are in an "open" state: drop-down text, expanding text, glossary term links, togglers. |
|
|
mc-open-image-alt-text Lets you set alternate text for related topic links. |
|
|
mc-output-support Lets you choose which kinds of outputs (e.g. all, all online, all print, or a specific output type) support a particular style. You typically will not need or want to change the value in this field, but there might be times when you do. For example, instead of using a skin for an index in online output, you could use an index proxy, which is primarily intended for print-based output. Therefore, you could change the mc-output-support property for the MadCap|indexProxy style from all-print to all. |
|
|
mc-page-number-format If you want the page numbers for this template page to take on a particular format (e.g., numbers without dashes, numbers with dashes, uppercase alpha, lowercase alpha, uppercase Roman, lowercase Roman), select it from this field. |
|
|
mc-page-number-start-value If you want the first printed page associated with this template page to start at a particular page number, enter that number in this field. |
|
|
mc-pagenum-display Determines how page numbers are displayed in TOC entries for print output. |
|
|
mc-page-type Select the pages to which these settings will be applied (All Pages, Odd Pages, Even Pages, First Page). The default is to apply the settings to all pages using the template page. If you want all of the pages in your output to share the same settings (page size, margins, etc.), you only need one Body proxy in the template page. However, if you want different pages to have different settings, you can add a Body proxy page for each configuration. Then, edit the settings for a particular Body proxy for specific pages (e.g., odd pages), and use this field to specify which pages the settings pertain to. |
|
|
mc-popup-height Determines the initial height of the popup window. |
|
|
mc-popup-width Determines the initial width of the popup window. |
|
|
mc-printer-page-custom-height If you selected "(custom)" from the mc-page-size field, enter a specific height for the page. Enter a value in the lower-left area and choose from several different units of measurement (points, pixels, centimeters, etc.) in the lower-right area. |
|
|
mc-printer-page-custom-width If you selected "(custom)" from the mc-page-size field, enter a specific width for the page. Enter a value in the lower-left area and choose from several different units of measurement (points, pixels, centimeters, etc.) in the lower-right area. |
|
|
mc-printer-page-footer-margin Specifies the margin between the footer and the page bottom. |
|
|
mc-printer-page-header-margin Specifies the margin between the header and the page top. |
|
|
mc-printer-page-margin-bottom Specifies the bottom margin for the printer page. |
|
|
mc-printer-page-margin-left Specifies the left margin for the printer page. |
|
|
mc-printer-page-margin-right Specifies the right margin for the printer page. |
|
|
mc-printer-page-margin-top Specifies the top margin for the printer page. |
|
|
mc-printer-page-orientation The orientation of the printer page. |
|
|
mc-printer-page-size Select a standard size for the page (e.g., Letter, Legal) or select (custom) to specify a non-standard width and height. |
|
|
mc-redacted This property lets you set redaction on a specific style. Redaction occurs when content is permanently eliminated from a printed or electronic document. In place of that content, end users will see black rectangles that indicate where the original content was found. The property can be set in the following ways.
|
|
|
mc-reference-initial- separator Determines the text or character that immediately precedes page references in the index. The default is blank, but you might change it to say " pages " or "—". |
|
|
mc-reference-separator Determines the text or character between page references in the index. The default is a comma (e.g., 1, 2, 3). If your page references span a range of pages (e.g., 8–10) the dash is not replaced. |
|
|
mc-required-question Specify to restrict navigation for a learner. If set to "true," then a question is required to answer before advancing to the next question in an eLearning course. If set to "false," then the navigation is not restricted (i.e., it is optional). |
|
|
mc-short-line Specify the length at which a line is considered "short," and therefore the short line settings come into play. If you do not select a length, a line is considered short if it has 10 or fewer characters. |
|
|
mc-short-line-loosen-end-length Specify the length at which a line is considered "long enough." For example, let's say you have specified 8 characters as the length of a short line, and you have specified 15 characters as the length of a long line. In that case, Flare Desktop will not allow the final line in a paragraph to have only 8 characters, and when you type content so that the text wraps around to a new line, the paragraph is automatically adjusted so that the new line always starts at a minimum of 15 characters. |
|
|
mc-short-line-loosen-maximum Specify the maximum number of pixels to loosen during short line elimination. |
|
|
mc-short-line-method Determines the method by which short line elimination will function. |
|
|
mc-short-line-step Specify the number of pixels of kerning should be used incrementally on the entire paragraph until the desired effect is achieved. For example, if you enter .5, the kerning will occur in increments of .5 pixels. |
|
|
mc-short-line-tighten-maximum Specify the maximum number of pixels to tighten during short line elimination. |
|
|
mc-template-page Lets you use multiple template pages for different online topics. For example, you might want most topics in your project to use the same template page (to display the same text at the bottom of each topic). However, maybe you want a select few other topics to use a different template page. It is recommended that you use the Topic Properties to select the template page, which automatically adds mc-template-page into the code of the topic. However, you can do this manually with the mc-template-page property if you want. |
|
|
mc-term-display Determines how the style will display glossary term links. You can select from expanding text, a hyperlink, or a popup. When you first create a glossary term and definition |
|
|
mc-thumbnail Determines the manner in which the user can switch from the thumbnail size to the image in its full size. |
|
|
mc-thumbnail-max-height Sets the maximum height for thumbnail images. |
|
|
mc-thumbnail-max-width Sets the maximum width for thumbnail images. |
|
|
mc-toc-depth Changes the number of levels of topic links that are shown in the mini-TOC. The default setting is 3. |
|
|
mc-topic-toolbar-items Determines what combination of Toolbar Item style classes are applied to the given style. You can add all of them, a combination of them, or choose to inherit them. These style classes are defined in the Styles tab of the Skin Editor. These buttons are typically enabled or disabled using settings in the skin. However, you can manually enter them in this field. |
|
|
mc-use-custom-sort-order Determines whether to enable custom sorting of topics (instead of alphabetical sorting) for topics listed in related topics links. This setting is typically enabled or disabled in the Insert Related Topics Control dialog. However, you can manually edit it here if desired. |
