Include selection keyword details in user guide
authorTeemu Murtola <teemu.murtola@gmail.com>
Wed, 20 May 2015 10:34:47 +0000 (13:34 +0300)
committerGerrit Code Review <gerrit@gerrit.gromacs.org>
Sun, 24 May 2015 14:45:43 +0000 (16:45 +0200)
commit59731e2a4c0b1a8c75a7f3d7598495141989204e
tree39317ac06b981c1a73ff42ff4fef8957d3ccd8bc
parentfbf83958e6e7503300677b1904c7fcd5f81eebea
Include selection keyword details in user guide

- Make 'gmx help -export rst' write out the detailed selection keyword
  help as subsections of the keywords topic.
- Separate the titles from the help texts to make it possible to format
  the title separately.
- Make synopsis formatting the same for each keyword details help topic.
- Make HelpWriterContext not write leading empty lines to console output
  when the help text starts with a literal block.
- Remove unnecessary stars from the keyword lists in the
  reStructuredText output.

Some minor cleanup of the formatting could be done, but otherwise this
closes #679.

Change-Id: Id91ce3c01e9dd5f1c068498217dbc536a712c231
14 files changed:
src/gromacs/onlinehelp/helpwritercontext.cpp
src/gromacs/onlinehelp/tests/helpwritercontext.cpp
src/gromacs/onlinehelp/tests/refdata/HelpWriterContextTest_FormatsLiteralTextAtBeginning.xml [new file with mode: 0644]
src/gromacs/selection/selhelp.cpp
src/gromacs/selection/selmethod.h
src/gromacs/selection/sm_compare.cpp
src/gromacs/selection/sm_distance.cpp
src/gromacs/selection/sm_insolidangle.cpp
src/gromacs/selection/sm_keywords.cpp
src/gromacs/selection/sm_merge.cpp
src/gromacs/selection/sm_permute.cpp
src/gromacs/selection/sm_position.cpp
src/gromacs/selection/sm_same.cpp
src/gromacs/selection/sm_simple.cpp