@windypro-rourou/dsh-eda 0.1.4 → 0.1.6

package/skill/format/project/meta.md

@@ -1,189 +1,189 @@
-# Basic Information
-
-### Project Config
-
-Stores project configuration data, previously kept in the backend project details.
-
-```json
-{ "type": "META", "ticket": 1 }||{ "name": "name", "default_sheet": "default_sheet_uuid"}|
-```
-
-1. name project name.
-2. default_sheet default sheet of the project.
-
-### Board
-
-```json
-{ "type": "META", "ticket": 1 }||{ "title": "title", "sort": 1}|
-```
-
-1. title board name.
-2. sort sort weight.
-
-### Schematic
-
-```json
-{ "type": "META", "ticket": 1 }||{ "name": "name", "board":"", "source": "", "version": ""}|
-```
-
-1. name name.
-2. board uuid of the board it belongs to, empty if none.
-3. source source document uuid.
-4. version version, update time of the source document.
-
-### Schematic Page
-
-```json
-{ "type": "META", "ticket": 1 }||
-{
-    "name": "Page Name",
-    "schematic": "SID",
-    "description": "description",
-    "sort": 0.5,
-    "source": "",
-    "version": "",
-}|
-```
-
-1. name name.
-2. schematic uuid of the schematic it belongs to.
-3. description description.
-4. sort sort weight.
-5. source source document uuid.
-6. version version, update time of the source document.
-
-### PCB
-
-```json
-{ "type": "META", "ticket": 1 }||
-{
-    "name": "PCB Name",
-    "board": "boardId",
-    "description": "description",
-    "parentId":"",
-    "sort": 0.5,
-    "source": "",
-    "version": "",
-}|
-```
-
-1. name name.
-2. board uuid of the board it belongs to, empty if none.
-3. description description.
-4. parentId parent PCB UUID, empty if none.
-5. sort sort weight.
-6. source source document uuid.
-7. version version, update time of the source document.
-
-Child PCB
-
-```json
-{ "type": "META", "ticket": 1 }||
-{
-    "name": "Child PCB Name",
-    "board": "",
-    "description": "description",
-    "parentId":"UUID",
-    "sort": 0.2,
-    "source": "",
-    "version": "",
-}|
-```
-
-### Panel
-
-```json
-{ "type": "META", "ticket": 1 }||
-{
-    "name": "Panel Name",
-    "description": "description",
-    "sort": 0.5,
-}|
-```
-
-1. name name.
-2. description description.
-3. sort sort weight.
-
-### Symbol
-
-```json
-{ "type": "META", "ticket": 1 }||
-{
-    "name": "Name",
-    "description": "description",
-    "type": 2,
-    "tags": "tag1",
-    "source": "",
-    "version": "",
-}|
-```
-
-1. name name.
-2. description description.
-3. type symbol type.
-4. tags classification tags.
-5. source source document uuid.
-6. version version, update time of the source document.
-
-### Footprint
-
-```json
-{ "type": "META", "ticket": 1 }||
-{
-    "name": "Name",
-    "description": "description",
-    "type": 4,
-    "tags": "tag1",
-    "source": "",
-    "version": "",
-    "pcb": "",
-}|
-```
-
-1. name name.
-2. description description.
-3. type footprint type.
-4. tags classification tags.
-5. source source document uuid.
-6. version version, update time of the source document.
-7. pcb uuid of the pcb it belongs to, empty by default. Only special footprints have this field.
-
-Special Footprint
-
-```json
-{ "type": "META", "ticket": 1 }||
-{
-    "name": "Name",
-    "description": "description",
-    "type": 4,
-    "tags": "tag1",
-    "source": "",
-    "version": "",
-    "pcb": "pcbUuid",
-}|
-```
-
-### Device
-
-```json
-{ "type": "META", "ticket": 1 }||
-{
-    "name": "Name",
-    "description": "description",
-    "type": 4,
-    "tags": "tag1",
-    "source": "",
-    "version": "",
-    "attributes": {},
-    "images": "",
-}|
-```
-
-1. name name.
-2. description description.
-3. tags classification tags.
-4. source source document uuid.
-5. version version, update time of the source document.
-6. attributes device attributes Key-Value.
-7. images image links.
+# Basic Information
+
+### Project Config
+
+Stores project configuration data, previously kept in the backend project details.
+
+```json
+{ "type": "META", "ticket": 1 }||{ "name": "name", "default_sheet": "default_sheet_uuid"}|
+```
+
+1. name project name.
+2. default_sheet default sheet of the project.
+
+### Board
+
+```json
+{ "type": "META", "ticket": 1 }||{ "title": "title", "sort": 1}|
+```
+
+1. title board name.
+2. sort sort weight.
+
+### Schematic
+
+```json
+{ "type": "META", "ticket": 1 }||{ "name": "name", "board":"", "source": "", "version": ""}|
+```
+
+1. name name.
+2. board uuid of the board it belongs to, empty if none.
+3. source source document uuid.
+4. version version, update time of the source document.
+
+### Schematic Page
+
+```json
+{ "type": "META", "ticket": 1 }||
+{
+    "name": "Page Name",
+    "schematic": "SID",
+    "description": "description",
+    "sort": 0.5,
+    "source": "",
+    "version": "",
+}|
+```
+
+1. name name.
+2. schematic uuid of the schematic it belongs to.
+3. description description.
+4. sort sort weight.
+5. source source document uuid.
+6. version version, update time of the source document.
+
+### PCB
+
+```json
+{ "type": "META", "ticket": 1 }||
+{
+    "name": "PCB Name",
+    "board": "boardId",
+    "description": "description",
+    "parentId":"",
+    "sort": 0.5,
+    "source": "",
+    "version": "",
+}|
+```
+
+1. name name.
+2. board uuid of the board it belongs to, empty if none.
+3. description description.
+4. parentId parent PCB UUID, empty if none.
+5. sort sort weight.
+6. source source document uuid.
+7. version version, update time of the source document.
+
+Child PCB
+
+```json
+{ "type": "META", "ticket": 1 }||
+{
+    "name": "Child PCB Name",
+    "board": "",
+    "description": "description",
+    "parentId":"UUID",
+    "sort": 0.2,
+    "source": "",
+    "version": "",
+}|
+```
+
+### Panel
+
+```json
+{ "type": "META", "ticket": 1 }||
+{
+    "name": "Panel Name",
+    "description": "description",
+    "sort": 0.5,
+}|
+```
+
+1. name name.
+2. description description.
+3. sort sort weight.
+
+### Symbol
+
+```json
+{ "type": "META", "ticket": 1 }||
+{
+    "name": "Name",
+    "description": "description",
+    "type": 2,
+    "tags": "tag1",
+    "source": "",
+    "version": "",
+}|
+```
+
+1. name name.
+2. description description.
+3. type symbol type.
+4. tags classification tags.
+5. source source document uuid.
+6. version version, update time of the source document.
+
+### Footprint
+
+```json
+{ "type": "META", "ticket": 1 }||
+{
+    "name": "Name",
+    "description": "description",
+    "type": 4,
+    "tags": "tag1",
+    "source": "",
+    "version": "",
+    "pcb": "",
+}|
+```
+
+1. name name.
+2. description description.
+3. type footprint type.
+4. tags classification tags.
+5. source source document uuid.
+6. version version, update time of the source document.
+7. pcb uuid of the pcb it belongs to, empty by default. Only special footprints have this field.
+
+Special Footprint
+
+```json
+{ "type": "META", "ticket": 1 }||
+{
+    "name": "Name",
+    "description": "description",
+    "type": 4,
+    "tags": "tag1",
+    "source": "",
+    "version": "",
+    "pcb": "pcbUuid",
+}|
+```
+
+### Device
+
+```json
+{ "type": "META", "ticket": 1 }||
+{
+    "name": "Name",
+    "description": "description",
+    "type": 4,
+    "tags": "tag1",
+    "source": "",
+    "version": "",
+    "attributes": {},
+    "images": "",
+}|
+```
+
+1. name name.
+2. description description.
+3. tags classification tags.
+4. source source document uuid.
+5. version version, update time of the source document.
+6. attributes device attributes Key-Value.
+7. images image links.

