Added new method for links to switching function documentation #1145
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This commit addresses something that has bothered me for a while; namely, how we should provide the links to the parts of the manual on swiching function when you encounter a keyword like switch. I would ideally like to provide the link to this page both in the tooltip that is generated for the annotated inputs and in the tables that contain the syntax. This commit addresses this problem. You can now use the command keys.linkActionInDocs when you register the keyword in registerKeywords. Links to the manual pages for relevant actions will then be included in the manual and in tooltips. As part of this I have also moved the documentation for switching function to the action LESS_THAN and the documentation for HistogramBead to BETWEEN as this is where these classes are used in their most basic form.
|
If you want to see an example of what this would look like see: https://gtribello.github.io/plumed-manual/new-manual/CONTACT_MATRIX.html You can see the links in the tooltips in the example input here and how the links are also added to the syntax pages. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This commit addresses something that has bothered me for a while; namely, how we should provide the links to the parts of the manual on swiching function when you encounter a keyword like switch. I would ideally like to provide the link to this page both in the tooltip that is generated for the annotated inputs and in the tables that contain the syntax.
This commit addresses this problem. You can now use the command keys.linkActionInDocs when you register the keyword in registerKeywords. Links to the manual pages for relevant actions will then be included in the manual and in tooltips.
As part of this I have also moved the documentation for switching function to the action LESS_THAN and the documentation for HistogramBead to BETWEEN as this is where these classes are used in their most basic form.
Target release
I would like my code to appear in release 2.11
Type of contribution
Copyright
COPYRIGHTfile with the correct license information. Code should be released under an open source license. I also used the commandcd src && ./header.sh mymodulenamein order to make sure the headers of the module are correct.Tests