Page MenuHomePhabricator
Create Task
Maniphest T14318

Restructure documentation
Closed, ResolvedPublic
Actions

Description

The documentation should be restructured so that new users can find the information they need more easily. The appended pdf shows a structure based on the role the user has:

  • Somebody not knowing MITK and searching information
  • Somebody wanting to use a MITK application
  • Somebody wanting to develop with MITK
    • As a toolkit
    • As a framework

Additionally the MITK meeting asked to make it possible to generate a pdf users guide comprising the documentation of at least the release relevant plugins similar to the old "Getting started" pdf.

Documentation.pdf218 KBDownload

Related Objects
Search...

StatusAssignedTask
 ResolvedNoneT14541 Extend MITK User Manual Portal page
 ResolvedNoneT14318 Restructure documentation

Event Timeline

• goch added projects: MITK, Bugzilla.Jan 22 2013, 12:24 PM
• goch added a subscriber: • goch.Jan 24 2013, 1:26 PM

Sidenote:

We should link more prominently to the examples plugins.

maerz added a subscriber: maerz.Jan 30 2013, 4:40 PM

New remote branch pushed: bug-14318-RestructureDocumentation

maerz added a comment.Feb 20 2013, 4:02 PM

The restructuring touches some core documentation files and moves some of them out of the core to better reflect the structure, so we require are core change flag. Only dox files are being touched.

• goch added a comment.Feb 20 2013, 4:20 PM

New remote branch pushed: bug-14318-RestructureDocumentation-Integration

• goch added a comment.Feb 21 2013, 9:55 AM

[2e00bf]: Merge branch 'bug-14318-RestructureDocumentation-Integration'

Merged commits:

2013-02-20 16:20:41 Caspar Goch [b3b9f2]
Moved new pages to more or less aprropriate places

2013-02-20 15:57:57 Caspar Goch [2108f6]
Merge branch 'bug-14318-RestructureDocumentation'

2013-02-20 15:55:12 Keno Maerz [8ec092]
Merge branch 'bug-14318-RestructureDocumentation' of mitk.org:MITK into bug-14318-RestructureDocumentation

2013-02-20 15:54:44 Keno Maerz [2c2716]
Reordered and explained application section

2013-02-20 15:54:23 Caspar Goch [2da46a]
Added deprecated pages to API, still at top level as well

2013-02-20 14:51:36 Caspar Goch [20e6f3]
Further cleanup of tree structure

2013-02-20 14:17:27 Caspar Goch [024f99]
Cleaned up Layout

2013-02-20 14:17:16 Caspar Goch [970bb7]
Renamed User Manual

2013-02-20 13:18:18 Caspar Goch [245a50]
Removed special characters from variable

2013-02-20 14:13:39 Keno Maerz [f022ab]
HTML fix

2013-02-20 14:12:36 Keno Maerz [9b9f5f]
Last Changes to the tree - everything should be referenced now

2013-02-13 15:49:16 Keno Maerz [7018e6]
Minor changes to Development section

2013-02-06 16:15:06 Keno Maerz [1d73b2]
First Steps, Getting to Know expandend, Moved some core docs

2013-02-06 15:53:27 Caspar Goch [59a124]
Typo

2013-02-06 15:52:20 Caspar Goch [b8650f]
Changed doxygen layout to reflect new structure

2013-02-06 15:44:20 Caspar Goch [a606d4]
Moved API to own folder for easier information separation

This will distinguish between pdf relevant information and generated or
reference information.

2013-02-06 14:56:18 Keno Maerz [726112]
Building up First steps / Getting to know

2013-02-06 14:23:37 Keno Maerz [178f88]
Growing the new tree...

2013-02-06 14:04:42 Keno Maerz [47a4f5]
Intermediate Changes

2013-01-30 15:07:38 Keno Maerz [2e2867]
Restructured Documentation. Lots of moved files. May contain dead links and orphans at this stage.

MITK · MIC · IMSY · DKFZ