From 7649cec683a937288a0eefd7d18fe29f066f326a Mon Sep 17 00:00:00 2001 From: Stefan Schippers Date: Fri, 9 Oct 2020 03:04:49 +0200 Subject: [PATCH] doc updates (developer info) --- doc/xschem_man/developer_info.html | 35 ++++++++++++++++++++---------- 1 file changed, 24 insertions(+), 11 deletions(-) diff --git a/doc/xschem_man/developer_info.html b/doc/xschem_man/developer_info.html index 0adfcec2..90176fba 100644 --- a/doc/xschem_man/developer_info.html +++ b/doc/xschem_man/developer_info.html @@ -111,7 +111,7 @@ p{padding: 15px 30px 10px;}

XSCHEM FILE FORMAT SPECIFICATION

XSCHEM schematics and symbols are stored in .sch and .sym files respectively. The two file formats are identical, with the - exception that symbol (.sym) files do not contain wires and component instantiations. + exception that symbol (.sym) files usually do not contain wires and component instantiations (although they can).

every schematic/symbol object has a corresponding record in the file. @@ -122,9 +122,11 @@ p{padding: 15px 30px 10px;}

  • S : Global property associated to the .sch file for SPICE netlisting
  • V : Global property associated to the .sch file for VERILOG netlisting
  • G : Global property associated to the .sch file for VHDL netlisting OR - Global property associated to the .sym file for netlisting
    • + Global property associated to the .sym file for netlisting (in 1,2 file + format K is used, although backward compatibility is guaranteed)
  • E : Global property associated to the .sch file for tEDAx netlisting
    • -
  • K : Global property associated to the .sch file for netlisting if schematic is instantiated as a component (file format 1.2 and newer)
    • +
  • K : Global property associated to the .sch/sym file for netlisting.
    + For schematic it is used if instantiated as a component (file format 1.2 and newer)
  • L : Line
  • B : Rectangle
  • P : Open / Closed polygon
    • @@ -184,11 +186,11 @@ T {NF=@nf} -5 -15 0 1 0.15 0.15 {}

    VERSION STRING

    Example:
    -v {xschem version=2.8.2_RC3 file_version=1.0}     +v {xschem version=2.9.7 file_version=1.2}

    Two attributes are defined, the xschem version and the file format version. - Current file format version is 1.0. This string is guaranteed to be the first one in XSCHEM .sch and .sym files. + Current file format version is 1.2. This string is guaranteed to be the first one in XSCHEM .sch and .sym files.

    GLOBAL SCHEMATIC/SYMBOL PROPERTIES

    @@ -204,14 +206,15 @@ template="name=U1 footprint=TO220"} Global properties define a property string bound to the parent schematic/symbol file, there is one global property record per netlisting mode, currently SPICE, VHDL, Verilog, tEDAx.
    - In addition (only in file_format 1.2 and newer) for schematics there is a global attribute ('K') - that defines how to netlist the schematic if placed as a - symbol into another parent schematic (should be set in the same way as the 'G' global attribute for symbols). - Normally only 'G' type property strings are used for symbols and define attributes + In addition (only in file_format 1.2 and newer) for schematics and symbols there is a global attribute ('K') + that defines how to netlist the schematic/symbol if placed as a + symbol into another parent schematic (should be set in the same way as the 'G' global attribute for symbols + in pre-1.2 file format). + Normally only 'G' ('K' in 1.2 file format) type property strings are used for symbols and define attributes telling netlisters what to do with the symbol, while global property strings in schematic files corresponding to the active netlisting mode of XSCHEM are copied verbatim to the netlist.
    - the object tag (S, V, G, E) is followed by the property string enclosed in curly braces + the object tag (S, V, G, E, K) is followed by the property string enclosed in curly braces ({...}). This allows strings to contain any white space and newlines. Curly braces if present in the string are automatically escaped with the '\' character by XSCHEM when saving data.
    @@ -241,7 +244,17 @@ in this case only the verilog-related global property has some definition. This with respect to its anchor point.

  • text X and Y sizes are stored as floating point numbers.
    • -
  • Finally a property string is stored with the same syntax as the displayed text field.
    • +
  • Finally a property string is stored with the same syntax as the displayed text field. + Currently the following attributes are predefined for text objects:

    + +

    • WIRE OBJECT