Skip to content

Commit 341cef4

Browse files
Jon Haitz Legarreta Gorroñothewtex
authored andcommitted
STYLE: Rework the folder structure and rename files.
Rework the folder structure of the LaTeX SW Guide files: create folders to host the *.tex files for each part: - Introduction - Architecture - DevelopmentGuidelines - DesignAndFunctionality - Appendices Rename the files to remove the part acronym and chapter number. Move "Iterators" and "Image Adaptors" chapters from "Development Guidelines" part to "Architecture". As per KWStyle, remove new lines in excess at the end of files. Change-Id: Ifa5346a657d607bb349ed0be23bc6e78b7df4199
1 parent 4dc9598 commit 341cef4

40 files changed

+67
-188
lines changed

SoftwareGuide/Latex/AP02-CodingStyleGuide.tex renamed to SoftwareGuide/Latex/Appendices/CodingStyleGuide.tex

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -349,7 +349,7 @@ \section{Citations}
349349
not use URL shortening services.
350350

351351
When documenting a class header, if citations are required, use the Doxygen
352-
\code{\par References} command to list the references in a separate and clearly
352+
\code{\\par References} command to list the references in a separate and clearly
353353
visible paragraph.
354354

355355
For instance,

SoftwareGuide/Latex/DG02-ImageAdaptors.tex renamed to SoftwareGuide/Latex/Architecture/ImageAdaptors.tex

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -87,4 +87,3 @@ \section{Adaptors and Writers}
8787
this circumstances is incorrect. You should avoid instantiating the
8888
\code{ImageFileWriter} or the \code{ImageSeriesWriter} over an image adaptor
8989
type.
90-

SoftwareGuide/Latex/CMakeLists.txt

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -78,21 +78,21 @@ set( Book1_Tex_SRCS
7878
02-Cover-Book1.tex
7979
03-Abstract-Book1.tex
8080
## Introduction
81-
I01-Introduction.tex
82-
I02-Installation.tex
81+
./Introduction/Introduction.tex
82+
./Introduction/Installation.tex
8383
## Architecture
84-
A01-SystemOverview.tex
85-
A02-DataRepresentation.tex
86-
A03-SpatialObjects.tex
84+
./Architecture/SystemOverview.tex
85+
./Architecture/DataRepresentation.tex
86+
./Architecture/SpatialObjects.tex
87+
./Architecture/Iterators.tex
88+
./Architecture/ImageAdaptors.tex
8789
## Development Guidelines
88-
DG01-Iterators.tex
89-
DG02-ImageAdaptors.tex
90-
DG03-WriteAFilter.tex
91-
DG04-CreateAModule.tex
92-
DG05-SoftwareProcess.tex
90+
./DevelopmentGuidelines/WriteAFilter.tex
91+
./DevelopmentGuidelines/CreateAModule.tex
92+
./DevelopmentGuidelines/SoftwareProcess.tex
9393
## Appendix
94-
AP01-Licenses.tex
95-
AP02-CodingStyleGuide.tex
94+
./Appendices/Licenses.tex
95+
./Appendices/CodingStyleGuide.tex
9696
)
9797

9898
set( Book2_Tex_SRCS
@@ -102,24 +102,24 @@ set( Book2_Tex_SRCS
102102
02-Cover-Book2.tex
103103
03-Abstract-Book2.tex
104104
## Design and Functionality
105-
DF01-IO.tex
106-
DF02-Filtering.tex
107-
#A03a-AnisotropicDiffusionFiltering.tex
108-
DF03-Registration.tex
109-
DF04-Segmentation.tex
110-
DF05-Statistics.tex
105+
./DesignAndFunctionality/IO.tex
106+
./DesignAndFunctionality/Filtering.tex
107+
#./DesignAndFunctionality/AnisotropicDiffusionFiltering.tex
108+
./DesignAndFunctionality/Registration.tex
109+
./DesignAndFunctionality/Segmentation.tex
110+
./DesignAndFunctionality/Statistics.tex
111111
)
112112

113113
set( Tex_SRCS
114114
## -- HACK TODO
115115
#set NOT_YET_SRCS # This needs to be added one at a time as they are cleaned up
116-
ImageMetrics.tex
117-
ImageInterpolators.tex
118-
Transforms.tex
116+
./DesignAndFunctionality/ImageMetrics.tex
117+
./DesignAndFunctionality/ImageInterpolators.tex
118+
./DesignAndFunctionality/Transforms.tex
119119
Visualization.tex
120-
WatershedSegmentation.tex
120+
./DesignAndFunctionality/WatershedSegmentation.tex
121121

122-
DG06-MarketingMaterial.tex
122+
MarketingMaterial.tex
123123
)
124124

125125
set( SoftwareGuide_Book1_Tex_SRCS "" )

SoftwareGuide/Latex/ConfidenceConnectedOnBrainWeb.tex renamed to SoftwareGuide/Latex/DesignAndFunctionality/ConfidenceConnectedOnBrainWeb.tex

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,5 +21,3 @@ \subsubsection{Application of the Confidence Connected filter on the Brain Web D
2121
\itkcaption[Axial, sagittal, and coronal slice of Confidence Connected segmentation.]{Axial, sagittal and coronal slice segmented using Confidence Connected region growing.}
2222
\label{fig:SlicesBrainWeb}
2323
\end{figure}
24-
25-

0 commit comments

Comments
 (0)