From a41ccd91d98b96e5942ddefc64f5f6f526826375 Mon Sep 17 00:00:00 2001 From: ysn Date: Mon, 21 Aug 2017 13:08:27 +0300 Subject: [PATCH] 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. --- .../contribution_workflow.md | 2 +- dox/dev_guides/documentation/documentation.md | 15 +++++++++++++++ 2 files changed, 16 insertions(+), 1 deletion(-) diff --git a/dox/dev_guides/contribution_workflow/contribution_workflow.md b/dox/dev_guides/contribution_workflow/contribution_workflow.md index ffc6191175..0cb0be1e71 100644 --- a/dox/dev_guides/contribution_workflow/contribution_workflow.md +++ b/dox/dev_guides/contribution_workflow/contribution_workflow.md @@ -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. diff --git a/dox/dev_guides/documentation/documentation.md b/dox/dev_guides/documentation/documentation.md index 79977fd1c9..4f12941c57 100644 --- a/dox/dev_guides/documentation/documentation.md +++ b/dox/dev_guides/documentation/documentation.md @@ -352,6 +352,21 @@ Smaller code blocks can be inserted by wrapping with tags \@code and \ Verbatim content (same as code but without syntax highlighting) can be inserted by wrapping with tags \@verbatim and \@endverbatim. +@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.