luke
/
klayout
mirror of https://github.com/KLayout/klayout.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'master' of https://github.com/klayoutmatthias/klayout

This commit is contained in:
klayoutmatthias 2017-08-06 18:22:13 +02:00
parent f8b3c92191 f940c00a24
commit ab98cd7678
9 changed files with 95 additions and 73 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

68
src/lay/doc/about/technology_manager.xml
View File

@ -32,12 +32,24 @@
are bound to a menu entry. Otherwise they will be invisible.
</li>
<li>DRC scripts: in the same way, DRC scripts can be associated with a technology.</li>
<li>Libraries: if a library is associated with a technology, it is shown in the list
of available libraries when an instance is created. Library association cannot be
edited. Instead, a library installed in the system comes with a technology
association itself.</li>
<li>File format options: technology specific file reader or writer options can be
given. When a layout is saved, it will use the writer options from it's technology.
When loading a layout, the reader options from the active technology will be used.</li>
</ul>
<p>
In the future, more aspects may be added to the technology definition.
</p>
<p>
There is always one "Default" technology that is used when no technology is
specified.
</p>
<h2>Setting up technologies</h2>
<p>
@ -105,56 +117,28 @@
or DRC scripts between technologies.
</p>
<h2>Importing and exporting technologies</h2>
<h2>Managing technologies</h2>
<p>
Technologies can be imported and exported to technology files (suffix ".lyt"). There is
one file per technology. To import or export a technology, choose "Import" or "Export" from
the technology tree's context menu (right mouse click). This way, technologies can be
shared between users.
Technologies can be imported and exported to technology files (suffix ".lyt"). This is mainly
useful to exchange technology settings between users or technologies.
</p>
<p>
When importing or exporting a technology, the associated files (i.e. scripts, layer properties
files etc.) are not exported. They have to be transferred manually. However, if no base path
is specified in the technology file, KLayout will use the location of the ".lyt" file as the
future base path. That way, a technology plus related files can be made into a self-contained
package using the following recipe:
</p>
<ul>
<li>Create any directory where you develop the technology. This will be the workspace.</li>
<li>Develop a technology with the technology manager. Enter the workspace path into the base path of the technology.
In the workspace you store all the required additional files.</li>
<li>If you want to include DRC scripts or macros, create a "drc" or "macros" folder in the
workspace. Store DRC scripts in the "drc" folder and macros in the macros folder.</li>
<li>If you need other files, store them in the workspace or in any sub-folder of the base
path. Other files are layer properties file or LEF files for example. Use relative paths to specify
those files or simply use the file name.</li>
<li>Export the technology as ".lyt" file into the workspace.</li>
<li>Open the ".lyt" file in an text editor and remove the line containing the base path. This
line is at the beginning of the file and uses the XML element "base-path". For example: "&lt;base-path&gt;/home/matthias/tech_devel&lt;/base-path&gt;".</li>
<li>The workspace with the ".lyt" can now be packaged (tar or zip for example) and send elsewhere. To
install, unpack the package and import the technology file from there. Since no base path
is specified, KLayout will set the default path to the ".lyt" file's location and
look for all the additional files from there.</li>
</ul>
<h2>Auto-import feature</h2>
<p>
KLayout offers an additional feature useful for the distribution or central installation
of a technology: On startup, KLayout will look for directories called "tech" in KLayout's
search path. If such an directory is found, KLayout will scan that directory recursively
for ".lyt" files and automatically import them. It will apply the same rules as for the
manual import and the imported technology will also show up in the technology manager, but
it cannot be edited.
Except for the default technology, technologies are kept in
technology folders in KLayout's application path. They are read from
subfolders from the "tech" directories. The technology definition itself
is held in a file with extension ".lyt". The technology folder may have
subfolders to hold library files, macros, DRC runsets, LEF files and
other pieces of the technology package.
</p>
<p>
Because the search path includes the application's installation path, this scheme
allows for a central installation of technology files plus the associated macros and DRC
scripts, by providing them together with the application binary on some network share.
Technologies can be managed using packages. Packages are a convenient way to share
add-ons between users. Packages can be installed from a common repository
and allow easy addition and removal of components. Technologies are one aspect
of packages, so it's possible to create packages that contribute one or more
technologies. See <link href="/about/packages.xml"/> for more details.
</p>
</doc>

3
src/lay/doc/manual/basic.xml
View File

@ -25,7 +25,8 @@
<topic href="/manual/descend.xml"/>
<topic href="/manual/layer_color.xml"/>
<topic href="/manual/layer_content.xml"/>
<topic href="/manual/layer_fill.xml"/>
<topic href="/manual/layer_content.xml"/>
<topic href="/manual/line_style.xml"/>
<topic href="/manual/layer_animation.xml"/>
<topic href="/manual/layer_style.xml"/>
<topic href="/manual/layer_visibility.xml"/>

