Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Compilation breaks if 'summary' has several paragraphs #1

Open
r03ert0 opened this issue Nov 12, 2020 · 2 comments
Open

Compilation breaks if 'summary' has several paragraphs #1

r03ert0 opened this issue Nov 12, 2020 · 2 comments

Comments

@r03ert0
Copy link
Contributor

r03ert0 commented Nov 12, 2020

My summary section had 3 paragraphs, and compilation didn't work. Making a single paragraph make compilation work again. If a single paragraph is expected, that should be said in the doc, or in the comments inside the template file. Probably, a maximum number of characters should be indicated, otherwise the layout of the webpage may break.

@agahkarakuzu
Copy link
Contributor

@r03ert0 yes, summary section requires a single paragraph as it is a yaml field. One trick would be passing <br> between paragraphs, on the other hand, I like single paragraphs as a summary :)

@r03ert0
Copy link
Contributor Author

r03ert0 commented Nov 12, 2020

Sure. We could make a single paragraph summary mandatory, but that would have to be made explicit. Otherwise, people will have broken compilations and it'll be tricky to track the bug...
Now, the single paragraph summary may be a matter of preference, and some other people may like to have several paragraphs. In particular, medical people like to separate their summary paragraphs into "background/methods/results" and stuff...

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants