A download zip file which contains all files to reproduce the content in the videos and have own experience is contained in
Note: This file contains all javadoc and the tools immediately, because it is the first version and the here used tools are not hosted yet. The javadoc should also able to download adequate load_tools from www in later versions, so that the zip file will be very more less for future versions.
This is a experience versions, no warranty. This side will be updated time to time with newer versions.
A documentation can be viewed or downloaded in
-
LibreOfcVmlAsciiDoc.html … The same document parallel generated as Asciidoc. Here some mistakes may contain in, because while developing, it was not in focus.
This text however is originally planned and written in Asciidoc, because it is only for html.
1. First video, showing possibility for link to Javadoc
This first video (14 min) shows how dealing with links to Javadoc.html is supported. The advantage is not only, you see all links originally in the plain text, a further advantage is, that the precise link with its sophisticated internal label for an operation is automatically supplemented with the evaluation of the linked html file, so you have lesser work to do, especially on frequently changes on your software, which you want to document.
This second video (16 min) shows with another, a larger document (yet 140 pages) which formatting approaches, especially indirect formatting, are used and how it is written in the specific VML (Vishia Markup Language).
Hint for the file tree in the example: The generally approaches for the file tree are described in ../../SwEng/html/srcFileTree.html.
It means here:
Working_tree_where_zip_is_unpacked +-tools This is created after src/load_tools +-src The sources, only this directory is contained in the zip +-load_toos To load the translation tools from vishia page +-srcJava_vishiaLibreOffc It is the originally part from the source tree: | +-java contains also the sources for the tool. | +-img Thhis are the images used in the odt | +-docuSrcJava_vishiaLibreOffc this contains the generated Javadoc from the sources, | means the folder is complete as used in the software | +-odt This folder contains the documentation in libre office and the scripts to work with it | +-asciidoc This folder contains the Asciidoc stuff, it is originally | +-example This contains an empty document but with some indirect styles used here. +-odt You can copy it to write your own document. +-asciidoc and the additional Asciidoc support
How load the tools for the example:
Generally the tools are contained in https://vishia.org/Java/deploy with jar, source.zip with reproducible build approach and with an MD5-checksum.
The src/load_tools contains a batch file and a tools.bom with the correct check sum. Start the batch file one time. The minisys.jar contains the minimal effort for tool loading.
You need java (version 8 Oracle, or Open Java) to run.