updated help texts

This commit is contained in:
jstaerk
2022-05-05 17:45:27 +02:00
parent 53882fe185
commit 7108ecdc92

View File

@@ -51,54 +51,54 @@ public class Main {
private static String getUsage() {
return "Usage: --action metrics|combine|extract|a3only|ubl|validate|validateExpectInvalid|validateExpectValid|visualize [-d,--directory] [-l,--listfromstdin] [-i,--ignore fileextension, PDF/A errors] | [-h,--help] \r\n"
+ " --action=license display open source license and notice\n"
+ " --action=metrics\n"
+ " --action license display open source license and notice\n"
+ " --action metrics\n"
+ " -d, --directory count ZUGFeRD files in directory to be scanned\n"
+ " If it is a directory, it will recurse.\n"
+ " -l, --listfromstdin count ZUGFeRD files from a list of linefeed separated files on runtime.\n"
+ " It will start once a blank line has been entered.\n" + "\n"
+ " Additional parameter for both count operations\n"
+ " [-i, --ignorefileextension] Check for all files (*.*) instead of PDF files only (*.pdf) in metrics, ignore PDF/A input file errors in combine\n"
+ " --action=extract extract Factur-X PDF to XML file\n"
+ " --action extract extract Factur-X PDF to XML file\n"
+ " Additional parameters (optional - user will be prompted if not defined)\n"
+ " [--source=<filename>]: set input PDF file\n"
+ " [--out=<filename>]: set output XML file\n"
+ " --action=a3only upgrade from PDF/A1 to A3 only (no ZUGFeRD data attached)\n"
+ " [--source <filename>]: set input PDF file\n"
+ " [--out <filename>]: set output XML file\n"
+ " --action a3only upgrade from PDF/A1 to A3 only (no ZUGFeRD data attached)\n"
+ " Additional parameters (optional - user will be prompted if not defined)\n"
+ " [--source=<filename>]: set input PDF file\n"
+ " [--out=<filename>]: set output PDF file\n"
+ " --action=combine combine XML and PDF file to Factur-X PDF file\n"
+ " [--source <filename>]: set input PDF file\n"
+ " [--out <filename>]: set output PDF file\n"
+ " --action combine combine XML and PDF file to Factur-X PDF file\n"
+ " Additional parameters (optional - user will be prompted if not defined)\n"
+ " [--source=<filename>]: set input PDF file\n"
+ " [--source-xml=<filename>]: set input XML file\n"
+ " [--out=<filename>]: set output PDF file\n"
+ " [--source <filename>]: set input PDF file\n"
+ " [--source-xml <filename>]: set input XML file\n"
+ " [--out <filename>]: set output PDF file\n"
+ " [--format <fx|zf|ox>]: set Factur-X, ZUGFeRD or Order-X\n"
+ " [--version <1|2>]: set ZUGFeRD version\n"
+ " [--profile <...>]: set ZUGFeRD profile\n"
+ " For ZUGFeRD v1: <B>ASIC, <C>OMFORT or EX<T>ENDED\n"
+ " For ZUGFeRD v1 or Order-X: <B>ASIC, <C>OMFORT or EX<T>ENDED\n"
+ " For ZUGFeRD v2: <M>INIMUM, BASIC <W>L, <B>ASIC, <C>IUS, <E>N16931, <X>Rechnung, EX<T>ENDED\n"
+ " [--attachments=<filenames>]: list of file attachments (passing a single empty file name prevents prompting)\n"
+ " --action=ubl convert UN/CEFACT 2016b CII XML to UBL XML\n"
+ " [--attachments <filenames>]: list of file attachments (passing a single empty file name prevents prompting)\n"
+ " --action ubl convert UN/CEFACT 2016b CII XML to UBL XML\n"
+ " [--source <filename>]: set input XML file\n"
+ " [--out <filename>]: set output XML file\n"
+ " --action=upgrade upgrade ZUGFeRD XML to ZUGFeRD 2 XML\n"
+ " --action upgrade upgrade ZUGFeRD XML to ZUGFeRD 2 XML\n"
+ " Additional parameters (optional - user will be prompted if not defined)\n"
+ " [--source <filename>]: set input XML ZUGFeRD 1 file\n"
+ " [--out <filename>]: set output XML ZUGFeRD 2 file\n"
+ " --action=validate validate XML or PDF file \n"
+ " --action validate validate XML or PDF file \n"
+ " [--no-notices]: refrain from reporting notices\n"
+ " [--logAppend=<text>]: text to be added to log line\n"
+ " [--logAppend <text>]: text to be added to log line\n"
+ " Additional parameters (optional - user will be prompted if not defined)\n"
+ " [--source=<filename>]: input PDF or XML file\n"
+ " --action=validateExpectInvalid validate directory expecting negative results \n"
+ " [--source <filename>]: input PDF or XML file\n"
+ " --action validateExpectInvalid validate directory expecting negative results \n"
+ " [--no-notices]: refrain from reporting notices\n"
+ " Additional parameters (optional - user will be prompted if not defined)\n"
+ " -d, --directory to check recursively\n"
+ " --action=validateExpectValid validate directory expecting positive results \n"
+ " --action validateExpectValid validate directory expecting positive results \n"
+ " [--no-notices]: refrain from reporting notices\n"
+ " Additional parameters (optional - user will be prompted if not defined)\n"
+ " -d, --directory to check recursively \n"
+ " --action=visualize convert XML to HTML \n"
+ " --action visualize convert XML to HTML \n"
+ " [--source <filename>]: set input XML file\n"
+ " [--out <filename>]: set output HTML file\n"
;
@@ -340,7 +340,6 @@ public class Main {
// create Options object
Options options = new Options();
options.addOption(new Option("h", "help",false, "display usage"));
options.addOption(new Option("a", "action",true, "which action to perform"));
options.addOption(new Option("f", "format",true, "which format to output"));
@@ -358,13 +357,13 @@ public class Main {
options.addOption(new Option("", "directory",true, "which directory to operate on"));
options.addOption(new Option("i", "ignorefileextension",false, "ignore non-matching file extensions"));
options.addOption(new Option("l", "listfromstdin",false, "take list of files from commandline"));
boolean optionsRecognized=false;
String action = "";
try {
cmd = parser.parse(options, args);
// Retrieve all options
String action = cmd.getOptionValue("action");
action = cmd.getOptionValue("action");
String directoryName = cmd.getOptionValue("directory");
Boolean filesFromStdIn = cmd.hasOption("listfromstdin");//((Number)cmdLine.getParsedOptionValue("integer-option")).intValue();
Boolean ignoreFileExt = cmd.hasOption("ignorefileextension");
@@ -381,9 +380,10 @@ public class Main {
String[] attachmentFilenames = cmd.hasOption("attachments") ? cmd.getOptionValues("attachments") : null;
ArrayList<FileAttachment> attachments=new ArrayList <>();
boolean optionsRecognized=false;
ArrayList<FileAttachment> attachments=new ArrayList <>();
if (helpRequested) {
printHelp();
optionsRecognized=true;
@@ -418,6 +418,11 @@ public class Main {
} else if ((action!=null)&&(action.equals("validateExpectInvalid"))) {
optionsRecognized=performValidateExpect(false, directoryName);
}
} catch (UnrecognizedOptionException ex) {
optionsRecognized=false;
}
if (!optionsRecognized){
// no argument or argument unknown
printUsage();