MadCap Software
What's New Guide
Doc-To-Help 4
Copyright 2016 MadCap Software. All rights reserved.
Information in this document is subject to change without notice. The software described in this document
is furnished under a license agreement or nondisclosure agreement. The software may be used or copied
only in accordance with the terms of those agreements. No part of this publication may be reproduced,
stored in a retrieval system, or transmitted in any form or any means electronic or mechanical, including
photocopying and recording for any purpose other than the purchaser's personal use without the written permission of MadCap Software.
MadCap Software
7777 Fay Avenue
La Jolla, California 92037
858-320-0387
www.madcapsoftware.com
THIS PDF WAS CREATED USING MADCAP FLARE.
CONTENTS
CHAPTER 1 Introduction
5
Summary of New Features
6
CHAPTER 2 Dynamic Add-In Modes
Supported Commands
CHAPTER 3 New Word Panels
Doc-To-Help Build Panel
Doc-To-Help Progress Panel
Doc-To-Help Project Panel
CHAPTER 4 Template Enhancements
Macro-Free Templates
Policies and Procedures Templates
Source Template Updates
9
10
21
22
24
25
37
38
42
44
CHAPTER 5 New Doc-To-Help Options Dialog Settings
57
CHAPTER 6 New Themes and Stylesheets
61
APPENDIX PDFs
65
iv
CHAPTER 1
Introduction
This version of Doc-To-Help contains several new features and enhancements.
For more information about each feature discussed in this manual, open the online Help and
refer to the "What's New in this Version" topic. Links are provided in each new feature
description, taking you to topics that contain additional information and steps.
This chapter discusses the following:
Summary of New Features
6
Summary of New Features
Following are the new features introduced in this version of Doc-To-Help.
Feature
What's New?
For More…
Dynamic Add-
The Doc-To-Help Word add-in dynamically adjusts the
See "Dynamic
In Modes
Doc-To-Help ribbon depending on the type of document
Add-In Modes" on
you opened
page 9.
No Features mode is used for templates
Basic mode is used for documents not in a D2H project
or final output
Full mode is used for documents in a D2H project
New Word
Three new panels in the Word interface give you access
See "New Word
Panels
to Doc-To-Help's most frequently used features
Panels" on page
Doc-To-Help Build panel allows you to build, rebuild,
21.
view, and cancel builds
Doc-To-Help Progress panel allows you to see current
build status
Doc-To-Help Project panel features four window panes
(Documents, Contents, Index and Groups, Variables)
from which you can perform common Doc-To-Help tasks
Template
Macro-enabled DOTM templates have been replaced
See "Template
Enhancements
with macro-free DOTX templates
Enhancements" on
Policies & Procedures templates now available in 8.5" x
page 37.
11" and A4 formats, based on both the Fancy and No Margin templates
Source templates can now be customized so that any
text in the source template is used when creating a new
document
6
Feature
What's New?
For More…
New Doc-To-
Two new settings in the Doc-To-Help Options dialog
See "New Doc-To-
Help Options
Option to control whether or not you will see the Doc-To-
Help Options Dia-
Dialog Set-
Help Progress Panel in Word
log Settings" on
tings
Option to prompt you if the Word add-in is disabled
page 57.
New Themes
The new Accordion Logo, Tabs Logo, and Responsive
See "New Themes
and
Logo themes offer a built-in default logo
and Stylesheets"
Stylesheets
Two new stylesheets are available: jquerymobile\green
on page 61.
for the Responsive and Responsive Logo themes;
jquery-ui\green-sheen for the Accordion, Accordion Logo,
Tabs, and Tabs Logo themes
All new projects now use the Responsive theme
CHAPTER 1│What's New Guide
7
8
CHAPTER 2
Dynamic Add-In Modes
When you open a document in Word, Doc-To-Help uses an add-in to determine what commands are necessary for the type of document you opened. Depending on what kind of document you opened, Doc-To-Help's Word add-in will open in one of three different modes.
The Doc-To-Help ribbon adjusts dynamically based on your document type and you will only
see the functionality applicable to the document you are working on.
The add-in will search for the document in Doc-To-Help projects and then open in one of the
following modes:
No Features This mode is used for templates; new, unsaved documents; and documents with an unsupported format.
Basic This mode is used when the document is not included in any Doc-To-Help project, the add-in is disabled, or the add-in cannot find the Doc-To-Help project associated with the document. This mode is also used for final output.
Full This mode is used for all documents included in a Doc-To-Help project.
This chapter discusses the following:
Supported Commands
10
Supported Commands
The following Doc-To- Help ribbon commands are supported in Basic and Full mode. For more information,
see the online Help.
Basic
Open Doc-ToHelp
Project Panel
Build Panel
Find Project
Add Topic
Rename Topic
Delete Topic
Heading 1 Style
Heading 2 Style
Heading 3 Style
Heading 4 Style
Body Text Style
Link
10
Full
Basic
Full
Inline Text
Keyword
Group
Link Tag
Topic Properties
Conditional
Text
Variable
Collapsible Section
Clear Formatting
Apply Style
Margin Note
Create Margin
Note
Remove Margin
Note
CHAPTER 2│What's New Guide
11
Basic
Set Margin Note
Link
Delete Margin
Note Link
Add Margin
Note Definition
Delete Margin
Note Definition
Clear Margin
Note Definition
Links
Highlight Margin Note Definition Links
Image Map
Editor
Multimedia
HTML Help ActiveX Control
Insert Cross
Reference
Add Glossary
Terms
Sort Glossary
12
Full
Basic
Full
Generate PDF
Print Master
Document
About Doc-ToHelp
1
If a project associated with the source document is opened, the add-in will switch to Full mode.
2
Allows you to change the project association to another project containing the open document.
EXA MPLE—N O
FEA TU R ES
MOD E
This document is a template. You do not need Doc-To-Help functionality for this document, so the
Doc-To-Help Word add-in opens in No Features mode. It is the same as if you opened Word without
using the Doc-To-Help add-in.
CHAPTER 2│What's New Guide
13
EXA MPLE—B A SIC
MOD E
This document was opened in Word but is not included in a Doc-To-Help project. The Doc-To-Help
Word add-in opens in Basic mode, so you can make simple changes to the document using the
Doc-To-Help ribbon.
14
EXA MPLE—B A SIC
MOD E,
PR OJEC T
OU TPU T
This document is a finished Manual output built from Doc-To-Help. The Doc-To-Help Word add-in
opens in Basic mode. This is because you do not want to do heavy editing in the finished output, but
you might want to make some minor changes or notes using the features in the Doc-To-Help ribbon.
You can also create PDF output from the Word document using the Doc-To-Help ribbon.
CHAPTER 2│What's New Guide
15
EXA MPLE—FU LL
MOD E
This document is included in a Doc-To-Help project. The Doc-To-Help Word add-in opens in Full
mode, and you can use all of the functionality in the Doc-To-Help ribbon.
16
Important: Doc-To-Help uses the DocToHelp WCF Service to communicate with the Word addin. This service runs at startup and is required for the Word add-in to run. If the service is stopped
or not installed, the add-in will not switch to Full mode.
Important: If the Doc-To-Help add-in is removed, do one of the following:
1. Reinstall or repair Doc-To-Help using the setup file.
2. Double-click the Word add-in, which is located at c:\Program Files (x86)\MadCap Software\DocToHelp\D2H.WordAddIn.vsto. This will reinstall the add-in.
CHAPTER 2│What's New Guide
17
Note: The Word add-in will search for projects in the following locations, in this order:
1. Open Doc-To-Help projects
2. Existing Doc-To-Help projects in the same folder as the opened document
3. Existing Doc-To-Help projects in the parent folder as the opened document
If more than one project is found, a dialog will open and you can select the appropriate project. The
project you select will be remembered as the default for the document.
If you open a document from the Sharepoint server (not the local copy), the Doc-To-Help project
won't be found automatically. You must open the document separately for Doc-To-Help to find the
project.
Note: When an existing document is added to a project, the Word add-in will run in Basic mode or
Full mode, depending on the settings you choose. By default, the document is copied into the project folder; if you leave this recommended default setting, the Word add-in in the original document
will still run in Basic mode, and the copied document now in your project will run in Full mode​. If
you do not select to copy the document to the project folder (i.e., you leave the document in its original location), the add-in in the original document will switch to Full mode.
If an existing document is removed from a project, the Word add-in automatically switches to
Basic mode.
Note: If you rename (Save As) a document in Word, the add-in will try to find a Doc-To-Help project that contains a file with that name. If it cannot find a project, the add-in will switch to Basic
mode.
18
Note: You do not need to open Doc-To-Help to open a source document. If the document you
open in Word is associated with a Doc-To-Help project, and that project is not already open in
Doc-To-Help, Doc-To-Help opens in hidden mode. When you close all of the source documents
associated with a hidden project, the hidden project is also closed.
When Doc-To-Help opens in hidden mode, it is like it is running in the background. You will have
access to any Doc-To-Help functionality available in the Doc-To-Help Word add-in. You can open
the Doc-To-Help application by selecting the Open Doc-To-Help option on the Doc-To-Help ribbon.
Note: The Special Formatting and Sandcastle ribbons are only available in Full mode.
Note: The Word add-in is supported by Word 2010 and higher. It supports *.doc, *.docx, *.docm,
and *.rtf files.
Note: If the add-in is disabled, you will not be able to use the Doc-To-Help ribbon. A prompt will
alert you if the add-in becomes disabled. You can turn this prompt on or off from the Options dialog.
CHAPTER 2│What's New Guide
19
20
CHAPTER 3
New Word Panels
If you open a source document in Word using Full mode (see "New Word Panels" above),
you can use three new panels to access build, progress, and project functionality found in
the Doc-To-Help application. By using these panels, you can spend more time working
without having to switch back and forth between Word and Doc-To-Help.
This chapter discusses the following:
Doc-To-Help Build Panel
Doc-To-Help Progress Panel
Doc-To-Help Project Panel
22
24
25
Doc-To-Help Build Panel
The Doc-To-Help Build panel allows you to build, rebuild, view, and cancel builds directly from Word. You
can also perform builds for specific targets by selecting the target from a drop-down. A progress bar and percentage indicator in the bottom right corner of the panel will also display build progress. Additionally, if there
is a build error or unresolved link, you can view the errors from this panel.
The panel will split into tabs (at the bottom of the panel) as the specified target builds. One tab is the Build
Log; the other displays the Error(s) and Unresolved Link(s) (if any). On the Build Log tab, click the Open
build log link to open a text version of the build log.
The Errors and Unresolved Links tab displays detailed information so that you can troubleshoot the issues
found during the build. Right-click in the panel for options to change the column display or sort. Click the
Errors, Warnings, or Unresolved Links buttons to sort by each of these error types.
22
HOW TO OPEN THE DOC-TO-HELP BUILD PANEL
1. In Word, select the Doc-To-Help ribbon.
2. In the Project section, select Build Panel.
BUILD PANEL VERSUS DOC-TO-HELP APPLICATION
This panel is almost identical to the Output window in the Doc-To-Help application. However, the Doc-ToHelp Build panel features an additional local toolbar where you can select the target you want to build, and
start and stop builds directly from the panel. This added functionality lets you spend more time working in
Word and less time switching back and forth between Word and the Doc-To-Help application.
When should you use Word and when should you use Doc-To-Help to build your target? Since the functionality is very similar, it is a matter of preference. However, we recommend that you use the Doc-To-Help
Build panel in Word if you are actively editing your source documents, and you use the Doc-To-Help application if you are not working in Word and need to build a new version of a Help target. This will help you save
time because you will not need to use both applications at once.
Note: When you select a target in the local toolbar, it does not affect the active target in the DocTo-Help application and it does not affect other Word panels and other open Word source documents. However, when you start building a target, if you have other Word source documents
open, the Target drop-down in those documents will synchronize to show the target that is being
built.
Note: If the Doc-To-Help Build panel is closed while a target is building, the Doc-To-Help Progress panel will open. See "Doc-To-Help Progress Panel" on the next page.
CHAPTER 3│What's New Guide
23
Doc-To-Help Progress Panel
The Doc-To-Help Progress panel displays build status messages and build progress percentages. When
you build a target, if the Doc-To-Help Build panel is not open because you built the target from the Doc-ToHelp application (i.e., the panel was never open in Word), or you closed the Doc-To-Help Build panel in
Word before the build completed, the Doc-To-Help Progress panel will display. A new checkbox in the
Options dialog controls when you will see the Doc-To-Help Progress panel (see "New Word Panels" on
page 21).
HOW TO ENABLE THE DOC-TO-HELP PROGRESS PANEL
The Doc-To-Help Progress Panel opens automatically. To enable it, do the following:
1. Select File>Doc-To-Help Options. The Options dialog opens.
2. Select the General tab.
3. In the Prompts section, select Display Progress Panel in all open Word documents during
build.
24
Doc-To-Help Project Panel
The Doc-To-Help Project panel allows you to access some of Doc-To-Help's most frequently used functions without having to leave Word. If you open a Word document that is associated with a Doc-To-Help
project, the panel will open automatically when Word opens.
CHAPTER 3│What's New Guide
25
HOW TO OPEN THE DOC-TO-HELP PROJECT PANEL
1. In Word, select the Doc-To-Help ribbon.
2. In the Project section, select Project Panel.
Note: Alternatively, you can open the Project Panel by opening a source document from Word or
Doc-To-Help.
WINDOW PANES
The Doc-To-Help Project panel includes four window panes: Documents, Contents, Index and Groups, and
Variables.
DOCUMENTS WINDOW PANE
You can use the Documents window pane to view and open all of the source documents that are part of the
current Doc-To-Help project. Double-click a document to open it in a new instance of Word.
You can drag documents from the Documents window pane to the current document to create a
D2HML link to another topic.
26
Note: Unlike the Documents window pane in the Doc-To-Help application, the Documents window pane in Word's Doc-To-Help Project panel does not have a local toolbar. This is because the
toolbar functionality in the Doc-To-Help application is not applicable while in Word. If you need to
perform a task available in the local toolbar (e.g., converting documents to HTML5), you can use
the window pane in Doc-To-Help.
CHAPTER 3│What's New Guide
27
CONTENTS WINDOW PANE
You can use the Contents window pane to view the table of contents (TOC) for the current project. If your
project uses target-specific tables of contents (see the online Help or the Documents, Templates, and Content Guide), you can select the target from the drop-down at the top of the window pane.
The table of contents shows all of the topics in the project (or target). You can expand or collapse the list of
topics using the
and
buttons in the local toolbar. Double-click any entry to quickly jump to that
topic. If the topic is in a source document that is not open, the document will open in a new instance of
Word.
You can also drag entries from the Contents window pane to the current document to create links.
28
CHAPTER 3│What's New Guide
29
INDEX AND GROUPS WINDOW PANE
You can use the Index and Groups window pane to view all of the available index keywords and groups in
the project. Click
(default) in the toolbar to display the project keywords (Index); click
project groups. You can expand or collapse the list of index keywords using the
and
to display the
buttons.
You can drag index keywords or groups from the Index and Groups window pane to the current document to
create links. Select the word you want to use as a keyword, then drag the keyword from the keyword from
the window pane to the document. To apply multiple keywords or groups to a selection, hold down the
SHIFT or CTRL key, then select the items you want to link.
30
CHAPTER 3│What's New Guide
31
Note: Keywords and groups that have a checkbox next to them were created using the Index and
Groups window pane in Doc-To-Help.
32
VARIABLES WINDOW PANE
Variables allow you to manage content in one place for reuse across your project.
You can use the Variables window pane to view the rich content variables and text variables available in
your project. To open the rich-content variable document in a new instance of Word, double-click a variable
or the variables document. Hover over a text variable to view additional information in a tooltip.
You can drag variables from the Variables window pane to the current document to add them to the document.
CHAPTER 3│What's New Guide
33
Note: Unlike the Variables window in the Doc-To-Help application, the Variables window pane in
Word's Doc-To-Help Project panel does not have a local toolbar. This is because the toolbar functionality in the Doc-To-Help application is not applicable while in Word. If you need to perform a
task available in the local toolbar (e.g., converting variables documents to HTML5), you can use
the window in Doc-To-Help.
34
PROJECT PANEL VERSUS DOC-TO-HELP APPLICATION
The Doc-To-Help Project panel is a convenient way to access many of Doc-To-Help's features without having to switch back and forth between Word and the Doc-To-Help application. In fact, you may be able to do
most of your work in Word without needing to use the Doc-To-Help application at all, simply by using the
features available in the Doc-To-Help Project panel.
We recommend that you use the Doc-To-Help Project panel in Word if you are actively editing your source
documents and need to do quick tasks, such as adding links to other project resources (e.g., topics,
keywords, variables), switching between documents, or viewing the table of contents. You should use the
Doc-To-Help application if you are doing project maintenance or setup (e.g., creating variables or keywords
in bulk, creating target-specific tables of contents, associating topics with keywords). This will help you
save time because you will not need to use both applications at once.
Note: If you make changes to your project that affect items in the Doc-To-Help Project panel
(e.g., adding a variable, adding an index keyword), the Doc-To-Help Project panel will update to
reflect these changes.
In general, changes to topics also update as you make them. However, you will have to build your
project to see changes in the Contents window pane if either of the following is true:
Your project has not yet been built (in which case the Contents window pane will be empty
until you build).
Your project uses target-specific tables of contents.
CHAPTER 3│What's New Guide
35
36
CHAPTER 4
Template Enhancements
Several enhancements have been made to Doc-To-Help's templates. Macros have been
removed from all templates, two new policies and procedures templates have been added,
and source template functionality has been changed to give you more flexibility when creating custom templates.
This chapter discusses the following:
Macro-Free Templates
Policies and Procedures Templates
Source Template Updates
38
42
44
Macro-Free Templates
Doc-To-Help's existing macro-enabled DOTM template files have been replaced with macro-free DOTX
templates.
When you open a new DOTX template, you will not see the Doc-To-Help ribbon. This is because the functionality available in the ribbon is not necessary when editing a template. However, you will still have
access to Doc-To-Help styles and variables.
UPGRADING TO NEW TEMPLATES
When you upgrade to Doc-To-Help 4, your current target and default source templates will be upgraded
automatically to the latest version.
Additionally, if any of your project documents reference previous-version templates, you will see a prompt
asking if you want to update all of your preinstalled templates to the new version.
If you choose to update the templates, the project documents will point to the new templates with the
DOTX extension.
Important: If you are using a custom template that uses the old macro-enabled DOTM format (or
if your import a Word document that uses a DOTM template), you may see two Doc-To-Help ribbons while authoring in Word. This occurs when you are working in a Word document based on a
template that contains macros while you are simultaneously using the latest version of Doc-ToHelp (which uses the Doc-To-Help Word add-in to open the Doc-To-Help ribbon).
If your target template uses the DOTM format, you may also see two Doc-To-Help ribbons when
viewing your Manual output in Word.
To resolve this, you should update your document's source template and your project's target template to a DOTX template. You can use the Word Organizer to import your styles from your old
template to your new template. See the online Help or the Making It Look Good Guide.
Note: A backup of your original templates will remain in C:\Users\<user name>\AppData\Roaming\Microsoft\Templates.
38
TABLE OF OLD AND NEW TEMPLATES
This table shows the old C1H and D2H templates and the new version of those templates.
Old Templates
C1H_HTML.dot
New Template
D2H_HTML.dotx
Note: This is the default template for HTML-based targets in new projects.
C1H_NOMARGIN.dot
D2H_NOMARGIN.dotm
C1H_NOMARGIN_
D2H_NOMARGIN.dotx
Note: This is the default source template in new projects.
D2H_NOMARGIN_A4.dotx
A4.dot
D2H_NOMARGIN_
A4.dotm
C1H_NORM.dot
D2H_NORM.dotx
D2H_NORM.dotm
C1H_NORM_A4.dot
D2H_NORM_A4.dotx
D2H_NORM_A4.dotm
C1H_PRNOMARGIN.- D2H_PRNOMARGIN.dotx
dot
D2H_PRNOMARGIN.-
Note: This is the default target template in new projects.
dotm
CHAPTER 4│What's New Guide
39
Old Templates
New Template
C1H_PRNOMARGIN_ D2H_PRNOMARGIN_A4.dotx
A4.dot
D2H_PRNOMARGIN_
A4.dotm
C1H_PRNORM.dot
D2H_PRNORM.dotx
D2H_PRNORM.dotm
C1H_PRNORM_A4.-
D2H_PRNORM_A4.dotx
dot
D2H_PRNORM_A4.dotm
C1H_PRSIDE.dot
D2H_PRSIDE.dotx
D2H_PRSIDE.dotm
C1H_PRSIDE_A4.dot
D2H_PRSIDE_A4.dotx
D2H_PRSIDE_A4.dotm
C1H_PRSMAL.dot
D2H_PRSMAL.dotx
D2H_PRSMAL.dotm
C1H_PRSMAL_A4.dot D2H_PRSMAL_A4.dotx
D2H_PRSMAL_A4.dotm
C1H_sandcastle_src.dot
D2H_sandcastle_src.dotm
40
D2H_sandcastle_src.dotx
Old Templates
C1H_SIDE.dot
New Template
D2H_SIDE.dotx
D2H_SIDE.dotm
C1H_SIDE_A4.dot
D2H_SIDE_A4.dotx
D2H_SIDE_A4.dotm
C1H_SMAL.dot
D2H_SMAL.dotx
D2H_SMAL.dotm
C1H_SMAL_A4.dot
D2H_SMAL_A4.dotx
D2H_SMAL_A4.dotm
D2H_FANCY.dotm
D2H_FANCY.dotx
Note: The Fancy template is now also available in A4 sizing. There is
not an "old" version of this template.
D2H_PRFANCY.dotm
D2H_PRFANCY.dotx
Note: The Fancy template is now also available in A4 sizing. There is
not an "old" version of this template.
Note: All four Policies and Procedures templates (A4 and 8.5" x 11", Fancy and Plain) are new in
Doc-To-Help 4.
CHAPTER 4│What's New Guide
41
Policies and Procedures Templates
Two new policies and procedures templates have been added to the Doc-To-Help template library. These
templates are designed to help you create policies and procedures manuals with ease. One template is
based on the default No Margin template, and the other is based on the Fancy template. These templates
are available in both A4 and 8.5" x 11" versions.
These templates incorporate the following unique features:
Numbered Headings Numbered headings provide structure and make it easier for readers to find
or refer to specific policies.
Policy and Procedure Sample Sections Sample sections have been added to the source template to give you a guideline when creating a new document.
Revision History A revision history table allows you to keep track of the changes you make to your
document.
Tip: You should edit your revision history in the final output of your document. This will prevent it from appearing in all documents that use the Policies & Procedures target template.
If you only use the Policies & Procedures target template in one project, you can edit the
revision history table directly in the target template (this will add your changes to the final
output when you build).
42
CHAPTER 4│What's New Guide
43
Source Template Updates
Doc-To-Help's source templates have been updated so any text that appears in the source template is
used as the default text when you create a new document. This change has two main benefits:
Simpler Source Templates To prevent duplicate text when you build output, all extra information
has been removed from the source templates (e.g., cover images, TOCs, index and glossary placeholders). This information has always been overwritten by the target template during build and is
unnecessary in source templates.
Ability to Create Custom Templates You can now edit Doc-To-Help's preinstalled templates to
create custom templates. Any content in the source template is added to new documents when they
are created. This is very useful if you frequently create documents using the same basic structure
(e.g., knowledge base article, user guide, brochure).
HOW TO CREATE CUSTOM TEMPLATES
1. Open the Microsoft Word Templates folder, located at C:\Users\[username]\AppData\Roaming\Microsoft\Templates. Copy the source and target templates that you
want to use as a basis for your custom template, and paste them in a new location, such as your
desktop or a network drive.
Important: It is recommended that you make copies of an existing Doc-To-Help template
to edit rather than creating a template from scratch. This is because Doc-To-Help templates use several proprietary styles and bookmarks to ensure that your output builds correctly.
2. Open the source template. Make any changes to the default text. You can add sample headings and
default text. Any content that appears in the source template will appear in new documents created
using the template.
Note: If you create styles in your custom templates, remember to define their authoring
behaviors in Doc-To-Help using the Project Styles dialog.
44
Tip: If you are creating custom templates and you edit the first-level heading (labeled
"Chapter 1" in most templates), be sure that the ChapterHeading bookmark does not get
deleted. The ChapterHeading bookmark is necessary for Doc-To-Help to know where to
insert content when building output. If it is deleted, you may end up with duplicate content.
To do this in Word, select the Insert ribbon, then click Bookmark. The Bookmarks dialog
opens. If the ChapterHeading bookmark is not listed in the dialog, you can add it. If it is
already listed, you do not need to do anything. For more information, see the Microsoft
Word online Help.
3. Save the source template. Be sure to save it as a .DOTX file and use a unique name.
Note: It is important that you save your templates to a shared location, such as a network
drive, if you are working with other authors.
If you are working alone, you can save the template to your C:\Users\[username]\AppData\Roaming\Microsoft\Templates folder.
4. (Optional) Open the target template. If you created any styles in the source template to use while creating your document, use the Word Organizer to copy those styles over to the target template.
Note: The placeholder text in the target template dictates where your content will be added
in the output. Do not change the text in the target template.
CHAPTER 4│What's New Guide
45
5. Save the target template. Be sure to save it as a .DOTX file and use a unique name.
Note: Be sure to save the template as a unique file even if you did not make any changes
to it.
Note: It is important that you save your templates to a shared location, such as a network
drive, if you are working with other authors.
If you are working alone, you can save the template to your C:\Users\[username]\AppData\Roaming\Microsoft\Templates folder.
6. Create a new Doc-To-Help project. When given the option to select a template, select Add my own
set of styles from the drop-down, then select your custom template.
7. (Optional) When Doc-To-Help opens, be sure to add your target template to the project to use when
building output. You will not need to do this if you are using NetHelp as your target, because the
HTML template is already selected by default.
EXA MPLE
Let's say your company writes knowledge base articles. Your articles need to include five
headings: a title, a summary, a description, a solution, and an attribution. You decide to create a custom template that includes headings for each of these sections. Because the articles are often written by different authors, you also want to include some sample text to guide the authors when they
create a new article so each article will be written the same way and have a common voice.
To do this, you first create a copy of the source Doc-To-Help template most like the template you
want to create. You decide to use D2H_NOMARGIN.dotx as a base for your new template because
it is basic and you do not need any extra frills for your knowledge base articles.
46
CHAPTER 4│What's New Guide
47
For now, you can save the copy of the D2H_NOMARGIN.dotx template to your desktop, since you
will be making changes to it. It is important to save a separate copy of the template in a new location, such as your desktop, so it does not get mixed up with the original Doc-To-Help template
while you are making changes.
48
Open the document and make your changes. You add a Title placeholder as a Heading 1, and the
rest of your headings as Heading 2s. You also add some sample text in each section. You do not
make any style changes.
When you are done, your sample document looks like this:
CHAPTER 4│What's New Guide
49
Save the new source template as Knowledge_Base.dotx. Since you are working with several other
authors, be sure to save it to a network drive so everyone has access to it.
Then you copy the coordinating Doc-To-Help target template (D2H_PRNOMARGIN.dotx) to your
desktop (again, it is important to keep this copy separate from the original to prevent errors).
Open the copy of the target template. Save it as PR_Knowledge_Base.dotx so you can distinguish
it from your source template. You do not make any other changes. Be sure to save your new template to the network drive so other authors can access it.
50
Once you have saved your copies to the network drive, you can remove the temporary copies from
your desktop.
CHAPTER 4│What's New Guide
51
Later, your authors create a new Doc-To-Help project using the Knowledge Base source template.
52
When they create a new document, they see all of the default text you added to the template. They
are able to use this text as a guideline to create the knowledge base article.
CHAPTER 4│What's New Guide
53
The authors also add the new Knowledge Base target template to the project, and use it when building printed output.
54
CHAPTER 4│What's New Guide
55
Important: If you do not update your preinstalled source templates when you update to the new
version of Doc-To-Help (not recommended), your projects will contain extra placeholder text when
you build output. You can delete this text.
It is recommended that you update your source templates when you update to ensure that your
output is built the way you intended. For more information, see the online Help.
Tip: If you are creating custom templates and you edit the first-level heading (labeled "Chapter 1"
in most templates), be sure that the ChapterHeading bookmark does not get deleted. The ChapterHeading bookmark is necessary for Doc-To-Help to know where to insert content when building
output. If it is deleted, you may end up with duplicate content.
To do this in Word, select the Insert ribbon, then click Bookmark. The Bookmarks dialog opens.
If the ChapterHeading bookmark is not listed in the dialog, you can add it. If it is already listed, you
do not need to do anything. For more information, see the Microsoft Word online Help.
56
CHAPTER 5
New Doc-To-Help Options Dialog Settings
There are two new settings in the Doc-To-Help options dialog. Both are found on the General
tab.
Display Progress Panel in All Open Word Documents During Build This setting is checked
by default. This setting is used to display the Doc-To-Help Progress Panel whenever you start building a target and the Doc-To-Help Build Panel is not open.
If the Doc-To-Help Build panel is already open, this setting doesn't have any effect.
58
Prompt if Word Add-In is Disabled On Startup This setting is checked by default. Doc-To-Help
will alert you if the Word add-in has been disabled when you start Doc-To-Help. If the add-in is disabled, you will not be able to use the Doc-To-Help ribbon. You will be able to re-enable the add-in
from the prompt (you can also re-enable the add-in manually from the Word Options dialog).
CHAPTER 5│What's New Guide
59
60
CHAPTER 6
New Themes and Stylesheets
Three new themes have been added to the Doc-To-Help interface. You can now use the
Accordion Logo, Tabs Logo, or Responsive Logo themes to easily create a project with a
default logo already included in the output.
Additionally, two stylesheets have been added to complement these themes and Doc-ToHelp's existing themes. You can use the jquerymobile\green stylesheet with your Responsive or Responsive Logo themes, and the jquery-ui\green-sheen stylesheet with the Accordion, Accordion Logo, Tabs, and Tabs Logo themes.
Doc-To-Help's default stylesheet and theme settings have been updated to use these new
theme and stylesheet settings.
By default, all new projects now use the Responsive theme.
The default stylesheet for the Responsive and Responsive Logo themes is jquerymobile\green.
The default stylesheet for the Tabs, Tabs Logo, Accordion, and Accordion Logo
themes is jquery-ui\green-sheen.
EXA MPLES
This is an example of the Responsive Logo theme and the jquerymobile\green stylesheet.
62
This is an example of the Accordion Logo theme and the jquery-ui\green-sheen stylesheet.
CHAPTER 6│What's New Guide
63
This is an example of the Tabs Logo theme and the jquery-ui\green-sheen stylesheet.
Note: If your project is using a default setting from a previous version, it will not be affected by
these changes. However, if you prefer to use one of the new themes or stylesheets, you can
manually change it to use a new setting.
64
APPENDIX
PDFs
The following PDFs are available for download from the online Help.
On the Doc-To-Help Start Page, click the PDF Guides icon to access them.
Context-sensitive Help Guide
Sandcastle Guide
Documents, Templates, and Content Guide
Shortcuts Guide
Getting Started Guide
Targets Guide
Making It Look Good Guide
Touring the Workspace Guide
Managing Your Project Guide
Upgrading Old Projects Guide
New User Tutorial Guide
What's New Guide