package/skill/format/project/variant.md

@@ -1,30 +1,30 @@
-# Variant
-
-## Document Header
-
-```json
-{ "type": "DOCHEAD" }||{ "docType": "VARIANT", "uuid": "UUID", "client": "clientID" }|
-```
-
-1. type: `DOCHEAD`, document header identifier.
-2. docType: `VARIANT` variant data.
-3. uuid: unique identifier, random id.
-4. client: terminal identifier for eventual consistency.
-
-## META Basic Information
-
-```json
-{ "type": "META", "ticket": 1 }||
-{
-	/** Name */
-	"title": string,
-	/** Description */
-	"description": string,
-	/** Schematic */
-	"schematicId": string,
-	/** Sort order */
-	"zIndex": number,
-	/** Whether there are ungrouped items */
-	"notGrouped": boolean,
-}|
-```
+# Variant
+
+## Document Header
+
+```json
+{ "type": "DOCHEAD" }||{ "docType": "VARIANT", "uuid": "UUID", "client": "clientID" }|
+```
+
+1. type: `DOCHEAD`, document header identifier.
+2. docType: `VARIANT` variant data.
+3. uuid: unique identifier, random id.
+4. client: terminal identifier for eventual consistency.
+
+## META Basic Information
+
+```json
+{ "type": "META", "ticket": 1 }||
+{
+	/** Name */
+	"title": string,
+	/** Description */
+	"description": string,
+	/** Schematic */
+	"schematicId": string,
+	/** Sort order */
+	"zIndex": number,
+	/** Whether there are ungrouped items */
+	"notGrouped": boolean,
+}|
+```

