Difference between revisions of "Naming Conventions"

Revision as of 15:17, 19 November 2014

This page is about naming conventions of application and module source directories and build artifacts.

Situation until 2013.12

Until MITK 2013.12 there was no official naming scheme, resulting in a mix of different styles.

Source tree

Applications/
  CoreApp
  mitkWorkbench

Modules/
  CameraCalibration
  MitkAlgorithmsExt
  Qmitk
  QmitkExt
  QmlMitk

Build artifacts

Current build artifacts in MITK-build/bin:

ImageExtractionTestDriver
MitkTestDriver
mitkCameraCalibrationTestDriver

mitkWorkbench
CoreApp
mitkIGTTutorialStep1
Step1

libConnectomics.so
libMitkAlgorithmsExt.so
libmitkCameraCalibration.so
libQmitk.so
libQmlMitk.so
...

Change proposal

No "mitk" string in source tree directories. There is no need to state that a module or appication belongs to "mitk", since it is already contained in the MITK source tree.
All build artifacts and module names are prefixed with "Mitk" (the prefix will be configurable for external projects). Module names are visible from external projects and should carry a prefix identifying the project where the module is hosted. The same is true for build artifact names like shared library names.
Qt dependent module directories and module names are prefixed with "Qt" or "Qml" (some modules will need to be renamed). They will then also additionally get the "Mitk" prefix.

New source tree layout

Applications/
  CoreApp
  Workbench  ← previously "mitkWorkbench"

Modules/
  CameraCalibration
  AlgorithmsExt      ← previously "MitkAlgorithmsExt"
  QtWidgets          ← previously "Qmitk"
  QtWidgetsExt       ← previously "QmitkExt"
  QmlWidgets         ← previously "QmlMitk"

New build artifact naming

New build artifacts in MITK-build/bin:

MitkImageExtractionTestDriver      ← previously "ImageExtractionTestDriver"
MitkTestDriver
MitkCameraCalibrationTestDriver    ← previously "mitkCameraCalibrationTestDriver"

MitkWorkbench                      ← previously "mitkWorkbench"
MitkCoreApp                        ← previously "CoreApp"
MitkIGTTutorialStep1               ← previously "mitkIGTTutorialStep1"
MitkStep1                          ← previously "Step1"

libMitkConnectomics.so             ← previously "libConnectomics.so"
libMitkAlgorithmsExt.so
libMitkCameraCalibration.so        ← previously "libmitkCameraCalibration.so"
libMitkQtWidgets.so                ← previously "libQmitk.so"
libMitkQmlWidgets.so               ← previously "libQmlMitk.so"

@@ Line 1: / Line 1: @@
 __NOTOC__
-= Naming Conventions =
 This page is about naming conventions of application and module source directories and build artifacts.
 == Situation until 2013.12 ==
@@ Line 8: / Line 8: @@
 Until MITK 2013.12 there was no official naming scheme, resulting in a mix of different styles.
-==== Source tree ====
+=== Source tree ===
@@ Line 25: / Line 26: @@
-==== Build artifacts ====
+=== Build artifacts ===
 Current build artifacts in MITK-build/bin:
@@ Line 55: / Line 56: @@
 # Qt dependent module directories and module names are prefixed with "Qt" or "Qml" (some modules will need to be renamed). They will then also additionally get the "Mitk" prefix.
-==== New source tree layout ====
+=== New source tree layout ===
 <pre><nowiki>
 Applications/
    CoreApp
-   Workbench  <-- previously "mitkWorkbench"
+   Workbench  &larr; previously "mitkWorkbench"
 Modules/
    CameraCalibration
-   AlgorithmsExt      <-- previously "MitkAlgorithmsExt"
+   AlgorithmsExt      &larr; previously "MitkAlgorithmsExt"
-   QtWidgets          <-- previously "Qmitk"
+   QtWidgets          &larr; previously "Qmitk"
-   QtWidgetsExt       <-- previously "QmitkExt"
+   QtWidgetsExt       &larr; previously "QmitkExt"
-   QmlWidgets         <-- previously "QmlMitk"
+   QmlWidgets         &larr; previously "QmlMitk"
 </nowiki></pre>
-==== New build artifact naming ====
+=== New build artifact naming ===
 New build artifacts in MITK-build/bin:
@@ Line 78: / Line 79: @@
 <pre><nowiki>
-MitkImageExtractionTestDriver      <-- previously "ImageExtractionTestDriver"
+MitkImageExtractionTestDriver      &larr; previously "ImageExtractionTestDriver"
 MitkTestDriver
-MitkCameraCalibrationTestDriver    <-- previously "mitkCameraCalibrationTestDriver"
+MitkCameraCalibrationTestDriver    &larr; previously "mitkCameraCalibrationTestDriver"
-MitkWorkbench                      <-- previously "mitkWorkbench"
+MitkWorkbench                      &larr; previously "mitkWorkbench"
-MitkCoreApp                        <-- previously "CoreApp"
+MitkCoreApp                        &larr; previously "CoreApp"
-MitkIGTTutorialStep1               <-- previously "mitkIGTTutorialStep1"
+MitkIGTTutorialStep1               &larr; previously "mitkIGTTutorialStep1"
-MitkStep1                          <-- previously "Step1"
+MitkStep1                          &larr; previously "Step1"
-libMitkConnectomics.so             <-- previously "libConnectomics.so"
+libMitkConnectomics.so             &larr; previously "libConnectomics.so"
 libMitkAlgorithmsExt.so
-libMitkCameraCalibration.so        <-- previously "libmitkCameraCalibration.so"
+libMitkCameraCalibration.so        &larr; previously "libmitkCameraCalibration.so"
-libMitkQtWidgets.so                <-- previously "libQmitk.so"
+libMitkQtWidgets.so                &larr; previously "libQmitk.so"
-libMitkQmlWidgets.so               <-- previously "libQmlMitk.so"
+libMitkQmlWidgets.so               &larr; previously "libQmlMitk.so"
 </nowiki></pre>