Convert the plugin pages to Markdown using code blocks - #578
Merged
Conversation
Follows the suggestion that the method signatures in these pages are code snippets, so the inline formatting is not needed. The xdoc used nested markup inside a code span and <br/> with   runs for indentation, which is why a straight conversion mangled it. As a fenced code block the same content converts cleanly and reads better: real monospace, real indentation, and the two parenthetical notes become comments on the methods they describe. The variable parts were marked up as <i>my.model.package</i> and <i>ModelName</i>; a code block cannot express that, so the sentence above now says where those come from. Also fixes the subsection heading, which read 'jackson-writer' on the SAX plugin page - copied from the Jackson page. The other nine plugin pages name their generators correctly. Part of codehaus-plexus/.github#58
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
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.
Part of codehaus-plexus/.github#58. All nine plugin pages, following your point that those
<li><code>blocks are really code snippets so the inline formatting isn't needed.You were right, and it reverses the conclusion I reached in #576.
Three commits — please merge or rebase, don't squash, so
git log --followsurvives the renames.Why the straight conversion failed
The xdoc marked up method signatures as inline HTML inside a list:
Markdown has no syntax for emphasis inside a code span, so
doxia-converteremitted`_RootClass_`— underscores rendering literally — and turned each<br/>into a backslash plus a blank line, which closed the list and dumped the rest as plain text.Treating them as code instead
Real monospace, real indentation instead of
 runs, and the parenthetical asides become comments on the method they describe.What is deliberately lost
The
<i>/<b>marked which parts ofmy.model.package.io.sax.ModelNameSAXWritercome from your model and which are literal. A code block can't carry that, so each page now says it in words above the block.This is a content change, not a faithful format migration, so unlike the other conversion PRs I'm not claiming an identical render.
Three real errors found while reading the sources
stax,snakeyamlandjacksonall documented their first reader overload with the method name missing —public RootClass ( Reader reader, boolean strict ). It'sread, as thexpp3page shows. Same copy-paste, three pages..io.xpp3.rather than.io.stax.— copied from the xpp3 page.jackson-writer. I checked all ten pages; that one is isolated.Dead links replaced
Not a format problem, but I wasn't going to rewrite these pages and leave them:
plexus.codehaus.org/plexus-utils/codehaus-plexus.github.io/plexus-utils/plexus.codehaus.org/…/Xpp3Dom.htmlXpp3Domlives there nowcode.google.com/p/snakeyamlbitbucket.org/snakeyaml/snakeyamlwiki.fasterxml.com/JacksonHomegithub.com/FasterXML/jacksondom4j.sourceforge.net/dom4j-1.6.1/dom4j.github.ioEach replacement checked for a 200.
Verified
All nine build. Titles and authors preserved (including the accented names). Subsection counts match the originals on every page, and so do the method signature counts:
xdochas no signatures and needed no code block; itsfeatures.htmllink is unchanged from the original.Supersedes part of #576
#576 says these nine pages stay as xdoc. That carve-out no longer applies — I'll update it. #576 still stands on its own for the Modello overview and the velocity page, including the image map the converter dropped.