Page MenuHomePhabricator

Create some getting started documentation for the ExtApp
Closed, ResolvedPublic

Description

Something like a joined version of the getting started pdf of the Qt3 application and the nice 3M3 introductory documentation. Caspar, could you do that?

Event Timeline

Sure. Is this higher priority than the Installer file associations?

Some questions:

  • What is the desired way of delivery (pdf/wiki/html/all of them)
  • Who is the target group (developers/end users/both/both but two different documents/both but only in the way the getting started does it)
  • How many of the views should be described (Which can be expected in ExtApp?)?

That's it for now.

Views available in ExtApp:

  • BasicImageProcessing
  • Datamanager
  • DeformableRegistration
  • Image Navigator
  • ImageCropper
  • Measurement
  • PointBasedRegistration
  • Property List
  • RigidRegistration
  • Scene Serialization
  • Segmentation
  • Surface Material Editor
  • Volume Visualization

Perspectives available:

Research

Currently there is no unified naming scheme regarding spaces in the view names. I will write the documentation using spaces. If no one objects I am going to change the names of the views accordingly in a week or two.

The available views depend on the build modules, the above is including all 3M3 modules and the image cropper.

F1 works for help files but shows all the 3M3 help files as well, including those of modules that are not part of ExtApp. Should I write the documentation assuming no help files at all, or will there be an appropriate help file system for ExtApp?

