]> OCCT Git - occt.git/commitdiff
0027018: Documentation - blockquotes are incorrectly formatted in PDF
authorysn <ysn@opencascade.com>
Mon, 21 Aug 2017 10:08:27 +0000 (13:08 +0300)
committerbugmaster <bugmaster@opencascade.com>
Thu, 24 Aug 2017 16:12:57 +0000 (19:12 +0300)
Trailing space is removed after ">" to avoid breaking the quote block in PDF output.

A section about quotes are added in the documentation guide.

dox/dev_guides/contribution_workflow/contribution_workflow.md
dox/dev_guides/documentation/documentation.md

index ffc61911754635afbf367dd738a9127cb0a0233f..0cb0be1e71655049f49e85e4b1f2b506db0d707d 100644 (file)
@@ -204,7 +204,7 @@ In a general case, the following elements should be present:
 Example:
 
 > *0026330: BRepOffsetAPI_ThruSections creates invalid shape.*
-> 
+>
 > *Methods BRep_Tool::CurveOnSurface() and BRepCheck_Edge::InContext() now properly handle parametric range on a 3D curve when it is used to generate a p-curve dynamically (on a planar surface) and both the surface and the 3D curve have non-null locations.*
 
 Provide sufficient context so that potential user of the affected functionality can understand what has been changed and how the algorithm works now.
index 79977fd1c9a36f6f7626d40bd324aa621478ce1b..4f12941c57cc285370504d3a4fb94ccd0d858b0a 100644 (file)
@@ -352,6 +352,21 @@ Smaller code blocks can be inserted by wrapping with tags <i>\@code</i> and <i>\
 
 Verbatim content (same as code but without syntax highlighting) can be inserted by wrapping with tags <i>\@verbatim</i> and <i>\@endverbatim</i>.
 
+@subsection  OCCT_DM_SECTION_A_5a Quotes
+
+Text quoted from other sources can be indented using ">" tag. For example:
+
+@verbatim
+> [Regression in 6.9.0] *IGES - Export of a reversed face leads to wrong data*
+@endverbatim
+
+will produce 
+
+> [Regression in 6.9.0] *IGES - Export of a reversed face leads to wrong data*
+
+Note that this tag should prefix each line of the quoted text.
+Empty lines in the quoted text, if any, should not have trailing spaces after the ">" (lines with trailing spaces will break the quote block).
+
 @subsection  OCCT_DM_SECTION_A_6 References
 
 To insert a reference to a website, it is sufficient to write an URL.