diff --git a/docs/cmdline-app.rst b/docs/cmdline-app.rst index 341fdf26..59009f31 100644 --- a/docs/cmdline-app.rst +++ b/docs/cmdline-app.rst @@ -5,7 +5,7 @@ Arguments of the application ............................. The application can validate one image or compare two images. - + ========================= ===== =================================================================================== Argument Description ========================= ===== =================================================================================== --save-report -s Save report into file with the same name and with extension drep diff --git a/docs/cmdline-app.rst.orig b/docs/cmdline-app.rst.orig deleted file mode 100644 index 530e6926..00000000 --- a/docs/cmdline-app.rst.orig +++ /dev/null @@ -1,126 +0,0 @@ -Command Line Application ---------------------------------------------------------------------- - -Arguments of the application -............................. - -The application can validate one image or compare two images. - - ========================= ===== =================================================================================== -<<<<<<< HEAD - Argument Description -======= - Argument What ->>>>>>> 4adbdfdb0c6c24ee8bfdb632f30765f67a8b2484 - ========================= ===== =================================================================================== - --save-report -s Save report into file with the same name and with extension drep - --load-report -l Load report from a given file and print it in a readable form at stdout - --include-image-in-report - --save-raw-outputs -r save raw outputs from validators into files -<<<<<<< HEAD - --load-properties program will print just properties that have value 1 in the file defined by this argument -======= - --load-properties program will print just properties that has 1 in the file defined by this argument ->>>>>>> 4adbdfdb0c6c24ee8bfdb632f30765f67a8b2484 - --save-properties program will print out all known properties - --send-report-to-web -w program will send report to web - ========================= ===== =================================================================================== - -<<<<<<< HEAD -Compare report contains both validation and comparision report. - -The property list can be added to choose which properties should be printed -======= -Compare report contains of all informations from validation reports and even compare informations. - ->>>>>>> 4adbdfdb0c6c24ee8bfdb632f30765f67a8b2484 - -Example of property list definition -................................... - -:: - - Image width;1 - Image height;0 - - -<<<<<<< HEAD -Property =Image width= will be printed and =Image height= will not be printed. -======= -So property =Image width= will be printed and =Image height= will not be printed. ->>>>>>> 4adbdfdb0c6c24ee8bfdb632f30765f67a8b2484 - -Examples -......... - -Program usage -~~~~~~~~~~~~~ - -:: - -<<<<<<< HEAD - validates image, prints readable report to stdout and saves it into file image.drep - c:\> differ.bat --save-report image.jpg - - loads report from file image.drep and prints it to stdout - c:\> differ.bat --load-report image.drep - - validates images and compares it and prints report to stdout - and save it into file image1.drep and image2.drep - c:\> differ.bat --save-report image1.jpg image2.jpg - - validates images and compares it and prints report readable way to stdout - The program will print properties regarding to a file properties.lst - c:\> differ.bat --load-properties properties.lst image1.jpg image2.jpg - - The program will print properties in a format that can be used to choose properties to print in the future - c:\> differ.bat --show-properties - - -Example output: One image validation -======= - validates image, prints report readable way at stdout and saves it into file image.drep - c:\> differ.bat --save-report image.jpg - - loads report from file image.drep and prints it readable way at stdout - c:\> differ.bat --load-report image.drep - - validates images and compares it and prints report readable way at stdout - and save it into file image1.drep and image2.drep - c:\> differ.bat --save-report image1.jpg image2.jpg - - validates images and compares it and prints report readable way at stdout - The program will print properties regarding to a file properties.lst - c:\> differ.bat --load-properties properties.lst image1.jpg image2.jpg - - The program will print properties in a format that can be used to choose properties to print in future - c:\> differ.bat --show-properties - -Program output when validating image ->>>>>>> 4adbdfdb0c6c24ee8bfdb632f30765f67a8b2484 -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -.. literalinclude:: outputs/cmdline.txt - -<<<<<<< HEAD -Example output: Compare two images and validate -======= -Program output when comparing images ->>>>>>> 4adbdfdb0c6c24ee8bfdb632f30765f67a8b2484 -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -.. literalinclude:: outputs/cmdline-compare.txt - - -.. note:: - -<<<<<<< HEAD - You can see many more examples in the /docs/ folder - -.. note:: - - Developers and unix users can use the helpful bash scripts in the folder /differ-cmdline/ to run the application. The application must be compiled with Maven to the jar file before these can be run. Validation in run.sh and compare in run-two.sh. Edit the file and comment out the lines you don't want. -======= - You can see a lot of examples of metadata extractor's outputs in a directory =examples=. ->>>>>>> 4adbdfdb0c6c24ee8bfdb632f30765f67a8b2484 - diff --git a/docs/important_parts.rst b/docs/important_parts.rst deleted file mode 100644 index b1bdf99d..00000000 --- a/docs/important_parts.rst +++ /dev/null @@ -1,101 +0,0 @@ -Transformers of a external program outputs and cmdline application -.................................................................. - -Each specified output format has its own Transformer class - - https://github.com/jstavel/differ/tree/master/differ-common/src/main/java/cz/nkp/differ/compare/metadata/external - -Each tranformation has its own configuration - - https://github.com/jstavel/differ/tree/master/differ-cmdline/src/main/resources - -Main cmdline application context is - - https://github.com/jstavel/differ/blob/master/differ-cmdline/src/main/resources/appCtx-differ-cmdline.xml - -All significant properties that are recognized - - https://github.com/jstavel/differ/blob/master/differ-cmdline/src/main/resources/metadataSignificantProperties.xml - -Text report output, main class for cmdline application, various formating classes - - https://github.com/jstavel/differ/tree/master/differ-cmdline/src/main/java/cz/nkp/differ/cmdline - -Main Class, that fills list of extracted metadata and do all required reports is - - https://github.com/jstavel/differ/blob/master/differ-cmdline/src/main/java/cz/nkp/differ/cmdline/Main.java - -Structure that hold all informations being extracted from all external image metadata extractors is - - https://github.com/jstavel/differ/blob/master/differ-common/src/main/java/cz/nkp/differ/compare/io/ImageProcessorResult.java - -A piece of an image metadata is - - https://github.com/jstavel/differ/blob/master/differ-common/src/main/java/cz/nkp/differ/compare/metadata/ImageMetadata.java - - -Documentation -............. - -Documentations is written using sphinx. - - https://github.com/jstavel/differ/tree/master/docs - -A lot of examples of an cmdline application outputs - - https://github.com/jstavel/differ/tree/master/docs/examples - -A lot of files with outputs of used extractors - - https://github.com/jstavel/differ/tree/master/docs/outputs - -Example of comparison text report - - https://github.com/jstavel/differ/blob/master/docs/outputs/cmdline-compare.txt - -Example of single image text report - - https://github.com/jstavel/differ/blob/master/docs/outputs/cmdline.txt - -Examples how the extractors were used - - https://github.com/jstavel/differ/tree/master/docs/bin - - -Web application -............... - -Configurations - - https://github.com/jstavel/differ/tree/master/differ-webapp/src/main/resources - -Main sources for a web application - - https://github.com/jstavel/differ/tree/master/differ-webapp/src/main/java/cz/nkp/differ - - -Common things used both cmdline and web application -................................................... - -interfaces, classes used both applications. - -https://github.com/jstavel/differ/tree/master/differ-common - -Interfaces mainly used by transformation process - - https://github.com/jstavel/differ/tree/master/differ-common/src/main/java/cz/nkp/differ/compare/metadata/external - -.. note:: - - this important part for all transformations. - -result finishing changes - - https://github.com/jstavel/differ/tree/master/differ-common/src/main/java/cz/nkp/differ/compare/metadata/external/result - - -**Image Metadata class** - -This class holds image metadata extracted from extractors. - - https://github.com/jstavel/differ/blob/master/differ-common/src/main/java/cz/nkp/differ/compare/metadata/ImageMetadata.java diff --git a/docs/source.rst b/docs/source.rst index 783ba010..ec6ec7e8 100644 --- a/docs/source.rst +++ b/docs/source.rst @@ -2,10 +2,10 @@ General Source Code Information ------------------------------------------------------------ Differ is split into three different packages. The differ-cmdline package is used to run differ in a command line environment with export in plaintext and drep (xml) format. The differ-webapp package creates a graphical web interface for the application. The differ-common package holds all classes and resources used by both applications to extract metadata and display it. - + Each extractor tool is run with preset arguments and exported to XML. The application then transforms this data with regexp or xslt and maps it to defined properties. -Transformers of external program output +Transformers of output from external programs ...................... Main application context is @@ -28,7 +28,7 @@ At the end of transformation, some values are normalized with these classes (def Metadata ...................... -Structure that hold all informations being extracted from all external image metadata extractors is +Structure that hold all informations being extracted from all external image metadata extractors https://github.com/Differ-GSOC/differ/blob/master/differ-common/src/main/java/cz/nkp/differ/compare/io/ImageProcessorResult.java @@ -57,11 +57,7 @@ Text report output and various formating classes Web application ...................... -Configurations - - https://github.com/jstavel/differ/tree/master/differ-webapp/src/main/resources - -Main sources for a web application +Main source for web application https://github.com/jstavel/differ/tree/master/differ-webapp/src/main/java/cz/nkp/differ @@ -70,7 +66,7 @@ Main sources for a web application Documentation ...................... -Documentations is written using Sphinx +Documentation is written using Sphinx https://github.com/jstavel/differ/tree/master/docs