(In reply to comment #4)

The available views depend on the build modules, the above is including all 3M3
modules and the image cropper.

The ExtApp will contain all modules of the open-source mitk, the trunk/mitk subdirectory.

F1 works for help files but shows all the 3M3 help files as well, including
those of modules that are not part of ExtApp. Should I write the documentation
assuming no help files at all, or will there be an appropriate help file system
for ExtApp?

I guess these are some old help files from a 3M build ?! The help file system for the ExtApp should work like for 3M3, maybe a few 3m3 app modifications still have to get ported. If it's not working please file a bug and describe the problem.

Yes those should be old ones from a 3M3 Build.

I just downloaded mitk from svn2 and build it with the option "build all plugins".

Concerning the documentation:

  • ExtApp - Missing, but can be copied and pasted from 3M3 Main App for the most part

And the views:

  • BasicImageProcessing - 3M3 level documentation
  • Datamanager - 3M3 level documentation
  • DeformableRegistration - For some reason the documentation is inaccessible, but does have 3M3 level documentation
  • IGT Example - Missing, lots of buttons
  • Image Guided Therapy Tutorial - Missing, two buttons, what do they do, why even Tutorial?
  • Image Navigator - Missing, but intuitive, needs only a couple of sentences
  • Image Cropper - short manual, missing screenshots, typo
  • IsoSurface - short manual
  • Log View - Missing, self explanatory unless it can do anything but logging
  • Measurement - 3M3 level documentation
  • MovieMaker - short manual, outdated screenshot
  • Object Browser - Missing, Debugging stuff
  • PointBasedRegistration - 3M3 level documentation
  • PointSet Interaction - 3M3 level documentation (looks like it, but layout needs to be adjusted [like Mainpage])
  • Property List - Missing, but intuitive, needs only a couple of sentences
  • RegionGrowing - stub
  • RigidRegistration - 3M3 level documentation
  • Scene Serialization - Missing, while its function should be rather obvious a couple of sentences and an example would be good
  • Segmentation - 3M3 level documentation
  • Simple Example - a lot of buttons and manual contains no information at all
  • SimpleMeasurement - short manual, missing screenshot
  • Surface Material Editor - Missing, but intuitive, needs only a couple of sentences
  • ViewInitialization - Missing, confusing options
  • Volume Visualization - 3M3 level documentation
  • Volumetry - Missing, one or two paragraphs should be sufficient

As I just don't understand some or even all of the options/buttons of those views I would like those who wrote them (or worked on them and know how to use them) to either write the documentation or, as I know that some of you have little time, to get somebody to do so. If you are willing to explain to me how to use the view that somebody might even be me. Here is the list of people (I should have cced you with this post):

Hannes: Could you take on the IGT example?
Jochen: What does the Image Guided Therapy Tutorial do?
Sascha: Could you take care of the Object Browser?
Alex: Could you write something on the Simple Example?
Diana: You ported the ViewInitialization, didn't you?
Marco: If the Volumetry remains for the release, could you write a couple of sentences?

Object Browser:

If I understood the bug correctly, this is about an end-user documentation. I would exclude the Object Browser from the documentation right now (it also shouldn't be included in an installable application). The view is only a debugging tool for berry::Object derived classes.

Jan takes care of the IsoSurface, ImageCropper and Region Growing.

I'll write something for

  • IGT Example
  • Image Guided Therapy Tutorial

[SVN revision 21202]
CHG (#3241): Updated manual

[SVN revision 21203]
DOC (#3241): Add user manual for IGTExample view

[SVN revision 21204]
DOC (#3241): Add user manual for IGTTutorial view

[SVN revision 21205]
ADD (#3241): Added manual - image navigator

[SVN revision 21207]
DOC (#3241): undo corrupt commits that modified BasicImageProcessing instead of IGTEXample and IGTTutorial

[SVN revision 21210]
DOC (#3241): Add user manuals for IGTTutorial and IGTExample views

[SVN revision 21214]
DOC (#3241): Added manual - log view, added note - object inspector

[SVN revision 21215]
DOC (#3241): added documentation for SimpleExample functionality

Image Statistics is now open source. Needs documentation as well.

[SVN revision 21217]
DOC (#3241): Updated manual - movie maker

[SVN revision 21218]
DOC (#3241): Updated ImageCropper, IsoSurface, RegionGrowing UserManuals to the '3M3-HelpPage Format', but there was not much done on the documentation text itself yet

[SVN revision 21238]
DOC (#3241): Updated manual - movie maker

[SVN revision 21246]
DOC (#3241): Added manual - view initialization

[SVN revision 21265]
DOC (#3241): Updated manual - simple measurement, renaming files, changing layout, no content added

[SVN revision 21267]
DOC (#3241): Added manual - surface material editor

[SVN revision 21269]
DOC (#3241): Added manual - Ext Application, updated manual - datamanager includes property list now

SceneSerialization is deprecated and should already have been deleted, thus it does not need a manual.
Image Statistics does not currently work for me, but the manual for that view will be written ASAP.

[SVN revision 21290]
DOC (#3241): Unified naming scheme of modules, spaces are now used. To change the name used in the qt help you have to change the Bundle-Name in the Manifest.MF

Two new bundles:

Marcus colourimageprocessing and Ingmars igttoolpairnavigation.

Both need icons and manuals.

Are you taking care of that? Are those bundles going to change soon?

[SVN revision 21384]
DOC (#3241): Added icons

i'll write the "manual" for the colourimageprocessing bundle,
its only a test bundle meant for application developers for creating combining RGBA images.

[SVN revision 21394]
DOC (#3241): Added manual - image statistics - no screenshot

[SVN revision 21396]
DOC (#3241): Added screenshot - image statistics

[SVN revision 21577]
DOC (#3241): Incorporated changes suggested by Markus

[SVN revision 21580]
DOC (#3241): Added documentation - tool pair navigation

[SVN revision 21596]
ENH (#3241): Adding Icon for igtToolPairNavigation

[SVN revision 21886]
DOC (#3241): Changed all online icons to png, removed sample app manual, changed ext app manual to bundlemainpage to get it to show up online

Assigning to Markus Fangerau, so that he finally writes his part of the documentation.

Resetting all bugs without active assignee flag to "CONFIRMED". Change status to IN_PROGRESS if you are working on it.

Colourimageproccessing documentation has been written by Laura.