Quickstart for fj-doc project (Venus)
Version : 0.8.9 (fj-mod-quickstart base version is always the fj-doc version used)
Date : 2022-02-20
Venus primary goal is to provide a simple xml doc template to render documents in various formats
Documentation index:
- README
- Basic Concepts
- Static XML Source examples (fj-mod-quickstart-a-basic module):
- Dynamic free marker template examples (fj-mod-quickstart-b-freemarker module):
- QuickstartB001ProcessDocFacade - java source - free marker template
- QuickstartB002CustomFreeMarkerMethod - java source - free marker template
- QuickstartB003EmbedBase64Image - java source - free marker template
- QuickstartB004ComplexProcessStep - java source - free marker template
- QuickstartB005DocMetaData - java source - free marker template
- Advanced customization examples (fj-mod-quickstart-c-advanced module):
Project structure (maven modules) :
- fj-doc-quickstart-a-basic , basic examples with static xml doc source
- fj-doc-quickstart-b-freemarker , dynamic examples which generates xml doc source using freemarker temaples (probably the most common usage)
- fj-doc-quickstart-c-advanced , advanced features examples (for instance custom type handler)
- custom-type-handler-fop , sample custom type handler changing behaviour of fj-doc-mod-fop type handler
- custom-type-handler-markdown , sample custom type handlers from scratch, for markdown output format (both basic and extended)
- fj-doc-quickstart-demo-springboot, demo application running on spring boot (see readme)
- fj-doc-quickstart-demo-quarkus, demo application running on quarkus (see readme)
- fj-doc-quickstart-demo-wlp, demo application running on web sphere liberty (see readme)
Other useful resources :