On 2022-10-17 Oliver Rettig wrote: 
> I also want to integrate a help-viewer as on offline viewer into the
rcp-app by invoking a browser but I also want to push to a online- available
documentation maybe into a docuwiki page.

Besides docuwiki consider also Docusaurus (Markdown + React). 

> what functionality you would like to see

For real use cases the source format should support:
- inserting unique IDs to offer the context-sensitive functionality
- ability to mark specific keywords as non-translatable In the case of
localizing
- ability to insert an alternative text for inserted images (accessibility)

For tools developed in our company (non-NB modules), all documentation is
written in XML (DocBook). Using XSLT you can get anything from it - either
customize default outputs or create custom ones from the scratch (we use
tailored outputs for the online portal or e-learning). But it requires
custom development and maintenance (e.g. when rebranding). A similar concept
offers DITA XML, which is rather topic-oriented (a set of topics is later
composed into larger units). That DITA approach is similar to your goal:
individual independent units get collected into the final collection. For
generating conventional outputs like HTML or PDF there is
https://www.dita-ot.org/ In sum, I can imagine if every unit has its DITA
topic, it should be then easy to generate help for the complete set. And if
you would manage to transform DITA to markdown, you could build in parallel
Docusaurus help for online use. 

Jan


---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscr...@netbeans.apache.org
For additional commands, e-mail: dev-h...@netbeans.apache.org

For further information about the NetBeans mailing lists, visit:
https://cwiki.apache.org/confluence/display/NETBEANS/Mailing+lists



Reply via email to