Flare WebHelp Guide

uglyveinInternet and Web Development

Jun 24, 2012 (5 years and 2 months ago)

1,029 views

MadCap
Flare
WebHelp
Outputs
Guide
Version
8.0
Copyright
2012
MadCap
Software.
All
rights
reserved.
Information
in
this
document
is
subject
to
change
without
notice.
The
software
described
in
this
document
is
fur
-
nished
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
Scan
to
open
online
Help
i
CONTENTS
CHAPTER
1
WebHelp
Outputs
5
About
WebHelp
Output
6
About
HTML5
(WebHelp
2.0)
Output
7
About
WebHelp
Plus
Output
14
About
WebHelp
Mobile
Output
16
About
WebHelp
AIR
Output
20
CHAPTER
2
Skin
Tasks
for
WebHelp
Outputs
23
Excluding
Accordion
Titles
from
WebHelp
Output
24
Changing
Text
Strings
in
HTML5
Skins
26
Selecting
an
Image
for
the
About
Box
27
Showing
Navigation
Links
in
WebHelp
Standalone
Topics
29
Specifying
Browser
Settings
for
WebHelp
Output
30
Specifying
Navigation
Pane
Settings
for
WebHelp
Output
31
Specifying
Skin
Style
Settings
34
Specifying
Web
Toolbar
Settings—
HTML5
Output
35
Specifying
Web
Toolbar
Settings—
WebHelp
Outputs
41
CHAPTER
3
Target
Tasks
for
WebHelp
Outputs
49
Adding
Mark
of
the
Web
50
Selecting
a
Language
for
the
Target
for
the
WebHelp
Interface
51
Compiler
Warnings
for
WebHelp
Outputs
52
Using
Custom
File
Extensions
55
CHAPTER
4
CSH
Calls
for
HTML5
Output
(WebHelp
2.0)
57
What
You
Need
To
Do
57
CSH
Calls
for
HTML5
Output
(WebHelp
2.0)—
Developers
58
CHAPTER
5
CSH
Calls
for
WebHelp
and
WebHelp
Plus
65
What
You
Need
To
Do
65
CSH
Calls
for
WebHelp
and
WebHelp
Plus—
Developers
66
CHAPTER
6
CSH
Calls
for
WebHelp
Mobile
73
What
You
Need
To
Do
73
CSH
Calls
for
WebHelp
Mobile—
Developers
74
CHAPTER
7
Merging
Output
from
Flare
WebHelp
77
CHAPTER
8
More
About
HTML5
Server-
based
Output
85
Enabling
HTML5
Server-
based
Output
87
Installing
IIS
88
Setting
Up
HTML5
Target
91
Configuring
IIS
on
Production
Server
92
Installing
ASP.NET
94
Starting
Microsoft
Indexing
Service
96
Starting
Microsoft
Windows
Search
97
Enabling
HTML5
Server-
based
Search
98
Testing
HTML5
Server-
based
Search
99
Viewing
HTML5
Server-
based
Output
100
Basics
of
Viewing
HTML5
server-
based
Output
100
Testing
Output
Locally—
Windows
Vista
and
Windows
7
101
Procedures
for
Viewing
HTML5
server-
based
Output
103
Merging
Output
at
Runtime
Using
HTML5
105
Including
Non-
XHTML
Files
in
HTML5
Search
113
HTML5
Server-
based
Output
Scenario
117
CHAPTER
9
More
About
WebHelp
Plus
123
Enabling
WebHelp
Plus
Output
125
Installing
IIS
126
Setting
Up
WebHelp
Plus
Target
129
Configuring
IIS
on
Production
Server
131
Installing
ASP.NET
133
Starting
Microsoft
Indexing
Service
135
Starting
Microsoft
Windows
Search
136
Enabling
WebHelp
Plus
Search
137
Testing
WebHelp
Plus
Search
138
MADCAP
FLARE
ii
Viewing
WebHelp
Plus
Output
139
Basics
of
Viewing
WebHelp
Plus
Output
139
Testing
Output
Locally—
Windows
Vista
and
Windows
7
140
Procedures
for
Viewing
WebHelp
Plus
Output
142
Merging
Output
at
Runtime
Using
WebHelp
Plus
144
Including
Non-
XHTML
Files
in
Search
152
WebHelp
Plus
Scenario
156
FAQs—
WebHelp
Plus
161
APPENDIX
A
PDF
Guides
167
APPENDIX
B
Output
Type
Comparison
Table
173
Table
of
Contents
iii
MADCAP
FLARE
iv
5
CHAPTER
1
WebHelp
Outputs
Flare
lets
you
choose
from
any
kinds
of
online
output
formats.
One
of
these
formats
is
called
"Web
-
Help,"
and
there
are
multiple
flavors
of
WebHelp.
These
output
formats
are
similar
in
many
ways,
but
each
has
its
unique
characteristics
and
advantages.
This
chapter
discusses
the
following.
About
WebHelp
Output
6
About
HTML5
(WebHelp
2.0)
Output
7
About
WebHelp
Plus
Output
14
About
WebHelp
Mobile
Output
16
About
WebHelp
AIR
Output
20
About
WebHelp
Output
WebHelp
is
a
Web-
based
Help
format
that
can
run
on
almost
any
browser
or
platform.
You
can
use
WebHelp
to
create
online
documentation
for
the
Internet
or
an
intranet,
as
well
as
for
desktop
applications.
The
WebHelp
output
consists
of
a
collection
of
files
that
you
will
distribute
to
users.
The
output
will
be
displayed
in
the
user's
Internet
browser
window.
The
main
entry
file
has
an
.htm
extension.
Following
are
some
of
the
key
features
of
the
WebHelp
format.
Multiple
browsers
This
format
is
a
good
choice
if
your
users
have
different
Internet
browsers
on
their
systems.
Multiple
languages
You
can
produce
an
output
interface
in
various
languages.
This
is
possible
through
the
use
of
language
skins.
Multiple
platforms
This
format
is
a
good
choice
if
your
users
are
working
on
different
platforms
(operating
systems).
Web-
based
This
format
is
a
good
choice
if
you
are
writing
online
documentation
for
distribution
on
the
Internet
or
an
intranet.
Sitemap/search
engine
optimization
(SEO)
You
can
generate
a
sitemap
during
compilation.
This
helps
with
search
engine
optimization
(SEO),
making
it
easier
for
webcrawlers
(i.e.,
spiders
or
bots)
to
find
your
output.
Therefore,
the
entire
output
is
indexed
and
search
engine
results
are
improved.
MADCAP
FLARE
6
CHAPTER
1
WebHelp
Outputs
About
HTML5
(WebHelp
2.0)
Output
HTML5
output
(also
referred
to
as
"WebHelp
2.0"
in
Flare)
is
an
online
format
that
is
the
next
generation
of
WebHelp.
It
is
similar
to
the
regular
WebHelp
format;
however,
whereas
the
original
WebHelp
format
works
with
HTML4,
WebHelp
2.0
supports
the
HTML5
specification
developed
by
the
Web
Hypertext
Application
Technology
Working
Group
(WHATWG—
http://whatwg.org
)
and
the
World
Wide
Web
Consortium
(W3C—
http://w3.org
).
Therefore,
the
HTML5
format
results
in
better
markup
and
offers
additional
features
not
found
in
the
other
WebHelp
outputs.
The
HTML5
output
consists
of
a
collection
of
files
that
you
will
distribute
to
users.
The
output
will
be
displayed
in
the
user's
Internet
browser
window.
The
main
entry
file
has
an
.htm
extension.
The
online
Help
on
the
madcapsoftware.com
website
was
created
with
HTML5.
Following
are
some
of
the
key
features
of
the
HTML5
format.
WebHelp
features
This
format
lets
you
take
advantage
of
features
and
benefits
available
with
the
regular
WebHelp
output
type.
7
Frameless
output
Pages
in
HTML5
output
do
not
use
<frameset>
or
<frame>
tags,
like
they
do
in
regular
WebHelp
output.
This
means
that,
behind
the
scenes,
HTML5
output
can
be
said
to
be
"frame
-
less,"
even
though
the
user
still
sees
distinct
areas
that
display
content,
navigation,
and
toolbars.
By
being
frameless,
HTML5
output
is
much
easier
for
web
crawlers
to
find,
thus
improving
search
engine
results.
Specific
page
addresses
With
the
regular
WebHelp
output,
you
can
only
give
readers
a
single
URL
path,
which
opens
the
starting
page
for
the
output.
With
HTML5
output,
you
can
point
end
users
to
a
specific
page
in
the
output
by
giving
them
the
exact
URL
path.
E X A M P L E
Let's
say
you
generate
regular
WebHelp
output,
with
the
primary
output
file
called
"MyOut
-
put.htm."
When
you
view
the
output
with
the
initial
topic
shown
(say
it's
called
"Wel
-
come.htm"),
the
URL
path
in
the
browser
might
look
something
like
this.
http://www.mycompany.com/documentation/
MyOutput.htm
And
if
you
then
click
on
another
topic
(say,
"WhatsNew.htm"),
the
same
URL path
will
be
shown.
It
does
not
change,
even
though
you
opened
a
different
page.
On
the
other
hand,
suppose
you
generate
HTML5
output.
The
URL
in
the
browser
may
look
the
same
as
the
path
for
regular
WebHelp
when
the
output
is
first
displayed.
http://www.mycompany.com/documentation/
MyOutput.htm
But
if
you
click
on
the
"WhatsNew.htm"
page,
the
URL
will
change
to
this.
http://www.mycompany.com/documentation/
MyOutput.htm#WhatsNew.htm
And
if
you
click
on
the
"Welcome.htm"
page
to
return
to
it,
the
URL
will
change
to
this.
http://www.mycompany.com/documentation/
MyOutput.htm#Welcome.htm
Sitemap/search
engine
optimization
(SEO)
You
can
generate
a
sitemap
during
compilation.
This
helps
with
search
engine
optimization
(SEO),
making
it
easier
for
webcrawlers
(i.e.,
spiders
or
bots)
to
find
your
output.
Therefore,
the
entire
output
is
indexed
and
search
engine
results
are
improved.
Modern
looking
When
you
build
HTML5
output,
you
will
notice
that
it
has
a
more
modern
look,
com
-
pared
with
the
older
WebHelp
formats.
.
MADCAP
FLARE
8
CHAPTER
1
WebHelp
Outputs
Search
bar
In
the
other
online
outputs,
the
search
feature
is
displayed
in
an
accordion
or
tab.
In
HTML5
output,
the
search
feature
is
included
in
a
search
bar
above
the
topics.
In
addition,
rather
than
enabling
or
disabling
the
search
feature
on
the
General
tab
of
the
Skin
Editor,
you
do
so
on
the
Styles
tab
by
editing
the
Search
Bar
property.
.
9
Search
with
context
If
end
users
perform
a
search
in
your
output,
they
will
see
context
next
to
each
result,
rather
than
terms
only.
MADCAP
FLARE
10
CHAPTER
1
WebHelp
Outputs
In
addition,
you
can
create
topic
meta
descriptions,
which
will
be
used
in
the
search
results
abstract.
Also,
the
meta
description
itself
is
searchable.
Smoother
dynamic
effects
Features
such
as
drop-
down
text,
expanding
text,
and
popups
have
a
smoother
appearance
when
they
are
activated.
Improved
accessibility
The
move
from
HTML4
to
HTML5
includes
new
elements
(such
as
<nav>
and
<article>),
which
provide
additional
help
to
screen
readers.
Unique
skin
Because
HTML5
output
is
quite
different
from
the
other
online
formats,
it
requires
its
own
skin.
Note:
Unlike
other
output
types,
separate
language
skins
are
not
used
for
HTML5
targets.
Instead,
a
UI
Text
tab
is
located
in
the
Skin
Editor,
which
lets
you
perform
all
of
the
localization
tasks
that
you
would
normally
accomplish
in
a
language
skin.
.
11
Server-
based
output
You
can
create
HTML5
output
in
its
regular
state,
or
you
can
select
an
option
in
the
Publishing
tab
of
the
Target
Editor
to
enable
server-
based
functionality.
This
allows
you
to
accomplish
the
same
results
as
WebHelp
Plus
output—
searching
of
non-
XHTML
content,
faster
server-
side
search,
and
automatic
runtime
merging.
See
"More
About
HTML5
Server-
based
Output"
on
page
85
.
Following
are
benefits
of
server-
based
HTML5
output.
Multiple
platforms
You
can
publish
to
a
machine
running
Windows
XP,
Windows
Server
2003,
Windows
Server
2008,
Windows
7,
or
Windows
Vista.
Searching
of
non-
XHTML
content
When
end
users
perform
a
search
in
your
online
out
-
put,
you
can
ensure
that
non-
XHTML
files
(e.g.
PDF,
DOC,
XLS)
are
included
in
that
search. When
you
build
HTML5
output,
a
subfolder
named
"AutoSearch"
is
created
and
placed
in
the
generated
output
folder.
You
can
place
non-
XHTML
files
within
the
published
MADCAP
FLARE
12
CHAPTER
1
WebHelp
Outputs
AutoSearch
subfolder
(whether
the
non-
XHTML
files
are
linked
to
content
from
your
Flare
project
or
not).
When
users
perform
a
search
in
your
output,
those
non-
XHTML
files
will
also
be
scanned
and
become
accessible
to
the
users.
See
"Including
Non-
XHTML
Files
in
HTML5
Search"
on
page
113
.
Faster
searching
Another
benefit
of
generating
and
publishing
HTML5
output
to
a
Web
server
running
Microsoft
IIS
is
that
users
will
find
the
task
of
performing
a
search
to
be
much
faster
than
it
is
otherwise.
This
is
especially
useful
if
you
have
a
very
large
Help
system.
Automatic
runtime
merging
of
Flare
projects
This
is
an
easy
way
to
merge
the
output
from
multiple
HTML5
server-
based
Flare
targets
into
one
Help
system.
These
targets
can
be
originated
from
the
same
Flare
project
or
from
different
Flare
projects.
You
simply
place
the
output
files
in
the
correct
location
on
the
server
(i.e.,
within
your
master
project's
AutoMerge
folder).
Flare
then
automatically
merges
the
output
from
all
of
the
targets
when
users
access
the
Help.
From
the
end
user's
perspective,
the
results
are
seamless,
appearing
as
one
large
Help
system.
All
of
the
TOCs,
browse
sequences,
indexes,
glossaries,
and
search
capabilities
for
the
projects
are
merged.
See
"Merging
Output
at
Runtime
Using
HTML5"
on
page
105
.
13
About
WebHelp
Plus
Output
WebHelp
Plus
is
a
Web-
based
Help
format
that
is
identical
to
the
regular
WebHelp
output
in
most
ways.
How
-
ever,
WebHelp
Plus
is
designed
to
work
on
a
Web
server
running
Windows
XP,
Windows
Server
2003,
Win
-
dows
Server
2008,
Windows
7,
or
Windows
Vista.
It
also
uses
Microsoft
Internet
Information
Services
(IIS)
and
ASP.NET.
To
provide
faster
search,
WebHelp
Plus
uses
Microsoft
Indexing
Service
(for
Windows
XP
and
Win
-
dows
Server
2003)
or
Windows
Search
(for
Windows
Server
2008).
The
benefit
of
publishing
WebHelp
Plus
output
is
that
you
and
your
users
can
take
advantage
of
some
advanced
features,
including
searching
of
non-
XHTML
content,
faster
server-
side
search,
and
automatic
runtime
merging. 
The
output
consists
of
a
collection
of
files
that
you
will
distribute
to
users
by
publishing
output
to
a
Microsoft
IIS
Web
server.
The
output
will
be
displayed
in
the
user's
Internet
browser
window.
The
main
entry
file
has
an
.htm
extension.
Following
are
some
of
the
key
features
of
the
WebHelp
Plus
format.
WebHelp
features
This
format
lets
you
take
advantage
of
features
and
benefits
available
with
the
regular
WebHelp
output
type.
Sitemap/search
engine
optimization
(SEO)
You
can
generate
a
sitemap
during
compilation.
This
helps
with
search
engine
optimization
(SEO),
making
it
easier
for
webcrawlers
(i.e.,
spiders
or
bots)
to
find
your
output.
Therefore,
the
entire
output
is
indexed
and
search
engine
results
are
improved.
Multiple
platforms
This
format
is
a
good
choice
if
you
publish
your
output
to
a
machine
running
Win
-
dows
XP,
Windows
Server
2003,
Windows
Server
2008,
Windows
7,
or
Windows
Vista.
Searching
of
non-
XHTML
content
When
end
users
perform
a
search
in
your
online
output,
you
can
ensure
that
non-
XHTML
files
(e.g.
PDF,
DOC,
XLS)
are
included
in
that
search.When
you
build
WebHelp
Plus
output,
a
subfolder
named
"AutoSearch"
is
created
and
placed
in
the
generated
output
folder.
You
can
place
non-
XHTML
files
within
the
published
AutoSearch
subfolder
(whether
the
non-
XHTML
files
are
linked
to
content
from
your
Flare
project
or
not).
When
users
perform
a
search
in
your
output,
those
non-
XHTML
files
will
also
be
scanned
and
become
accessible
to
the
users.
See
"Including
Non-
XHTML
Files
in
Search"
on
page
152
.
Faster
searching
Another
benefit
of
generating
and
publishing
WebHelp
Plus
output
to
a
Web
server
running
Microsoft
IIS
is
that
users
will
find
the
task
of
performing
a
search
to
be
much
faster
than
it
is
otherwise.
This
is
especially
useful
if
you
have
a
very
large
Help
system.
Automatic
runtime
merging
of
Flare
projects
This
is
an
easy
way
to
merge
the
output
from
mul
-
tiple
WebHelp
Plus
Flare
targets
into
one
Help
system.
These
targets
can
be
originated
from
the
same
Flare
project
or
from
different
Flare
projects.
You
simply
place
the
output
files
in
the
correct
location
on
the
server
(i.e.,
within
your
master
project's
AutoMerge
folder).
Flare
then
automatically
merges
the
output
from
all
of
the
targets
when
users
access
the
Help.
From
the
end
user's
perspective,
the
results
are
seamless,
appearing
as
one
large
Help
system.
All
of
the
TOCs,
browse
sequences,
indexes,
MADCAP
FLARE
14
CHAPTER
1
WebHelp
Outputs
glossaries,
and
search
capabilities
for
the
projects
are
merged.
See
"Merging
Output
at
Runtime
Using
WebHelp
Plus"
on
page
144
.
Note:
If
you
want
to
test
WebHelp
Plus
on
your
local
computer,the
advanced
search
features
of
Web
-
Help
Plus
are
not
operable.
Tasks
Associated
With
WebHelp
Plus
Following
are
the
primary
tasks
that
you
are
likely
to
perform
when
working
with
WebHelp
Plus.
Enable
If
you
want
to
take
advantage
of
the
advanced
server-
side
features
of
WebHelp
Plus
(i.e.,
automatic
runtime
project
merging,
faster
search,
searching
of
non-
XHTML
files),
you
must
enable
WebHelp
Plus
output.
This
includes
performing
the
following
tasks:
(1)
installing
Microsoft
Internet
Information
Services
(IIS),
(2)
setting
up
the
WebHelp
Plus
target
and
generating/publishing,
(3)
con
-
figuring
IIS
on
the
production
server,
(4)
installing
ASP.NET,
(5)
starting
Microsoft
Indexing
Service
or
Microsoft
Windows
Search
(depending
on
the
operating
system),
and
(6)
enabling
WebHelp
Plus
search.
See
"Enabling
WebHelp
Plus
Output"
on
page
125
.
View
the
output
You
can
view
the
WebHelp
Plus
output
on
the
server
as
well
as
on
your
local
machine.
This
is
a
necessary
step
if
you
are
testing
the
output
on
your
local
machine.
See
"Viewing
WebHelp
Plus
Output"
on
page
139
.
Merge
multiple
outputs
at
runtime
If
you
want
to
merge
multiple
outputs
so
that
they
appear
as
one
big
Help
system
to
end
users,
you
can
do
so
easily
with
WebHelp
Plus.
The
outputs
from
the
dif
-
ferent
projects
will
be
merged
at
runtime
when
users
open
the
Help.
See
"Merging
Output
at
Runtime
Using
WebHelp
Plus"
on
page
144
.
Add
non-
XHTML
files
for
searching
When
end
users
perform
a
search
in
your
online
output,
you
can
ensure
that
non-
XHTML
files
(e.g.
PDF,
DOC,
XLS)
are
included
in
that
search.
See
"Including
Non-
XHTML
Files
in
Search"
on
page
152
.
More
Information
About
WebHelp
Plus
Following
are
additional
sources
of
information
about
WebHelp
Plus.
Scenario
You
can
read
through
a
detailed
scenario
that
provides
a
real-
life
example
of
how
someone
might
set
up
a
local
computer
and
server
for
producing
WebHelp
Plus
output.
See
"WebHelp
Plus
Sce
-
nario"
on
page
156
.
FAQs
You
can
take
a
look
at
some
frequently
asked
questions
about
WebHelp
Plus.
See
"FAQs—
WebHelp
Plus"
on
page
161
.
15
About
WebHelp
Mobile
Output
WebHelp
Mobile
is
an
output
type
that
lets
you
deploy
Web-
based,
XHTML
output
to
mobile
devices.
WebHelp
Mobile
maintains
an
easy
and
intuitive
interface
that
fits
on
a
very
small
screen.
The
Home
page
in
WebHelp
Mobile
output
contains
navigation
links
to
access
the
various
panes
that
you
can
include:
TOC,
Index,
Glossary,
Search,
Browse
Sequences.
The
WebHelp
Mobile
output
consists
of
a
collection
of
files
that
you
distribute
to
users
by
placing
them
on
a
Web
server.
End
users
then
use
their
mobile
device
to
open
those
files,
just
as
they
would
open
any
website.
The
out
-
put
will
be
displayed
in
the
user's
mobile
browser.
The
main
entry
file
has
an
.htm
extension.
Following
are
some
of
the
key
features
of
the
WebHelp
Mobile
format.
WebHelp
features
This
format
lets
you
take
advantage
of
features
and
benefits
available
with
the
regular
WebHelp
output
type.
Mobile
This
format
is
a
good
choice
if
your
end
users
are
on
the
move
and
need
to
be
able
to
access
your
documentation
on
their
mobile
devices.
Multiple
languages
You
can
produce
an
output
interface
in
various
languages.
This
is
possible
through
the
use
of
language
skins.
Multiple
platforms
This
format
is
a
good
choice
if
your
users
are
working
on
different
mobile
plat
-
forms.
Some
of
the
major
platforms
supported
are
iPhone,
iPad,
Microsoft
Mobile,
Palm
WebOS,
Blackberry,
and
Android.
Sitemap/search
engine
optimization
(SEO)
You
can
generate
a
sitemap
during
compilation.
This
helps
with
search
engine
optimization
(SEO),
making
it
easier
for
webcrawlers
(i.e.,
spiders
or
bots)
to
find
your
output.
Therefore,
the
entire
output
is
indexed
and
search
engine
results
are
improved.
Note:
Some
older
mobile
browsers
do
not
support
certain
features
(e.g.,
DHTML,
search),
whereas
newer
mobile
browsers
do
support
them.
Other
features,
such
as
"mouse
over,"
are
not
supported
in
either
older
or
newer
mobile
browsers.
.
MADCAP
FLARE
16
CHAPTER
1
WebHelp
Outputs
E X A M P L E
Let's
say
you
want
to
create
WebHelp
Mobile
output
so
that
end
users
can
see
your
documentation
on
their
cell
phones.
In
the
skin
associated
with
the
target,
you
specify
that
the
output
should
include
a
TOC,
an
index,
a
glossary,
and
search.
After
generating
the
output,
the
home
page
might
look
some
-
thing
like
this:
17
MADCAP
FLARE
18
CHAPTER
1
WebHelp
Outputs
19
About
WebHelp
AIR
Output
WebHelp
AIR
is
a
Web-
based
Help
format
that
is
identical
to
the
regular
WebHelp
output
in
most
ways.
How
-
ever,
WebHelp
AIR
uses
direct
integration
with
Adobe
AIR,
which
is
designed
to
bring
Web-
related
content
to
a
desktop
environment
by
taking
Web
files
and
incorporating
them
into
a
single
file
to
be
opened
locally,
rather
than
from
a
server.
The
WebHelp
AIR
output
that
you
generate
consists
of
a
single
file
with
an
.air
extension,
which
you
distribute
to
users.
When
users
access
this
file,
they
are
taken
through
an
installation
process,
and
as
a
result
an
execut
-
able
file
with
an
.exe
extension
is
created
on
their
local
drive
and
saved
in
their
C:\Program
Files
directory.
In
other
words,
the
output
becomes
its
own
application.
The
output
will
be
displayed
in
the
application
window
that
is
part
of
the
AIR
installation.
Following
are
some
of
the
key
features
of
the
WebHelp
AIR
format.
WebHelp
features
This
format
lets
you
take
advantage
of
features
and
benefits
available
with
the
regular
WebHelp
output
type.
Local
This
format
is
a
good
choice
if
you
want
users
to
store
and
open
the
output
locally,
rather
than
from
a
server,
such
as
a
website.
Single
file
This
format
is
a
good
choice
if
you
want
to
create
output
that
has
just
one
file.
Windows,
Mac,
and
Linux
This
format
is
a
good
choice
if
you
want
users
to
be
able
to
install
the
file
not
only
in
Windows,
but
in
a
Macintosh
and
Linux
environment
as
well.
In
order
for
you
and
your
end
users
to
take
advantage
of
this
output,
both
you
and
they
must
perform
additional
installations.
Java
Runtime
Environment
installation
(you)
As
the
individual
compiling
the
output,
you
need
to
install
the
Java
Runtime
Environment
(JRE)
before
generating
output.
You
can
download
the
JRE
from:
http://java.sun.com/javase/downloads/index.jsp
Adobe
AIR
installation
(you
and
end
users)
Anyone
who
wants
to
view
the
generated
WebHelp
AIR
output
needs
to
install
Adobe
AIR
first.
This
means
that
both
you
and
your
end
users
must
run
this
installation.
You
can
download
Adobe
AIR
from:
http://get.adobe.com/air/
MADCAP
FLARE
20
CHAPTER
1
WebHelp
Outputs
Specifying
WebHelp
AIR
Options
If
you
are
generating
WebHelp
AIR
output,
there
are
several
options
that
you
can
set
in
order
to
affect
the
out
-
put.
How
to
specify
WebHelp
AIR
options
1.
Open
a
target
that
is
using
the
WebHelp
AIR
format.
If
necessary,
you
can
change
the
output
type
for
a
target.
2.
Select
the
Adobe
AIR
Options
tab.
3.
Complete
the
fields
in
the
dialog.
Program
Name
The
WebHelp
AIR
format
creates
a
file
with
an
.air
extension.
When
this
file
is
accessed,
an
executable
file
with
an
.exe
extension
is
created
and
placed
on
the
user's
hard
drive.
By
default,
the
executable
file
will
be
named
after
the
target
that
you
are
generating.
However,
if
you
want
the
output
to
use
a
different
file
name,
you
can
enter
it
in
this
field.
ID
You
can
enter
an
identifier
for
the
application,
which
uniquely
identifies
your
application
along
with
the
publisher
ID
(which
AIR
derives
from
the
certificate
used
to
sign
the
application
package).
You
cannot
use
spaces
in
this
field.
Copyright
You
can
enter
a
copyright
in
this
field.
Digital
Certificate
If
your
company
has
a
digital
certificate,
you
can
click
the
browse
button
next
to
this
field
and
select
it.
By
using
a
digital
certificate,
the
installation
will
not
display
"unknown"
for
the
name
of
the
publisher
when
the
user
installs
the
application
(i.e.,
opens
the
online
output
).
Certificate
Password
Enter
the
password
for
the
digital
certificate.
Program
Title
You
can
enter
a
title
for
the
online
output
.
When
a
user
installs
the
application
to
open
the
online
output
,
this
title
will
be
displayed
in
one
of
the
installation
windows.
It
is
also
displayed
when
you
uninstall
the
application.
Version
You
can
use
this
field
to
enter
a
version
number
for
your
online
output
.
Description
You
can
enter
a
description
for
your
online
output
.
When
a
user
installs
the
appli
-
cation
to
open
the
online
output
,
this
description
will
be
displayed
in
one
of
the
installation
win
-
dows,
under
the
title
(if
you
specify
one).
Install
Folder
By
default,
when
a
user
installs
the
application
to
view
your
online
output
,
the
executable
file
is
placed
in
their
c:\Program
Files
directory,
within
a
subfolder
named
after
the
21
target
.
If
you
want
the
EXE
file
to
be
placed
in
a
subfolder
with
a
different
name,
you
can
enter
it
in
this
field.
Program
Menu
Folder
You
can
enter
a
folder
name,
which
dictates
where
the
program
menu
option
displays
in
the
Start
menu.
If
you
do
not
enter
a
folder
name,
the
program
option
is
displayed
at
the
root
level
of
the
Start
menu.
4.
Select
File>Save
or
press
CTRL+S
.
MADCAP
FLARE
22
23
CHAPTER
2
Skin
Tasks
for
WebHelp
Outputs
There
are
various
skin-
related
tasks
unique
to
WebHelp
outputs
that
you
can
perform.
This
chapter
discusses
the
following.
Excluding
Accordion
Titles
from
WebHelp
Output
24
Changing
Text
Strings
in
HTML5
Skins
26
Selecting
an
Image
for
the
About
Box
27
Showing
Navigation
Links
in
WebHelp
Standalone
Topics
29
Specifying
Browser
Settings
for
WebHelp
Output
30
Specifying
Navigation
Pane
Settings
for
WebHelp
Output
31
Specifying
Skin
Style
Settings
34
Specifying
Web
Toolbar
Settings—
HTML5
Output
35
Specifying
Web
Toolbar
Settings—
WebHelp
Outputs
41
Excluding
Accordion
Titles
From
WebHelp
Output
This
feature
is
supported
in
WebHelp,
WebHelp
AIR,
and
WebHelp
Plus
output.
If
you
generate
output
using
WebHelp,
WebHelp
AIR,
or
WebHelp
Plus,
the
title
of
the
active
accordion
bar
dis
-
plays
by
default
in
the
output,
like
this:
You
have
the
option
of
excluding
this
accordion
title
from
the
output.
This
shifts
the
navigation
buttons
for
the
output
to
the
left,
like
this:
MADCAP
FLARE
24
CHAPTER
2
Skin
Tasks
for
WebHelp
Outputs
How
to
exclude
accordion
titles
from
WebHelp
output
1.
Open
a
Standard
skin.
2.
Select
the
WebHelp
Setup
tab.
3.
Select
Exclude
Accordion
Title
.
4.
Select
File>Save
or
press
CTRL+S
.
25
Changing
Text
Strings
In
HTML5
Skins
This
feature
is
supported
in
WebHelp
2.0
(HTML5)
output.
Unlike
other
output
types,
separate
language
skins
are
not
used
for
HTML5
targets.
Instead,
a
UI
Text
tab
is
located
in
the
Skin
Editor,
which
lets
you
perform
all
of
the
localization
tasks
that
you
would
normally
accomplish
in
a
language
skin.
This
tab
not
only
lets
you
enter
text
in
other
languages,
but
it
lets
you
change
the
substance
of
text
strings
altogether,
whether
they
are
in
your
primary
language
or
another.
How
to
change
text
strings
in
an
HTML5
skin
1.
Open
an
HTML5
skin.
2.
Select
the
UI
Text
tab.
3.
From
the
Language
tab,
select
the
language
for
the
skin.
4.
In
the
grid
below,
type
text
in
the
Value
field
for
each
relevant
row.
5.
Select
File>Save
or
press
CTRL+S
.
MADCAP
FLARE
26
CHAPTER
2
Skin
Tasks
for
WebHelp
Outputs
Selecting
An
Image
For
The
About
Box
This
feature
is
supported
in
Microsoft
HTML
Help,
WebHelp,
WebHelp
AIR,
WebHelp
Mobile,
and
Web
-
Help
Plus
output.
You
can
select
an
image
to
be
used
for
the
"About
box"
in
the
output
window.
You
can
use
this
About
box
for
any
purpose
you
like.
When
users
click
the
icon…

your
image
is
displayed.
When
users
click
the
image,
it
disappears.
How
to
select
an
image
for
the
About
box
1.
Open
a
Standard
or
Mobile
skin.
2.
Select
the
About
tab.
3.
Click
Include
About
in
output
.
4.
Click
the
Browse
button.
5.
In
the
Open
dialog,
find
and
select
the
image
file
that
you
want
to
use
for
the
About
box.
A
preview
of
the
image
is
shown
at
the
bottom
of
the
tab.
6.
Select
File>Save
or
press
CTRL+S
.
Note:
If
you
want
to
remove
the
image,
click
the
Reset
button.
.
27
How
to
select
a
different
image
for
the
icon
What
if
you
want
to
use
an
image
other
than
the
default
MadCap
icon
(the
image
that
users
click
to
open
the
"About"
box
image")?
Use
the
following
steps
to
accomplish
this.
1.
In
the
skin
select
the
Styles
tab.
2.
In
the
Styles
section,
expand
the
ToolbarItem
node.
3.
Under
it,
click
Logo
.
4.
Select
the
Property
Groups
option.
5.
In
the
Properties
section,
click
in
the
cell
to
the
right
of
Icon
.
6.
Select
Browse
for
Image
.
7.
In
the
dialog
that
opens,
find
and
double-
click
the
image
that
you
want
to
use.
8.
Select
File>Save
or
press
CTRL+S
.
MADCAP
FLARE
28
CHAPTER
2
Skin
Tasks
for
WebHelp
Outputs
Showing
Navigation
Links
In
WebHelp
Standalone
Topics
This
feature
is
supported
in
WebHelp,
WebHelp
2.0 (HTML5),
WebHelp
AIR,
and
WebHelp
Plus
output.
You
can
add
a
navigation
link
to
the
top
or
bottom
of
topics
in
WebHelp,
WebHelp
2.0
(HTML5),
WebHelp
AIR,
or
WebHelp
Plus
outputs.
This
navigation
link
will
not
display
unless
the
output
topic
is
opened
as
a
standalone
(outside
of
the
main
navigation
framework
of
the
Help
system).
By
clicking
the
link,
a
user
can
view
the
stand
-
alone
topic
in
the
main
navigation
framework.
You
can
also
modify
the
skin
styles
for
these
navigation
links
to
change
the
way
they
look
or
the
words
used
in
the
links.
To
do
this
in
a
Standard
skin,
open
the
Skin
Editor,
select
the
Styles
tab,
expand
the
Control
group,
and
set
the
values
for
the
NavigationLinkBottom
and
NavigationLinkTop
properties.
To
do
this
in
an
HTML5
skin,
open
the
Skin
Editor,
select
the
Styles
tab,
expand
the
Navigation
Link
group,
and
set
the
values
for
the
Bottom
and
Top
properties.
See
"Specifying
Skin
Style
Settings"
on
page
34
.
How
to
show
navigation
links
in
WebHelp
standalone
topics
1.
Open
a
Standard
or
HTML5
skin.
2.
If
you
opened
a
Standard
skin,
select
the
WebHelp
Setup
tab.
If
you
opened
an
HTML5
skin,
select
the
Setup
tab.
3.
In
the
Topic
Settings
section,
click
Show
navigation
link
at
top
of
topic
or
Show
navigation
link
at
bottom
of
topic
.
4.
Select
File>Save
or
press
CTRL+S
.
29
Specifying
Browser
Settings
For
WebHelp
Output
This
feature
is
supported
in
WebHelp,
WebHelp
2.0 (HTML5),
and
WebHelp
Plus
output.
You
can
specify
which
features
will
be
used
in
the
output
window
when
a
browser
is
involved.
How
to
specify
browser
settings
for
WebHelp
output
1.
Open
a
Standard
or
HTML5
skin.
2.
Select
the
WebHelp
Setup
tab.
If
you
opened
an
HTML5
skin,
select
the
Setup
tab.
3.
Select
the
options
that
you
want
to
include
in
the
browser
output
window.
Use
Browser
Default
Settings
Click
this
check
box
if
you
want
the
output
window
to
use
the
settings
specified
in
the
user's
Internet
browser.
If
you
do
not
select
this
check
box,
you
can
select
specific
browser
features
below
to
include
in
the
output
window.
If
you
do
not
select
"Use
Browser
Default
Settings"
above,
click
the
check
boxes
next
to
each
browser
feature
that
you
want
to
include
in
the
output
window.
Toolbar
Displays
the
browser
toolbar
at
the
top
of
the
output
window.
Menu
Displays
the
browser
menu
at
the
top
of
the
output
window.
LocationBar
Displays
the
browser
location
bar
(or
address
bar)
at
the
top
of
the
output
win
-
dow.
StatusBar
Displays
the
browser
status
bar
at
the
bottom
of
the
output
window.
Resizable
Allows
users
to
resize
the
output
window.
4.
Select
File>Save
or
press
CTRL+S
.
IMPORTANT:
If
you
specify
browser
settings
for
WebHelp,
WebHelp
Plus
or
HTML5,
you
must
pro
-
vide
your
users
with
a
proper
link
to
open
your
online
Help.
Otherwise
the
browser
features
men
-
tioned
below
will
not
work
properly.
For
details,
see
"CSH
Calls
for
WebHelp
and
WebHelp
Plus—
Developers"
on
page
66
and
"CSH
Calls
for
HTML5
Output
(WebHelp
2.0)—
Developers"
on
page
58
.
MADCAP
FLARE
30
CHAPTER
2
Skin
Tasks
for
WebHelp
Outputs
Specifying
Navigation
Pane
Settings
For
WebHelp
Output
This
feature
is
supported
in
WebHelp,
WebHelp
2.0 (HTML5),
WebHelp
AIR,
and
WebHelp
Plus
output.
You
can
specify
navigation
settings
for
WebHelp,
WebHelp
2.0
(HTML5),
WebHelp
AIR,
or
WebHelp
Plus
out
-
put.
The
navigation
pane
is
used
to
hold
the
TOC,
Index,
Search,
Glossary,
Browse
Sequences,
and
Favorites
in
an
accordion-
type
structure.
How
to
specify
navigation
pane
settings
for
WebHelp
output
1.
Open
a
Standard
or
HTML5
skin.
2.
Select
the
WebHelp
Setup
tab.
If
you
opened
an
HTML5
skin,
select
the
Setup
tab.
3.
Select
the
appropriate
options.
Pane
Position
Select
a
location
(Left,
Right,
Top,
Bottom)
in
the
output
window
for
the
navi
-
gation
pane.
A
small
preview
to
the
right
changes
as
you
make
your
selection.
Pane
Size
Enter
the
width
of
the
navigation
pane
for
the
output
window
(in
pixels).
You
can
type
a
number
or
use
the
up
and
down
arrows.
Visible
Accordion
Items
Specify
how
many
navigation
items
(e.g.,
TOC,
Index,
Search)
you
want
to
be
included
at
full
size
in
the
navigation
pane.
(This
option
is
not
available
in
HTML5
skins.)
E X A M P L E
If
you
include
six
tabs
in
the
output
window
(using
the
General
tab)
and
set
this
field
to
"4,"
the
first
four
navigation
items
will
be
shown
with
full-
sized
links.
The
remaining
two
items
will
still
be
accessible
in
the
navigation
pane,
but
their
links
will
not
be
full-
sized,
but
rather
smaller
icons.
Hide
Navigation
Pane
on
Startup
Click
this
check
box
if
you
do
not
want
the
navigation
pane
to
be
immediately
displayed
when
the
Help
is
accessed
in
this
skin.
You
might
use
this
option,
for
example,
if
you
are
creating
a
skin
to
be
used
for
context-
sensitive
Help
(CSH)
top
-
ics
(as
opposed
to
your
main
Help
system
with
full
navigation).
With
CSH
topics,
the
navi
-
gation
pane
is
not
usually
necessary
because
the
user
wants
to
see
information
only
for
a
very
specific
area.
31
Exclude
Accordion
Title
Removes
the
accordion
title
from
the
WebHelp
output.
(This
option
is
not
available
in
HTML5
skins.)
If
you
generate
output
using
WebHelp,
WebHelp
AIR,
or
WebHelp
Plus,
the
title
of
the
active
accordion
bar
displays
by
default
in
the
output,
like
this:
You
have
the
option
of
excluding
this
accordion
title
from
the
output.
This
shifts
the
navigation
buttons
for
the
output
to
the
left,
like
this:
MADCAP
FLARE
32
CHAPTER
2
Skin
Tasks
for
WebHelp
Outputs
4.
Select
File>Save
or
press
CTRL+S
.
33
Specifying
Skin
Style
Settings
This
feature
is
supported
in
all
online
outputs
(DotNet
Help,
Microsoft
HTML
Help,
WebHelp,
WebHelp
2.0
(HTML5),
WebHelp
AIR,
WebHelp
Mobile,
and
WebHelp
Plus).
For
certain
elements
of
the
online
output
window
(e.g.,
navigation
pane,
TOC
or
browse
sequence
entries,
index
keywords)
you
can
determine
skin
style
settings.
When
it
comes
to
the
Standard
skin,
please
note
that
the
vast
majority
of
these
skin
styles
pertain
to
WebHelp,
WebHelp
Plus,
or
WebHelp
AIR
output.
Some
of
the
settings
(those
that
have
to
do
with
MadCap
Feedback
and
toolbar
items)
also
apply
to
Microsoft
HTML
Help.
DotNet
Help
output
only
supports
skin
style
changes
for
toolbar
items.
How
to
specify
skin
style
settings—
general
steps
1.
Open
a
skin.
2.
Select
the
Styles
tab.
3.
Select
the
style
item
that
you
want
to
modify
(e.g.,
ToolbarItem).
4.
Select
the
Property
Groups
or
Alphabetical
List
option
to
display
the
properties
for
the
style
item.
5.
In
the
Properties
section,
set
the
values
for
the
properties
that
you
want
modify.
6.
Select
File>Save
or
press
CTRL+S
.
For
more
information
and
detailed
steps
for
specific
skin
elements,
see
the
online
Help,
the
Styles
Guide
,
or
the
Skins
Guide
.
MADCAP
FLARE
34
CHAPTER
2
Skin
Tasks
for
WebHelp
Outputs
Specifying
Web
Toolbar
Settings—
HTML5
Output
This
feature
is
supported
in
WebHelp
2.0
(HTML5)
output.
You
can
specify
Web
toolbar
settings
for
some
online
outputs.
This
includes
determining
which
buttons
are
dis
-
played
in
the
toolbar.
You
can
also
add
custom
JavaScript
for
the
toolbar.
How
to
specify
custom
toolbar
settings
for
HTML5
output
1.
Open
an
HTML5
skin.
2.
Select
the
Toolbar
tab.
3.
Select
options
to
include
specific
features
(buttons)
in
the
toolbar.
Items
that
will
be
included
in
the
tool
-
bar
are
displayed
in
the
Selected
section
on
the
right.
Items
that
will
not
be
included
in
the
toolbar
are
displayed
in
the
Available
section
on
the
left.
You
can
use
the
right
arrow
button
to
move
items
from
the
Available
section
to
the
Selected
section.
Below
are
descriptions
of
the
various
items.
Current
Topic
Index
Lets
users
see
the
display
for
the
current
topic
in
the
sequence.
This
label
is
typically
used
in
conjunction
with
the
"NextTopic"
and
"PreviousTopic"
buttons
when
the
topic
in
question
exists
in
a
browse
sequence.
Flare
finds
the
current
topic
in
a
browse
sequence
and
display
its
position
in
relation
to
the
rest
of
the
topics
in
that
sequence.
(The
root
node
is
used
to
determine
the
count;
in
other
words,
if
there
are
"child"
topics
in
the
sequence
structure
under
the
current
topic,
they
will
be
included
in
the
count.)
35
Edit
User
Profile
Lets
users
edit
their
Feedback
registration
profile
settings.
Expand
All
Lets
users
expand
all
elements
such
as
togglers,
drop-
down
effects,
and
expanding
text
effects
in
a
topic
(if
they
are
not
yet
expanded).
.
MADCAP
FLARE
36
CHAPTER
2
Skin
Tasks
for
WebHelp
Outputs
Filler
Lets
users
add
a
filler
item,
which
is
used
to
specify
where
the
empty
space
should
go
in
the
toolbar.
Next
Topic
Lets
users
open
the
next
topic
in
the
sequence.
First,
Flare
attempts
to
find
the
current
topic
in
a
browse
sequence
and
navigate
to
the
next
topic
from
there.
If
you
do
not
have
a
browse
sequence,
Flare
looks
at
the
position
of
the
current
topic
in
your
table
of
con
-
tents
(TOC)
and
opens
the
next
topic
after
it.
.
37
Previous
Topic
Lets
users
open
the
previous
topic
in
the
sequence.
First,
Flare
attempts
to
find
the
current
topic
in
a
browse
sequence
and
navigate
to
the
previous
topic
from
there.
If
you
do
not
have
a
browse
sequence,
Flare
looks
at
the
position
of
the
current
topic
in
your
table
of
contents
(TOC)
and
opens
the
previous
topic
before
it.
Print
Lets
users
open
the
Print
dialog
so
that
they
can
send
the
open
topic
to
the
printer.
.
MADCAP
FLARE
38
CHAPTER
2
Skin
Tasks
for
WebHelp
Outputs
Topic
Ratings
Lets
users
submit
ratings
for
a
topic
(if
you
have
incorporated
your
output
with
MadCap
Feedback).
4.
(Optional)
You
can
use
the
buttons
at
the
bottom
of
the
tab
to
perform
additional
tasks.
Opens
the
New
Toolbar
Button
dialog,
which
lets
you
add
a
custom
button
to
the
toolbar.
After
creating
the
custom
button,
select
it
and
click
to
move
it
to
the
Selected
section.
If
you
want
to
provide
a
command
for
the
custom
button
(e.g.,
so
that
clicking
the
button
opens
a
website),
you
can
select
the
Styles
tab
in
the
Skin
Editor,
select
one
of
the
styles
listed
above,
expand
the
Event
property
group,
and
enter
a
command
in
the
Click
field.
For
example,
the
following
command
opens
the
MadCap
Software
website
when
a
user
clicks
the
button:
window.open("http://www.madcapsoftware.com");
Alternatively,
you
can
use
the
JavaScript
area
on
the
Toolbar
tab
to
enter
a
command
for
the
button.
See
the
next
step.
Removes
the
selected
custom
button
from
the
Available
section.
39
Moves
the
selected
item
up
in
the
order
in
the
Selected
section.
In
the
output,
buttons
are
displayed
left
to
right
according
to
the
order
in
which
they
appear
on
this
tab,
with
the
item
at
the
top
being
the
first
button
shown
on
the
left
in
the
output.
Moves
the
selected
item
down
in
the
order
in
the
Selected
section.
Removes
the
selected
item(s)
from
the
Selected
section.
Adds
a
separator
to
the
Selected
section.
A
separator
is
the
divider
between
the
toolbar
buttons
and
the
navigation
pane.
Resets
the
toolbar
to
the
default
settings.
5.
(Optional)
If
you
want
to
include
custom
JavaScript
in
the
toolbar,
click
Edit
in
the
area
to
the
right.
This
opens
the
Toolbar
JavaScript
dialog,
which
you
can
use
to
enter
or
load
custom
JavaScript
for
the
tool
-
bar.
For
example,
the
following
command
opens
the
MadCap
Software
website
when
a
user
clicks
the
but
-
ton:
function
MyFunction()
{
window.open("http://www.madcapsoftware.com");
}
6.
Select
File>Save
or
press
CTRL+S
.
MADCAP
FLARE
40
CHAPTER
2
Skin
Tasks
for
WebHelp
Outputs
Specifying
Web
Toolbar
Settings—
WebHelp
Outputs
This
feature
is
supported
in
WebHelp,
WebHelp
AIR,
and
WebHelp
Plus
output.
You
can
specify
Web
toolbar
settings
for
some
online
outputs.
This
includes
determining
which
buttons
are
dis
-
played
in
the
toolbar.
You
can
also
add
custom
JavaScript
for
the
toolbar.
How
to
specify
custom
toolbar
settings
for
WebHelp
outputs
1.
Open
a
Standard
skin.
2.
Select
the
WebHelp
Toolbar
tab.
3.
Select
options
to
include
specific
features
(buttons)
in
the
toolbar.
Items
that
will
be
included
in
the
tool
-
bar
are
displayed
in
the
Selected
section
on
the
right.
Items
that
will
not
be
included
in
the
toolbar
are
displayed
in
the
Available
section
on
the
left.
You
can
use
the
right
arrow
button
to
move
items
from
the
Available
section
to
the
Selected
section.
41
Below
are
descriptions
of
the
various
items.
MADCAP
FLARE
42
CHAPTER
2
Skin
Tasks
for
WebHelp
Outputs
AddTopicToFavorites
Lets
users
add
the
active
topic
to
the
Favorites
pane
so
that
they
can
quickly
access
the
topic
in
the
future.
Back
Lets
users
open
the
topic
that
was
viewed
previously.
CollapseAll
Lets
users
collapse
all
elements
such
as
togglers,
drop-
down
effects,
and
expanding
text
effects
in
a
topic
(if
they
are
expanded).
CurrentTopicIndex
Lets
users
see
the
display
for
the
current
topic
in
the
sequence.
This
label
is
typically
used
in
conjunction
with
the
"NextTopic"
and
"PreviousTopic"
buttons
when
the
topic
in
question
exists
in
a
browse
sequence.
Flare
finds
the
current
topic
in
a
browse
sequence
and
display
its
position
in
relation
to
the
rest
of
the
topics
in
that
sequence.
(The
root
node
is
used
to
determine
the
count;
in
other
words,
if
there
are
"child"
topics
in
the
sequence
structure
under
the
current
topic,
they
will
be
included
in
the
count.)
EditUserProfile
Lets
users
edit
their
Feedback
registration
profile
settings.
43
ExpandAll
Lets
users
expand
all
elements
such
as
togglers,
drop-
down
effects,
and
expand
-
ing
text
effects
in
a
topic
(if
they
are
not
yet
expanded).
Forward
Lets
users
open
the
next
topic
in
a
previously
viewed
sequence.
Home
Lets
users
open
a
designated
home
page
(such
as
your
company's
website).
Next
Topic
Lets
users
open
the
next
topic
in
the
sequence.
First,
Flare
attempts
to
find
the
current
topic
in
a
browse
sequence
and
navigate
to
the
next
topic
from
there.
If
you
do
not
have
a
browse
sequence,
Flare
looks
at
the
position
of
the
current
topic
in
your
table
of
con
-
tents
(TOC)
and
opens
the
next
topic
after
it.
Previous
Topic
Lets
users
open
the
previous
topic
in
the
sequence.
First,
Flare
attempts
to
find
the
current
topic
in
a
browse
sequence
and
navigate
to
the
previous
topic
from
there.
If
you
do
not
have
a
browse
sequence,
Flare
looks
at
the
position
of
the
current
topic
in
your
table
of
contents
(TOC)
and
opens
the
previous
topic
before
it.
.
MADCAP
FLARE
44
CHAPTER
2
Skin
Tasks
for
WebHelp
Outputs
Print
Lets
users
open
the
Print
dialog
so
that
they
can
send
the
open
topic
to
the
printer.
QuickSearch
Lets
users
initiate
a
search
in
the
active
topic
for
the
word
or
phrase
that
has
been
typed
in
the
field
next
to
the
button.
Refresh
Lets
users
update
the
content
of
the
topic
being
viewed.
RemoveHighlight
After
a
user
performs
a
quick
search
in
a
topic,
the
search
text
found
in
the
topic
is
highlighted.
This
button
lets
users
turn
the
highlights
off.
SelectBrowseSequence
Lets
users
open
the
Browse
Sequence
feature.
SelectFavorites
Lets
users
open
the
Favorites
feature.
.
45
SelectGlossary
Lets
users
open
the
Glossary
feature.
SelectIndex
Lets
users
open
the
Index
feature.
SelectSearch
Lets
users
open
the
Search
feature.
SelectTOC
Lets
users
open
the
TOC
feature.
Stop
Lets
users
prevent
a
page
from
downloading
file
information.
ToggleNavigationPane
Lets
users
toggle
between
hiding
and
showing
the
navigation
pane
in
the
output
window.
.
MADCAP
FLARE
46
CHAPTER
2
Skin
Tasks
for
WebHelp
Outputs
TopicRatings
Lets
users
submit
ratings
for
a
topic
(if
you
have
incorporated
your
output
with
MadCap
Feedback).
4.
(Optional)
You
can
use
the
buttons
at
the
bottom
of
the
tab
to
perform
additional
tasks.
Opens
the
New
Toolbar
Button
dialog,
which
lets
you
add
a
custom
button
to
the
toolbar.
After
creating
the
custom
button,
select
it
and
click
to
move
it
to
the
Selected
section.
Unless
you
specify
otherwise,
in
the
output
the
new
button
will
display
the
text
for
the
name
you
gave
it.
However,
you
can
change
this
by
editing
the
control
type
for
the
new
button.
To
do
this,
you
can
select
the
Styles
tab
in
the
Skin
Editor,
expand
the
Toolbar
Item
node,
select
one
of
the
styles
listed
above,
expand
the
Type
property
group,
and
from
the
ControlType
field
select
Button
.
To
choose
an
image
for
the
button,
expand
the
General
property
group
on
the
Styles
tab
and
select
image
files
in
the
Icon
fields.
If
you
want
to
provide
a
command
for
the
custom
button
(e.g.,
so
that
clicking
the
button
opens
a
website),
you
can
select
the
Styles
tab
in
the
Skin
Editor,
expand
the
Toolbar
Item
node,
select
one
of
the
styles
listed
above,
expand
the
Type
property
group,
and
enter
a
command
in
the
OnClick
field.
For
example,
the
following
command
opens
the
MadCap
Software
website
when
a
user
clicks
the
button:
window.open("http://www.madcapsoftware.com");
Alternatively,
you
can
use
the
JavaScript
area
on
the
WebHelp
toolbar
tab
to
enter
a
com
-
mand
for
the
button.
See
the
next
step.
Removes
the
selected
custom
button
from
the
Available
section.
Moves
the
selected
item
up
in
the
order
in
the
Selected
section.
In
the
output,
buttons
are
displayed
left
to
right
according
to
the
order
in
which
they
appear
on
this
tab,
with
the
item
at
the
top
being
the
first
button
shown
on
the
left
in
the
output.
Moves
the
selected
item
down
in
the
order
in
the
Selected
section.
Removes
the
selected
item(s)
from
the
Selected
section.
47
Adds
a
separator
to
the
Selected
section.
A
separator
is
the
divider
between
the
toolbar
buttons
and
the
navigation
pane.
Resets
the
toolbar
to
the
default
settings.
5.
(Optional)
If
you
want
to
include
custom
JavaScript
in
the
toolbar,
click
Edit
in
the
area
to
the
right.
This
opens
the
Toolbar
JavaScript
dialog,
which
you
can
use
to
enter
or
load
custom
JavaScript
for
the
tool
-
bar.
For
example,
the
following
command
opens
the
MadCap
Software
website
when
a
user
clicks
the
but
-
ton:
function
MyFunction()
{
window.open("http://www.madcapsoftware.com");
}
6.
Select
File>Save
or
press
CTRL+S
.
Note:
You
can
also
specify
custom
toolbar
settings
for
HTML5
output.
MADCAP
FLARE
48
49
CHAPTER
3
Target
Tasks
for
WebHelp
Outputs
There
are
various
target-
related
tasks
unique
to
WebHelp
outputs
that
you
can
perform.
This
chapter
discusses
the
following.
Adding
Mark
of
the
Web
50
Selecting
a
Language
for
the
Target
for
the
WebHelp
Interface
51
Compiler
Warnings
for
WebHelp
Outputs
52
Using
Custom
File
Extensions
55
Adding
Mark
Of
The
Web
This
feature
is
supported
in
WebHelp,
WebHelp
2.0 (HTML5),
and
WebHelp
Plus
output.
Mark
of
the
Web
(MOTW)
is
a
comment
added
to
the
HTML
markup
for
a
web
page.
When
users
open
the
web
page
from
their
local
machine,
Internet
Explorer
references
this
comment
to
determine
the
security
zone
in
which
it
should
run
the
page.
This
means
you
can
deliver
WebHelp,
WebHelp
2.0
(HTML5),
or
WebHelp
Plus
output
without
your
online
Help
initially
being
blocked
on
the
user's
machine
with
this
security
message:
Normally,
the
user
would
have
to
click
on
this
message
and
select
Allow
Blocked
Content
to
view
your
Help
system.
By
adding
MOTW,
you
can
avoid
this
situation.
However,
please
note
that
if
you
have
links
in
your
project
to
non-
HTML
files
(e.g.,
DOC,
PDF,
JPG,
GIF),
those
links
will
not
work
with
MOTW
enabled.
Therefore,
MOTW
should
not
be
used
unless
the
links
in
your
project
are
limited
to
HTML
documents
only.
How
to
add
Mark
of
the
Web
1.
Open
a
target.
2.
On
the
Advanced
tab
of
the
Target
Editor,
select
Insert
Mark
of
the
Web
.
3.
Select
File>Save
or
press
CTRL+S
.
Note:
With
Mark
of
the
Web
enabled
in
your
target,
some
links
to
external
files
may
not
work
properly
in
some
versions
of
Internet
Explorer
when
pages
are
viewed
locally
(file://).
This
is
not
an
issue
if
pages
are
viewed
online
(http://).
For
more
information
about
MOTW,
see
Microsoft's
MSDN
web
-
site.
MADCAP
FLARE
50
CHAPTER
3
Target
Tasks
for
WebHelp
Outputs
Selecting
A
Language
For
The
Target
For
The
WebHelp
Interface
This
feature
is
supported
in
all
WebHelp
outputs
(WebHelp,
WebHelp
2.0
(HTML5),
WebHelp
AIR,
Web
-
Help
Mobile,
and
WebHelp
Plus
).
There
are
two
pieces
to
the
generated
output:
the
content
and
the
user
interface
(e.g.,
navigation
buttons
and
labels).
If
you
are
generating
one
of
the
WebHelp
output
formats
(
WebHelp,
WebHelp
2.0
(HTML5),
WebHelp
AIR,
WebHelp
Mobile,
or
WebHelp
Plus)
output,
you
can
select
a
specific
language
skin
for
displaying
the
user
interface.
You
can
then
edit
the
language
skin
as
necessary,
adjusting
text
for
buttons
and
labels.
Normally,
you
would
edit
a
skin
in
the
Skin
Editor.
However
if
you
want
to
display
the
output
user
interface
in
a
particular
lan
-
guage,
you
can
use
the
Language
Skin
Editor
instead.
Flare
provides
completed
language
skins
for
certain
languages,
such
as
French,
German,
and
Spanish
(i.e.,
they
are
already
translated
for
you).
These
are
languages
that
are
already
identified
as
being
"localized"
skins.
For
other
languages,
you
can
create
language
skins
so
that
they
can
be
applied
to
the
output
too.
E X A M P L E
Let's
say
that
you
want
to
display
the
user
interface
of
the
WebHelp
output
in
Bulgarian.
Flare
does
not
provide
a
language
skin
in
Bulgarian,
so
you
can
create
your
own
skin,
entering
the
Bulgarian
text
in
the
skin
where
appropriate.
After
you
create
the
user-
defined
language
skin
with
Bulgarian
text,
you
can
select
it
for
use
in
the
WebHelp
output
interface.
Each
project
is
associated
with
a
specific
language.
However,
you
can
override
this
setting
for
a
particular
tar
-
get
if
you
want
the
user
interface
for
that
target
output
to
use
a
certain
language
skin.
How
to
select
a
language
for
a
target
1.
Open
the
target.
2.
In
the
Target
Editor,
select
the
Language
tab.
3.
Select
the
language
from
the
list.
The
language
must
have
"Yes"
displayed
in
the
Localized
Skins
col
-
umn.
4.
Select
File>Save
or
press
CTRL+S
.
51
Compiler
Warnings
For
WebHelp
Outputs
This
feature
is
supported
in
all
WebHelp
outputs
(WebHelp,
WebHelp
2.0
(HTML5),
WebHelp
AIR,
Web
-
Help
Mobile,
and
WebHelp
Plus
).
If
you
are
generating
any
of
the
WebHelp
output
formats,
you
can
use
the
Target
Editor
to
indicate
whether
you
want
to
receive
compiler
warnings
when
your
output
fails
to
include
information
that
makes
it
accessible.
How
to
select
compiler
warnings
for
WebHelp
outputs
1.
Open
a
target
using
one
of
the
WebHelp
formats.
2.
Select
the
Warnings
tab.
3.
Select
any
of
the
options
to
enable
them.
Warn
when
image
elements
are
missing
alternate
text
Warn
when
equation
elements
are
missing
alternate
text
Warn
when
QR
code
elements
are
missing
alternate
text
Warn
when
tables
are
missing
a
caption
and
summary
Warn
when
tables
are
missing
header
elements
Warn
when
form
elements
are
missing
labels
Warn
when
frame
elements
are
missing
titles
and
names
MADCAP
FLARE
52
CHAPTER
3
Target
Tasks
for
WebHelp
Outputs
4.
Select
File>Save
or
press
CTRL+S
.
Note:
If
you
also
have
the
latest
version
of
MadCap
Analyzer
installed,
you
can
see
these
same
warn
-
ings
before
you
generate
output.
If
you
receive
one
or
more
of
these
types
of
compiler
warnings,
what
should
you
do?
That
depends
on
the
type
of
warning
you
receive.
Image
elements
If
you
receive
this
type
of
warning,
you
can
fix
the
issue
by
editing
the
image
and
entering
a
description
in
the
Alternate
Text
field.
Equation
elements
If
you
receive
this
type
of
warning,
you
can
fix
the
issue
by
editing
the
equation
and
entering
a
description
in
the
Alternate
Text
field.
QR
code
elements
If
you
receive
this
type
of
warning,
you
can
fix
the
issue
by
editing