Skip to content

Commit 4746709

Browse files
authored
Update CZIcmd usage documentation for clarity (ZEISS#160)
* Update CZIcmd usage documentation for clarity Reformatted the `CZIcmd` usage instructions to improve readability and consistency. Updated the `code-block` directive from `bash` to `console` for better context. Enhanced alignment, spacing, and formatting of command descriptions and examples. Ensured the help text matches the updated format. No functional changes were made; updates are limited to documentation and presentation. * review * Improve CLI help text and usage docs formatting Refactor the help text for the --rect/-r option in code and documentation for better readability and clarity, especially regarding relative and absolute coordinates. Update czicmd_usage.rst to libCZI version 0.67.3 and reformat several option descriptions for consistency and improved user experience. No functional changes to program behavior.
1 parent da3d7dc commit 4746709

File tree

2 files changed

+253
-252
lines changed

2 files changed

+253
-252
lines changed

Src/CZICmd/cmdlineoptions.cpp

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -639,7 +639,7 @@ CCmdLineOptions::ParseResult CCmdLineOptions::Parse(int argc, char** argv)
639639
"Specifies the property-bag used for creating the stream used for reading the source CZI-file. The data is given in JSON-notation.")
640640
->option_text("PROPBAG");
641641
cli_app.add_option("-o,--output", argument_output_filename,
642-
"specifies the output-filename. A suffix will be appended to the name given here depending on the type of the file.")
642+
"Specifies the output-filename. A suffix will be appended to the name given here depending on the type of the file.")
643643
->option_text("OUTPUTFILE");
644644
// editorconfig-checker-disable
645645
cli_app.add_option("-p,--plane-coordinate", argument_plane_coordinate,
@@ -651,7 +651,7 @@ CCmdLineOptions::ParseResult CCmdLineOptions::Parse(int argc, char** argv)
651651
// editorconfig-checker-disable
652652
cli_app.add_option("-r,--rect", argument_rect,
653653
R"(Select a paraxial rectangular region as the region-of-interest. The coordinates may be given either absolute or relative. If using relative
654-
coordinates, they are relative to what is determined as the upper-left point in the document.\nRelative coordinates are specified with
654+
coordinates, they are relative to what is determined as the upper-left point in the document. \nRelative coordinates are specified with
655655
the syntax 'rel([x],[y],[width],[height])', absolute coordinates are specified 'abs([x],[y],[width],[height])'.
656656
\nExamples: rel(0, 0, 1024, 1024), rel(-100, -100, 500, 500), abs(-230, 100, 800, 800).)")
657657
->option_text("ROI")
@@ -665,7 +665,7 @@ CCmdLineOptions::ParseResult CCmdLineOptions::Parse(int argc, char** argv)
665665
cli_app.add_flag("-t,--drawtileboundaries", argument_drawtileboundaries, "Draw a one-pixel black line around each tile.");
666666
cli_app.add_option("-j,--jpgxrcodec", argument_jpgxrcodec,
667667
"Choose which decoder implementation is used. Specifying \"WIC\" will request the Windows-provided decoder - which "
668-
"is only available on Windows.By default the internal JPG-XR-decoder is used.")
668+
"is only available on Windows. By default the internal JPG-XR-decoder is used.")
669669
->option_text("DECODERNAME")
670670
->check(jpgxr_codec_validator);
671671
cli_app.add_option("-v,--verbosity", argument_verbosity,
@@ -676,13 +676,13 @@ CCmdLineOptions::ParseResult CCmdLineOptions::Parse(int argc, char** argv)
676676
->check(verbosity_validator);
677677
cli_app.add_option("-b,--background", argument_backgroundcolor,
678678
"Specify the background color. BACKGROUND is either a single float or three floats, separated by a comma or semicolon. In case of "
679-
"a single float, it gives a grayscale value, in case of three floats it gives a RGB - value.The floats are given normalized to a range "
679+
"a single float, it gives a grayscale value, in case of three floats it gives a RGB - value. The floats are given normalized to a range "
680680
"from 0 to 1.")
681681
->option_text("BACKGROUND")
682682
->check(background_color_validator);
683683
cli_app.add_option("-y,--pyramidinfo", argument_pyramidinfo,
684684
"For the command 'SingleChannelPyramidTileAccessor' the argument PYRAMIDINFO specifies the pyramid layer. It consists of two "
685-
"integers(separated by a comma, semicolon or pipe-symbol), where the first specifies the minification-factor (between pyramid-layers) and "
685+
"integers (separated by a comma, semicolon or pipe-symbol), where the first specifies the minification-factor (between pyramid-layers) and "
686686
"the second the pyramid-layer (starting with 0 for the layer with the highest resolution).")
687687
->option_text("PYRAMIDINFO")
688688
->check(pyramidinfo_validator);
@@ -742,7 +742,7 @@ CCmdLineOptions::ParseResult CCmdLineOptions::Parse(int argc, char** argv)
742742
->option_text("CZI-File-GUID")
743743
->check(guidofczi_validator);
744744
cli_app.add_option("--bitmapgenerator", argument_bitmapgenerator,
745-
"Only used for 'CreateCZI': specifies the bitmap-generator to use. Possibly values are \"gdi\", \"freetype\", \"null\" or \"default\". "
745+
"Only used for 'CreateCZI': specifies the bitmap-generator to use. Possible values are \"gdi\", \"freetype\", \"null\" or \"default\". "
746746
"Run with argument '--version' to get a list of available bitmap-generators.")
747747
->option_text("BITMAPGENERATORCLASSNAME")
748748
->check(bitmapgenerator_validator);
@@ -753,7 +753,7 @@ CCmdLineOptions::ParseResult CCmdLineOptions::Parse(int argc, char** argv)
753753
->check(createsubblockmetadata_validator);
754754
cli_app.add_option("--compressionopts", argument_compressionoptions,
755755
"Only used for 'CreateCZI': a string in a defined format which states the compression-method and (compression-method specific) "
756-
"parameters.The format is \"compression_method: key=value; ...\". It starts with the name of the compression-method, followed by a colon, "
756+
"parameters. The format is \"compression_method: key=value; ...\". It starts with the name of the compression-method, followed by a colon, "
757757
"then followed by a list of key-value pairs which are separated by a semicolon. Examples: \"zstd0:ExplicitLevel=3\", \"zstd1:ExplicitLevel=2;PreProcess=HiLoByteUnpack\".")
758758
->option_text("COMPRESSIONDESCRIPTION")
759759
->check(compressionoptions_validator);

0 commit comments

Comments
 (0)