Project

General

Profile

task #8555

Updated by Andreas Kohlbecker over 4 years ago

1. research on suitable document formats 
 1. documentation within the taxeditor would be preferrable (see [[Meeting_2019-09-07]]: 
     * In-App_Doku im Taxeditor: (see #8555) 
         * via Tooltips 
         * F1 --> Eclipse RCP Helpsystem 
         * Export als PDF 

 ---- 

 The eclipse help system supports multiple document formats, of which [DocBook](https://docbook.org/) is the most versatile format. 

 Documentations created in DocBook can be modularized (http://www.sagehill.net/docbookxsl/ModularDoc.html). Books can be assembled from individual chapter files whereas chapters can be hierarchically nested at arbitrary levels. Specific parts of a chapter can be included and repeating of the same content at various places is possible. So called xml-catalog-files map virtual to real file locations. This could for example be useful to provide the location of release/develop files.   

 Even if DocBook files are XML files, some editors exist which allow editing these files in a word processor like style: 

 * [Vex](https://www.eclipse.org/vex/) 
 * OpenOffice 

 ### Potential workflow to convert docx files into modularized DocBook xml files 

 Tools: 

 * LibreOffice Writer (Version: 6.0.7.3) 
     * Extract embedded images and replace embedded images with linked images: [PicExtract - 1.0](https://extensions.libreoffice.org/extensions/extract-embedded-images-and-replace-embedded-images-with-linked-images-picextract)

Back