Next set of fixes for the reStructuredText import. #2027
Merged
Conversation
This file contains hidden or 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
Pass on CSS class arguments from `<inline>` elements to support "custom interpreted text roles" (https://docutils.sourceforge.io/docs/ref/rst/directives.html#role) Add special handling for "del" and "ins" roles, so that they will become `<del>` and `<ins>` in HTML.
Both, rST and Moin support ordered lists starting with a value other than one. Docutils also generates an INFO level system message that is usually not shown. This may have led to the missing conversion of the start value. Correct handling of system messages will be added in the next steps.
Docutils system messages (https://docutils.sourceforge.io/docs/ref/doctree.html#system-message) contain useful information that is currently ignored: * type/level (DEBUG, INFO, WARNING, ERROR, SEVERE) * source description, line number of the issue Show this info in the inserted "admonition". Use a "caution" instad of an "error admonition" for merely informative messages.
The rst_in converter is a Docutils "writer" component (exporting a "doctree" to some other format) but does not inherit `docutils.writers.Writer`. Therefore, we add the "transfroms" that are usually loaded by the Writer class to the transforms added by Moin (in the parser component). https://docutils.sourceforge.io/docs/api/transforms.html#transforms-added-by-components
To report issues in inline content, Docutils uses a combination of a `<problematic>` element and a `<system_message>`. https://docutils.sourceforge.io/docs/ref/doctree.html#problematic Make "problematic" content stay out by a red background and turn it into a link to the related "system message" (if there is one). Add a backlink from the "system message" to the "problematic" element at the place of origin.
gmilde
changed the title
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Next set of fixes for the reStructuredText import.
Support custom "interpreted text roles"
Pass on CSS class arguments from
<inline>elements to support "custom interpreted text roles"(https://docutils.sourceforge.io/docs/ref/rst/directives.html#role)
Add special handling for "del" and "ins" roles, so that they will become
<del>and<ins>in HTML.Support a custom start value for ordered lists.
Run "transform" to filter INFO-level messages.
(Unless the "report-level" configuration setting is changed to keep them.)
More informative system messages: include severity level, line of occurence and (if applicable) a back-link to the problematic text when reporting a parser issue.
Documentation will follow once the current doc PR is handled.