22
src/lay/doc/manual/hier.xml
View File

@ -9,24 +9,30 @@
<p>
By default, only the bounding box of the cell selected is shown. This
corresponds to zero hierarchy levels being shown.
corresponds to zero hierarchy levels being shown. If you select one more
level of hierarchy (Levels 0 to 1), this content of the child cells of
the current cell are drawn, but grandchildren (children of child cells)
are drawn as boxes. Increasing the hierarchy levels will draw more
and more details of child cells until all cells below the current
cell are drawn in detail.
</p>
<p>
To select more hierarchy levels, choose
To select more hierarchy levels
</p>
<ul>
<li>"Full Hierarchy" from the "Display" menu or press the "*" key to
<li>Select "Full Hierarchy" from the "Display" menu or press the "*" key to
show all hierarchy levels</li>
<li>"Box Only" from the "Display" menu or press the "0" key to show
<li>Select "Box Only" from the "Display" menu or press the "0" key to show
only the bounding box (the default)</li>
<li>"Top Level Only" from the "Display" menu or press the "1" key to
<li>Select "Top Level Only" from the "Display" menu or press the "1" key to
show the top level elements</li>
<li>"Increment Hierarchy" from the "Display" menu or press the "+"
<li>Select "Increment Hierarchy" from the "Display" menu or press the "+"
key to show one more hierarchy level</li>
<li>"Decrement Hierarchy" from the "Display" menu or press the "-"
<li>Select "Decrement Hierarchy" from the "Display" menu or press the "-"
key to show one hierarchy level less</li>
<li>the hierarchy level entry fields below the cell list to change the
<li>Use the hierarchy level entry fields below the cell list to change the
current minimum or maximum level</li>
</ul>

6
src/lay/doc/manual/layer_fill.xml
View File

@ -16,11 +16,11 @@
panel.
</p>
<p>
New pattern can be created with the "Edit" button. A pattern editor
New pattern can be created with the "Custom Pattern" button. A pattern editor
will come up that allows creating and editing of new pattern. The predefined
pattern cannot be changed. To select a new pattern, select "More" from the
pattern cannot be changed. To apply a new pattern, select "More" from the
pattern selection panel and choose the new pattern from the list.
The new pattern is saved with the layer display properties.
The custom pattern are saved with the layer display properties.
</p>
</doc>

4
src/lay/doc/manual/layer_source_expert.xml
View File

@ -18,7 +18,7 @@
<p>
A geometrical transformation is specified by appending a transformation in
round brackets to the layer/datatype source specification. The format of this
transformation is (not necessarily in this order):
transformation is (in any order):
</p>
<p class="indent">
@ -33,7 +33,7 @@
</p>
<p>
A comprehensive explanation of the transformation syntax can be found in <link href="/about/transformations.xml"/>.
A detailed explanation of the transformation syntax can be found in <link href="/about/transformations.xml"/>.
</p>
<p>

8
src/lay/doc/manual/layer_style.xml
View File

@ -14,6 +14,7 @@
the change on. "0px" removes the line, "1px" draws a single-pixel wide
line (the default), "2px" a somewhat thicker line and so on.
</p>
<p>
"Simple" is the normal draw mode while "Marked" draws a cross on each
vertex of the element. The cross size is constant so the shapes stay
@ -21,4 +22,11 @@
single pixels.
</p>
<p>
A layer can be configured to draw a diagonal cross on rectangles.
To enable this style, select "Cross" from
the "Styles" toolbox. To disable it, choose "No Cross". The cross
drawing will add to the fill pattern and applies to rectangles only.
</p>
</doc>

42
src/lay/doc/manual/measure.xml
View File

