org.vishia.odt.readOdt

Class WriteOdt.CmdArgs

java.lang.Object

org.vishia.util.Arguments

org.vishia.odt.readOdt.TranslateOdtCommon.CommonArgs

org.vishia.odt.readOdt.WriteOdt.CmdArgs

Enclosing class:

WriteOdt

public static class WriteOdt.CmdArgs
extends TranslateOdtCommon.CommonArgs

Nested Class Summary

Nested classes/interfaces inherited from class org.vishia.odt.readOdt.TranslateOdtCommon.CommonArgs

TranslateOdtCommon.CommonArgs.DirName

Nested classes/interfaces inherited from class org.vishia.util.Arguments

org.vishia.util.Arguments.Argument, org.vishia.util.Arguments.SetArgument

Field Summary

Fields

Modifier and Type	Field and Description
(package private) org.vishia.util.Arguments.Argument[]	argList1 This array describes the commands with its help and stores the result to CmdArgs.
(package private) boolean	bReadAdoc True then read adoc, false specific markup.
(package private) boolean	bRenameImageFiles If true then it tries to rename an image with that name which is given in title.
(package private) boolean	bWriteExternRefs Default false, set to true with -extRefs.
(package private) java.io.File	dirCreateCfgJavaData If true then call GenXmlCfgJavaData with the used existing XmlCfg.
(package private) java.io.File	dirDbg
(package private) java.io.File	fCfg A configuartion file to read.
(package private) java.io.File	fDirOdt
(package private) java.io.File	fOdtStyles
(package private) java.io.File	fOutOdt
(package private) java.io.File	fOutXml An XML file to write.
(package private) java.io.File	fRptClassesJavadoc from '-reportJavadocClasses:path/to/file' to write out the list of supported classes for JavaDoc detection.
(package private) java.io.File	fWriteXmlStruct If true then write with the only one read #fIn a new analyzed XmlCfg to this file.
(package private) java.util.List<WriteOdt.DirPrepareJavadoc>	listDirJavadoc from '-javadoc:', contains paths which directories should be regard in JavaDoc
(package private) float	pixelPerPageWidth
(package private) java.lang.String	swwwRoot If a www link starts with this, replace also the absolute link if an anchor is replaced.

Fields inherited from class org.vishia.odt.readOdt.TranslateOdtCommon.CommonArgs

argListCommon, bBackAll, dirIn, dirLabel, dirOutBack, dirZml, fIn, fLog, fReport, sCurrDir, sDirSrcCmpn, sExtOut, sExtRefBesideHtml, sExtRefBesidePdf, sExtZmL, sNameDoc, sNameLabel, sRefBesideHtml, sRefBesideInWWWHtml, sRefBesideInWWWPdf, sRefBesidePdf

Fields inherited from class org.vishia.util.Arguments

aboutInfo, exitCodeArgError, helpInfo, sVersion

Constructor Summary

Constructors

Constructor and Description
CmdArgs()

Method Summary

Modifier and Type	Method and Description
boolean	testConsistence(java.lang.Appendable msg)

Methods inherited from class org.vishia.odt.readOdt.TranslateOdtCommon.CommonArgs

getDirNameReplaceSrcCmpn, getDirRepaceSrcCmpn, setCurrDir

Methods inherited from class org.vishia.util.Arguments

aboutInfo, addArg, addArgs, checkArg, checkArgVal, errMsg, getEnv, getLogLevel, getLogPath, parseArgs, parseArgs, readArguments, readConfig, readConfig, replaceEnv, showHelp, testArgument

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

dirDbg

java.io.File dirDbg

fOdtStyles

java.io.File fOdtStyles

bReadAdoc

boolean bReadAdoc

True then read adoc, false specific markup.

fCfg

java.io.File fCfg

A configuartion file to read.

fDirOdt

java.io.File fDirOdt

fOutOdt

java.io.File fOutOdt

fOutXml

java.io.File fOutXml

An XML file to write.

swwwRoot

java.lang.String swwwRoot

If a www link starts with this, replace also the absolute link if an anchor is replaced.

dirCreateCfgJavaData

java.io.File dirCreateCfgJavaData

If true then call GenXmlCfgJavaData with the used existing XmlCfg.

fWriteXmlStruct

java.io.File fWriteXmlStruct

If true then write with the only one read #fIn a new analyzed XmlCfg to this file.

listDirJavadoc

java.util.List<WriteOdt.DirPrepareJavadoc> listDirJavadoc

from '-javadoc:', contains paths which directories should be regard in JavaDoc

fRptClassesJavadoc

java.io.File fRptClassesJavadoc

from '-reportJavadocClasses:path/to/file' to write out the list of supported classes for JavaDoc detection.

pixelPerPageWidth

float pixelPerPageWidth

bRenameImageFiles

boolean bRenameImageFiles

If true then it tries to rename an image with that name which is given in title. This is helpful for example if an exporter writes "Img12.png" with current number and the images should have a proper name.

bWriteExternRefs

boolean bWriteExternRefs

Default false, set to true with -extRefs. Decides to write a list of all extern references to related docu. This is currently not recommended. This information are also available in the *.Labels.txt files, see TranslateOdtCommon.CommonArgs.dirLabel and argument -labels:...

argList1

org.vishia.util.Arguments.Argument[] argList1

This array describes the commands with its help and stores the result to CmdArgs. More is not necessary.

Since:

2023-09-23 moved from org.vishia.fbcl.readSmlk.GenSmlk2FBcl, there was using the older concept with org.vishia.mainCmd.MainCmd.Arguments now proper to Arguments. This list is possible, alternatively to direct instantiating in ctor.

Constructor Detail

CmdArgs

CmdArgs()

Method Detail

testConsistence

public boolean testConsistence(java.lang.Appendable msg)

Specified by:

testConsistence in class org.vishia.util.Arguments