{# ------------------------------------------------------------------- template for module_formatter.py for LaTeX output (Ansible Booklet) by Jan-Piet Mens. Note: nodes & code examples are omitted on purpose. -------------------------------------------------------------------- #} %--- @{ module | upper }@ ---- from @{ filename }@ --- %: -- module header \mods{@{module}@}{@{docuri}@}{ {% for desc in description -%} @{ desc | jpfunc }@ {% endfor -%} {% if version_added is defined -%} (\I{* new in version @{ version_added }@}) {% endif -%} } %: -- module options {% if options %} \begin{xlist}{abcdefghijklmno} {% for (opt,v) in options.iteritems() %} {% if v['required'] %} \item[\man\,\C{@{ opt }@}] {% else %} \item[\opt\,\C{@{ opt }@}] {% endif %} {# -------- option description ----------#} {% for desc in v.description %} @{ desc | jpfunc }@ {% endfor %} {% if v['choices'] %} \B{Choices}:\, {% for choice in v['choices'] %}\C{@{ choice }@}{% if not loop.last %},{% else %}.{% endif %} {% endfor %} {% endif %} {% if v['default'] %} (default \C{@{ v['default'] }@}) {% endif %} {% if v['version_added'] is defined %} (\I{* version @{ v['version_added'] }@}) {% endif %} {% endfor %} \end{xlist} {% endif %} {# --------------------------------------- {% if notes %} {% for note in notes %} \I{@{ note | jpfunc }@} {% endfor %} {% endif %} ----------------------------- #} {#------------------------------------------- {% if examples is defined -%} {% for e in examples %} \begin{extymeta} @{ e['code'] }@ \end{extymeta} {% endfor %} {% endif %} ----------------------------------- #} {% if extradata is defined %} %--- BEGIN-EXTRADATA \begin{extymeta} @{ extradata }@ \end{extymeta} %----- END-EXTRADATA {% endif %}