Archived issue #0027018
Documentation - blockquotes are incorrectly formatted in PDF
Description
Doxygen support insertion of text block as blockquotes, with the following format:
> Text...
>
> Another paragraph...
These blockquotes are rendered correctly in HTML output, but are formatted incorrectly in PDF:
a) First line in the paragraph has indentation -- this breaks layout
b) Empty lines get lost (seem to be interpreted as separation of paragraphs)
See attached document, example at page 7
> Text...
>
> Another paragraph...
These blockquotes are rendered correctly in HTML output, but are formatted incorrectly in PDF:
a) First line in the paragraph has indentation -- this breaks layout
b) Empty lines get lost (seem to be interpreted as separation of paragraphs)
See attached document, example at page 7
Steps to reproduce
gendoc.bat -overview -pdf -ug=dev_guides/contribution_workflow/contribution_workflow.md
Public activity
11 archived notes
Participants are labeled by their role within this record.
Branch [archived branch] has been created by Participant.
[revision removed]
Detailed log of new commits:
Author: ski
Date: Thu Dec 15 12:44:36 2016 +0300
0027018: Documentation - blockquotes are incorrectly formatted in PDF
Corrected block quotes in documentation for correct format in PDF files.
[revision removed]
Detailed log of new commits:
Author: ski
Date: Thu Dec 15 12:44:36 2016 +0300
0027018: Documentation - blockquotes are incorrectly formatted in PDF
Corrected block quotes in documentation for correct format in PDF files.
I have checked Doxygen documentation and it seems that we should use ">" character instead "> " for empty lines in text block formatted as blockquotes, because "> " means the end of current blockquotes item:
"Note that doxygen requires that you put a space after the (last) > character to avoid false positives, i.e. when writing" (see https://www.stack.nl/~dimitri/doxygen/manual/markdown.html#md_blockquotes)
Attached images show the difference between ">" and "> " cases.
"Note that doxygen requires that you put a space after the (last) > character to avoid false positives, i.e. when writing" (see https://www.stack.nl/~dimitri/doxygen/manual/markdown.html#md_blockquotes)
Attached images show the difference between ">" and "> " cases.
Dear ysn,
please review.
please review.
Yes, this is the solution.
There seems to be no difference between the branch and the current master, so no integration is required.
There seems to be no difference between the branch and the current master, so no integration is required.
Dear Commenter 1,
please close the issue.
please close the issue.
There IS the difference: exactly a space removed after ">" in Contribution Workflow document. Apart of this fix, please also:
- Make sure that Documentation guide describes how to add blockquotes properly, taking into account that issue
- Check for possible other cases of incorrectly formatted blockquotes across the doc
- Make sure that Documentation guide describes how to add blockquotes properly, taking into account that issue
- Check for possible other cases of incorrectly formatted blockquotes across the doc
Fixed in branch CR27018_1.
AFAIK, we don't use block-quotes anywhere except for coding rules.
AFAIK, we don't use block-quotes anywhere except for coding rules.
Branch [archived branch] has been created by Author.
[revision removed]
Detailed log of new commits:
Author: ysn
Date: Mon Aug 21 13:08:27 2017 +0300
0027018: Documentation - blockquotes are incorrectly formatted in PDF
Trailing space is removed after ">" to avoid breaking the quote block in PDF output.
A section about quotes are added in the documentation guide.
[revision removed]
Detailed log of new commits:
Author: ysn
Date: Mon Aug 21 13:08:27 2017 +0300
0027018: Documentation - blockquotes are incorrectly formatted in PDF
Trailing space is removed after ">" to avoid breaking the quote block in PDF output.
A section about quotes are added in the documentation guide.
Please integrate branch CR27018_1; no testing is needed
Branch [archived branch] has been deleted by Commenter 3.
[revision removed]
[revision removed]
Branch [archived branch] has been deleted by Commenter 3.
[revision removed]
[revision removed]