View Issue Details [ Jump to Notes ] [ Print ]
IDProjectCategoryView StatusDate SubmittedLast Update
0005183ParaView(No Category)public2007-06-13 21:362007-12-14 14:12
ReporterAlan Scott 
Assigned ToBerk Geveci 
PrioritynormalSeverityminorReproducibilityalways
StatusclosedResolutionfixed 
PlatformOSOS Version
Product Version 
Target VersionFixed in Version 
Summary0005183: Help needs help
DescriptionThe ParaView help system is a major step forward (from nothing), but still needs lots of work. I don't know how to be specific with such a general topic, so shall give some thoughts and then specifics.

* We need a "getting started, or ParaView 101, or somesuch. This could be as simple as "Open a file from the included data. Turn on a filter. Spin stuff. Here is the Pipeline Browser. Here is the object Inspector. Here is how they play together.

* Somewhere under contents, there should be an entry for every item at the top menu of ParaView - including what it is. For instance, File (obvious) / Save State (not obvious). What state? Animation state? My data file? etc. The following enries, under File, have no help: Open, Recent Files, Load State, Save State, Save Data, Save Screenshot, Connect and Disconnect. Save Animation and Save Geometry are found at the bottom of the animation tab.

* Although fabulously important, we have Readers (attached to file extensions), Sources (a menu item), Filters (Another menu item) and Writers (I don't really know what this is - for developers?) as the bottom four items of the Contents. Use a user-centric approach, and go through Menus, then icons, then Pipeline Browser, then Object Inspector, etc. Put reference stuff at the bottom, for instance writers. Use more sub-menus (as is used for the Display Panel).

* We are missing stuff out of the Index - in fact it is almost non existant. For instance, Filters - and all specific types of Filters - are missing.

* Search state is very anemic. For instance, Load State doesn't exist. Almost everything under "File" doesn't exist. If two words are used, search is often wrong, giving me every instance of each word individually.

* General statement: Every word (or at least label) in every menu should be findable by doing a search.

* General statement: Every sub menu item should be findable by going to the index.

By the way, the general statement that the Help system needs lots of work comes from one of our first users.

Alan
TagsNo tags attached.
Project
Topic Name
Type
Attached Files

 Relationships

  Notes
(0008805)
Berk Geveci (administrator)
2007-09-03 10:46

 Reminder sent to: Berk Geveci, Utkarsh Ayachit

If Amy needs help with this, Utarsh and I can help.
(0008880)
Amy Squillacote (reporter)
2007-09-07 10:50

 I've checked in changes so that the names of the sources, filters, readers, and writers show up in the index.

/cvsroot/ParaView3/ParaView3/Documentation/pqClient.adp,v <-- pqClient.adp
new revision: 1.12; previous revision: 1.11
/cvsroot/ParaView3/ParaView3/Servers/ServerManager/CMakeLists.txt,v <-- CMakeLists.txt
new revision: 1.200; previous revision: 1.199
/cvsroot/ParaView3/ParaView3/Servers/ServerManager/vtkSMExtractDocumentation.cxx,v <-- vtkSMExtractDocumentation.cxx
new revision: 1.17; previous revision: 1.16
(0009439)
Amy Squillacote (reporter)
2007-10-12 11:29

 I have added documentation for the menus and toolbars. Dave Demarle also wrote some text about selection. These have been committed to CVS head and to the ParaView-3-2 branch.

Utkarsh is going to be filling in some per-writer documentation. I think this bug is finished other than this.
(0009476)
Utkarsh Ayachit (administrator)
2007-10-15 11:39

 Updated writer documentation.

/cvsroot/ParaView3/ParaView3/Servers/ServerManager/Resources/writers.xml,v <-- writers.xml
new revision: 1.19; previous revision: 1.18
(0009487)
Alan Scott (manager)
2007-10-15 16:52

 As far as "Help needs Help, this issue is finished. However, Berk and I want to have another entry added to the help, either adding a link to the kitware web page for the 3.X book, or a direct plug for the 3.X book. An entry needs to be added such as "ParaView 3.X book", or "ParaView book information", or "Advanced Paraview", or somesuch. I am keeping this bug open as a place holder.
(0009488)
Alan Scott (manager)
2007-10-15 16:58

 I am changing the priority to reflect a future change. We want to reference the new ParaView book in the help. This change should occur when the book is available.
(0009795)
Alan Scott (manager)
2007-11-29 12:47

 Berk,
This one should be ready to close.

alan
(0009901)
Alan Scott (manager)
2007-12-14 14:11

 This is finished. MUCH BETTER.

 Issue History
Date Modified Username Field Change
2007-08-23 17:10 Berk Geveci Category => 3.2
2007-09-03 10:44 Berk Geveci Assigned To Berk Geveci => Amy Squillacote
2007-09-03 10:46 Berk Geveci Note Added: 0008805
2007-09-07 10:50 Amy Squillacote Note Added: 0008880
2007-10-12 11:29 Amy Squillacote Note Added: 0009439
2007-10-12 15:06 Berk Geveci Assigned To Amy Squillacote => Utkarsh Ayachit
2007-10-15 11:39 Utkarsh Ayachit Note Added: 0009476
2007-10-15 11:39 Utkarsh Ayachit Status tabled => @80@
2007-10-15 11:39 Utkarsh Ayachit Resolution open => fixed
2007-10-15 16:52 Alan Scott Status @80@ => @20@
2007-10-15 16:52 Alan Scott Resolution fixed => reopened
2007-10-15 16:52 Alan Scott Note Added: 0009487
2007-10-15 16:58 Alan Scott Note Added: 0009488
2007-10-15 16:58 Alan Scott Priority high => normal
2007-10-15 16:58 Alan Scott Severity major => minor
2007-10-17 08:56 Utkarsh Ayachit Status @20@ => tabled
2007-10-17 08:56 Utkarsh Ayachit Assigned To Utkarsh Ayachit => Berk Geveci
2007-11-29 12:47 Alan Scott Note Added: 0009795
2007-11-29 12:47 Alan Scott Status tabled => @20@
2007-12-14 14:11 Alan Scott Status @20@ => @80@
2007-12-14 14:11 Alan Scott Resolution reopened => fixed
2007-12-14 14:11 Alan Scott Note Added: 0009901
2007-12-14 14:12 Alan Scott Status @80@ => closed
2011-06-16 13:10 Zack Galbreath Category => (No Category)

Copyright © 2000 - 2018 MantisBT Team