[
Date Prev][
Date Next][
Thread Prev][
Thread Next][
Date Index][
Thread Index]
[
List Home]
Re: [platform-ua-dev] Need help with making Pre-Built Index
|
Hi Todd,
See my answers
below...
Thanks,
Curt
Todd Rose <rogue.writer@xxxxxxxxx>
Sent by: platform-ua-dev-bounces@xxxxxxxxxxx
28/07/2006 07:52 AM
Please respond to
"Eclipse Platform User Assistance component developers list."
<platform-ua-dev@xxxxxxxxxxx> |
|
To
| platform-ua-dev@xxxxxxxxxxx
|
cc
|
|
Subject
| [platform-ua-dev] Need help with making
Pre-Built Index |
|
I'm new to this list, so forgive me if this question has
been answered. I'm having trouble generating the pre-built index from the
instructions in the Eclipse Help. Here are my major sticking points:
Building a documentation index for a plug-in.
To build an index follow the steps:
- add an index
element to the org.eclipse.help.toc extension
in a documentation plug-in, to specify directory where index will exist,
In what directory should this index exist? (the
plugin folder?)
Yes, in your doc plugin. This is a plug-in
relative path so if you enter "index" here you're saying you
want the index to be in the index folder within your plugin. To see an
example check out the org.eclipse.platform.doc.user plug-in from the eclipse
cvs. Note that you do not have to create this directory yet; you're only
telling it where to look for the index (next step will actually create
the directory and its contents).
- What is the syntax?
- create an index for a desired locale by running the help.buildHelpIndex
ANT task for each plug-in and fragment with documentation.
So,
what' the exact syntax?
This task takes in the manifest and destination
attributes. Manifest is the path to your plugin.xml and the destination
is where you want it to place the generated index directory (i.e. the root
dir of your doc plugin). For example, if you look at org.eclipse.platform.doc.user/customBuildCallbacks.xml
you'll see it being called this way:
<help.buildHelpIndex
manifest="plugin.xml"
destination="."/>
Note that you only need to use this ant task
for pre-indexing as part of your build. If you want to do this manually
in your workspace, PDE provides a function to do this. In 3.2 you can right-click
on your doc plugin project in your workspace and select PDE Tools >
Create Help Index, and it will achieve the same as calling the ant task.
- Is the "doc_index.zip" automatically generated
from this command?
No, the doc_index.zip only gets generated when
you're doing a per-product index. The ant task and PDE utility are used
to generate per-plugin indexes, which will generate the /index dir and
its contents, not doc_index.zip.
I would greatly appreciate any help.
Thanks! Todd
__________________________________________________
Do You Yahoo!?
Tired of spam? Yahoo! Mail has the best spam protection around
http://mail.yahoo.com _______________________________________________
platform-ua-dev mailing list
platform-ua-dev@xxxxxxxxxxx
https://dev.eclipse.org/mailman/listinfo/platform-ua-dev