@ -7,20 +7,30 @@
<keyword name="Rulers"/>
<p>
A measurement can be performed by choosing "Ruler" mode in the toolbar and
left-clicking a point in the layout
and left-clicking another point. A ruler will be shown that indicates
A measurement can be performed by clicking on the ruler icon in the
toolbar and selecting "Ruler" from the drop-down options.
Left-click on a point in the layout and then left-click again to
specify the second point. A ruler will be shown that indicates
the distance measured.
</p>
<p>
Various options can be specified for the rulers using the setup dialog.
To show the setup dialog, choose "Setup" from the "File" menu.
A more convenient way is provided with the single-click measurement
ruler. Select "Measure" from the drop-down options of the ruler symbol.
In this mode, a single click will set a ruler to the specified
position. This feature will look for edges in the vicinity of the
ruler and set the ruler to connect the neighboring edges. The ruler
is attached perpendicular to the edge next to the initial point.
</p>
<p>
On the "Rulers" tab, different options can be selected. A ruler can be
Rulers can be configured in manifold ways. Use "Rulers And Annotations Setup"
in the "Edit" menu to open the ruler configuration dialog.
A ruler can be
made to snap to edges of objects by selecting "Snap to edge/vertex".
Ruler orientations can be constrained by using the "Angle Constraint"
options.
options. The number of rulers can be limited using the "Limit
number of annotations" setting.
</p>
<p>
@ -30,27 +40,27 @@
while pressing both will release any direction constraint.
</p>
<p>
The number of rulers can be limited. If the number of rulers specified
is two for example, only the last two rulers are shown.
</p>
<p>
All rulers can be cleared using the "Clear all rulers" function from the
"Edit" menu.
</p>
<p>
Ruler dragging can be canceled with the "Esc" key or using the "Cancel"
function from the "Edit" menu.
</p>
<p>
Rulers can be moved by selecting "Move" mode with the speedbar buttons
in the toolbar or "Move" from the "Mode" submenu in the "Edit" menu. Then
left-click and drag the ruler or the ruler end point that should be changed.
</p>
<p>
Rulers can be deleted selectively by selecting a ruler in "Select" mode and
pressing "Delete".
</p>
<p>
Rulers can be modified in a variety of ways. For example, rulers can be shown
as arrows. To edit the properties of a ruler, double-click the ruler or
@ -58,11 +68,13 @@
See <link href="/manual/ruler_properties.xml"/> for a description of the
properties.
</p>
<p>
Multiple templates can be configured to be available for rulers. If multiple
templates are available, the "Ruler" mode toolbar button will show a drop-down
menu which allows selecting of one template to be used. Templates can be edited in the
ruler setup page ("Setup" from the "File" menu) or "Ruler Setup" from the "Edit" menu.
Multiple templates can be configured to be available for rulers. Each template defined
will be shown in the "Ruler" mode toolbar button's drop-down menu.
If a template is selected, new rulers produced from this template will inherit
the template's properties. Templates are managed in the
ruler setup page ("Setup" from the "File" menu) or "Ruler And Annotation Setup" from the "Edit" menu.
</p>
</doc>

14
src/lay/doc/manual/ruler_properties.xml
View File

@ -15,13 +15,18 @@
Each label can be configure individually to either show a text or the measurement
values. The main label is always present, X and Y labels are only present, if the ruler
has an explicit vertical or horizontal component (all outline styles except "diagonal").
For the main label the position of the label can be specified ("P" setting): the label
can be made to appear on the first or the second point or in the middle of the ruler.
The Alignment of the labels can be specified too: whether the appear left or right-aligned
or centered.
</li>
<li><b>Style:</b> the style determines how the ruler or it's components are drawn. This can be
"ruler-like" (with ticks), arrow style or a plain line.
"ruler-like" (with ticks), arrow style, a plain line or with cross markers at the end.
</li>
<li><b>Outline:</b> the outline determines how the two points forming the ruler are connected
to render the ruler shape. This is either just one line ("diagonal"), a horizontal and a vertical line
(in some outline styles combined with the diagonal line) or a box given by the two points of the
ruler. A special outline is the ellipse which draws an ellipse inside the box defined by the
ruler.
</li>
<li><b>Angle constraint:</b> the orientation of the ruler can be restricted in several ways, i.e.
@ -31,10 +36,15 @@
<li><b>Object snapping:</b> each ruler can be configure to snap to the closest object edge or vertex.
By default, the rulers use the global setting. It may be disabled however for each ruler.
</li>
<li><b>Mode:</b> in normal mode, two clicks are required to define a ruler: to set the first
point and to set the second one. In "Single click" mode, a single click will set both
points to the same. In "Auto measure" mode, the points will be determined by looking
for edges in the vicinity of the click point and adjusting the points accordingly.
</li>
</ul>
<p>
The label format is an arbitrary text with embedded expressions that may represent a measurement
The "Label format" is an arbitrary text with embedded expressions that may represent a measurement
value. Each such expression starts with a dollar sign, followed by the expression string. The expression
syntax supportis the basic operations ("*", "/", "+", "-" ..), bitwise operations ("|", "&amp;", ..),
the conditional operator ("x:y?z") as well as some functions, i.e. "abs", "sqrt", "exp". It includes a "sprintf"

1
src/lay/layHelpResources.qrc
View File

@ -187,6 +187,7 @@
<file alias="layer_color.xml">doc/manual/layer_color.xml</file>
<file alias="layer_content.xml">doc/manual/layer_content.xml</file>
<file alias="layer_fill.xml">doc/manual/layer_fill.xml</file>
<file alias="line_style.xml">doc/manual/line_style.xml</file>
<file alias="layer_hier.xml">doc/manual/layer_hier.xml</file>
<file alias="layer_ops.xml">doc/manual/layer_ops.xml</file>
<file alias="layer_order.xml">doc/manual/layer_order.xml</file>