91
Doc-To-Help 2014 User Guide
Customizing Your Project
153
Live links:
If enabled, hyperlinks are live in the manual Word document. If the document is converted to PDF, the
hyperlinks will also be live in the PDF. The
Create Master Document
check box must be enabled for this setting to take
effect. If this check box is cleared, only cross-references are hyperlinks in the manual Word document.
There is an issue with live links in the Adobe Acrobat PDF converter (including version 7). When the PDF is produced
and the Word hyperlinks are converted to PDF links, the links jump to the top of the page containing the destination
topic instead of jumping to the desired topic location. To fix this problem, clear the
Enable accessibility and reflow
with Tagged PDF
check box in Adobe Acrobat before creating a PDF or use a PDF converter other than Adobe
Acrobat.
Advanced
Fix numbered lists:
Controls how numbered lists are corrected in the printed manual output when the
Create master
document
check box is enabled. The numbering issues this field corrects were for the most part resolved in Word 2002.
Never
— Never corrects the numbered lists.
Always
— Always corrects the numbered lists.
Word 2000 Only
(Default) — Corrects lists with Word 2000, but not with other versions of Word.
Section break:
Doc-To-Help automatically inserts a break between each of your Source documents in a Manual Target.
If you have Word source documents that begin with a secondary heading style (for example, a Heading 2), use this
option to control the type of section break that will be inserted in your Manual Target. The available values are:
Next
page
,
Continuous
,
Even page
,
Odd page
. If you would like no page break, set it to
Continuous
. This option is only
available if the
Create master document
option is selected.
Show expanding text:
If selected, expanding text is shown in the target, otherwise it is removed.
Show dropdown text:
If selected, dropdown text is shown in the target, otherwise it is removed. Dropdown text is a
Dynamic HTML effect that some help targets do not support.
Create master document:
If selected, subdocuments are linked together into a single master document in printed
manual builds. If cleared, the master document will use Word RD fields to reference subdocuments.
Use template text:
If selected, the text of the
Template
associated with the Manual help target is included in the
resulting document. Otherwise, the text is ignored, only template styles are used to format the document. If cleared,
template text — even if present in the template — does not appear in the resulting document. In that case Doc-To-Help
adds default title, TOC and index sections to the target document without using the template text.
Strings
Title:
The text displayed below the
Supertitle
on the cover of the printed manual. This field is editable. This field is
often the book’s name, such as “Administrator Guide” or “User Guide.”
Supertitle:
The text displayed above the
Title
on the cover of the printed manual. This field is editable. This field is
often the product or company name.
“By” line:
The byline displayed on the cover of the printed manual. This field is editable. It is usually the author’s name.
Contents heading:
This field is used only if there is no
Template
selected for the manual, or if the
Use template text
check box is cleared. Otherwise, the template text is used.
Index heading:
This field is used only if there is no
Template
selected for the manual, or if the
Use template text
check
box is cleared. Otherwise, the template text is used.
77
154
Customizing Your Project
Doc-To-Help 2014 User Guide
Microsoft Help Viewer Targets
Use the following options to configure your Microsoft Help Viewer output. Please note that this output is only used for
developing help for Microsoft Visual Studio 2010 and above.
For more information on Targets and how to distribute them, see Doc-To-Help Outputs and Deliverables on page 13.
MHV resources:
MSHelpWiki.com
: http://www.mshelpwiki.com/wiki/tiki-index.php?page=Help3
MSDN Forum
: http://social.msdn.microsoft.com/Forums/en-US/devdocs/threads
Yahoo! Group
: http://tech.groups.yahoo.com/group/MSHelpViewer/
Basic
Name:
The name of the target, which will also appear in the list on the left of the dialog box. This name is also used
when you select a target using the
Select Target
button in the Target ribbon group on page 109.
Base name:
If you would like your Target output to have a different name than the project name, enter it here.
Self-branded:
If selected, allows you to use your own CSS and scripts for the Microsoft Help Viewer 1.x target,
otherwise the target would use the default Microsoft Help Viewer 1.x CSS and scripts. Doc-To-Help supports only self-
branded targets.
Style sheet:
The cascading style sheet used to format the target. This style-sheet controls the formatting of the target for
HTML source documents. Target CSS styles will override any matching styles in the Source CSS. See the Guide to
Templates and Styles on page 7. (The style sheet can also be changed using the
Target CSS
button in the
Target Design
ribbon group.)
Template:
The Word template used to format the target. This template controls the formatting of the Target for Word
source documents. Target template styles will override any matching styles in the Source Template. See the Guide to
Templates and Styles on page 7. (The template can also be changed using the
Target Template
button in the
Target
Design
ribbon group.)
Theme
: The theme or “skin” used for the target. Themes are created/edited in the Theme Designer. (The theme can also
be changed using the
Theme
button in the
Target Design
ribbon group.)
Attributes
: The Attributes or Expression this target includes in the final build. For more information, see Defining
Attributes on page 162.
Folder
: The folder where the target output will be stored in your Doc-To-Help project. If you change the name of the
folder after generating this target, you should delete the original folder to avoid confusion.
Localization
Locale:
Specifies the language in the target files. Each target has its own way of specifying language. For example,
HTML Help has a Language option in the [OPTIONS] section of the project file (.hhp). Some common values for this
property are as follows:
English (U.S.)
— 1033
English (U.K.)
— 2057
French
— 1036
German
— 1031
How to C#: Basic SDK Concept of XDoc.PDF for .NET XDoc.PDF for .NET allows C# developers to edit hyperlink of PDF document, including editing PDF url links and quick navigation link in bookmark/outline.
bookmark page in pdf; how to add bookmarks to a pdf
61
Doc-To-Help 2014 User Guide
Customizing Your Project
155
Italian
— 1040
Spanish
— 1034
Deployment
Product vendor:
The vendor name, used for installing and uninstalling the target in the Microsoft Help Viewer 1.x. The
target's base name will be used if this field is left empty.
Product name:
The target name, used for installing, uninstalling, and identifying the target in the Microsoft Help
Viewer 1.x. The target's base name will be used if this field is left empty.
Product book:
The target book, used for installing, uninstalling, and organizing the target in the Microsoft Help Viewer
1.x. The target's base name will be used if this field is left empty.
Topic version
: The target topic's version. It is used to determine differences between version one and subsequent
versions of the installed topic. It is 100 by default.
Doc-To-Help allows you to install a target and later reinstall newer versions into the local Microsoft Help Viewer 1.x.
However, if the Target properties "Product vendor," "Product name," or "Product book" are changed between builds the
old target version won't be uninstalled from the Microsoft Help Viewer 1.x.
Users will be able to uninstall or install targets manually using the Microsoft Help Library Manager. Doc-To-Help
produces two install files: HelpContentSetup.msha and <target base name>.mshc.
Parent in Contents
Topic ID:
The ID of the parent topic in Microsoft Help Viewer 1.x, which will be the parent for all root entries in the
target table of contents.
Topic version:
Version of the parent topic in Microsoft Help Viewer 1.x, which will be the parent for all root entries in
the target table of contents (100 by default).
Background
Color:
Displays the current color setting for the target help window. To change the color, click the adjacent button to
select or define a color.
Image file:
Displays the image file to be used as a background in the target help window. To insert a background image,
click the adjacent button to open the selection dialog.
Repeat image:
Specifies how the background image is arranged in the target help window. Options are Tiled,
Horizontal, or Vertical.
Advanced
Color Reduction:
Determines the color threshold for images embedded in Word source documents. This setting has no
impact on images used in HTML source documents.
Keep original color format
— Images are not converted.
Reduce to 16 Colors
— Images with more than 16 colors are reduced to 16.
Reduce to 256 Colors
— Images with more than 256 colors are reduced to 256.
Image format:
Determines the storage format in the Help target of the images used in Word source documents. This
setting has no impact on images used in HTML source documents.
VB.NET PDF - WPF PDF Viewer for VB.NET Program C#.NET PDF file & pages edit, C#.NET PDF pages extract, copy, paste, C#.NET rotate PDF pages, C#.NET search text in PDF, C#.NET edit PDF bookmark, C#.NET edit
copy bookmarks from one pdf to another; export pdf bookmarks
91
156
Customizing Your Project
Doc-To-Help 2014 User Guide
Original format
— All graphics are stored in the original format without conversion.
JPG
always
— All graphics are stored in JPG files.
JPG if transformed
—Graphics are converted to JPG if they undergo any transformation when the help target is
built.
PNG
always
— All graphics are stored in PNG files.
PNG if transformed
— Graphics are converted to PNG if they undergo any transformation when the help target
is built.
Graphics scaling:
Determines the scaling applied to the graphics in Word source documents. This setting has no impact
on images used in HTML source documents.
For graphics embedded within Word documents,
Scale in target
and
Scale in build
options are equivalent, the size of
the picture is the same as it is displayed in Word. For linked graphics, options
Scale in target
and
Scale in build
also
produce pictures of the same size, the size it is displayed in Word. The only difference between them is that quality of
scaling (resampling) can differ for some images. With
Scale in build
option, Doc-To-Help is responsible for resampling
the image, and with
Scale in target
option that task is left to the browser that displays the online help target. Choose
whichever produces best results. For WinHelp targets,
Scale in target
and
Scale in build
options are equivalent for all
graphics, the resampling is performed by Doc-To-Help.
Do not scale graphics
— Graphics are displayed at their original size. If graphics are rescaled in the source Word
document, they are reset.
Scale in target
— Graphics stay the same size as they are displayed in Word (where they may be scaled). Linked
graphics are scaled by the viewer (browser) displaying the online help target. Linked image files remain at their
original size; scaling is delegated to the browser by setting the IMG tag dimensions.
Scale in build
— Graphics stay the same size as they are displayed in Word (where they may be scaled). Linked
graphics are scaled by Doc-To-Help when the help target is built; the linked image file is resampled to the required
size.
XML transformation
: This property allows you to insert boilerplate content or code into every Help topic, for example:
headers, footers, or code that automates analytics. Custom HTML5 code can be added inside the <head> element, above
the topic title, or at the end of topic text. Click the
Wizard
button to open the
Transformation Wizard
dialog box and
enter your custom code. Existing configuration files can be selected by clicking the ellipsis button.
Graphics scale with fonts:
When selected, all graphics in Word source documents are resized proportionally when the
system font size is changed (for example, changing the Text Size in your browser). This setting has no impact on images
used in HTML source documents.
Overwrite CSS:
If selected, the existing cascading style sheet will be overwritten when building the Help target. This
check box should be selected by default.
Related Links
Label:
Specifies the text that precedes the subtopic links. If you clear this field, there will be no text above the links. If
you would like to change the label text for a specific topic, change it in the Topic Properties dialog box on page 321.
Label Style:
The name of the style used to format the label that precedes the subtopic links.
Links Style:
The name of the style used to format the automatically generated subtopic links.
Add separator between topic text and subtopic links:
If selected, a dividing line will separate the topic text from the
subtopic links.
Strings
56
Doc-To-Help 2014 User Guide
Customizing Your Project
157
Breadcrumbs label:
For HMTL Help targets, specifies the text that precedes topic breadcrumbs (for example, “You are
here:”). The breadcrumbs label is set with this field; to make additional changes or disable breadcrumbs, see
Customizing with the Theme Designer.
Previous:
The text displayed on the
Previous
button in your Help project. This field is editable.
Next:
The text displayed on the
Next
button in your Help project. This field is editable.
Warnings about Limitations
Warn about Popup link:
If selected, will write a warning to the build log about popup links usage in topics. Only self-
branded targets support popup links, so warnings will be ignored for those.
Warn about Group link:
If selected, will write a warning to the build log about group links usage in topics. Only self-
branded targets support group links, so warnings will be ignored for those.
Warn about Keyword link:
If selected, will write a warning to the build log about keyword links usage in topics. Only
self-branded targets support keyword links, so warnings will be ignored for those.
Warn about Bookmark link:
If selected, will write a warning to the build log about links to bookmarks in topics. This
target type doesn't support links to bookmarks that are located in another topic, so those links will be ignored.
Warn about Mid Topic link:
If selected, will write a warning to the build log about links to mid topics in topics. This
target type doesn't support links to mid topics that are located in another topic, so those links will be ignored.
Warn about Contents title:
If selected, will write a warning to the build log about the use of a custom contents title for
a topic. This target type doesn't support topic contents title customization. Values of this property will be ignored.
Warn about Display title:
If selected, will write a warning to the build log about the use of a custom display title for a
topic. This target type doesn't support topic display title customization. Values of this property will be ignored.
Warn about Keyword level depth:
If selected, will write a warning to the build log about the use of keywords higher
than the second level. This target type supports only first and second level keywords. Keywords higher than the second
level will be ignored.
Warn about 'Contents only' styles:
If selected, will write a warning to the build log about the use of topics whose
styles have been set to the "Contents only" property. This target type doesn't support topics with this style; all table of
contents entries must be a topic, not just an empty book. The style "Contents only" property will be ignored.
Warn about 'Suppress empty topic' property
: If selected, will write a warning to the build log about the use of topics
whose styles have been set to the "Suppress empty topic" property. This target type doesn't support with this style, all
table of contents entries must be topic, not just an empty book. The style "'Suppress empty topic" property will be
ignored.
Microsoft Help 2.0 Targets
Use the following options to configure your Help 2.0 output. Please note that this output is only used for developing help
for Microsoft Visual Studio 2002-2008.
For more information on Targets and how to distribute them, see Doc-To-Help Outputs and Deliverables on page 13.
Basic
87
158
Customizing Your Project
Doc-To-Help 2014 User Guide
Name:
The name of the target, which will also appear in the list on the left of the dialog box. This is the internal name
for the project; the name used as the label on the final output is set in the Advanced section. This name is also used
when you select a target using the
Select Target
button in the
Target
ribbon group.
Base name:
If you would like your Target output to have a different name than the project name, enter it here.
Style sheet:
The cascading style sheet used to format the target. This style-sheet controls the formatting of the Target for
HTML source documents. Target CSS styles will override any matching styles in the Source CSS. (The style sheet can
also be changed using the
Target CSS
button in the
Target Design
ribbon group.)
Template:
The Word template used to format the target. This template controls the formatting of the Target for Word
source documents. Target template styles will override any matching styles in the Source Template. (The template can
also be changed using the
Target Template
button in the
Target Design
ribbon group.)
Theme
: The theme or “skin” used for the target. Themes are created/edited in the
Theme Designer
. (The theme can also
be changed using the
Theme
button in the
Target Design
ribbon group.)
Attributes
: The Attributes or Expression this target includes in the final build.
Folder
: The folder where the target output will be stored in your Doc-To-Help project. If you change the name of the
folder after generating this target, you should delete the original folder to avoid confusion.
Localization
Locale:
Specifies the language in the target files. Each target has its own way of specifying language. For example,
HTML Help has a Language option in the [OPTIONS] section of the project file (.hhp). Some common values for this
property are as follows:
English
(U.S.) — 1033
English
(U.K.) — 2057
French
— 1036
German
— 1031
Italian
— 1040
Spanish
— 1034
CodePage:
Defines the windows codepage number to be used by the help file. This integer is most commonly used
when producing help files in foreign languages, providing special character sets for translation on the screen or in print.
Charset:
Specifies one of the character set aliases listed in HTML Character Sets and Named Entities. Used for
localization.
Background
Color:
Displays the current color setting for the target help window. To change the color, click the adjacent button to
select or define a color. If you change a System color for a NetHelp or JavaHelp Target, Doc-To-Help will display a
message box about System colors and Windows. This message can be turned off using the
Doc-To-Help Options
dialog
box.
Image file:
Displays the image file to be used as a background in the target help window. To insert a background image,
click the adjacent button to open the selection dialog.
Repeat image:
Specifies how the background image is arranged in the target help window. Options are Tiled,
Horizontal, or Vertical.
92
Doc-To-Help 2014 User Guide
Customizing Your Project
159
Advanced
Caption:
The text displayed in the Caption bar of the Help window.
Color Reduction:
Determines the color threshold for images embedded in Word source documents. This setting has no
impact on images used in HTML source documents.
Keep original color format
— Images are not converted.
Reduce to 16 Colors
— Images with more than 16 colors are reduced to 16.
Reduce to 256 Colors
— Images with more than 256 colors are reduced to 256.
Image format:
Determines the storage format in the Help target of the images used in Word source documents. This
setting has no impact on images used in HTML source documents.
Original format
— All graphics are stored in the original format without conversion.
JPG always
— All graphics are stored in JPG files.
JPG if transformed
— Graphics are converted to JPG if they undergo any transformation when the help target
is built.
PNG always
— All graphics are stored in PNG files.
PNG if transformed
— Graphics are converted to PNG if they undergo any transformation when the help
target is built.
Graphics scaling:
Determines the scaling applied to the graphics in Word source documents. This setting has no impact
on images used in HTML source documents.
For graphics embedded within Word documents,
Scale in target
and
Scale in build
options are equivalent, the size of
the picture is the same as it is displayed in Word. For linked graphics, options
Scale in target
and
Scale in build
also
produce pictures of the same size, the size it is displayed in Word. The only difference between them is that quality of
scaling (resampling) can differ for some images. With
Scale in build
option, Doc-To-Help is responsible for resampling
the image, and with
Scale in target
option that task is left to the browser that displays the online help target. Choose
whichever produces best results. For WinHelp targets,
Scale in target
and
Scale in build
options are equivalent for all
graphics, the resampling is performed by Doc-To-Help.
Do not scale graphics
— Graphics are displayed at their original size. If graphics are rescaled in the source
Word document, they are reset.
Scale in target
— Graphics stay the same size as they are displayed in Word (where they may be scaled).
Linked graphics are scaled by the viewer (browser) displaying the online help target. Linked image files remain
at their original size; scaling is delegated to the browser by setting the IMG tag dimensions.
Scale in build
— Graphics stay the same size as they are displayed in Word (where they may be scaled).
Linked graphics are scaled by Doc-To-Help when the help target is built; the linked image file is resampled to
the required size.
XML transformation
: This property allows you to insert boilerplate content or code into every Help topic, for example:
headers, footers, or code that automates analytics. Custom HTML5 code can be added inside the <head> element, above
the topic title, or at the end of topic text. Click the
Wizard
button to open the
Transformation Wizard
dialog box and
enter your custom code. Existing configuration files can be selected by clicking the ellipsis button.
Graphics scale with fonts:
When selected, all graphics in Word source documents are resized proportionally when the
system font size is changed (for example, changing the Text Size in your browser). This setting has no impact on images
used in HTML source documents.
60
160
Customizing Your Project
Doc-To-Help 2014 User Guide
Overwrite CSS:
If selected, the existing cascading style sheet will be overwritten when building the Help target. This
check box should be selected by default.
Generate XHTML:
If selected,
the online help output is generated as XHTML. (For NetHelp 2.0 and Eclipse Help
targets, the output is always HTML5 in XML form.)
Namespace:
Specifies the Help 2.0 namespace that is used to register the Help file after a successful build. If this field is
empty, the Base Name is used. If the Base Name field is empty, the file name of the project itself is used. Please note, the
Namespace and Parent Namespace only affect Help file registration on the author's machine. Registration on the user
machine is handled by standard Help 2.0 means, with Windows Installer.
Parent Namespace:
Specifies the namespace for the built help collection to plug into. Usually, that will be the
namespace of the Visual Studio .NET Combined Collection. Set this property if you want the built Help to be
automatically registered as a plug-in for Visual Studio help. For example, for Visual Studio .NET 2003, set Parent
Namespace to "MS.VSCC.2003". Please note, the Namespace and ParentNamespace fields only affect Help file
registration on the author's machine. Registration on the user machine is handled by standard Help 2.0 means, with
Windows Installer.
Related Links
Label:
Specifies the text that precedes the subtopic links. If you clear this field, there will be no text above the links. If
you would like to change the label text for a specific topic, change it in the
Topic Properties
dialog box.
Label Style:
The name of the style used to format the label that precedes the subtopic links.
Links Style:
The name of the style used to format the automatically generated subtopic links.
Add separator between topic text and subtopic links:
If selected, a dividing line will separate the topic text from the
subtopic links.
Strings
Breadcrumbs label:
For HMTL Help targets, specifies the text that precedes topic breadcrumbs (for example, “You are
here:”).
Utilizing Conditions
Conditions make it possible to efficiently single-source your content.
Using conditions, you can easily include/exclude information from a Help Target. You can quickly mark text, graphics,
topics, or documents so that they are included or excluded from your final output — manuals or any combination of
online Help.
Some examples of using conditions:
If you’d like specific graphics to appear only in your printed output, mark those graphics with the
Platform
condition named “Printed Manual.”
You’d like links to related topics to be included only in your NetHelp output (and excluded from your Manual
Targets). Mark that text with the
Target
condition named “NetHelp.”
Reminder notes to you and your team can be included in your project for reference, but can be marked with the
“Internal”
Attribute
so that they are not included with the Targets delivered to customers.
Documents you may be interested
Documents you may be interested
