Re: [platform-ua-dev] Need help with making Pre-Built Index

["Curtis D'Entremont" <curtispd@xxxxxxxxxx>]

The customBuildCallbacks.xml file is
in CVS only, so you need to check out that project from CVS. It doesn't
get included in the built plugin.

As far as using DITA, it doesn't matter
what tools you use as long as the end result is something help understands
like HTML files and toc XML files, etc. I would advise creating your doc
plugin "skeleton" in your workspace and dragging and dropping
your generated docs inside that plugin in your workspace. This way you
don't have to regen the whole plugin everytime, only the doc content, and
you gain some PDE tools and validation. Trying to generate a complete plugin
including the manifest and extensions etc from some other tooling could
get complicated. Jarring may give you a manifest, but it won't give you
the extensions in your plugin.xml that you need to contribute the TOC,
for example.

Curt

Todd Rose <rogue.writer@xxxxxxxxx>
Sent by: platform-ua-dev-bounces@xxxxxxxxxxx

28/07/2006 12:22 PM

Please respond to
"Eclipse Platform User Assistance component developers list." <platform-ua-dev@xxxxxxxxxxx>

To	"Eclipse Platform User Assistance component developers list." <platform-ua-dev@xxxxxxxxxxx>
cc
Subject	Re: [platform-ua-dev] Need help with making Pre-Built Index

Thanks Curtis,
 
OK, I figured out that I need to add the reference
to the toc.xml file.  Now, the next step has me lost.  
 
"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"
destinationfiltered="."/>

I can't find the "customBuildCallbacks.xml file you
are referring to. 
 
It probably makes a difference to tell you that I'm building
plugins using the DITA Open Toolkit and dragging the output folders to
the Eclipse Plugins folder.  If I'm interpreting this correctly, I
have to "jar" the output folder so it has its own Manifest.  Is
that right?


Curtis D'Entremont <curtispd@xxxxxxxxxx> wrote:

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
_______________________________________________
platform-ua-dev mailing list
platform-ua-dev@xxxxxxxxxxx
https://dev.eclipse.org/mailman/listinfo/platform-ua-dev

 __________________________________________________
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