77
Doc-To-Help 2014 User Guide
Using D2HML (Doc-To-Help Markup Language)
313
URL:
Specifies the name of the generated .htm file for this topic. You can edit the name manually, or you can set a rule
for it in the
Project Settings
dialog box,
URL mode
field. You can also limit the character length of this URL using the
Truncate file name length
field in the
Project Settings
.
Context ID:
The unique numeric identifier assigned to the topic during compilation (read-only). This allows the topic to
be used in context-sensitive help. Context ID settings are managed in the
Project Properties
dialog box.
Comments:
An editable textbox for comments by the help author. These comments are not accessible by the end user.
Default topic:
If selected, this will be the topic displayed when a Help file is opened (the “home page”). The default
topic can also be set by selecting a topic in the
Topics
window, and choosing
Default Topic
from the right-click menu.
Appearance
Contents title:
This field allows you to change the topic title in the Table of Contents (
Contents
pane) without changing
the actual topic title in the source document.
Display title:
This field allows for modification of a topic title with respect to help file searches without changing the
actual topic title in the source document. Use this property to add qualifying text to like-named topics. For example, a
search for “intro” may yield several topics named Introduction, but by modifying the DisplayTitle, you can force results
such as Introduction (Help Authoring), Introduction (HTML), Introduction (WinHelp) without adding the text in
parentheses to the source documents. This is the equivalent of adding a $ footnote in WinHelp or a <Title> in HTML.
Related Links Label:
Specifies the text that precedes the subtopic buttons for this topic. If you clear this field, there will
be no text above the buttons. If you would like to change the label text for a specific Help Target, change it in the
Help
Targets
dialog box. The default label is
More:
Include in Search:
If selected, Search is enabled for this topic in NetHelp Targets. If cleared, this topic is excluded from
the search.
Condition
These can also be set and will appear in the Condition ribbon group on page 117.
Platforms:
Sets a platform-based condition for the selected topic. The topic will be included in all the target platform(s)
selected. A platform includes all the targets that produce the output specified; Online Help, HTML Help, NetHelp,
Printed Manual, etc.
Targets:
Sets a target-based condition for the selected topic. The topic will be included in all the target(s) selected.
Attributes:
Set an attribute-based condition for the selected topic. The topic will be included or excluded when creating
conditional builds (for example, internal or external.) Use the
Attributes
dialog box (
Project
tab >
Project
ribbon group
>
Attributes
button) to create custom attributes.
Disable comments
: If checked, DISQUS commenting will be disabled for this topic. See Adding DISQUS Commenting
to NetHelp 2.0 Targets on page 335 for more information.
Marking Text as Conditional
Using conditional text, you can mark specific text or graphics to display only in specific instances; by platform, target,
attribute, or a combination. This makes logical single sourcing on page 3 easy to accomplish.
100
314
Using D2HML (Doc-To-Help Markup Language)
Doc-To-Help 2014 User Guide
You can also mark entire documents and topics as conditional, see Setting Document Properties on page 297 and Setting
Topic Conditions on page 325.
Where to find the Conditional Text button
Doc-To-Help’s Content Editor: the Insert tab on page 115
Microsoft® Word: the Doc-To-Help toolbar or ribbon on page 285
Microsoft® FrontPage®, and Adobe® Dreamweaver®: the Doc-To-Help D2HML Styles toolbar or ribbon on
page 293.
To mark text as conditional
1.
Select text in the
Editor
window.
2.
Click the
Conditional Text
button. The
Conditional Text
dialog box will open. The selected text will be
displayed in the
Text
area.
3.
Choose the appropriate
Conditional Properties
. You may select more than one. Options are:
Platforms
— Set a platform-based condition for the selected text. The text will be included in all of the
target platform(s) selected. A platform includes all the targets that produce the output specified; Online
Help, HTML Help, NetHelp, Printed Manual, etc.
Targets
— Set a target-based condition for the selected text. The text will be included in all the target(s)
selected.
Attributes
— Set an attribute-based condition for the selected text. The text will be included or excluded
when creating conditional builds (for example, internal or external.) Use the Attributes dialog box on page
162 (Project tab > Project ribbon group on page 119 >
Attributes
button) to create custom attributes.
4.
Set your
Options
. Options will vary slightly depending on your choice of editor.
In Doc-To-Help's Content Editor and HTML Editors:
Properties in attribute
puts the conditional text properties inside the html tag in an attribute. The tag
properties may be viewed in the
Code
or
Source
view of the Editor window.
Properties in text
puts the attribute in the text. The tag will display in the
Design
view of the Editor
window, as well as in the
Code
or
Source
view.
Conditional text|tag=platform;
attribute;target
(In Dreamweaver, you may use the
Hidden
check box to hide this tag in
Design
mode.)
In Word:
Hide Properties in Document
puts the conditional text properties in the text.
Text in comment
puts the conditional text properties in a Word comment.
5.
Click
OK
.
Marking text as
HTML passthrough code
is an advanced feature for Word documents only. HTML passthrough allows
you to include HTML code in your document without Word treating that code as text. It is recommended that the
Rich
Text variables
feature be used instead of the HTML passthrough code. With this feature, you can define a variable in an
HTML document and insert it into a Word document. See Variables window on page 129 for more information.
If you insert an HTML Help ActiveX Control into your Word document (also an advanced feature), that HTML code
will be marked with the HTML passthrough condition. See Inserting an HTML Help ActiveX Control on page 290 for
more information.
How to C#: Basic SDK Concept of XDoc.PDF for .NET create, load, combine, and split PDF file(s), and add, create, insert, delete, re-order, copy, paste, cut This class describes bookmarks in a PDF document.
how to create bookmark in pdf automatically; create bookmark in pdf automatically
97
Doc-To-Help 2014 User Guide
Using D2HML (Doc-To-Help Markup Language)
315
To clear conditional text
1.
Select conditionalized text in the
Editor
window.
2.
Click the
Clear
Condition
button (FrontPage and Dreamweaver only)
. The conditional text styles will
be cleared while leaving other formatting intact.
Please note that you can see how your conditional text will display for the currently selected target by clicking the
Preview
button at the bottom of the Content Editor window in Doc-To-Help.
Inserting a Variable
Using variables, you can manage content in one place for reuse across your project because variable hotspots are
replaced with variable text in the final project.
Text Variables
may be used for unformatted text or use
Rich Content
Variables
for blocks of formatted content. You can even assign conditions to variables. Variables make single sourcing
on page 3 easier to accomplish, and also saves time making multiple updates throughout your projects.
Please note that
Text Variables
will use the formatting that is used at their insertion point.
Rich Content Variables
will
use the formatting applied to the variable itself.
See Creating Variables for more information about creating variables.
Where to find the Variable button
Doc-To-Help’s Content Editor: the Insert tab on page 115
Microsoft® Word: the Doc-To-Help toolbar or ribbon on page 285
Microsoft® FrontPage®, and Adobe® Dreamweaver®: the Doc-To-Help D2HML Styles toolbar or ribbon on
page 293.
To insert a variable
1.
Select text in the Editor window. (You may want to use the name of the Variable for the hotspot text. The hotspot
selected will be completely replaced by the variable.)
2.
Click the
Variable
button. The
Variable
dialog box will open. The selected text will be displayed in the
Text
area.
3.
Choose the appropriate
Variable
from the list.
4.
Set your
Options
. Options will vary slightly depending on your choice of editor.
In Doc-To-Help's Content Editor and HTML Editors:
Properties in attribute
puts the variable properties inside the html tag in an attribute. The tag properties
may be viewed in the
Code
or
Source
view of the Editor window.
Properties in text
puts the attribute in the text. The tag will display in the
Design
view of the Editor
window, as well as in the
Code
or
Source
view.
Hotspot|tag=variable
(In Dreamweaver, you may
use the
Hidden
check box to hide this tag in
Design
mode.)
In Word, you may select the
Hide Properties in Document
check box to
hide the tag.
5.
Click
OK
.
VB.NET PDF: Basic SDK Concept of XDoc.PDF create, load, combine, and split PDF file(s), and add, create, insert, delete, re-order, copy, paste, cut This class describes bookmarks in a PDF document.
create pdf with bookmarks from word; how to add bookmark in pdf
71
316
Using D2HML (Doc-To-Help Markup Language)
Doc-To-Help 2014 User Guide
Shortcut:
You can also insert Text Variables using drag-and-drop. See Drag-and-Drop Linking on page 307 for more
information.
Please note that if you are working in the Content Editor, you can see how your variables will display for the currently
selected target by clicking the
Preview
button at the bottom of the editor window in Doc-To-Help.
When your help target is built, the value of the variable(s) used is automatically inserted in the target. For text variables,
the value will have the same formatting (font, etc.) as its insertion point. For rich content variables, the variable will
retain the formatting applied to the variable when it was created.
Creating an Expanding/Collapsing Section
In online Help Targets, you can create sections that are expanded or collapsed by default. This is an ideal way to
subdivide a long topic in online Help. The sections can be displayed as expanded or collapsed by default, and include
“+” and “-” controls for end users next to each section and at the top of the topic.
Where to find the Collapsible Section button
Doc-To-Help’s Content Editor: the Insert tab on page 115
Microsoft® Word: the Doc-To-Help toolbar or ribbon on page 285
Microsoft® FrontPage®, and Adobe® Dreamweaver®: the Doc-To-Help D2HML Styles toolbar or ribbon on
page 293.
To create expanding/collapsing sections
1.
Select the header and the text that you would like to make into a section. (An example header: "Penn State" and
then the text could be a description of the university.)
2.
Click the
Collapsible Section
button. The
Collapsible Section
dialog box will open. The selected text will display
in the
Header
and
Text
areas.
3.
If you would like the section to be collapsed by default, select the
Collapsed
radio button in the
Options
area.
For text expanded by default, select the
Expanded
radio button.
4.
Click
OK
.
5.
Continue creating sections. Note that the Heading for each section now has the
C1H Section Collapsed
or
C1H
Section Expanded
style applied to it.
Note:
The
Generate XHTML
check box in the
Help Targets
dialog box must be selected to enable
expanding/collapsing sections.
The header will be displayed in the Target with a “+” and “-” control next to it. When the user clicks on the control, the
text will be displayed or hidden. The "Expand All" or "Collapse All" control at the top of the topic will allow the user to
expand/collapse all of the text at once.
43
Doc-To-Help 2014 User Guide
Using D2HML (Doc-To-Help Markup Language)
317
This is an example of a topic with sections collapsed by default; Doc-To-Help automatically added the “Expand All”
control at the top of the topic.
Note:
In EPUB Targets, all content in Collapsible Sections will be displayed (just as it would in Manual Targets).
Clearing D2HML Styles
In Doc-To-Help’s Editor, the
Clear D2HML
button will be on the Insert tab on page 115; in Microsoft® FrontPage®,
and Adobe® Dreamweaver®, the button will be on the
Doc-To-Help D2HML Styles
toolbar or ribbon.
In Microsoft® Word, the
Clear Formatting
button will be on the
Doc-To-Help
toolbar or ribbon.
See Using D2HML (Doc-To-Help Markup Language) on page 303 for more information on D2HML styles and how
they work.
To clear a style
1.
Select text in the
Editor
window.
2.
Click the
Clear D2HML
button
. The style will be removed from the text. (In Word, the button is named
Clear Formatting
.)
Showing Hidden Hotspots
Invisible hot spot types, such as Invisible Keyword and Topic Properties, are not visible in help targets and certain
source documents. The
Show Hidden Hot Spots
button available on the
D2HML Styles
toolbar in Microsoft® Word
and Adobe® Dreamweaver® allows you to show any invisible hot spots in your source document, making it possible to
see all formatted text.
56
318
Using D2HML (Doc-To-Help Markup Language)
Doc-To-Help 2014 User Guide
Note:
The
Show Hidden Hot Spots
button is not available in the FrontPage
D2HML Styles
toolbar, because all styles
are visible in HTML source documents in Design view. Click the
Preview
tab to see how the styles will look in the help
target.
The following hot spot types are invisible by default:
Invisible Keyword
Invisible Group
Invisible Link Tag
Topic Properties
Inline Text (The inline text is invisible by default; the hot spot is displayed.)
Dropdown Text (The dropdown text is invisible by default; the hot spot is displayed.)
Popup Text (The popup text is invisible by default; the hot spot is displayed.)
To make hidden hot spots visible
1.
Click the
Show Hidden Hotspots
button
. The
Show Hidden Hotspots
dialog box will appear.
2.
Select the
Show All
button, or individually choose the hotspot types you’d like to view.
3.
Select
Apply to all documents with this template
if you would like your selections in this dialog box to apply to
any other documents that have the same template attached.
4.
You have the option of being prompted to show all hidden hot spots when you format text as one of the invisible
hot spot types. The
Prompt to show all hot spots on adding invisible hot spot
is checked by default. Clear it if
you do not want a dialog to display each time you format text with an invisible hotspot style.
5.
Click
OK
.
4
Doc-To-Help 2014 User Guide
Using D2HML (Doc-To-Help Markup Language)
319
Documents you may be interested
Documents you may be interested
