View Issue Details

IDProjectCategoryView StatusLast Update
0027018Open CASCADEOCCT:Documentationpublic2017-09-29 16:29
Reporterabv Assigned Tobugmaster  
PrioritynormalSeverityminor 
Status closedResolutionfixed 
Target Version7.2.0Fixed in Version7.2.0 
Summary0027018: Documentation - blockquotes are incorrectly formatted in PDF
DescriptionDoxygen 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
Steps To Reproducegendoc.bat -overview -pdf -ug=dev_guides/contribution_workflow/contribution_workflow.md
TagsNo tags attached.
Test case numberNot required

Attached Files

  • occt_contribution_workflow.pdf (341,039 bytes)
  • wo_patch.png (13,212 bytes)
  • with_patch.png (12,839 bytes)

Activities

abv

2015-12-21 10:46

manager  

occt_contribution_workflow.pdf (341,039 bytes)

git

2016-12-16 12:53

administrator   ~0061724

Branch CR27018 has been created by ski.

SHA-1: ea0c0f3ba35986042dda713324f6382bc4b201bf


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.

ski

2016-12-16 13:02

developer   ~0061725

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.

ski

2016-12-16 13:02

developer  

wo_patch.png (13,212 bytes)

ski

2016-12-16 13:02

developer  

with_patch.png (12,839 bytes)

ski

2016-12-16 13:05

developer   ~0061726

Dear ysn,

please review.

ysn

2017-06-02 12:18

developer   ~0067012

Yes, this is the solution.

There seems to be no difference between the branch and the current master, so no integration is required.

ski

2017-06-02 14:19

developer   ~0067023

Dear bugmaster,

please close the issue.

abv

2017-06-02 15:03

manager   ~0067025

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

ysn

2017-08-21 13:10

developer   ~0069706

Fixed in branch CR27018_1.
AFAIK, we don't use block-quotes anywhere except for coding rules.

git

2017-08-21 17:39

administrator   ~0069725

Branch CR27018_1 has been created by abv.

SHA-1: f996248950a820b16d41acc6244643bb6e132d65


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.

abv

2017-08-21 17:39

manager   ~0069726

Please integrate branch CR27018_1; no testing is needed

git

2017-08-25 16:13

administrator   ~0069892

Branch CR27018 has been deleted by kgv.

SHA-1: ea0c0f3ba35986042dda713324f6382bc4b201bf

git

2017-08-25 16:13

administrator   ~0069893

Branch CR27018_1 has been deleted by kgv.

SHA-1: f996248950a820b16d41acc6244643bb6e132d65

Related Changesets

occt: master a41ccd91

2017-08-21 10:08:27

ysn


Committer: bugmaster Details Diff
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.
Affected Issues
0027018
mod - dox/dev_guides/contribution_workflow/contribution_workflow.md Diff File
mod - dox/dev_guides/documentation/documentation.md Diff File

Issue History

Date Modified Username Field Change
2015-12-21 10:46 abv New Issue
2015-12-21 10:46 abv Assigned To => ysn
2015-12-21 10:46 abv File Added: occt_contribution_workflow.pdf
2015-12-21 10:46 abv Target Version 7.0.0 => 7.1.0
2016-11-22 10:55 kgv Summary Documentation -- blockquotes are incorrectly formatted in PDF => Documentation - blockquotes are incorrectly formatted in PDF
2016-11-22 11:07 abv Assigned To ysn => ski
2016-11-22 11:07 abv Status new => assigned
2016-11-22 11:07 abv Target Version 7.1.0 => 7.2.0
2016-12-16 12:53 git Note Added: 0061724
2016-12-16 13:02 ski Note Added: 0061725
2016-12-16 13:02 ski File Added: wo_patch.png
2016-12-16 13:02 ski File Added: with_patch.png
2016-12-16 13:05 ski Note Added: 0061726
2016-12-16 13:05 ski Assigned To ski => ysn
2016-12-16 13:05 ski Status assigned => resolved
2017-06-02 12:18 ysn Note Added: 0067012
2017-06-02 12:18 ysn Assigned To ysn => ski
2017-06-02 12:18 ysn Status resolved => reviewed
2017-06-02 14:19 ski Note Added: 0067023
2017-06-02 14:19 ski Assigned To ski => bugmaster
2017-06-02 14:19 ski Status reviewed => feedback
2017-06-02 15:03 abv Note Added: 0067025
2017-06-02 15:03 abv Assigned To bugmaster => ysn
2017-06-02 15:03 abv Status feedback => assigned
2017-08-21 13:10 ysn Note Added: 0069706
2017-08-21 13:11 ysn Assigned To ysn => abv
2017-08-21 13:11 ysn Status assigned => resolved
2017-08-21 17:39 git Note Added: 0069725
2017-08-21 17:39 abv Note Added: 0069726
2017-08-21 17:39 abv Assigned To abv => bugmaster
2017-08-21 17:39 abv Status resolved => reviewed
2017-08-21 21:47 bugmaster Status reviewed => tested
2017-08-24 12:42 bugmaster Test case number => Not required
2017-08-25 15:02 bugmaster Changeset attached => occt master a41ccd91
2017-08-25 15:02 bugmaster Status tested => verified
2017-08-25 15:02 bugmaster Resolution open => fixed
2017-08-25 16:13 git Note Added: 0069892
2017-08-25 16:13 git Note Added: 0069893
2017-09-29 16:17 aiv Fixed in Version => 7.2.0
2017-09-29 16:29 aiv Status verified => closed