[Paraview] Integrating Help for Custom Filters

[Michael Jackson]

If I click on the "?" button when the reader is used I do get my help  
page showing up. But there does not seem to be any "links" to it in  
the TOC of the help which may or may not be a problem. I should work  
on that..
--
Mike Jackson <www.bluequartz.net>

On Mar 4, 2010, at 10:39 AM, Eric E. Monson wrote:

> Hey Mike,
>
> Won't you also need to add an entry to the paraview.qhp.in file to  
> get your docs to show up correctly in the help table of contents?
>
> Incidentally, while I was just searching through the CVS ParaView  
> documentation directory, it looks like ParaViewFilters.html is  
> missing...
>
> -Eric
>
> ------------------------------------------------------
> Eric E Monson
> Duke Visualization Technology Group
>
>
> On Mar 4, 2010, at 10:27 AM, Michael Jackson wrote:
>
>> This is the current "hack" that I am trying. In the "Client" part  
>> of the CMake files I include the following:
>>
>> set (PV_DOCUMENTATION_FILES
>> ${AngReaderClient_SOURCE_DIR}/Resources/AngReader.html )
>> foreach (file ${PV_DOCUMENTATION_FILES})
>>   GET_FILENAME_COMPONENT(fname ${file} NAME)
>>   configure_file(
>>     "${CMAKE_CURRENT_SOURCE_DIR}/Resources/${fname}"
>>     "${ParaView_BINARY_DIR}/Documentation/${fname}"
>>   COPYONLY)
>> endforeach (file)
>>
>> After looking through some of the actual ParaView CMake files, the  
>> documentation is built _after_ all the plugins and  
>> PARAVIEW_EXTRA_EXTERNAL_MODULES have run. The CMake commands just  
>> run a "Copy" from the actual ParaView Documentation directory into  
>> the "Build Directory"/Documentation. Then a FILE (GLOB... ) command  
>> is run. So I am basically just injecting my html file into the  
>> Documentation Directory in the Build directory and it _should_  
>> work. I hope.
>>
>> --
>> Mike Jackson <www.bluequartz.net>
>>
>> On Mar 4, 2010, at 10:10 AM, Utkarsh Ayachit wrote:
>>
>>> Not currently, but it has been something that we'd like to add.
>>>
>>> On Thu, Mar 4, 2010 at 9:38 AM, Michael Jackson
>>> <mike.jackson at bluequartz.net> wrote:
>>>> Is there any mechanism in place to add html help files for custom  
>>>> filters to
>>>> ParaView?
>>>>
>>>> Thanks
>>>> ___________________________________________________________
>>>> Mike Jackson                      www.bluequartz.net
>>>> Principal Software Engineer       mike.jackson at bluequartz.net
>>>> BlueQuartz Software               Dayton, Ohio
>>>>
>>>>
>>>> _______________________________________________
>>>> Powered by www.kitware.com
>>>>
>>>> Visit other Kitware open-source projects at
>>>> http://www.kitware.com/opensource/opensource.html
>>>>
>>>> Please keep messages on-topic and check the ParaView Wiki at:
>>>> http://paraview.org/Wiki/ParaView
>>>>
>>>> Follow this link to subscribe/unsubscribe:
>>>> http://www.paraview.org/mailman/listinfo/paraview
>>>>
>>
>> _______________________________________________
>> Powered by www.kitware.com
>>
>> Visit other Kitware open-source projects at http://www.kitware.com/opensource/opensource.html
>>
>> Please keep messages on-topic and check the ParaView Wiki at: http://paraview.org/Wiki/ParaView
>>
>> Follow this link to subscribe/unsubscribe:
>> http://www.paraview.org/mailman/listinfo/paraview
>