rusefi
/
rusefi_documentation
mirror of https://github.com/rusefi/rusefi_documentation.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update Connector Mapping for new version of interactive-pinout (#415) 

* add directory field

* id -> cid
This commit is contained in:
David Holdeman 2023-02-10 07:27:56 -06:00 committed by GitHub
parent 0051788b97
commit f466b12c96
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 2 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
Connector-Mapping.md
View File

@ -33,9 +33,10 @@ The 'info' section contains information which is used to generate the interactiv
|field |description|required for|
|---------|-----------|------------|
|id |contains a short name for the connector, to be used in the URL when linking to a particular pin|pinouts|
|cid |contains a short name for the connector, to be used in the URL when linking to a particular pin|pinouts|
|image |subsection which contains a single field, 'file', which contains the filename of the image, which is stored in the same directory as the YAML|pinouts|
|pins |subsection with a list of the pins' locations on the image. Its fields are 'pin', which matches to an 'id' in the main 'pins' section, 'x' and 'y', which are the coordinates on the image|pinouts|
|directory|contains the target directory for the page. Only one connector for a particular board needs this field|pinouts|
|title |contains the title for the page. Only one connector for a particular board needs this field|informational|
|board_url|contains a URL for documentation, which will be placed as a link on the top of the page. Only one connector for a particular board needs this field|informational|
|name |contains a human-readable name for the connector|informational|