Page MenuHomePhabricator

Many file names in the plugins documentation folders are not unique
Closed, ResolvedPublic

Description

Currently there are many files in the documentation directories which have identical names (e.g. icon.png for [1] and [2] ). For easier creation of manuals these files should receive unique names.
Remember to change the corresponding includes in the .dox files.

[1] http://mitk.org/git/?p=MITK.git;a=tree;f=Plugins/org.mitk.gui.qt.volumevisualization/documentation/UserManual;h=ee464a48d757150a6766e0fd0928b0316103dcf9;hb=HEAD
[2] http://mitk.org/git/?p=MITK.git;a=tree;f=Plugins/org.mitk.gui.qt.moviemaker/documentation/UserManual;h=74bcac4ef610ff436b999bd79bc2ad0a9de2cdc8;hb=HEAD

Event Timeline

New remote branch pushed: bug-14879-many-filenames-in-the-plugins-documentation-folder-are-not-unique

[68de6e]: Merge branch 'bug-14879-many-filenames-in-the-plugins-documentation-fo

Merged commits:

2013-04-03 16:52:00 Tobias Hegemann [82aab6]
Renamed and replaced all references to make all files unique as recommended! :-P

[5b5ead]: Merge branch 'bug-14879-many-filenames-in-the-plugins-documentation-fo

Merged commits:

2013-04-03 17:35:15 Tobias Hegemann [b86f0c]
COMP: Reverted commit which deketed important files

This reverts commit 82aab6cca264374ccbf0931be554ef367d0d0bc0.

I've been sweet-talked into taking this bug by Caspar.

Caspar, you owe me one.

New remote branch pushed: bug-14879-PluginDocumentationFilesAreNotUnique

[fe395b]: Merge branch 'bug-14879-PluginDocumentationFilesAreNotUnique'

Merged commits:

2014-01-29 16:57:02 Keno Maerz [14e1bf]
Updated org.mitk.gui.qt.measurementtoolbox

Christ... that was a mess


2014-01-29 16:46:28 Keno Maerz [5ed691]
Updated org.mitk.gui.qt.materialeditor


2014-01-29 16:45:16 Keno Maerz [f30242]
Updated org.mitk.gui.qt.imagenavigator and fixed org.mitk.gui.qt.imagecropper


2014-01-29 16:39:27 Keno Maerz [d8232d]
Updated org.mitk.gui.qt.imagecropper


2014-01-29 16:28:34 Keno Maerz [1705d8]
Updated org.mitk.gui.qt.igttracking


2014-01-29 16:19:22 Keno Maerz [754a3c]
Deleted superfluous files in igtExamples


2014-01-29 16:07:10 Keno Maerz [1d0062]
Updated org.mitk.gui.qt.igtexamples


2014-01-29 15:59:46 Keno Maerz [0d008f]
Updated org.mitk.gui.qt.ext


2014-01-29 15:48:24 Keno Maerz [47f72a]
org.mitk.gui.qt.dicom


2014-01-29 15:41:25 Keno Maerz [068704]
Updated org.mitk.gui.qt.datamanager


2014-01-29 15:29:36 Keno Maerz [123ce7]
Updated org.mitk.gui.qt.cmdlinemodules


2014-01-29 15:18:45 Keno Maerz [48f7a9]
Updated org.mitk.gui.qt.basicimageprocessing

I worked down the plugins alphabetically, the last one today was org.mitk.gui.qt.measurementtoolbox. I standardized File Naming in the following way:

  1. PluginDocumentation is named QmitkPluginName.dox
  2. View name is ViewName.dox
  3. All image files are named QmitkPluginName_ImageName, disregarding which view they are documented in

All names are written in CamelCase

In this run, I'm only fixing the UserManual folders. Resurces folders are currently untouched

New remote branch pushed: bug-14879-PluginDocumentationFilesAreNotUniquePart2

[008b2f]: Merge branch 'bug-14879-PluginDocumentationFilesAreNotUniquePart2'

Merged commits:

2014-02-12 16:18:24 Keno Maerz [10a44b]
Fixed Missing Logo in Ultrasound Plugin


2014-02-12 16:15:51 Keno Maerz [32a5c8]
Updated VolumeVisualization Plugin


2014-02-12 16:09:09 Keno Maerz [a085e5]
Updated Ultrasound Plugin


2014-02-12 15:59:42 Keno Maerz [40a551]
Registration Updated


2014-02-12 15:04:40 Keno Maerz [198744]
Remashing Updated


2014-02-12 14:55:14 Keno Maerz [4d815a]
Fixed Wrong Filename in pointsetinteractor plugin


2014-02-12 14:52:18 Keno Maerz [4b2fff]
Updated org.mitk.gui.gt.registration


2014-02-05 14:50:35 Keno Maerz [57a44b]
org.mitk.gui.qt.python


2014-02-05 14:49:00 Keno Maerz [c5c701]
updated org.mitk.gui.qt.pointsetinteraction


2014-02-05 14:45:18 Keno Maerz [5224c3]
updated org.mitk.gui.qt.moviemaker


2014-02-05 14:29:56 Keno Maerz [02008a]
Updated org.mitk.gui.qt.meshdecimation

Filenames should no all be unique and following this standard:

  1. PluginDocumentation is named QmitkPluginName.dox
  2. View name is ViewName.dox
  3. All image files are named QmitkPluginName_ImageName, disregarding which view they are documented in

All names are written in CamelCase