Restore the document metadata dropped when the pages were ported - #506
Open
slachiewicz wants to merge 1 commit into
Open
Restore the document metadata dropped when the pages were ported#506slachiewicz wants to merge 1 commit into
slachiewicz wants to merge 1 commit into
Conversation
An APT document opens with a header block giving its title, authors and date, and doxia-converter turns that into YAML front matter. The port removed the front matter along with the converter's per-line licence comments, so the generated pages lost their author and date meta tags, and took their title from the first heading rather than from the document title. The front matter has to come first in the file: the Markdown parser only looks for it when the source begins with "---". A licence header ahead of it would hide it, and RAT is happy either way.
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
1 participant
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.
The site pages lost their document metadata when they were ported from APT.
An APT document opens with a header block giving its title, authors and date, and
doxia-converterturns that into YAML front matter. The port dropped the front matteralong with the converter's per-line licence comments, so the generated pages lost their
<meta name="author">and date, and took their<title>from the first heading insteadof from the document title.
Building one project's site from the APT sources and from the ported Markdown shows the
difference:
<title>producedRelease Notes - ModelloModello - ModelloRelease Notes - ModelloThe front matter has to come first in the file, because the Markdown parser only looks
for it when the source begins with
---; a licence header ahead of it would hide it.RAT is happy either way.
Verified by building the site before and after and comparing
<title>and the authormeta tags of every generated page, and by confirming the front matter does not reach
the rendered body.