[Core/Dicom_Archive] Markdown File Help Content #2196
Merged
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
driusan
added
Feature
driusan
force-pushed
the
MarkdownHelp
branch
from
620221c
to
ef91c98
Compare
Current coverage is 13.76% (diff: 9.09%)@@ 17.0-dev #2196 diff @@
==========================================
Files 121 121
Lines 20241 20249 +8
Methods 1132 1133 +1
Messages 0 0
Branches 0 0
==========================================
+ Hits 2787 2788 +1
- Misses 17454 17461 +7
Partials 0 0
|
christinerogers
added
the
Documentation
driusan
added
Request Code Review
Add to Release Notes
gluneau
approved these changes
Sep 23, 2016
driusan
added
the
Needs Rebase
added 6 commits
September 28, 2016 09:28
This should be significantly easier to maintain and review than storing the help content in the database where everything requires an SQL patch to update. It's also significantly faster. This is only available for "new" style modules, and the dicom_archive (which previously had no help at all) is used as an example.
driusan
force-pushed
the
MarkdownHelp
branch
from
ef91c98
to
a11bee5
Compare
driusan
removed
Needs Rebase
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.
This adds the help content from markdown format files in the module
help/directory.This should be significantly easier to maintain and review than storing the help content in the database where everything requires an SQL patch to update. It's also faster.
This is only available for "new" style modules, and the dicom_archive (which previously had no help at all) is used as an example.
Only a subset of markdown is supported. Namely:
#characters. Note that unlike real markdown, there must be an empty line before the first paragraph of the section)*or**(The new React "Markdown" component can be used to render markdown other places in LORIS, if required.)