package/skill/format/schematic/attr.md

@@ -1,41 +1,41 @@
-# ATTR Attribute
-
-ATTR is a relatively generic primitive that means:
-
-1. It expresses one of multiple attributes composed of a KEY-VALUE pair.
-2. It can be displayed on the canvas and controls what content is displayed, as well as style and position.
-
-When the affiliation ID is not specified, it defaults to the current block-level primitive.
-
-```json
-{ "type": "ATTR", "id": "UUID", "ticket": 1 }||
-{ "partId": "", "groupId": 0, "locked": false, "zIndex": 0.1, "parentId": "UUID", "key":"string", "value":"string", "keyVisible":false, "valueVisible":false, "positionX":200, "positionY":200, "rotation":0, "color":null, "fillColor":null, "fontFamily":null, "fontSize":null, "strikeout":null, "underline":null, "italic":null, "fontWeight":null, "vAlign":0, "hAlign":2,}|
-```
-
-1. type attribute name: ATTR.
-2. id unique ID.
-3. ticket logical clock.
-4. partId sub-library ID, exclusive to symbol pages; ignored on schematics.
-5. groupId group ID, cannot be 0, empty by default when none.
-6. locked whether locked.
-7. zIndex Z-axis height.
-8. parentId affiliation ID: the primitive it belongs to, `""` means it belongs to the current block. _Default block is the file._
-9. key attribute Key.
-10. value attribute Value.
-11. keyVisible whether to display Key.
-12. valueVisible whether to display Value.
-13. positionX position X: fixed to `null` for attributes that have never been displayed.
-14. positionY position Y: fixed to `null` for attributes that have never been displayed.
-15. rotation rotation angle, rotated around `position`.
-16. color color.
-17. fillColor background color.
-18. fontFamily font name.
-19. fontSize font size, same unit as coordinates.
-20. strikeout whether to strike out.
-21. underline whether to underline.
-22. italic whether italic.
-23. fontWeight whether bold.
-24. vAlign vertical alignment: 0 top, 1 middle, 2 bottom.
-25. hAlign horizontal alignment: 0 left, 1 center, 2 right.
-
-When the attribute Value contains the `~` character, XTools needs to implement overline text from the start to the end: text is overlined starting at odd-numbered `~` and ending at even-numbered `~`.
+# ATTR Attribute
+
+ATTR is a relatively generic primitive that means:
+
+1. It expresses one of multiple attributes composed of a KEY-VALUE pair.
+2. It can be displayed on the canvas and controls what content is displayed, as well as style and position.
+
+When the affiliation ID is not specified, it defaults to the current block-level primitive.
+
+```json
+{ "type": "ATTR", "id": "UUID", "ticket": 1 }||
+{ "partId": "", "groupId": 0, "locked": false, "zIndex": 0.1, "parentId": "UUID", "key":"string", "value":"string", "keyVisible":false, "valueVisible":false, "positionX":200, "positionY":200, "rotation":0, "color":null, "fillColor":null, "fontFamily":null, "fontSize":null, "strikeout":null, "underline":null, "italic":null, "fontWeight":null, "vAlign":0, "hAlign":2,}|
+```
+
+1. type attribute name: ATTR.
+2. id unique ID.
+3. ticket logical clock.
+4. partId sub-library ID, exclusive to symbol pages; ignored on schematics.
+5. groupId group ID, cannot be 0, empty by default when none.
+6. locked whether locked.
+7. zIndex Z-axis height.
+8. parentId affiliation ID: the primitive it belongs to, `""` means it belongs to the current block. _Default block is the file._
+9. key attribute Key.
+10. value attribute Value.
+11. keyVisible whether to display Key.
+12. valueVisible whether to display Value.
+13. positionX position X: fixed to `null` for attributes that have never been displayed.
+14. positionY position Y: fixed to `null` for attributes that have never been displayed.
+15. rotation rotation angle, rotated around `position`.
+16. color color.
+17. fillColor background color.
+18. fontFamily font name.
+19. fontSize font size, same unit as coordinates.
+20. strikeout whether to strike out.
+21. underline whether to underline.
+22. italic whether italic.
+23. fontWeight whether bold.
+24. vAlign vertical alignment: 0 top, 1 middle, 2 bottom.
+25. hAlign horizontal alignment: 0 left, 1 center, 2 right.
+
+When the attribute Value contains the `~` character, XTools needs to implement overline text from the start to the end: text is overlined starting at odd-numbered `~` and ending at even-numbered `~`.

