Description
The Media object defines the media on which the printed or online documentation is rendered. It defines the page layout in the printed documentation, the help windows in the Help, and the page in HTML. Objects, such as topics, glossaries, or indexes reference media objects to define the layout (or media) they will use when published.
The Media element represents an Author-it Media object, and contains all of its properties.
Attributes
Attribute Name | Optional | Data Type | Values |
wordcount | Yes | Integer | >= 0 |
Parent Element
Objects
Children
Element | Optional |
Object | No |
PrintDifferentFirst | Yes |
PrintDifferentOddEven | Yes |
PrintEvenFooter | Yes |
PrintEvenHeader | Yes |
PrintFirstFooter | Yes |
PrintFirstHeader | Yes |
PrintMarginBottom | Yes |
PrintMarginFooter | Yes |
PrintMarginGutter | Yes |
PrintMarginHeader | Yes |
PrintMarginLeft | Yes |
PrintMarginRight | Yes |
PrintMarginTop | Yes |
PrintMirrorMargins | Yes |
PrintNumColumns | Yes |
PrintOddFooter | Yes |
PrintOddHeader | Yes |
PrintOrientation | Yes |
PrintPageNumberFormat | Yes |
PrintPageNumberStartFrom | Yes |
PrintPageNumberStartType | Yes |
PrintPaperSize | Yes |
PrintSectionStart | Yes |
PrintSizeHeight | Yes |
PrintSizeWidth | Yes |
HelpAutoSize | Yes |
HelpBack | Yes |
HelpBrowse | Yes |
HelpColourHeading | Yes |
HelpColourTopic | Yes |
HelpContents | Yes |
HelpFind | Yes |
HelpHeight | Yes |
HelpIndex | Yes |
HelpKeepOnTop | Yes |
HelpLeft | Yes |
HelpMacro | Yes |
HelpMaximise | Yes |
HelpOptions | Yes |
HelpPrintTopic | Yes |
HelpTitle | Yes |
HelpTop | Yes |
HelpTopics | Yes |
HelpWidth | Yes |
HelpWindowName | Yes |
WebALinkColour | Yes |
WebAdditionalFiles | Yes |
WebBackColour | Yes |
WebBackImage | Yes |
WebBackImageNonScrolling | Yes |
WebBackSound | Yes |
WebBackSoundRepeat | Yes |
WebMetaData | Yes |
WebLinkColour | Yes |
WebTemplate | Yes |
WebTextColour | Yes |
WebTitle | Yes |
WebVLinkColour | Yes |
Sample XML
<Media>
+ <Object>
<PrintDifferentFirst>true</PrintDifferentFirst>
<PrintDifferentOddEven>true</PrintDifferentOddEven>
<PrintEvenFooter>(none)</PrintEvenFooter>
<PrintEvenHeader>HeaderEven</PrintEvenHeader>
<PrintFirstFooter>(none)</PrintFirstFooter>
<PrintFirstHeader>HeaderFirst</PrintFirstHeader>
<PrintMarginBottom inherited="true">2.5</PrintMarginBottom>
<PrintMarginFooter inherited="true">1.75</PrintMarginFooter>
<PrintMarginGutter>0</PrintMarginGutter>
<PrintMarginHeader inherited="true">1.75</PrintMarginHeader>
<PrintMarginLeft>7</PrintMarginLeft>
<PrintMarginRight inherited="true">2.5</PrintMarginRight>
<PrintMarginTop inherited="true">2.5</PrintMarginTop>
<PrintMirrorMargins inherited="true">false</PrintMirrorMargins>
<PrintNumColumns>1</PrintNumColumns>
<PrintOddFooter>(none)</PrintOddFooter>
<PrintOddHeader>HeaderOdd</PrintOddHeader>
<PrintOrientation inherited="true">1</PrintOrientation>
<PrintPageNumberFormat>0</PrintPageNumberFormat>
<PrintPageNumberStartFrom inherited="true">1</PrintPageNumberStartFrom>
<PrintPageNumberStartType>1</PrintPageNumberStartType>
<PrintPaperSize inherited="true">5</PrintPaperSize>
<PrintSectionStart>4</PrintSectionStart>
<PrintSizeHeight inherited="true">29.7</PrintSizeHeight>
<PrintSizeWidth inherited="true">21</PrintSizeWidth>
<HelpAutoSize>false</HelpAutoSize>
<HelpBack>true</HelpBack>
<HelpBrowse>true</HelpBrowse>
<HelpColourHeading>16777215</HelpColourHeading>
<HelpColourTopic>16777215</HelpColourTopic>
<HelpContents>true</HelpContents>
<HelpFind>true</HelpFind>
<HelpHeight>-1</HelpHeight>
<HelpIndex>true</HelpIndex>
<HelpKeepOnTop>true</HelpKeepOnTop>
<HelpLeft>-1</HelpLeft>
<HelpMacro>0</HelpMacro>
<HelpMaximise>true</HelpMaximise>
<HelpOptions>true</HelpOptions>
<HelpPrintTopic>true</HelpPrintTopic>
<HelpTitle />
<HelpTop>-1</HelpTop>
<HelpTopics>true</HelpTopics>
<HelpWidth>-1</HelpWidth>
<HelpWindowName>Normal</HelpWindowName>
<WebALinkColour inherited="true">255</WebALinkColour>
<WebAdditionalFiles />
<WebBackColour>16777215</WebBackColour>
<WebBackImage />
<WebBackImageNonScrolling>false</WebBackImageNonScrolling>
<WebBackSound />
<WebBackSoundRepeat>false</WebBackSoundRepeat>
<WebMetaData />
<WebLinkColour inherited="true">8404992</WebLinkColour>
<WebTemplate>..\Templates\CGI FTS\main_template.htm</WebTemplate>
<WebTextColour inherited="true">0</WebTextColour>
<WebTitle />
<WebVLinkColour inherited="true">255</WebVLinkColour>
</Media>