Page MenuHomePhabricator

Add a concept documentation for the data storage inspectors and the overhaul of the selection concept
Open, NormalPublic

Description

In D126#2692, @kislinsk wrote:

I noticed that it's a bit hard to understand the overall concept when dive right into a review of the essential classes. Hence I would like to suggest you to write a concept documention page about the data storage viewers. Despite the very good class documentation you already wrote, concept pages in our documentation turned out to be the number one source for understanding concepts. It would fit perfectly into "Data Concepts" I guess: http://docs.mitk.org/2016.11/Concepts.html.

It's a good point. We should add pages that explain

  • the reasoning for the new/improved (local) selection concept
    • How to use it in own widgets (the currently available selections widgets)
    • How to introduce own selection widgets/control structures (deriving from our abstract classes)
  • the data storage inspectors and their jobs
    • How to use custom inspectors the modify selections widgets (via NodeSelectionDialog and MicroServices)
    • Preference settings for NodeSelectionDialog and how to preset how a custom application handles selections.

Event Timeline

floca created this task.May 14 2018, 11:29 AM

@kalali could you be so kind and start with a draft vor the pages?

kalali claimed this task.May 17 2018, 1:36 PM
kalali triaged this task as Normal priority.May 29 2018, 2:14 PM

I added the first draft as a doxygen file. The documentation can be build and then displayed by opening the file: MITK-build/Documentation/Doxygen/html/SelectionConceptPage.html

floca added a comment.May 29 2018, 2:29 PM

Is the PDF you've sent me out dated or still valid?

Now it's out dated. I added some parts and changed some sentences. However, if you already have some comments you can send it to me and I can include them for the next commit.

kalali updated the task description. (Show Details)Nov 23 2018, 7:12 PM
kalali updated the task description. (Show Details)Dec 11 2018, 7:38 PM
kalali updated the task description. (Show Details)Dec 12 2018, 2:46 PM
kalali renamed this task from Add a concept documentation for the data storage inspectors and the overhaule of the selection concepts to Add a concept documentation for the data storage inspectors and the overhaul of the selection concept.Jan 10 2019, 3:48 PM
kalali updated the task description. (Show Details)
kalali removed kalali as the assignee of this task.Jun 14 2019, 4:02 PM