Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migration of unmigrated content due to installation of a new plugin

toc-local

Introduction

jgendoc generates HTML documentation based on flattened profile settings. The output is suitable for documenting the system and queues.

Usage

No Format
usage: jgendoc [<options>]-p <profile>

Load profile and generate document for configuration.

Options:
--fmt <fmt>         Output format. Default is html.
--namespaces <name>[,...]
                    Provide information for namespaces. Default is request.
--skip-title        Do not output a title.
--toc-code <html>   Insert table of contents snippet at the very top
                    of the page.

Examples

Generate document:

No Format
jgendoc -p gpsc1

Add a TOC snippet for Confluence:

No Format
jgendoc -p gpsc1 --skip-title --toc-code '<div><b>Contents</b><div><ac:macro ac:name="toc" /></div></div>'

Notes:

  • Added at the very top of the page.
  • Use --skip-title to disable generation of an H1 level page title. Confluence provides the page title itself.
  • The "Contents" heading is also provided.
  • The standard "toc" macro is used.