Hyperlink Element

Description

The Hyperlink element represents an Author-it Hyperlink object, and contains all of its properties.

A Hyperlink object represents one or more links between individual characters in a Topic object and other Topic objects and/or Internet URL locations. When published these links become hypertext jumps in Help and HTML, and page number cross references or footnotes in the printed documentation.

Attributes

Attribute Name	Optional	Data Type	Values
wordcount	Yes	Integer	>= 0

Parent Element

Objects

Children

Element	Optional
Object	No
HyperLinksTargets	Yes
PrintCrossRefBrackets	Yes
PrintCrossRefIncludeHeading	Yes
PrintCrossRefIncludePageNum	Yes
PrintCrossRefPageNumText	Yes
PrintCrossRefText	Yes
PrintFootnoteCustomRef	Yes
PrintFootnoteNumberFormat	Yes
PrintFootnoteNumberType	Yes
PrintLinkType	Yes
HelpIncludeButton	Yes
HelpJumpType	Yes
HelpRemoveUnderline	Yes
HelpWindow	Yes
WebHHPopupFontName	Yes
WebHHPopupFontSize	Yes
WebHHPopupMarginsLR	Yes
WebHHPopupMarginsTB	Yes
WebJumpType	Yes
WebOpenWithJavaScript	Yes
WebWindowHeight	Yes
WebWindowLeft	Yes
WebWindowName	Yes
WebWindowResizable	Yes
WebWindowStatusBar	Yes
WebWindowToolbar	Yes
WebWindowTop	Yes
WebWindowWidth	Yes

Sample XML

<Hyperlink>
+ <Object>
  <HyperLinksTargets /> 
  <PrintCrossRefBrackets>true</PrintCrossRefBrackets> 
  <PrintCrossRefIncludeHeading>2</PrintCrossRefIncludeHeading> 
  <PrintCrossRefIncludePageNum>true</PrintCrossRefIncludePageNum> 
  <PrintCrossRefPageNumText>on page</PrintCrossRefPageNumText> 
  <PrintCrossRefText>see</PrintCrossRefText> 
  <PrintFootnoteCustomRef /> 
  <PrintFootnoteNumberFormat>0</PrintFootnoteNumberFormat> 
  <PrintFootnoteNumberType>1</PrintFootnoteNumberType> 
  <PrintLinkType>1</PrintLinkType> 
  <HelpIncludeButton>false</HelpIncludeButton> 
  <HelpJumpType>1</HelpJumpType> 
  <HelpRemoveUnderline>false</HelpRemoveUnderline> 
  <HelpWindow>0</HelpWindow> 
  <WebHHPopupFontName>Arial</WebHHPopupFontName> 
  <WebHHPopupFontSize>9 pt</WebHHPopupFontSize> 
  <WebHHPopupMarginsLR>10 px</WebHHPopupMarginsLR> 
  <WebHHPopupMarginsTB>10 px</WebHHPopupMarginsTB> 
  <WebJumpType>1</WebJumpType> 
- <WebJumpURLs>
  - <WebJumpURL>
      <Target>http://www.author-it.com</Target> 
      AuthorIT Website</Description> 
    </WebJumpURL>
  </WebJumpURLs>
  <WebOpenWithJavaScript>false</WebOpenWithJavaScript> 
  <WebWindowHeight>200 px</WebWindowHeight> 
  <WebWindowLeft>100 px</WebWindowLeft> 
  <WebWindowName /> 
  <WebWindowResizable>false</WebWindowResizable> 
  <WebWindowStatusBar>false</WebWindowStatusBar> 
  <WebWindowToolbar>false</WebWindowToolbar> 
  <WebWindowTop>100 px</WebWindowTop> 
  <WebWindowWidth>200 px</WebWindowWidth> 
</Hyperlink>