ParaView
/builddir/build/BUILD/ParaView-v5.2.0-RC2/Utilities/Doxygen/pages/ProxyDocumentationFormatting.md
Go to the documentation of this file.
1 Proxy Documentation Formatting {#ProxyDocumentationFormatting}
2 ==============================
3 
4 This page describes formatting options for proxy documentation in
5 different ParaView versions (since we started tracking these after
6 version 4.2).
7 
8 Changes in 4.3
9 --------------
10 
11 ###Formatting options are added for proxy documentation###
12 Documentation for proxies (and for input properties for proxies)
13 accepts reStructured text(RST) formatting options. Supported options
14 are: **bold** (use ``**bold**``), *italic* (use ``*italic*``),
15 unordered lists, and paragraphs (use an empty line). Unordered list
16 are formatted like in the following example, with an empty line
17 before and after the list.
18 
19  - first item
20  - second item
21 
22 Nested lists are not supported. Note that the text enclosed between
23 **Documentation** tags has to be aligned at column 0, (space is
24 significant in RST documents) and that we do not accept empty lines
25 between items in an unordered list. Formatted output will be displayed
26 in ParaView online help, ParaView Python documentation, and tooltips
27 displayed in ParaView client. See the **Calculator** and **Glyph**
28 filters for examples on how to format other filters.