OpenCascade/occt
1
0
Fork 0
mirror of https://git.dev.opencascade.org/repos/occt.git synced 2025-04-10 18:51:21 +03:00
Code Packages Releases Activity

0027018: Documentation - blockquotes are incorrectly formatted in PDF

Browse Source 
Trailing space is removed after ">" to avoid breaking the quote block in PDF output.

A section about quotes are added in the documentation guide.
This commit is contained in:
ysn 2017-08-21 13:08:27 +03:00 committed by bugmaster
parent 5b83cdb642
commit a41ccd91d9
2 changed files with 16 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
dox/dev_guides/contribution_workflow/contribution_workflow.md
View File

@ -204,7 +204,7 @@ In a general case, the following elements should be present:
Example: Example:
> *0026330: BRepOffsetAPI_ThruSections creates invalid shape.* > *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.* > *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. Provide sufficient context so that potential user of the affected functionality can understand what has been changed and how the algorithm works now.

15
dox/dev_guides/documentation/documentation.md
View 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>. 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 @subsection OCCT_DM_SECTION_A_6 References
To insert a reference to a website, it is sufficient to write an URL. To insert a reference to a website, it is sufficient to write an URL.