Project

General

Profile

Task #679

g_select documentation should be included in the manual

Added by Mark Abraham almost 9 years ago. Updated over 4 years ago.

Status:
Closed
Priority:
Normal
Assignee:
Category:
documentation
Target version:
Difficulty:
uncategorized
Close

Description

I think the help text that is available interactively in g_select should also be in the manual. If it is planned that g_select will still be around by next release (5, or 4.5.4, whichever) then I'll adapt the manual Makefile to include that help text.

I seem to recall that you wrote g_select, Teemu. Can you comment please?


Related issues

Related to GROMACS - Task #666: Improve help printing in the command-line runnerClosed01/14/2011
Blocked by GROMACS - Feature #969: Generating man pages, html help etc. from OptionsClosed07/12/2012

Associated revisions

Revision 57ecfc60 (diff)
Added by Teemu Murtola over 4 years ago

Add subsection depth to HelpWriterContext

Necessary for exporting, e.g., the selection help as rst (#679), and
cleans up the code by making more output go through HelpWriterContext
instead of directly writing to the output file.

Also, reorganize the way help topic titles are written: HelpManager is
now responsible for writing out the title for a topic. This makes
things behave the same as with HelpWriterContext::createSubSection().

Change-Id: If7e0ee6d4c9dd313e1523fa457f64cf3c4f891f9

Revision 53270aa5 (diff)
Added by Teemu Murtola over 4 years ago

Base to get all 'gmx help' contents to user guide

Implement initial functionality to get all 'gmx help' contents to the
reStructuredText user guide. Make 'gmx help -export rst' export also
the help topics, and make minimal changes to the user guide and the
selection help to get it go through Sphinx cleanly. Subsequent changes
will clean up the documentation further.

Part of #679.

Change-Id: I66219110fac4f4acd9ff9c36a19ca10f9561ca29

Revision 0119f5e5 (diff)
Added by Teemu Murtola over 4 years ago

Allow any order for sections in 'gmx help -export'

Make the selection help appear in a more logical order in the user guide
by writing out the subtopics in the order in which they were added, and
ordering the topics like they were in 4.5 and 4.6.

Part of #679.

Change-Id: I0adf875fc36d32d79e1e066c0ee8025a6277c0df

Revision 59731e2a (diff)
Added by Teemu Murtola over 4 years ago

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

History

#1 Updated by Mark Abraham almost 9 years ago

  • Assignee set to Mark Abraham

#2 Updated by Teemu Murtola almost 9 years ago

Mark Abraham wrote:

I seem to recall that you wrote g_select, Teemu. Can you comment please?

Which online help you mean, the one printed by g_select -h or the one printed by g_select -select "help all"? The former is easy to add if it is missing, but the latter will require either additional code or some scripting, because currently it only supports formatting the text to stderr.

Nevertheless, it would be good to include that text in the manual. The main reason that it isn't in the 4.5 manual is that there have been plans to integrate the selection functionality to other analysis tools as well, and without it, a big part of planned functionality is missing. So the effort to put the text in the manual in its current, not very complete format, has not had a very high priority. For the next major release, the analysis framework will (hopefully) also see larger changes (that's what the separate analysis subproject is for), so putting substantial effort into getting the text into the 4.5 manual will only be justified if it can be reused in the later releases as well. But any thoughts (and help) in this respect are welcome. For any changes to the code, it should be considered how they relate to the points in issue #666, in particular the third point.

#3 Updated by Teemu Murtola almost 7 years ago

  • Target version set to 5.0

Setting target version to 5.0, as this should be straightforward to do as part of #969.

#4 Updated by Erik Lindahl over 5 years ago

  • Target version changed from 5.0 to 5.x

Not going to make the cut ;-)

#5 Updated by Teemu Murtola over 5 years ago

  • Category set to documentation

#6 Updated by Teemu Murtola over 4 years ago

  • Status changed from New to In Progress
  • Assignee changed from Mark Abraham to Teemu Murtola

Some prerequisite patches are now in Gerrit (for tests of this functionality), and I'm working on getting the text of gmx help selections and all subpages into the user guide.

#7 Updated by Gerrit Code Review Bot over 4 years ago

Gerrit received a related patchset '6' for Issue #679.
Uploader: Teemu Murtola ()
Change-Id: If7e0ee6d4c9dd313e1523fa457f64cf3c4f891f9
Gerrit URL: https://gerrit.gromacs.org/1333

#8 Updated by Gerrit Code Review Bot over 4 years ago

Gerrit received a related patchset '1' for Issue #679.
Uploader: Teemu Murtola ()
Change-Id: I66219110fac4f4acd9ff9c36a19ca10f9561ca29
Gerrit URL: https://gerrit.gromacs.org/4620

#9 Updated by Gerrit Code Review Bot over 4 years ago

Gerrit received a related patchset '1' for Issue #679.
Uploader: Teemu Murtola ()
Change-Id: I0adf875fc36d32d79e1e066c0ee8025a6277c0df
Gerrit URL: https://gerrit.gromacs.org/4622

#10 Updated by Gerrit Code Review Bot over 4 years ago

Gerrit received a related patchset '1' for Issue #679.
Uploader: Teemu Murtola ()
Change-Id: Id91ce3c01e9dd5f1c068498217dbc536a712c231
Gerrit URL: https://gerrit.gromacs.org/4625

#11 Updated by Teemu Murtola over 4 years ago

  • Status changed from In Progress to Fix uploaded
  • Target version changed from 5.x to 5.1

#12 Updated by Teemu Murtola over 4 years ago

  • Status changed from Fix uploaded to Resolved

#13 Updated by Erik Lindahl over 4 years ago

  • Status changed from Resolved to Closed

Also available in: Atom PDF