WriteOdt

java.lang.Object
- org.vishia.odt.readOdt.TranslateOdtCommon
- - org.vishia.odt.readOdt.WriteOdt

public class WriteOdt
extends TranslateOdtCommon

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

private static class WriteOdt.Cfg

static class WriteOdt.CmdArgs

static class WriteOdt.DirPrepareJavadoc
- Nested classes/interfaces inherited from class org.vishia.odt.readOdt.TranslateOdtCommon
  TranslateOdtCommon.CommonArgs

Nested Classes
Modifier and Type	Class and Description
`private static class`	`WriteOdt.Cfg`
`static class`	`WriteOdt.CmdArgs`
`static class`	`WriteOdt.DirPrepareJavadoc`

Field Summary

Fields
Modifier and Type	Field and Description
`(package private) WriteOdt.CmdArgs`	`args`
`(package private) boolean`	`bColumnBreakBefore` True then a "'''" was seen before.
`(package private) boolean`	`bInsideCode`
`(package private) boolean`	`bInsideColumn2`
`(package private) boolean`	`bInsideListItem` true then a <text:list-item...
`(package private) boolean`	`bPage2Start`
`(package private) boolean`	`bPageBreakBefore` True then a "'''" was seen before.
`(package private) boolean`	`bParagrFirstline` true only immediately after set <text:p ...>
`(package private) boolean`	`bSetNrChapter` Set `nrChapter` from ZmL should only done one time, then this flag should be set to false.
`(package private) WriteOdt.Cfg`	`cfg`
`(package private) java.util.Map<java.lang.String,ReadOdt.LabelRef>`	`idxChnrExternRef` Same content as `idxLabelExternRef` but sorted to document and chapter number to write out `writeExternReferences()`.
`(package private) java.util.Map<java.lang.String,ReadOdt.LabelRef>`	`idxLabelExternRef` Index of all book marks of related docu suite (adequate option -labels:*.Labels.text) filled from this files.
`(package private) java.util.Map<java.lang.String,java.lang.String>`	`idxLabelIntern`
`private java.lang.String`	`lastAnchorReplaced` The last anchor which is replaced for operation arguments.
`(package private) int`	`nList` >=1 then the deepness of nesting list nodes.
`(package private) int[]`	`nrChapter`
`(package private) int`	`nrFrameImgName`
`(package private) int`	`nrSectionName`
`(package private) int`	`nrTableName`
`(package private) int`	`nSection` >=1 then the deepness of nesting section nodes.
`(package private) java.io.BufferedReader`	`rZmL`
`(package private) java.lang.StringBuilder`	`sbo`
`(package private) static java.lang.String[]`	`sCheckTextReplZmL` Builds the search Strings for replacing from ZmL to character in `sTextReplace` [0].
`(package private) java.lang.String`	`sCodeStyle` If set (not null) then the next lines till "----" should be written as <text:p...
`(package private) java.lang.String`	`sInclude` If !=null then this is the label after '__PART_...' to include another file.
`(package private) java.lang.String`	`sLineNext` Last read line from aDoc.
`private static java.lang.String[]`	`specificLineStarts`
`(package private) java.lang.String`	`sRefBookmark` It is set if a ref to bookmark was created.
`(package private) java.lang.String`	`sStyleParagr` If not null then a `[.style] was read.`
`(package private) java.util.Stack<java.io.BufferedReader>`	`stack_rAdoc`
`(package private) static java.lang.String[][]`	`sTextCtrlCommon`
`(package private) static java.lang.String[]`	`sTextCtrlCommonSearchAsciidoc` Contains the Strings to search in Markup source to replace with function or style..
`(package private) static java.lang.String[]`	`sTextCtrlCommonSearchMu` Contains the Strings to search in Markup source to replace with function or style..
`(package private) static java.lang.String[][]`	`sTextReplace` Replacement of special characters.
`(package private) static java.lang.String[][]`	`sTextReplaceAsciidoc` This Strings are replaced from Asciidoc to LibreOffice.
`(package private) static java.lang.String`	`sTextReplaceChars` Single characters to replace with `sTextReplace` proper for StringFunctions#
`(package private) static java.lang.String[]`	`sWwwLink`
`(package private) java.lang.String`	`sXXXLabel` Stores a [#label] for the next header or paragraph.
`static java.lang.String`	`version` Version, history and license.
`private java.io.Writer`	`wrRep`
`(package private) org.vishia.xmlReader.XmlCfg`	`xmlCfgOdt`
`(package private) org.vishia.xmlSimple.XmlSequWriter`	`xmlWr`

Fields inherited from class org.vishia.odt.readOdt.TranslateOdtCommon
javadocLabel, log

Constructor Summary

Constructors
Modifier Constructor and Description

protected WriteOdt(WriteOdt.CmdArgs args)
Note: close of LogMessageStream as in amain(CmdArgs) where this instance is constructed.

Constructors
Modifier	Constructor and Description
`protected`	`WriteOdt(WriteOdt.CmdArgs args)` Note: close of LogMessageStream as in `amain(CmdArgs)` where this instance is constructed.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static int`	`amain(WriteOdt.CmdArgs args)` main for this class, with given prepared arguments Does not catch unexpected exceptions and does not System.exit(...), use it to execute in a Java environment.
`private java.io.File`	`checkAndChangeFileImage(java.lang.String[] sLinkUse, java.io.File dirOdt, java.lang.String sLink, java.lang.String sTitle)`
`private static boolean`	`checkIndentation(int nrIndent, int nrofSpacesIndent, int posTag, java.lang.String sLine)` Checks whether the line has the requested indentation, in cohesion with searching a tag.
`private java.lang.String`	`checkParseCommentLine(java.lang.String line)`
`private java.lang.String`	`checkReplaceLinkOperationLabel(java.lang.String sRef)`
`void`	`execute()`
`private void`	`finitList(int nList)`
`private void`	`finitSection(int toLevel)`
`private void`	`includeSrcCode(java.lang.String sLineInclArg, java.lang.String sCodeStyle)` Includes lines from a source file.
`private boolean`	`isEmptyLine(java.lang.String line, int fromPos)`
`static void`	`main(java.lang.String[] sArgs)` main for WriteOdt, invoked from cmd line.
`protected java.lang.String`	`parseAdocLine(java.lang.String line)` Parse a new line for paragraph etc, not the continued lines from a paragraph.
`private java.lang.String`	`parseAdocM(java.lang.String line)` Parse a new line for paragraph etc, not the continued lines from a paragraph.
`private java.lang.String`	`parseImage(java.lang.String args, boolean bOnlyImage)` Writes an image with given arguments from the text <:image:....>
`private java.lang.String`	`parseList(java.lang.String line)`
`private java.lang.String`	`parseTableRow(java.lang.String line)`
`private java.lang.String`	`parseWriteCodeBlock(java.lang.String sStartLine)` Writes a block as code, write each line as extra <text:p....
`private java.lang.String`	`parseWriteParagr(java.lang.String line, java.lang.String sLabel)`
`private java.lang.String`	`parseWriteParagrStyleLabel(java.lang.String line)`
`private java.lang.String`	`parseWriteSection(java.lang.String line)`
`private java.lang.String`	`parseWriteTable(java.lang.String line)`
`private java.lang.String`	`parseWriteText(java.lang.CharSequence clineArg, boolean bIndentSpaces)` Analyzes the given line where interpretation are necessrary, and writes it with <:text:span...
`void`	`parseZmlWriteOdt()`
`private java.lang.StringBuilder`	`readAllTextLinesOfParagraph(java.lang.String sLineStart)` Reads all text lines till empty line or till specific such as "* " for a list.
`private int`	`readHeaderNr(java.lang.String line, int zLine, int pos0, int nHeader)` Reads the number before the chapter title (header).
`private void`	`readLabelFile(java.io.File fLabel, java.lang.String nameRefFile)`
`private void`	`readOwnLabels()`
`private java.lang.CharSequence`	`replaceBackslasSubscription(java.lang.CharSequence txtArg, java.lang.StringBuilder sbTextArg, boolean bReplaceToAscii, boolean bRemoveSpace)` Replace the ZmL specific backslash subscription by the specific UTF16 character to save in odg.
`void`	`searchFirstHeaderLine()` This is called one time on start of the main file.
`private void`	`showArguments()`
`static int`	`smain(java.lang.String[] sArgs, java.lang.Appendable logHelp, java.lang.Appendable logError)` main gets the arguments as String, but does not catch unexpected exceptions and does not System.exit(...), use it to execute in a Java environment.
`private boolean`	`switchToInclude(java.lang.String sFileArg)` Switches to the file to include due to Label '__PART_Name' or __PART_RD_Name'
`private void`	`writeChapterRef(java.lang.String refArg)` Writes a link to a chapter due to <@ref:Label:....>.
`private void`	`writeChapterRefExtern(java.lang.String sRefZmL, ReadOdt.LabelRef labelRef)` Writes links to pdf and html www and local in the following form: '>>docu.pdf[] >>1.2 Chapter page 23' Whereas: The first '>>' contains the pdf link to www, if given, else '>>' is not written.
`private void`	`writeExternReferences()` Writes a list of external references with the labels.
`private java.lang.String`	`writeHeaderLine(java.lang.String lineArg)`
`private void`	`writeInternalRefPage(java.lang.String sRefArg)` Writes a page reference due to given <:@page:sRef.>
`private boolean`	`writeJavadocLink(java.lang.CharSequence textw, java.lang.String styleChars)` Writes a link to a Javadoc/...html entry.
`private void`	`writeLink(java.lang.String sLink)`
`private java.lang.String`	`writeSectionEnd(java.lang.String line)`
`private int`	`writeSpaceSupplement(java.lang.CharSequence spaces)`
`private void`	`writeStyleSections()`
`private java.lang.String`	`writeTableOfContents(java.lang.String line)`
`private java.lang.String`	`writeText(java.lang.CharSequence txtArg, boolean bNewline)` Writes the pure text to XML, whereby spaces are replaced by <text:s...> and also \n and \t are replaced by elements <text:line-break/> and <text:tab/> as necessary in LibreOffice See also `#parseWriteText(String)`
`private void`	`wrRep(java.lang.CharSequence line)`

Methods inherited from class org.vishia.odt.readOdt.TranslateOdtCommon
getLinkFileFromURL, getLinkNameFromURL, searchForReplacingLinkOperationLabel, writeBackupFile

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - version
```
public static final java.lang.String version
```
    Version, history and license.
    - 2024-12-13 bug: It has often missing a page break on a new included chapter. Hartmut fix: searchFirstHeaderLine() now new, called only on the main file to detect the first line which starts with "=" in ZmL. This should not done if parseZmlWriteOdt() is started again after an included file. The cause was, that this has skipped the '<::pageBreak.>' line in the main file because continued with the next chapter content.
    - 2024-12-13 cleanup: #XXXfinitParagr() and #XXXnParagr removed, really without functionality.
    - 2024-05-29 Hartmut creation. Necessity to handle Libre Office writer content.
    Copyright/Copyleft: For this source the LGPL Lesser General Public License, published by the Free Software Foundation is valid. It means:
    1. You can use this source without any restriction for any desired purpose.
    2. You can redistribute copies of this source to everybody.
    3. Every user of this source, also the user of redistribute copies with or without payment, must accept this license for further using.
    4. But the LPGL ist not appropriate for a whole software product, if this source is only a part of them. It means, the user must publish this part of source, but don't need to publish the whole source of the own product.
    5. You can study and modify (improve) this source for own using or for redistribution, but you have to license the modified sources likewise under this LGPL Lesser General Public License. You mustn't delete this Copyright/Copyleft inscription in this source file.
    If you are intent to use this sources without publishing its usage, you can get a second license subscribing a special contract with the author.
    See Also:
    
    Constant Field Values
  - args
```
final WriteOdt.CmdArgs args
```
  - cfg
```
final WriteOdt.Cfg cfg
```
  - xmlCfgOdt
```
final org.vishia.xmlReader.XmlCfg xmlCfgOdt
```
  - rZmL
```
java.io.BufferedReader rZmL
```
  - stack_rAdoc
```
java.util.Stack<java.io.BufferedReader> stack_rAdoc
```
  - sLineNext
```
java.lang.String sLineNext
```
    Last read line from aDoc.
  - sStyleParagr
```
java.lang.String sStyleParagr
```
    If not null then a [.style] was read. Valid for the next paragraph.
  bParagrFirstline boolean bParagrFirstline true only immediately after set <text:p ...> nSection int nSection >=1 then the deepness of nesting section nodes. nList int nList >=1 then the deepness of nesting list nodes. bInsideListItem boolean bInsideListItem true then a <text:list-item... is opened in the moment. bPageBreakBefore boolean bPageBreakBefore True then a "'''" was seen before. It is in html an horizontal line. It means the next paragraph makes a page break or column break: bColumnBreakBefore boolean bColumnBreakBefore True then a "'''" was seen before. It is in html an horizontal line. It means the next paragraph makes a page break or column break: bInsideColumn2 boolean bInsideColumn2 bPage2Start boolean bPage2Start nrSectionName int nrSectionName nrTableName int nrTableName nrFrameImgName int nrFrameImgName bSetNrChapter boolean bSetNrChapter Set nrChapter from ZmL should only done one time, then this flag should be set to false. nrChapter int[] nrChapter idxLabelIntern java.util.Map<java.lang.String,java.lang.String> idxLabelIntern idxLabelExternRef java.util.Map<java.lang.String,ReadOdt.LabelRef> idxLabelExternRef Index of all book marks of related docu suite (adequate option -labels:*.Labels.text) filled from this files. See readLabelFile(File, String). This index is used for writeChapterRef(String) and writeInternalRefPage(String) to write the external link. idxChnrExternRef java.util.Map<java.lang.String,ReadOdt.LabelRef> idxChnrExternRef Same content as idxLabelExternRef but sorted to document and chapter number to write out writeExternReferences(). sCodeStyle java.lang.String sCodeStyle If set (not null) then the next lines till "----" should be written as <text:p... with this style. It is for code snippets. bInsideCode boolean bInsideCode sRefBookmark java.lang.String sRefBookmark It is set if a ref to bookmark was created. Use the same bookmark to create a page ref. sXXXLabel java.lang.String sXXXLabel Stores a [#label] for the next header or paragraph. sInclude java.lang.String sInclude If !=null then this is the label after '__PART_...' to include another file. It is also used as bookmark for the first chapter title of the included file. sbo final java.lang.StringBuilder sbo wrRep private java.io.Writer wrRep lastAnchorReplaced private java.lang.String lastAnchorReplaced The last anchor which is replaced for operation arguments. xmlWr final org.vishia.xmlSimple.XmlSequWriter xmlWr specificLineStarts private static java.lang.String[] specificLineStarts sTextReplace static java.lang.String[][] sTextReplace Replacement of special characters. [0]https://op.europa.eu/de/web/eu-vocabularies/formex/physical-specifications/character-encoding/quotation-marks [1] the subscription in ZmL [1] subscription in Asciidoc [3] subscription using for technical paths, "x"=use as given in [0], " " can be removed in a file system path. sTextReplaceChars static java.lang.String sTextReplaceChars Single characters to replace with sTextReplace proper for StringFunctions# sTextReplaceAsciidoc static java.lang.String[][] sTextReplaceAsciidoc This Strings are replaced from Asciidoc to LibreOffice. It means if Asciidoc contains it, they will be replaced with the UTF-16 character or UTF-8 used for LibreOffice but they are not replaced backward. It means for generated Asciidoc UTF-8 should be used in editor and files. sCheckTextReplZmL static java.lang.String[] sCheckTextReplZmL Builds the search Strings for replacing from ZmL to character in sTextReplace [0]. sTextCtrlCommon static java.lang.String[][] sTextCtrlCommon sTextCtrlCommonSearchMu static java.lang.String[] sTextCtrlCommonSearchMu Contains the Strings to search in Markup source to replace with function or style.. It is the sTextCtrlCommon[...][0] sTextCtrlCommonSearchAsciidoc static java.lang.String[] sTextCtrlCommonSearchAsciidoc Contains the Strings to search in Markup source to replace with function or style.. sWwwLink static java.lang.String[] sWwwLink
Constructor Detail WriteOdt protected WriteOdt(WriteOdt.CmdArgs args) Note: close of LogMessageStream as in amain(CmdArgs) where this instance is constructed. This closes also a given TranslateOdtCommon.CommonArgs.fLog because of call LogMessageStream(java.io.OutputStream, java.io.OutputStream, Appendable, Appendable, boolean, Charset) with trut for argument closeOnClose. Parameters: args - Method Detail amain public static int amain(WriteOdt.CmdArgs args) throws java.io.IOException main for this class, with given prepared arguments Does not catch unexpected exceptions and does not System.exit(...), use it to execute in a Java environment. Parameters: args - prepared cmd line arguments Returns: 0 if all is ok Throws: java.io.IOException java.lang.Exception - if unexpected. smain public static int smain(java.lang.String[] sArgs, java.lang.Appendable logHelp, java.lang.Appendable logError) throws java.io.IOException main gets the arguments as String, but does not catch unexpected exceptions and does not System.exit(...), use it to execute in a Java environment. Parameters: sArgs - Returns: 0 if all is ok Throws: java.io.IOException java.lang.Exception - if unexpected. main public static void main(java.lang.String[] sArgs) main for WriteOdt, invoked from cmd line. Catch and report an unexpected exceptions via console error output, returns an exit code Parameters: sArgs - wrRep private void wrRep(java.lang.CharSequence line) throws java.io.IOException Throws: java.io.IOException execute public void execute() throws java.io.IOException Throws: java.io.IOException showArguments private void showArguments() switchToInclude private boolean switchToInclude(java.lang.String sFileArg) throws java.io.IOException Switches to the file to include due to Label '__PART_Name' or __PART_RD_Name' Parameters: sFileArg - the line after the label '__PART_' or '__PART_RD_', start of file name Returns: false if the file to include is not found. Then should continue with the given chaper header. Throws: java.io.IOException readOwnLabels private void readOwnLabels() throws java.io.IOException Throws: java.io.IOException readLabelFile private void readLabelFile(java.io.File fLabel, java.lang.String nameRefFile) writeStyleSections private void writeStyleSections() throws java.io.IOException Throws: java.io.IOException searchFirstHeaderLine public void searchFirstHeaderLine() throws java.io.IOException This is called one time on start of the main file. It searches the first line starting with "=", which is the title or the first header line. Throws: java.io.IOException parseZmlWriteOdt public void parseZmlWriteOdt() throws java.io.IOException Throws: java.io.IOException parseAdocLine protected java.lang.String parseAdocLine(java.lang.String line) throws java.io.IOException Parse a new line for paragraph etc, not the continued lines from a paragraph. Parameters: line - found line Returns: Throws: java.io.IOException parseAdocM private java.lang.String parseAdocM(java.lang.String line) throws java.io.IOException Parse a new line for paragraph etc, not the continued lines from a paragraph. Parameters: line - found line Returns: Throws: java.io.IOException isEmptyLine private boolean isEmptyLine(java.lang.String line, int fromPos) writeHeaderLine private java.lang.String writeHeaderLine(java.lang.String lineArg) throws java.io.IOException Throws: java.io.IOException readHeaderNr private int readHeaderNr(java.lang.String line, int zLine, int pos0, int nHeader) Reads the number before the chapter title (header). If bSetNrChapter is true, then the read number is written to nrChapter, but with -1 subtracted because it will be incremented. This is the numbering of the first chapter in this odt. After detection the first chapter in first ZmL, bSetNrChapter is set to false. Then, all other chapters are incremented and set back to 0 if a parent chapter is offered. Parameters: line - the header line with '=== 2.3.4 Title' from ZmL zLine - line length pos0 - Position after '===' as start nHeader - The number of '===', nHeader ==0 for one '=', for the title. Returns: the position of begin of header title after numbers, '.' and spaces checkParseCommentLine private java.lang.String checkParseCommentLine(java.lang.String line) throws java.io.IOException Throws: java.io.IOException parseWriteSection private java.lang.String parseWriteSection(java.lang.String line) throws java.io.IOException Throws: java.io.IOException writeSectionEnd private java.lang.String writeSectionEnd(java.lang.String line) throws java.io.IOException Throws: java.io.IOException parseWriteParagrStyleLabel private java.lang.String parseWriteParagrStyleLabel(java.lang.String line) throws java.io.IOException Throws: java.io.IOException parseWriteParagr private java.lang.String parseWriteParagr(java.lang.String line, java.lang.String sLabel) throws java.io.IOException Parameters: line - This is only the start (first) line. All other lines will be read here calling readAllTextLinesOfParagraph(String) sLabel - null or a label (bookmark) for this paragraph TODO not implemented yet. Returns: Throws: java.io.IOException parseList private java.lang.String parseList(java.lang.String line) throws java.io.IOException Throws: java.io.IOException readAllTextLinesOfParagraph private java.lang.StringBuilder readAllTextLinesOfParagraph(java.lang.String sLineStart) throws java.io.IOException Reads all text lines till empty line or till specific such as "* " for a list. Parameters: sLineStart - The first line. Returns: StringBuilder with all lines. A read line which is not used is stored in sLineNext for using for the next paragraph, especially a list. Throws: java.io.IOException parseWriteText private java.lang.String parseWriteText(java.lang.CharSequence clineArg, boolean bIndentSpaces) throws java.io.IOException Analyzes the given line where interpretation are necessrary, and writes it with <:text:span... > in the given line, writes the text with #writeText(String, boolean) outside interpreations stuff. Which is regarded: see sTextCtrlCommon, #sTextCtrlItalicBold, #sTextCtrlStyleForItalicBold. The WriteOdt.Cfg.useItalicBold decides whether __textInItalic__ etc. is outputted as indirect style italic or as direct style "Quotation". Both is possible. Parameters: line - Returns: Throws: java.io.IOException writeJavadocLink private boolean writeJavadocLink(java.lang.CharSequence textw, java.lang.String styleChars) throws java.io.IOException Writes a link to a Javadoc/...html entry. It writes '>>Class#element' whereby under ">>" the www-link is written, and under the "Class#element" the locale link is written. The given short label in ZmL is expanded to the correct target label in the html target file, using the known and analyzed Javadoc.html files. Parameters: textw - the "Class" or "Class#element" itself styleChars - "cJ" as style definition Returns: Throws: java.io.IOException writeSpaceSupplement private int writeSpaceSupplement(java.lang.CharSequence spaces) throws java.io.IOException Throws: java.io.IOException writeChapterRef private void writeChapterRef(java.lang.String refArg) throws java.io.IOException Writes a link to a chapter due to <@ref:Label:....>. It checkes idxLabelExternRef idxChnrExternRef Parameters: refArg - Throws: java.io.IOException writeChapterRefExtern private void writeChapterRefExtern(java.lang.String sRefZmL, ReadOdt.LabelRef labelRef) throws java.io.IOException Writes links to pdf and html www and local in the following form: '>>docu.pdf[] >>1.2 Chapter page 23' Whereas: The first '>>' contains the pdf link to www, if given, else '>>' is not written. The 'docu.pdf' is a Hyperlink to the local file, or without Hyperlink if a local file is not given. The [] is a hidden text with '@ref#sRefZmL' with the given sRefZml. The second '>>' is the link of the given www html file inclusively the intern label. It is the same label is in '[]'. Under the '1.2 Chapter' the link to a local html file is hyperlinked. Parameters: sRefZmL - reference as given in ZmL after '@ref:#' without leading '#' labelRef - Throws: java.io.IOException writeInternalRefPage private void writeInternalRefPage(java.lang.String sRefArg) throws java.io.IOException Writes a page reference due to given <:@page:sRef.> Parameters: sRef - can be empty or only consist of a max 3-digit number, then it is ignored, instead the reference use on last called writeChapterRef(String) is used here also. This is sensible if the <:@page:.> follows after the <:@ref:sRef:Title.>. If sRef is given, it can be used only for a page reference without reference text. Throws: java.io.IOException writeLink private void writeLink(java.lang.String sLink) throws java.io.IOException Throws: java.io.IOException checkReplaceLinkOperationLabel private java.lang.String checkReplaceLinkOperationLabel(java.lang.String sRef) writeText private java.lang.String writeText(java.lang.CharSequence txtArg, boolean bNewline) throws java.io.IOException Writes the pure text to XML, whereby spaces are replaced by <text:s...> and also \n and \t are replaced by elements <text:line-break/> and <text:tab/> as necessary in LibreOffice See also #parseWriteText(String) Parameters: txtArg - bNewline - Returns: Throws: java.io.IOException replaceBackslasSubscription private java.lang.CharSequence replaceBackslasSubscription(java.lang.CharSequence txtArg, java.lang.StringBuilder sbTextArg, boolean bReplaceToAscii, boolean bRemoveSpace) Replace the ZmL specific backslash subscription by the specific UTF16 character to save in odg. Parameters: txtArg - If given use it. If it is a StringBuilder, use it already for return. sbTextArg - If given use it. Returns: text with specific UTF16 chars. For the content.xml there will be replaced in the specific XML way. It is either txtArg as String, if no changes are done, or txtArg as given as StringBuilder, in the Stringbuilder changes or made; or it is the given sbTextArg which may be changed if txtArg is not a StringBuilder. parseWriteCodeBlock private java.lang.String parseWriteCodeBlock(java.lang.String sStartLine) throws java.io.IOException Writes a block as code, write each line as extra <text:p.... The content of lines are evaluated with #parseWriteText(String). It means, also here character mark up (span) and character replacements (#replaceBackslasSubscription(CharSequence, StringBuilder) are also done here. A line starting with <:include:PATH/TO/File::tag> includes a source part, see #includeSrcCode(String). Parameters: sStartLine - first line of code block, containing the <:Code.... Returns: Throws: java.io.IOException includeSrcCode private void includeSrcCode(java.lang.String sLineInclArg, java.lang.String sCodeStyle) throws java.io.IOException Includes lines from a source file. Syntax example: <::include:../path/to/src::TAG::44::4:marker,6:-,8:+,10:-.> Syntax in ZBNF: includeCode::=\<::include:<*|::?PATH>::<*|::?TAG> [::<#?LineWidth>][::-<*|::?removeComment>] [{[+<?nextLine>]<#?LINE>[,<#?COLUMN>][:<*:\.?MARKER>?::}]:;. It means: PATH is the path from the ZmL file to the source, usual starting with ../../path/to/source.c 'TAG' is the tag searched in the source. If TAG=="$" then the source is taken from the first line. if TAG starts with ' (ASCII 0x27, apostrophe), then a text in the source is searched as start tag and this text is not suppressed. LineWidth is the max line length, src lines are shorten and ends with ... if necessary. This is optional, if not given 44 is taken. ::-//:: if this is written after the LineWidth, then removes empty lines and only comment lines and comments in the line, which starts with the given String removeComment, here with //. This is sensible if the comment in code is irritating, because the code is commented in docu by the markers. The part in [{....}] is an optional repetition of: LINE A line number starting from 1 for the showed line in the docu (with the start tag) optional COLUMN for the column of the marker: MARKER after a colon: If the MARKER is '-' (written "...::12:-" then the code shown is switched off from this line. If the MARKER is '+' (written "...::12:+" then the code shown is switched on again from this line. Else: The marker is shown in docu with this text on this line and column. ?, means: The combination of LINE[,COLUMN}:MARKER can be repeated with comma as separator. For the TAG a sub syntax is valid: Examples: <::include:../path/to/source.c::startTAG::80.> includes the lines from <::startTag> to <.startTag> with a line width of max 80 character. <::include:../path/to/source.c::'code text'::80::16:-.> includes from the line which contains "code text", 16 lines. Source: <::TAG.> If contains anywhere in the line, this is the first line to get. <::~TAG.> If contains anywhere in the line, the next line is the first line to get. <.TAG.> Marked with this, it is the last line to contain, then include is stopped. <.~TAG.> Marked with this, from this line include is stopped. <:-TAG> This line and following are omitted and replaced by " ....." <:+TAG> from this line insertion is recovered Markers can also contain in the source in the form <:marker.> Examples: <::include:../path/to/source.c::startTAG::80.> includes the lines from <::startTag> to <.startTag> with a line width of max 80 character. <::include:../path/to/source.c::'code text'::80::16:-.> includes from the line which contains "code text", 16 lines. <::include:../path/to/source.c::'code text'::80::4:MARKER::16:-.> as above, writes on end of line 4 "MARKER" <::include:../path/to/source.c::'code text'::80::4:MARKER::7,25:M2::16:-.> as above, writes in line 7 column 25 "M2" Parameters: sLineIncl - Throws: java.io.IOException checkIndentation private static boolean checkIndentation(int nrIndent, int nrofSpacesIndent, int posTag, java.lang.String sLine) Checks whether the line has the requested indentation, in cohesion with searching a tag. Parameters: nrIndent - number of indentation levels required nrofSpacesIndent - number of spaces presents one indentation level posTag - sLine - Returns: writeTableOfContents private java.lang.String writeTableOfContents(java.lang.String line) throws java.io.IOException Throws: java.io.IOException writeExternReferences private void writeExternReferences() throws java.io.IOException Writes a list of external references with the labels. For that the odt should contain the paragraph styles 'ExternRefTitle' and 'ExternRefList'. It is not necessary and only activated with the command line option '-extRefs'. The information are also contained in the files due to the option '-labels:*.Labels.txt'. Throws: java.io.IOException finitList private void finitList(int nList) throws java.io.IOException Throws: java.io.IOException finitSection private void finitSection(int toLevel) throws java.io.IOException Throws: java.io.IOException parseWriteTable private java.lang.String parseWriteTable(java.lang.String line) throws java.io.IOException Throws: java.io.IOException parseTableRow private java.lang.String parseTableRow(java.lang.String line) throws java.io.IOException Throws: java.io.IOException parseImage private java.lang.String parseImage(java.lang.String args, boolean bOnlyImage) throws java.io.IOException Writes an image with given arguments from the text <:image:....> Parameters: args - starts with the path to the image, contains all after "<:image:" bOnlyImage - true then the paragraph contains only the image. Note in LibreOffice an image is always embedded in a paragraph. Returns: null if no error Throws: java.io.IOException checkAndChangeFileImage private java.io.File checkAndChangeFileImage(java.lang.String[] sLinkUse, java.io.File dirOdt, java.lang.String sLink, java.lang.String sTitle)

Class WriteOdt

Nested Class Summary

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

Field Summary

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

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Field Detail

version

args

cfg

xmlCfgOdt

rZmL

stack_rAdoc

sLineNext

sStyleParagr

bParagrFirstline

nSection

nList

bInsideListItem

bPageBreakBefore

bColumnBreakBefore

bInsideColumn2

bPage2Start

nrSectionName

nrTableName

nrFrameImgName

bSetNrChapter

nrChapter

idxLabelIntern

idxLabelExternRef

idxChnrExternRef

sCodeStyle

bInsideCode

sRefBookmark

sXXXLabel

sInclude

sbo

wrRep

lastAnchorReplaced

xmlWr

specificLineStarts

sTextReplace

sTextReplaceChars

sTextReplaceAsciidoc

sCheckTextReplZmL

sTextCtrlCommon

sTextCtrlCommonSearchMu

sTextCtrlCommonSearchAsciidoc

sWwwLink

Constructor Detail

WriteOdt

Method Detail

amain

smain

main

wrRep

execute

showArguments

switchToInclude

readOwnLabels

readLabelFile

writeStyleSections

searchFirstHeaderLine

parseZmlWriteOdt

parseAdocLine

parseAdocM

isEmptyLine

writeHeaderLine

readHeaderNr

checkParseCommentLine

parseWriteSection

writeSectionEnd

parseWriteParagrStyleLabel

parseWriteParagr

parseList

readAllTextLinesOfParagraph

parseWriteText