diff --git a/src/lay/doc/about/technology_manager.xml b/src/lay/doc/about/technology_manager.xml index 59a440a28..1cc3fa189 100644 --- a/src/lay/doc/about/technology_manager.xml +++ b/src/lay/doc/about/technology_manager.xml @@ -32,12 +32,24 @@ are bound to a menu entry. Otherwise they will be invisible.
  • DRC scripts: in the same way, DRC scripts can be associated with a technology.
    • +
  • 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.
    • +
  • 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.

    • In the future, more aspects may be added to the technology definition.

    +

    + There is always one "Default" technology that is used when no technology is + specified. +

    +

    Setting up technologies

    @@ -105,56 +117,28 @@ or DRC scripts between technologies.

    -

    Importing and exporting technologies

    +

    Managing technologies

    - 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.

    - 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: -

    - - - -

    Auto-import feature

    - -

    - 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.

    - 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 for more details.

    diff --git a/src/lay/doc/manual/basic.xml b/src/lay/doc/manual/basic.xml index 91bd1941b..fcceaac52 100644 --- a/src/lay/doc/manual/basic.xml +++ b/src/lay/doc/manual/basic.xml @@ -25,7 +25,8 @@ - + + diff --git a/src/lay/doc/manual/hier.xml b/src/lay/doc/manual/hier.xml index 072c302b3..369e5ed27 100644 --- a/src/lay/doc/manual/hier.xml +++ b/src/lay/doc/manual/hier.xml @@ -9,24 +9,30 @@

    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.

    +

    - To select more hierarchy levels, choose + To select more hierarchy levels

      -
    • "Full Hierarchy" from the "Display" menu or press the "*" key to +
    • Select "Full Hierarchy" from the "Display" menu or press the "*" key to show all hierarchy levels
      • -
    • "Box Only" from the "Display" menu or press the "0" key to show +
    • Select "Box Only" from the "Display" menu or press the "0" key to show only the bounding box (the default)
      • -
    • "Top Level Only" from the "Display" menu or press the "1" key to +
    • Select "Top Level Only" from the "Display" menu or press the "1" key to show the top level elements
      • -
    • "Increment Hierarchy" from the "Display" menu or press the "+" +
    • Select "Increment Hierarchy" from the "Display" menu or press the "+" key to show one more hierarchy level
      • -
    • "Decrement Hierarchy" from the "Display" menu or press the "-" +
    • Select "Decrement Hierarchy" from the "Display" menu or press the "-" key to show one hierarchy level less
      • -
    • the hierarchy level entry fields below the cell list to change the +
    • Use the hierarchy level entry fields below the cell list to change the current minimum or maximum level
    diff --git a/src/lay/doc/manual/layer_fill.xml b/src/lay/doc/manual/layer_fill.xml index cf0a65cc0..03c2514f8 100644 --- a/src/lay/doc/manual/layer_fill.xml +++ b/src/lay/doc/manual/layer_fill.xml @@ -16,11 +16,11 @@ panel.

    - 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.

    diff --git a/src/lay/doc/manual/layer_source_expert.xml b/src/lay/doc/manual/layer_source_expert.xml index c0d719d8d..30619a4c1 100644 --- a/src/lay/doc/manual/layer_source_expert.xml +++ b/src/lay/doc/manual/layer_source_expert.xml @@ -18,7 +18,7 @@

    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):

    @@ -33,7 +33,7 @@

    - A comprehensive explanation of the transformation syntax can be found in . + A detailed explanation of the transformation syntax can be found in .

    diff --git a/src/lay/doc/manual/layer_style.xml b/src/lay/doc/manual/layer_style.xml index d42de02a3..6a3c5c6b5 100644 --- a/src/lay/doc/manual/layer_style.xml +++ b/src/lay/doc/manual/layer_style.xml @@ -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.

    +

    "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.

    +

    + 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. +

    + diff --git a/src/lay/doc/manual/measure.xml b/src/lay/doc/manual/measure.xml index e1ad3d182..836557ac3 100644 --- a/src/lay/doc/manual/measure.xml +++ b/src/lay/doc/manual/measure.xml @@ -7,20 +7,30 @@

    - 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.

    +

    - 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.

    +

    - 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.

    @@ -30,27 +40,27 @@ while pressing both will release any direction constraint.

    -

    - The number of rulers can be limited. If the number of rulers specified - is two for example, only the last two rulers are shown. -

    All rulers can be cleared using the "Clear all rulers" function from the "Edit" menu.

    +

    Ruler dragging can be canceled with the "Esc" key or using the "Cancel" function from the "Edit" menu.

    +

    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.

    +

    Rulers can be deleted selectively by selecting a ruler in "Select" mode and pressing "Delete".

    +

    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 for a description of the properties.

    +

    - 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.

    diff --git a/src/lay/doc/manual/ruler_properties.xml b/src/lay/doc/manual/ruler_properties.xml index fa6e3b7c3..bfcababf0 100644 --- a/src/lay/doc/manual/ruler_properties.xml +++ b/src/lay/doc/manual/ruler_properties.xml @@ -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.
  • Style: 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.
  • Outline: 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.
  • Angle constraint: the orientation of the ruler can be restricted in several ways, i.e. @@ -31,10 +36,15 @@
  • Object snapping: 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.
    • +
  • Mode: 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. +

    • - 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 ("|", "&", ..), the conditional operator ("x:y?z") as well as some functions, i.e. "abs", "sqrt", "exp". It includes a "sprintf" diff --git a/src/lay/layHelpResources.qrc b/src/lay/layHelpResources.qrc index d4ef98e04..33ed75312 100644 --- a/src/lay/layHelpResources.qrc +++ b/src/lay/layHelpResources.qrc @@ -187,6 +187,7 @@ doc/manual/layer_color.xml doc/manual/layer_content.xml doc/manual/layer_fill.xml + doc/manual/line_style.xml doc/manual/layer_hier.xml doc/manual/layer_ops.xml doc/manual/layer_order.xml