Skip to content
Open
Binary file added tutorial/MolexKK254.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added tutorial/MolexKK254MALE.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
55 changes: 55 additions & 0 deletions tutorial/readme.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,24 @@
# WireViz Tutorial

[01 - Bare-bones example](#01---Bare-bones-example)

[02 - Adding parameters and colors](#02---adding-parameters-and-colors)

[03 - Pinouts, shielding, templates (I)](#03---pinouts-shielding-templates-(I))

[04 - Templates (II), notes, American standards, daisy chaining (I)](#04---templates-(II)-notes-american-standards-daisy-chaining-(I))

[05 - Ferrules, wire bundles, custom wire colors](#05---ferrules,-wire-bundles,-custom-wire-colors)

[06 - Custom ferrules](#06---custom-ferrules)

[07 - Daisy chaining (II)](#07---daisy-chaining-(II))

[08 - Part numbers and additional components](#08---part-numbers-and-additional-components)

[09 - Hidden wire information and using a template for nice display](#09---hidden-wire-information-and-using-a-template-for-nice-display-as-a-din6771-document)


## 01 - Bare-bones example

* Minimum working example
Expand Down Expand Up @@ -417,3 +436,39 @@ additional_bom_items:
[Source](tutorial08.yml) - [Bill of Materials](tutorial08.bom.tsv)


## 09 - Hidden wire information and using a template for nice display as a DIN6771 document

What will this 'tutorial' show you?

## Hide wire information

* Sometimes the box around the wire will be distracting
* unfortunately some fields can not (yetd) be suppressed:
length
gauge
color_code
manufacturer
mpn
supplier
spn
pn

## Nice uniform template

* Formatting the end result in a DIN-6771 template makes for a very nice result.
* using a template ensures all your wiring diagrams will have a uniform look
* the template can be found at:
/home/[USER]/.local/lib/python3.10/site-packages/wireviz/templates/din-6771.html

## Adding images to your components
* Add an image to your component


```yaml
<!-- include(tutorial09.yml) -->

```

![](tutorial09.png)

[Source](tutorial09.yml) - [Bill of Materials](tutorial09.bom.tsv)
Loading