package/skill/format/schematic/common.md

@@ -1,47 +1,47 @@
-# Common Format
-
-This chapter details the format specification of the EasyEDA schematic file. Schematic files mainly consist of the following parts:
-
-- **Common Configuration**: Document header and canvas configuration.
-- **Structural Elements**: PART sub-libraries and GROUP combinations.
-- **Attributes**: Primitive attribute definitions.
-- **Wires**: Wires, buses, and bus entries.
-- **Text**: Text elements.
-- **Shapes**: Rectangles, polygons, circles, arcs, Bezier curves, ellipses.
-- **Pins**: Pin definitions.
-- **Components**: Schematic component instances.
-- **Objects**: Binary objects (images, etc.).
-- **Tables**: Tables and cells.
-
-
-## Document Header
-
-```json
-{ "type": "DOCHEAD" }||{ "docType": "SCH_PAGE", "uuid": "UUID", "client": "clientID" }|
-```
-
-```json
-{ "type": "DOCHEAD" }||{ "docType": "SYMBOL", "uuid": "UUID", "client": "clientID" }|
-```
-
--   type: "DOCHEAD", document header identifier.
--   docType: document type, "SCH_PAGE": schematic, "SYMBOL": symbol.
--   uuid: document unique ID, unique within the project.
--   client: terminal identifier for eventual consistency.
-
-## Canvas Configuration
-
-Editor additional information, used for data analysis and other functions. Currently occupied fields:
-
-```json
-{ "type": "CANVAS", "ticket": 1 }||
-{
-  "originX":0,
-  "originY":0,
-}|
-```
-
-1. type: "CANVAS", canvas configuration identifier.
-2. ticket logical clock.
-3. originX canvas origin X.
-4. originY canvas origin Y.
+# Common Format
+
+This chapter details the format specification of the EasyEDA schematic file. Schematic files mainly consist of the following parts:
+
+- **Common Configuration**: Document header and canvas configuration.
+- **Structural Elements**: PART sub-libraries and GROUP combinations.
+- **Attributes**: Primitive attribute definitions.
+- **Wires**: Wires, buses, and bus entries.
+- **Text**: Text elements.
+- **Shapes**: Rectangles, polygons, circles, arcs, Bezier curves, ellipses.
+- **Pins**: Pin definitions.
+- **Components**: Schematic component instances.
+- **Objects**: Binary objects (images, etc.).
+- **Tables**: Tables and cells.
+
+
+## Document Header
+
+```json
+{ "type": "DOCHEAD" }||{ "docType": "SCH_PAGE", "uuid": "UUID", "client": "clientID" }|
+```
+
+```json
+{ "type": "DOCHEAD" }||{ "docType": "SYMBOL", "uuid": "UUID", "client": "clientID" }|
+```
+
+-   type: "DOCHEAD", document header identifier.
+-   docType: document type, "SCH_PAGE": schematic, "SYMBOL": symbol.
+-   uuid: document unique ID, unique within the project.
+-   client: terminal identifier for eventual consistency.
+
+## Canvas Configuration
+
+Editor additional information, used for data analysis and other functions. Currently occupied fields:
+
+```json
+{ "type": "CANVAS", "ticket": 1 }||
+{
+  "originX":0,
+  "originY":0,
+}|
+```
+
+1. type: "CANVAS", canvas configuration identifier.
+2. ticket logical clock.
+3. originX canvas origin X.
+4. originY canvas origin Y.