Doc updates (vias, paths)

This commit is contained in:
Matthias Koefferlein 2025-09-04 20:46:30 +02:00
parent 3d8eaf8dbf
commit 50cad403b2
3 changed files with 22 additions and 5 deletions

View File

@ -156,7 +156,7 @@ Class<db::ViaType> decl_dbViaType ("db", "ViaType",
"@brief If non-zero, the top layer's dimensions will be rounded to this grid.\n"
),
"@brief Describes a via type\n"
"These objects are used by PCellDeclaration#via_types to specify the via types a "
"These objects are used by \\PCellDeclaration#via_types to specify the via types a "
"via PCell is able to provide.\n"
"\n"
"The basic parameters of a via type are bottom and top layers (the layers that are "

View File

@ -10,16 +10,16 @@
<p>
Select "Path" mode from the toolbar. The editor options dialog will open that additionally prompts for
basic path parameters, such as width and extension scheme. When a path is being drawn, it will receive
the settings entered into this dialog. The path properties can even be changed, while the path is
being drawn. Don't forget to click "Apply" to take over the current entries. If the dialog has been
closed unintentionally, it can be reopened with the F3 shortcut.
the settings entered into this dialog. The path properties can be changed, while the path is
being drawn. If the option page has been closed unintentionally, it can be reopened with the F3 shortcut.
</p>
<p>
To actually draw a path,
choose a layer from the layer panel in which to create a new box.
choose a layer from the layer panel in which to create a new path.
Left click at the first vertex, move the mouse to the second vertex, click to place this one and continue
to the last vertex. Double-click at the last vertex to finish the path. Press the ESC key to cancel the operation.
Use the backspace key to remove the current segment and go back to the previous segment.
</p>
<p>
@ -30,5 +30,21 @@
also during editing.
</p>
<p>
<keyword name="Via"/>
<keyword name="Vias"/>
Paths are often used for wires. KLayout can be configured to provide
vias that allow switching from one layer to another and place a via
between the layers where the paths overlap. Before you can use the via feature,
KLayout has to be equipped with via definitions. Vias are basically PCells which
need to support a specific set of parameters. Via PCells need to expose a number
of descriptors to define the options supported by a particular PCell (e.g. the
layers which are connected or the type of via if multiple flavors are available).
This scheme allows for a lot of flexibility, but needs some coding skills.
In the macro IDE, a code sample is provided which implements two simple vias
for a three-layer metal stack. For more details see <class_doc href="PCellDeclaration"/>,
method "via_types" and <class_doc href="ViaType"/>.
</p>
</doc>

View File

@ -15,6 +15,7 @@
<topic href="/manual/create_cells.xml"/>
<topic href="/manual/create_polygon.xml"/>
<topic href="/manual/create_box.xml"/>
<topic href="/manual/create_path.xml"/>
<topic href="/manual/create_text.xml"/>
<topic href="/manual/create_instance.xml"/>
<topic href="/manual/move_sel.xml"/>