MantisBT - ParaView
View Issue Details
IDProjectCategoryView StatusDate SubmittedLast Update
0012745ParaViewFeaturepublic2011-11-22 11:152012-02-08 17:26
ReporterUtkarsh Ayachit 
Assigned ToUtkarsh Ayachit 
PrioritynormalSeverityminorReproducibilityhave not tried
StatusclosedResolutionfixed 
PlatformOSOS Version
Product Version3.12 
Target VersionFixed in Version3.14 
ProjectParaViS
Topic Name12745_help_from_plugins
Typeincorrect functionality
Summary0012745: Add support for incorporate documentation for filters/readers from plugins.
DescriptionAdd support for incorporate documentation for filters/readers from plugins. It must be noted that the documentation should be dynamically loaded when the plugin is loaded, paraview being oblivious of the plugin at compile time.
Steps To Reproduce
Additional Information
TagsNo tags attached.
Relationships
Attached Files
Issue History
Date ModifiedUsernameFieldChange
2011-11-22 11:15Utkarsh AyachitNew Issue
2011-11-22 13:58Utkarsh AyachitAssigned To => Utkarsh Ayachit
2011-11-22 13:58Utkarsh AyachitStatusbacklog => todo
2011-11-22 13:58Utkarsh AyachitStatustodo => active development
2011-11-22 22:30Utkarsh AyachitCategory(No Category) => Feature
2011-11-28 11:13Mike JacksonNote Added: 0027734
2011-11-28 11:28Utkarsh AyachitNote Added: 0027735
2011-11-28 11:29Utkarsh AyachitNote Edited: 0027735bug_revision_view_page.php?bugnote_id=27735#r400
2011-12-02 16:45Utkarsh AyachitTopic Name => 12745_help_from_plugins
2011-12-05 13:21Utkarsh AyachitNote Added: 0027772
2011-12-05 13:21Utkarsh AyachitStatusactive development => gatekeeper review
2011-12-05 13:21Utkarsh AyachitFixed in Version => git-next
2011-12-05 13:21Utkarsh AyachitResolutionopen => fixed
2011-12-19 15:14Utkarsh AyachitNote Added: 0027835
2011-12-19 15:15Utkarsh AyachitStatusgatekeeper review => customer review
2011-12-19 15:15Utkarsh AyachitNote Added: 0027855
2011-12-19 15:16Utkarsh AyachitFixed in Versiongit-next => git-master
2012-02-08 17:21Utkarsh AyachitFixed in Versiongit-master => 3.14
2012-02-08 17:26Utkarsh AyachitStatuscustomer review => closed
2012-02-08 17:26Utkarsh AyachitNote Added: 0028154

Notes
(0027734)
Mike Jackson   
2011-11-28 11:13   
Does this mean that there is NO support in 3.12? Or can I adjust my code to compile in my help file directly into my plugin?
(0027735)
Utkarsh Ayachit   
2011-11-28 11:28   
(edited on: 2011-11-28 11:29)
There's no support in 3.12. The way the documentation is generated makes it really tricky to hack in a quick fix for 3.12.
(0027772)
Utkarsh Ayachit   
2011-12-05 13:21   
commit 97e7bf1c98aecf4cc3bff4ee7066419d552e4f38
Merge: 1bbb909 a7a4f65
Author: Utkarsh Ayachit <utkarsh.ayachit@kitware.com>
Date: Mon Dec 5 13:20:03 2011 -0500

    Merge topic '12745_help_from_plugins' into next
    
    a7a4f65 Fix title for index page.
    3c50229 Added Index and Search widgets to the help dialog.
    503edef Help index was not refreshed when plugins were loaded.
    69058d1 Added support to add html pages in plugins as documentation.
    b978eab Added support to show proxy help for proxies loaded from plugins.
    21aad08 Updating documenation as plugins are loaded.
    4c88eb5 Added simple API to connect VTK events to QT slots/signals.
    ef96341 Fixing the index.
    512ea94 Minor cleanups.
    a0651ab Added logic to automatically generate TOC when not provided.
    1e101d5 removed obsolete code.
    429aacb WIP: Started adding component to load docs from plugin.
    19c2324 Added support to access binary resources from vtkPVPlugin.
    bf5a65f Fixing geenration to work when empty prefix/suffix are provided.
    08bdf81 WIP: Compiling the plugin help as a SM resource.
    d8969a3 Fixes to ensure the functions work in different setups.
    ...
(0027835)
Utkarsh Ayachit   
2011-12-19 15:14   
merged into master (wherever applicable)
(0027855)
Utkarsh Ayachit   
2011-12-19 15:15   
merged into master (wherever applicable)
(0028154)
Utkarsh Ayachit   
2012-02-08 17:26   
closing bugs sitting in "customer review" for a long time.