From 19d43ec662b23cab9a899c7bff4cd4d17a345646 Mon Sep 17 00:00:00 2001 From: Andrew Maclean <andrew.amaclean@gmail.com> Date: Sat, 2 Oct 2021 14:41:20 +1000 Subject: [PATCH] Fix markdown errors --- src/Python/GeometricObjects/Axes.md | 2 +- src/Python/GeometricObjects/ColoredLines.md | 2 +- src/Python/GeometricObjects/CylinderExample.md | 3 ++- src/Python/GeometricObjects/EllipticalCylinder.md | 4 ++-- src/Python/GeometricObjects/LongLine.md | 2 +- src/Python/GeometricObjects/OrientedArrow.md | 4 ++-- src/Python/GeometricObjects/OrientedCylinder.md | 4 ++-- src/Python/GeometricObjects/ParametricObjectsDemo.md | 9 ++++++--- src/Python/GeometricObjects/ShrinkCube.md | 9 ++++----- src/Python/GeometricObjects/SourceObjectsDemo.md | 3 ++- src/Python/GeometricObjects/TessellatedBoxSource.md | 2 +- src/Python/GeometricObjects/TriangleStrip.md | 3 ++- 12 files changed, 26 insertions(+), 21 deletions(-) diff --git a/src/Python/GeometricObjects/Axes.md b/src/Python/GeometricObjects/Axes.md index db805f471fd..8634528ce73 100644 --- a/src/Python/GeometricObjects/Axes.md +++ b/src/Python/GeometricObjects/Axes.md @@ -4,4 +4,4 @@ This example shows how to position an vtkAxesActor in 3D. Notice that position a done with a user transform. !!! seealso -[DisplayCoordinateAxes](../../Visualization/DisplayCoordinateAxes). + [DisplayCoordinateAxes](../../Visualization/DisplayCoordinateAxes). diff --git a/src/Python/GeometricObjects/ColoredLines.md b/src/Python/GeometricObjects/ColoredLines.md index 5852f2eb799..2daad4671f3 100644 --- a/src/Python/GeometricObjects/ColoredLines.md +++ b/src/Python/GeometricObjects/ColoredLines.md @@ -3,4 +3,4 @@ Displays two lines, each with a different color. !!! seealso -[LongLine](../LongLine). + [LongLine](../LongLine). diff --git a/src/Python/GeometricObjects/CylinderExample.md b/src/Python/GeometricObjects/CylinderExample.md index 301e4699969..766a2854baf 100644 --- a/src/Python/GeometricObjects/CylinderExample.md +++ b/src/Python/GeometricObjects/CylinderExample.md @@ -2,6 +2,7 @@ This example creates a minimal visualization program, demonstrating VTK's basic rendering and pipeline creation. -!!! note This original C++ source code for this example +!!! note + This original C++ source code for this example is [here](https://gitlab.kitware.com/vtk/vtk/blob/73465690278158b9e89661cd6aed26bead781378/Examples/Rendering/Cxx/Cylinder.cxx) . diff --git a/src/Python/GeometricObjects/EllipticalCylinder.md b/src/Python/GeometricObjects/EllipticalCylinder.md index 788c245afbf..ac28284ea21 100644 --- a/src/Python/GeometricObjects/EllipticalCylinder.md +++ b/src/Python/GeometricObjects/EllipticalCylinder.md @@ -4,6 +4,6 @@ The example creates an elliptical cross-section and stores it in a vtkPolyData. creates an elliptical cylinder by extruding the vtkPolyLine along a vector. The example sets the backface property of the vtkActor to show the front and back face of the cylinder. -!!! info "See also" -[EllipticalCylinderDemo](../EllipticalCylinderDemo) to see the vtkPolyLine and the vector represented as an oriented +!!! seealso + [EllipticalCylinderDemo](../EllipticalCylinderDemo) to see the vtkPolyLine and the vector represented as an oriented arrow. diff --git a/src/Python/GeometricObjects/LongLine.md b/src/Python/GeometricObjects/LongLine.md index 87c0c84ac0d..453afea2e48 100644 --- a/src/Python/GeometricObjects/LongLine.md +++ b/src/Python/GeometricObjects/LongLine.md @@ -3,4 +3,4 @@ Connect several points with a line. !!! seealso -[ColoredLines](../ColoredLines). + [ColoredLines](../ColoredLines). diff --git a/src/Python/GeometricObjects/OrientedArrow.md b/src/Python/GeometricObjects/OrientedArrow.md index 6938204e784..fc769544a95 100644 --- a/src/Python/GeometricObjects/OrientedArrow.md +++ b/src/Python/GeometricObjects/OrientedArrow.md @@ -11,6 +11,6 @@ It demonstrates two different ways to apply the transform: Switch between the two methods by #defining USER_MATRIX or leaving out the #define. -!!! info "See also" -Compare this example with [OrientedCylinder](../OrientedCylinder). The transform is different because the cylinder +!!! seealso + Compare this example with [OrientedCylinder](../OrientedCylinder). The transform is different because the cylinder height direction is along the y-axis and the arrow height is along the x axis. diff --git a/src/Python/GeometricObjects/OrientedCylinder.md b/src/Python/GeometricObjects/OrientedCylinder.md index 48cdef8a924..00a564659c6 100644 --- a/src/Python/GeometricObjects/OrientedCylinder.md +++ b/src/Python/GeometricObjects/OrientedCylinder.md @@ -11,6 +11,6 @@ It demonstrates two different ways to apply the transform: Switch between the two methods by setting USER_MATRIX to **True** or **False**. -!!! info "See also" -Compare this example with [OrientedArrow](../OrientedArrow). The transform is different because the cylinder height +!!! seealso + Compare this example with [OrientedArrow](../OrientedArrow). The transform is different because the cylinder height direction is along the y-axis and the arrow height is along the x axis. diff --git a/src/Python/GeometricObjects/ParametricObjectsDemo.md b/src/Python/GeometricObjects/ParametricObjectsDemo.md index 45a79e110d6..f8d5a52f99a 100644 --- a/src/Python/GeometricObjects/ParametricObjectsDemo.md +++ b/src/Python/GeometricObjects/ParametricObjectsDemo.md @@ -24,13 +24,16 @@ ParametricSurfaces -w Will write out a file with no other options enabled called `ParametricObjectsDemo.png`. -!!! Note To really appreciate the complexity of some of these surfaces, select a single surface, and use the +!!! Note + To really appreciate the complexity of some of these surfaces, select a single surface, and use the options `-b -n`. Also try specifying wireframe ( toggle "w" on the keyboard) and zooming in and out. -!!! Tip If you color the back face, the three-dimensional orientable surfaces will only show backface coloring inside +!!! Tip + If you color the back face, the three-dimensional orientable surfaces will only show backface coloring inside the surface e.g `ConicSpiral` or `Torus`. For three dimensional non-orientable surfaces; backface coloring is visible because of the twisting used to generate these surfaces e.g `Boy` or `Figure8Klein`. -!!! Cite See: [Parametric Equations for Surfaces](http://www.vtk.org/wp-content/uploads/2015/11/ParametricSurfaces.pdf), +!!! Cite + See: [Parametric Equations for Surfaces](http://www.vtk.org/wp-content/uploads/2015/11/ParametricSurfaces.pdf), for more information. This paper gives a description of the first fifteen surfaces, including their parametric equations and derivatives. Also provided is an example of how to create your own surface, namely the Figure-8 Torus. diff --git a/src/Python/GeometricObjects/ShrinkCube.md b/src/Python/GeometricObjects/ShrinkCube.md index 6f3bac7b111..87ac36104e7 100644 --- a/src/Python/GeometricObjects/ShrinkCube.md +++ b/src/Python/GeometricObjects/ShrinkCube.md @@ -2,11 +2,10 @@ Generates a cube using vtkCubeSource, then a shrink filter is applied. -vtkShrinkFilter object shrinks cells composing an arbitrary data set towards their centroid. The centroid of a cell is -computed as the average position of the cell points. Shrinking results in disconnecting the cells from one another. +vtkShrinkFilter object shrinks cells composing an arbitrary data set towards their centroid. The centroid of a cell is computed as the average position of the cell points. Shrinking results in disconnecting the cells from one another. !!! seealso -[TessellatedBoxSource](../TessellatedBoxSource) generates multiple quads or triangles per side. + [TessellatedBoxSource](../TessellatedBoxSource) generates multiple quads or triangles per side. -!!! info See [Figure 5-17](../../../VTKBook/05Chapter5/#Figure%205-17) in [Chapter 5](../../../VTKBook/05Chapter5) -the [VTK Textbook](../../../VTKBook/01Chapter1). +!!! info + See [Figure 5-17](../../../VTKBook/05Chapter5/#Figure%205-17) in [Chapter 5](../../../VTKBook/05Chapter5) the [VTK Textbook](../../../VTKBook/01Chapter1). diff --git a/src/Python/GeometricObjects/SourceObjectsDemo.md b/src/Python/GeometricObjects/SourceObjectsDemo.md index aedd909dcb7..5a26307e7bc 100644 --- a/src/Python/GeometricObjects/SourceObjectsDemo.md +++ b/src/Python/GeometricObjects/SourceObjectsDemo.md @@ -4,5 +4,6 @@ Examples of source objects that procedurally generate polygonal models. These ni capability of VTK. From upper left in reading order: sphere, cone, cylinder, cube, plane, text, random point cloud, disk (with or without hole), and line source. -!!! info See [Figure 3-26](../../../VTKBook/03Chapter3/#Figure%203-26) in [Chapter 3](../../../VTKBook/03Chapter3) +!!! info + See [Figure 3-26](../../../VTKBook/03Chapter3/#Figure%203-26) in [Chapter 3](../../../VTKBook/03Chapter3) the [VTK Textbook](../../../VTKBook/01Chapter1). diff --git a/src/Python/GeometricObjects/TessellatedBoxSource.md b/src/Python/GeometricObjects/TessellatedBoxSource.md index 70c21e07b9f..59b7b0b92ca 100644 --- a/src/Python/GeometricObjects/TessellatedBoxSource.md +++ b/src/Python/GeometricObjects/TessellatedBoxSource.md @@ -4,4 +4,4 @@ Generates a box(cube) using vtkTessellatedBoxSource with 6 sides. The faces of t triangles or quads. !!! seealso -[Cube](../Cube) generates multiple quads or triangles per side. + [Cube](../Cube) generates multiple quads or triangles per side. diff --git a/src/Python/GeometricObjects/TriangleStrip.md b/src/Python/GeometricObjects/TriangleStrip.md index d5fd779b598..c0b82b44e13 100644 --- a/src/Python/GeometricObjects/TriangleStrip.md +++ b/src/Python/GeometricObjects/TriangleStrip.md @@ -4,4 +4,5 @@ The triangle strip is a composite two-dimensional cell consisting of one or more triangle strip need not lie in a plane. The triangle strip is defined by an ordered list of n+2 points, where n is the number of triangles. The ordering of the points is such that each set of three points defines a triangle. -!!! info See [this wikipedia article](http://en.wikipedia.org/wiki/Triangle_strip) for an explanation. +!!! info + See [this wikipedia article](http://en.wikipedia.org/wiki/Triangle_strip) for an explanation. -- GitLab